src/emuvim/test/api_base.py

   1 # Copyright (c) 2015 SONATA-NFV and Paderborn University
   2 # ALL RIGHTS RESERVED.
   3 #
   4 # Licensed under the Apache License, Version 2.0 (the "License");
   5 # you may not use this file except in compliance with the License.
   6 # You may obtain a copy of the License at
   7 #
   8 #    http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15 #
  16 # Neither the name of the SONATA-NFV, Paderborn University
  17 # nor the names of its contributors may be used to endorse or promote
  18 # products derived from this software without specific prior written
  19 # permission.
  20 #
  21 # This work has been performed in the framework of the SONATA project,
  22 # funded by the European Commission under Grant number 671517 through
  23 # the Horizon 2020 and 5G-PPP programmes. The authors would like to
  24 # acknowledge the contributions of their colleagues of the SONATA
  25 # partner consortium (www.sonata-nfv.eu).
  26 import unittest
  27 import os
  28 import subprocess
  29 import docker
  30 from emuvim.dcemulator.net import DCNetwork
  31 from emuvim.api.rest.rest_api_endpoint import RestApiEndpoint
  32 from mininet.clean import cleanup
  33 from mininet.node import Controller
  34
  35
  36 class SimpleTestTopology(unittest.TestCase):
  37     """
  38         Helper class to do basic test setups.
  39         s1 -- s2 -- s3 -- ... -- sN
  40     """
  41
  42     def __init__(self, *args, **kwargs):
  43         self.net = None
  44         self.api = None
  45         self.s = []   # list of switches
  46         self.h = []   # list of hosts
  47         self.d = []   # list of docker containers
  48         self.dc = []  # list of data centers
  49         self.docker_cli = None
  50         super(SimpleTestTopology, self).__init__(*args, **kwargs)
  51
  52     def createNet(
  53             self,
  54             nswitches=0, ndatacenter=0, nhosts=0, ndockers=0,
  55             autolinkswitches=False, controller=Controller, **kwargs):
  56         """
  57         Creates a Mininet instance and automatically adds some
  58         nodes to it.
  59
  60         Attention, we should always use Mininet's default controller
  61         for our tests. Only use other controllers if you want to test
  62         specific controller functionality.
  63         """
  64         self.net = DCNetwork(controller=controller, **kwargs)
  65         self.api = RestApiEndpoint("127.0.0.1", 5001, self.net)
  66         # add some switches
  67         # start from s1 because ovs does not like to have dpid = 0
  68         # and switch name-number is being used by mininet to set the dpid
  69         for i in range(1, nswitches + 1):
  70             self.s.append(self.net.addSwitch('s%d' % i))
  71         # if specified, chain all switches
  72         if autolinkswitches:
  73             for i in range(0, len(self.s) - 1):
  74                 self.net.addLink(self.s[i], self.s[i + 1])
  75         # add some data centers
  76         for i in range(0, ndatacenter):
  77             self.dc.append(
  78                 self.net.addDatacenter(
  79                     'datacenter%d' % i,
  80                     metadata={"unittest_dc": i}))
  81         # connect data centers to the endpoint
  82         for i in range(0, ndatacenter):
  83             self.api.connectDatacenter(self.dc[i])
  84         # add some hosts
  85         for i in range(0, nhosts):
  86             self.h.append(self.net.addHost('h%d' % i))
  87         # add some dockers
  88         for i in range(0, ndockers):
  89             self.d.append(self.net.addDocker('d%d' %
  90                                              i, dimage="ubuntu:trusty"))
  91
  92     def startApi(self):
  93         self.api.start()
  94
  95     def stopApi(self):
  96         self.api.stop()
  97
  98     def startNet(self):
  99         self.net.start()
 100
 101     def stopNet(self):
 102         self.net.stop()
 103
 104     def getDockerCli(self):
 105         """
 106         Helper to interact with local docker instance.
 107         """
 108         if self.docker_cli is None:
 109             self.docker_cli = docker.APIClient(
 110                 base_url='unix://var/run/docker.sock')
 111         return self.docker_cli
 112
 113     def getContainernetContainers(self):
 114         """
 115         List the containers managed by containernet
 116         """
 117         return self.getDockerCli().containers(
 118             filters={"label": "com.containernet"})
 119
 120     @staticmethod
 121     def setUp():
 122         pass
 123
 124     @staticmethod
 125     def tearDown():
 126         cleanup()
 127         # make sure that all pending docker containers are killed
 128         with open(os.devnull, 'w') as devnull:
 129             subprocess.call(
 130                 "sudo docker rm -f $(sudo docker ps --filter 'label=com.containernet' -a -q)",
 131                 stdout=devnull,
 132                 stderr=devnull,
 133                 shell=True)