CSIT-1477: add 1n_tx2 VPP Device
[csit.git] / resources / libraries / python / ContainerUtils.py
index 11bb964..2286489 100644 (file)
 
 """Library to manipulate Containers."""
 
+from string import Template
 from collections import OrderedDict, Counter
 
 from resources.libraries.python.ssh import SSH
-from resources.libraries.python.constants import Constants
+from resources.libraries.python.Constants import Constants
 from resources.libraries.python.topology import Topology
 from resources.libraries.python.VppConfigGenerator import VppConfigGenerator
 
@@ -135,18 +136,17 @@ class ContainerManager(object):
             self.engine.container = self.containers[container]
             self.engine.execute(command)
 
-    def install_vpp_in_all_containers(self):
-        """Install VPP into all containers."""
+    def start_vpp_in_all_containers(self):
+        """Start VPP in all containers."""
         for container in self.containers:
             self.engine.container = self.containers[container]
             # We need to install supervisor client/server system to control VPP
             # as a service
             self.engine.install_supervisor()
-            self.engine.install_vpp()
-            self.engine.restart_vpp()
+            self.engine.start_vpp()
 
     def restart_vpp_in_all_containers(self):
-        """Restart VPP on all containers."""
+        """Restart VPP in all containers."""
         for container in self.containers:
             self.engine.container = self.containers[container]
             self.engine.restart_vpp()
@@ -166,83 +166,167 @@ class ContainerManager(object):
         dut_cnt = len(Counter([self.containers[container].node['host']
                                for container in self.containers]))
         mod = len(self.containers)/dut_cnt
-        container_vat_template = 'memif_create_{topology}.vat'.format(
-            topology=chain_topology)
-
-        if chain_topology == 'chain':
-            for i, container in enumerate(self.containers):
-                mid1 = i % mod + 1
-                mid2 = i % mod + 1
-                sid1 = i % mod * 2 + 1
-                sid2 = i % mod * 2 + 2
-                self.engine.container = self.containers[container]
-                self.engine.create_vpp_startup_config()
-                c_name = self.engine.container.name
-                guest_dir = self.engine.container.mnt[0].split(':')[1]
-                self.engine.create_vpp_exec_config(
-                    container_vat_template,
-                    mid1=mid1, mid2=mid2, sid1=sid1, sid2=sid2,
-                    socket1='{dir}/memif-{c_name}-{sid}'.
-                    format(c_name=c_name, sid=sid1, dir=guest_dir),
-                    socket2='{dir}/memif-{c_name}-{sid}'.
-                    format(c_name=c_name, sid=sid2, dir=guest_dir))
-        elif chain_topology == 'cross_horiz':
-            if mod > 1:
-                raise RuntimeError('Container chain topology {topology} '
-                                   'supports only single container.'.
-                                   format(topology=chain_topology))
-            for i, container in enumerate(self.containers):
-                mid1 = i % mod + 1
-                sid1 = i % mod * 2 + 1
-                try:
-                    dut1_if = kwargs['dut1_if']
-                except KeyError:
-                    raise AttributeError('Missing dut1_if parameter.')
-                try:
-                    dut2_if = kwargs['dut2_if']
-                except KeyError:
-                    raise AttributeError('Missing dut2_if parameter.')
-                self.engine.container = self.containers[container]
-                c_name = self.engine.container.name
-                guest_dir = self.engine.container.mnt[0].split(':')[1]
-                if 'DUT1' in self.engine.container.name:
-                    if_pci = Topology.get_interface_pci_addr(
-                        self.engine.container.node, dut1_if)
-                    if_name = Topology.get_interface_name(
-                        self.engine.container.node, dut1_if)
-                if 'DUT2' in self.engine.container.name:
-                    if_pci = Topology.get_interface_pci_addr(
-                        self.engine.container.node, dut2_if)
-                    if_name = Topology.get_interface_name(
-                        self.engine.container.node, dut2_if)
-                self.engine.create_vpp_startup_config_dpdk_dev(if_pci)
-                self.engine.create_vpp_exec_config(
-                    container_vat_template,
-                    mid1=mid1, sid1=sid1, if_name=if_name,
-                    socket1='{dir}/memif-{c_name}-{sid}'.
-                    format(c_name=c_name, sid=sid1, dir=guest_dir))
-        elif chain_topology == 'chain_functional':
-            for i, container in enumerate(self.containers):
-                mid1 = i % mod + 1
-                mid2 = i % mod + 1
-                sid1 = i % mod * 2 + 1
-                sid2 = i % mod * 2 + 2
-                memif_rx_mode = 'interrupt'
-                self.engine.container = self.containers[container]
-                self.engine.create_vpp_startup_config_func_dev()
-                c_name = self.engine.container.name
-                guest_dir = self.engine.container.mnt[0].split(':')[1]
-                self.engine.create_vpp_exec_config(
-                    container_vat_template,
-                    mid1=mid1, mid2=mid2, sid1=sid1, sid2=sid2,
-                    socket1='{dir}/memif-{c_name}-{sid}'.
-                    format(c_name=c_name, sid=sid1, dir=guest_dir),
-                    socket2='{dir}/memif-{c_name}-{sid}'.
-                    format(c_name=c_name, sid=sid2, dir=guest_dir),
-                    rx_mode=memif_rx_mode)
-        else:
-            raise RuntimeError('Container topology {topology} not implemented'.
-                               format(topology=chain_topology))
+
+        for i, container in enumerate(self.containers):
+            mid1 = i % mod + 1
+            mid2 = i % mod + 1
+            sid1 = i % mod * 2 + 1
+            sid2 = i % mod * 2 + 2
+            self.engine.container = self.containers[container]
+            guest_dir = self.engine.container.mnt[0].split(':')[1]
+
+            if chain_topology == 'chain':
+                self._configure_vpp_chain_l2xc(mid1=mid1, mid2=mid2,
+                                               sid1=sid1, sid2=sid2,
+                                               guest_dir=guest_dir,
+                                               **kwargs)
+            elif chain_topology == 'cross_horiz':
+                self._configure_vpp_cross_horiz(mid1=mid1, mid2=mid2,
+                                                sid1=sid1, sid2=sid2,
+                                                guest_dir=guest_dir,
+                                                **kwargs)
+            elif chain_topology == 'chain_functional':
+                self._configure_vpp_chain_functional(mid1=mid1, mid2=mid2,
+                                                     sid1=sid1, sid2=sid2,
+                                                     guest_dir=guest_dir,
+                                                     **kwargs)
+            elif chain_topology == 'chain_ip4':
+                self._configure_vpp_chain_ip4(mid1=mid1, mid2=mid2,
+                                              sid1=sid1, sid2=sid2,
+                                              guest_dir=guest_dir,
+                                              **kwargs)
+            elif chain_topology == 'pipeline_ip4':
+                self._configure_vpp_pipeline_ip4(mid1=mid1, mid2=mid2,
+                                                 sid1=sid1, sid2=sid2,
+                                                 guest_dir=guest_dir,
+                                                 **kwargs)
+            else:
+                raise RuntimeError('Container topology {name} not implemented'.
+                                   format(name=chain_topology))
+
+    def _configure_vpp_chain_l2xc(self, **kwargs):
+        """Configure VPP in chain topology with l2xc.
+
+        :param kwargs: Named parameters.
+        :param kwargs: dict
+        """
+        self.engine.create_vpp_startup_config()
+        self.engine.create_vpp_exec_config(
+            'memif_create_chain_l2xc.exec',
+            mid1=kwargs['mid1'], mid2=kwargs['mid2'],
+            sid1=kwargs['sid1'], sid2=kwargs['sid2'],
+            socket1='{guest_dir}/memif-{c.name}-{sid1}'.
+            format(c=self.engine.container, **kwargs),
+            socket2='{guest_dir}/memif-{c.name}-{sid2}'.
+            format(c=self.engine.container, **kwargs))
+
+    def _configure_vpp_cross_horiz(self, **kwargs):
+        """Configure VPP in cross horizontal topology (single memif).
+
+        :param kwargs: Named parameters.
+        :param kwargs: dict
+        """
+        if 'DUT1' in self.engine.container.name:
+            if_pci = Topology.get_interface_pci_addr(
+                self.engine.container.node, kwargs['dut1_if'])
+            if_name = Topology.get_interface_name(
+                self.engine.container.node, kwargs['dut1_if'])
+        if 'DUT2' in self.engine.container.name:
+            if_pci = Topology.get_interface_pci_addr(
+                self.engine.container.node, kwargs['dut2_if'])
+            if_name = Topology.get_interface_name(
+                self.engine.container.node, kwargs['dut2_if'])
+        self.engine.create_vpp_startup_config_dpdk_dev(if_pci)
+        self.engine.create_vpp_exec_config(
+            'memif_create_cross_horizon.exec',
+            mid1=kwargs['mid1'], sid1=kwargs['sid1'], if_name=if_name,
+            socket1='{guest_dir}/memif-{c.name}-{sid1}'.
+            format(c=self.engine.container, **kwargs))
+
+    def _configure_vpp_chain_functional(self, **kwargs):
+        """Configure VPP in chain topology with l2xc (functional).
+
+        :param kwargs: Named parameters.
+        :param kwargs: dict
+        """
+        self.engine.create_vpp_startup_config_func_dev()
+        self.engine.create_vpp_exec_config(
+            'memif_create_chain_functional.exec',
+            mid1=kwargs['mid1'], mid2=kwargs['mid2'],
+            sid1=kwargs['sid1'], sid2=kwargs['sid2'],
+            socket1='{guest_dir}/memif-{c.name}-{sid1}'.
+            format(c=self.engine.container, **kwargs),
+            socket2='{guest_dir}/memif-{c.name}-{sid2}'.
+            format(c=self.engine.container, **kwargs),
+            rx_mode='interrupt')
+
+    def _configure_vpp_chain_ip4(self, **kwargs):
+        """Configure VPP in chain topology with ip4.
+
+        :param kwargs: Named parameters.
+        :param kwargs: dict
+        """
+        self.engine.create_vpp_startup_config()
+
+        vif1_mac = kwargs['tg_if1_mac'] \
+            if (kwargs['mid1'] - 1) % kwargs['nodes'] + 1 == 1 \
+            else '52:54:00:00:{0:02X}:02'.format(kwargs['mid1'] - 1)
+        vif2_mac = kwargs['tg_if2_mac'] \
+            if (kwargs['mid2'] - 1) % kwargs['nodes'] + 1 == kwargs['nodes'] \
+            else '52:54:00:00:{0:02X}:01'.format(kwargs['mid2'] + 1)
+        self.engine.create_vpp_exec_config(
+            'memif_create_chain_ip4.exec',
+            mid1=kwargs['mid1'], mid2=kwargs['mid2'],
+            sid1=kwargs['sid1'], sid2=kwargs['sid2'],
+            socket1='{guest_dir}/memif-{c.name}-{sid1}'.
+            format(c=self.engine.container, **kwargs),
+            socket2='{guest_dir}/memif-{c.name}-{sid2}'.
+            format(c=self.engine.container, **kwargs),
+            mac1='52:54:00:00:{0:02X}:01'.format(kwargs['mid1']),
+            mac2='52:54:00:00:{0:02X}:02'.format(kwargs['mid2']),
+            vif1_mac=vif1_mac, vif2_mac=vif2_mac)
+
+    def _configure_vpp_pipeline_ip4(self, **kwargs):
+        """Configure VPP in pipeline topology with ip4.
+
+        :param kwargs: Named parameters.
+        :param kwargs: dict
+        """
+        self.engine.create_vpp_startup_config()
+        node = (kwargs['mid1'] - 1) % kwargs['nodes'] + 1
+        mid1 = kwargs['mid1']
+        mid2 = kwargs['mid2']
+        role1 = 'master'
+        role2 = 'master' \
+            if node == kwargs['nodes'] or node == kwargs['nodes'] and node == 1\
+            else 'slave'
+        kwargs['mid2'] = kwargs['mid2'] \
+            if node == kwargs['nodes'] or node == kwargs['nodes'] and node == 1\
+            else kwargs['mid2'] + 1
+        vif1_mac = kwargs['tg_if1_mac'] \
+            if (kwargs['mid1'] - 1) % kwargs['nodes'] + 1 == 1 \
+            else '52:54:00:00:{0:02X}:02'.format(kwargs['mid1'] - 1)
+        vif2_mac = kwargs['tg_if2_mac'] \
+            if (kwargs['mid2'] - 1) % kwargs['nodes'] + 1 == kwargs['nodes'] \
+            else '52:54:00:00:{0:02X}:01'.format(kwargs['mid2'] + 1)
+        socket1 = '{guest_dir}/memif-{c.name}-{sid1}'.\
+            format(c=self.engine.container, **kwargs) \
+            if node == 1 else '{guest_dir}/memif-pipe-{mid1}'.\
+            format(c=self.engine.container, **kwargs)
+        socket2 = '{guest_dir}/memif-{c.name}-{sid2}'.\
+            format(c=self.engine.container, **kwargs) \
+            if node == 1 and kwargs['nodes'] == 1 or node == kwargs['nodes'] \
+            else '{guest_dir}/memif-pipe-{mid2}'.\
+            format(c=self.engine.container, **kwargs)
+
+        self.engine.create_vpp_exec_config(
+            'memif_create_pipeline_ip4.exec',
+            mid1=kwargs['mid1'], mid2=kwargs['mid2'],
+            sid1=kwargs['sid1'], sid2=kwargs['sid2'],
+            socket1=socket1, socket2=socket2, role1=role1, role2=role2,
+            mac1='52:54:00:00:{0:02X}:01'.format(mid1),
+            mac2='52:54:00:00:{0:02X}:02'.format(mid2),
+            vif1_mac=vif1_mac, vif2_mac=vif2_mac)
 
     def stop_all_containers(self):
         """Stop all containers."""
@@ -310,10 +394,11 @@ class ContainerEngine(object):
 
     def install_supervisor(self):
         """Install supervisord inside a container."""
-        self.execute('sleep 3')
-        self.execute('apt-get update')
-        self.execute('apt-get install -y supervisor')
-        self.execute('echo "{config}" > {config_file}'.
+        if isinstance(self, LXC):
+            self.execute('sleep 3; apt-get update')
+            self.execute('apt-get install -y supervisor')
+        self.execute('echo "{config}" > {config_file} && '
+                     'supervisord -c {config_file}'.
                      format(
                          config='[unix_http_server]\n'
                          'file  = /tmp/supervisor.sock\n\n'
@@ -330,41 +415,20 @@ class ContainerEngine(object):
                          'loglevel=debug\n'
                          'nodaemon=false\n\n',
                          config_file=SUPERVISOR_CONF))
-        self.execute('supervisord -c {config_file}'.
-                     format(config_file=SUPERVISOR_CONF))
-
-    def install_vpp(self):
-        """Install VPP inside a container."""
-        self.execute('ln -s /dev/null /etc/sysctl.d/80-vpp.conf')
-        self.execute('apt-get update')
-        # Workaround for install xenial vpp build on bionic ubuntu.
-        self.execute('apt-get install -y wget')
-        self.execute('deb=$(mktemp) && wget -O "${deb}" '
-                     'http://launchpadlibrarian.net/336117627/'
-                     'libmbedcrypto0_2.5.1-1ubuntu1_amd64.deb && '
-                     'dpkg -i "${deb}" && '
-                     'rm -f "${deb}"')
-        self.execute('deb=$(mktemp) && wget -O "${deb}" '
-                     'http://launchpadlibrarian.net/252876048/'
-                     'libboost-system1.58.0_1.58.0+dfsg-5ubuntu3_amd64.deb && '
-                     'dpkg -i "${deb}" && '
-                     'rm -f "${deb}"')
-        self.execute(
-            'dpkg -i --force-all '
-            '{guest_dir}/openvpp-testing/download_dir/*.deb'.
-            format(guest_dir=self.container.mnt[0].split(':')[1]))
-        self.execute('apt-get -f install -y')
-        self.execute('apt-get install -y ca-certificates')
+
+    def start_vpp(self):
+        """Start VPP inside a container."""
         self.execute('echo "{config}" >> {config_file}'.
                      format(
                          config='[program:vpp]\n'
                          'command=/usr/bin/vpp -c /etc/vpp/startup.conf\n'
+                         'autostart=false\n'
                          'autorestart=false\n'
                          'redirect_stderr=true\n'
                          'priority=1',
                          config_file=SUPERVISOR_CONF))
         self.execute('supervisorctl reload')
-        self.execute('supervisorctl restart vpp')
+        self.execute('supervisorctl start vpp')
 
     def restart_vpp(self):
         """Restart VPP service inside a container."""
@@ -441,23 +505,23 @@ class ContainerEngine(object):
         self.execute('echo "{config}" | tee /etc/vpp/startup.conf'
                      .format(config=vpp_config.get_config_str()))
 
-    def create_vpp_exec_config(self, vat_template_file, **kwargs):
+    def create_vpp_exec_config(self, template_file, **kwargs):
         """Create VPP exec configuration on container.
 
-        :param vat_template_file: File name of a VAT template script.
-        :param kwargs: Parameters for VAT script.
-        :type vat_template_file: str
+        :param template_file: File name of a template script.
+        :param kwargs: Parameters for script.
+        :type template_file: str
         :type kwargs: dict
         """
-        vat_file_path = '{p}/{f}'.format(p=Constants.RESOURCES_TPL_VAT,
-                                         f=vat_template_file)
+        running = '/tmp/running.exec'
+
+        template = '{res}/{tpl}'.format(
+            res=Constants.RESOURCES_TPL_CONTAINER, tpl=template_file)
 
-        with open(vat_file_path, 'r') as template_file:
-            cmd_template = template_file.readlines()
-            for line_tmpl in cmd_template:
-                vat_cmd = line_tmpl.format(**kwargs)
-                self.execute('echo "{c}" >> /tmp/running.exec'
-                             .format(c=vat_cmd.replace('\n', '')))
+        with open(template, 'r') as src_file:
+            src = Template(src_file.read())
+            self.execute('echo "{out}" > {running}'.format(
+                out=src.safe_substitute(**kwargs), running=running))
 
     def is_container_running(self):
         """Check if container is running."""
@@ -528,7 +592,7 @@ class LXC(ContainerEngine):
                 return
 
         image = self.container.image if self.container.image else\
-            "-d ubuntu -r xenial -a amd64"
+            "-d ubuntu -r bionic -a amd64"
 
         cmd = 'lxc-create -t download --name {c.name} -- {image} '\
             '--no-validate'.format(c=self.container, image=image)
@@ -547,11 +611,14 @@ class LXC(ContainerEngine):
         if self.container.mnt:
             for mount in self.container.mnt:
                 host_dir, guest_dir = mount.split(':')
+                options = 'bind,create=dir' \
+                    if guest_dir.endswith('/') else 'bind,create=file'
                 entry = 'lxc.mount.entry = {host_dir} '\
                     '/var/lib/lxc/{c.name}/rootfs{guest_dir} none ' \
-                    'bind,create=dir 0 0'.format(c=self.container,
-                                                 host_dir=host_dir,
-                                                 guest_dir=guest_dir)
+                    '{options} 0 0'.format(c=self.container,
+                                           host_dir=host_dir,
+                                           guest_dir=guest_dir,
+                                           options=options)
                 ret, _, _ = self.container.ssh.exec_command_sudo(
                     "sh -c 'echo \"{e}\" >> /var/lib/lxc/{c.name}/config'".
                     format(e=entry, c=self.container))
@@ -717,7 +784,8 @@ class Docker(ContainerEngine):
                 return
 
         if not self.container.image:
-            setattr(self.container, 'image', 'snergster/csit-sut:latest')
+            setattr(self.container, 'image',
+                    Constants.DOCKER_SUT_IMAGE_UBUNTU)
 
         cmd = 'docker pull {image}'.format(image=self.container.image)
 
@@ -780,7 +848,7 @@ class Docker(ContainerEngine):
 
         :param command: Command to run inside container.
         :type command: str
-        :raises RuntimeError: If runnig the command in a container failed.
+        :raises RuntimeError: If running the command in a container failed.
         """
         cmd = "docker exec --interactive {c.name} /bin/sh -c '{command}; "\
             "exit $?'".format(c=self.container, command=command)