src/emuvim/test/base.py

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