Merge pull request #135 from mpeuster/master
[osm/vim-emu.git] / src / emuvim / test / api_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 emuvim.api.rest.rest_api_endpoint import RestApiEndpoint
39 from mininet.clean import cleanup
40 from mininet.node import Controller
41
42 class SimpleTestTopology(unittest.TestCase):
43 """
44 Helper class to do basic test setups.
45 s1 -- s2 -- s3 -- ... -- sN
46 """
47
48 def __init__(self, *args, **kwargs):
49 self.net = None
50 self.api = None
51 self.s = [] # list of switches
52 self.h = [] # list of hosts
53 self.d = [] # list of docker containers
54 self.dc = [] # list of data centers
55 self.docker_cli = None
56 super(SimpleTestTopology, self).__init__(*args, **kwargs)
57
58 def createNet(
59 self,
60 nswitches=0, ndatacenter=0, nhosts=0, ndockers=0,
61 autolinkswitches=False, controller=Controller, **kwargs):
62 """
63 Creates a Mininet instance and automatically adds some
64 nodes to it.
65
66 Attention, we should always use Mininet's default controller
67 for our tests. Only use other controllers if you want to test
68 specific controller functionality.
69 """
70 self.net = DCNetwork(controller=controller, **kwargs)
71 self.api = RestApiEndpoint("127.0.0.1", 5001)
72 # add some switches
73 # start from s1 because ovs does not like to have dpid = 0
74 # and switch name-number is being used by mininet to set the dpid
75 for i in range(1, nswitches+1):
76 self.s.append(self.net.addSwitch('s%d' % i))
77 # if specified, chain all switches
78 if autolinkswitches:
79 for i in range(0, len(self.s) - 1):
80 self.net.addLink(self.s[i], self.s[i + 1])
81 # add some data centers
82 for i in range(0, ndatacenter):
83 self.dc.append(
84 self.net.addDatacenter(
85 'datacenter%d' % i,
86 metadata={"unittest_dc": i}))
87 # connect data centers to the endpoint
88 for i in range(0, ndatacenter):
89 self.api.connectDatacenter(self.dc[i])
90 # add some hosts
91 for i in range(0, nhosts):
92 self.h.append(self.net.addHost('h%d' % i))
93 # add some dockers
94 for i in range(0, ndockers):
95 self.d.append(self.net.addDocker('d%d' % i, dimage="ubuntu:trusty"))
96
97 def startApi(self):
98 self.api.start()
99
100 def startNet(self):
101 self.net.start()
102
103 def stopNet(self):
104 self.net.stop()
105
106 def getDockerCli(self):
107 """
108 Helper to interact with local docker instance.
109 """
110 if self.docker_cli is None:
111 self.docker_cli = docker.Client(
112 base_url='unix://var/run/docker.sock')
113 return self.docker_cli
114
115 def getContainernetContainers(self):
116 """
117 List the containers managed by containernet
118 """
119 return self.getDockerCli().containers(filters={"label": "com.containernet"})
120
121 @staticmethod
122 def setUp():
123 pass
124
125 @staticmethod
126 def tearDown():
127 cleanup()
128 # make sure that all pending docker containers are killed
129 with open(os.devnull, 'w') as devnull:
130 subprocess.call(
131 "sudo docker rm -f $(sudo docker ps --filter 'label=com.containernet' -a -q)",
132 stdout=devnull,
133 stderr=devnull,
134 shell=True)