CSIT-859: KW to add crypto SW device to startup.conf

Change-Id: I8441d58a2d7f604b64fff358a3cef8d72289dcdc
Signed-off-by: Jan Gelety <jgelety@cisco.com>

3 files changed, 161 insertions, 14 deletions

diff --git a/resources/libraries/python/VppConfigGenerator.py b/resources/libraries/python/VppConfigGenerator.py
index 25862025e1..eccada9979 100644
--- a/resources/libraries/python/VppConfigGenerator.py
+++ b/resources/libraries/python/VppConfigGenerator.py
@@ -38,6 +38,12 @@ class VppConfigGenerator(object):
         self._vpp_config = ''
         # VPP Service name
         self._vpp_service_name = 'vpp'
+        # VPP Logfile location
+        self._vpp_logfile = '/tmp/vpe.log'
+        # VPP Startup config location
+        self._vpp_startup_conf = '/etc/vpp/startup.conf'
+        # VPP Startup config backup location
+        self._vpp_startup_conf_backup = None
 
     def set_node(self, node):
         """Set DUT node.
@@ -52,6 +58,22 @@ class VppConfigGenerator(object):
         self._node = node
         self._hostname = Topology.get_node_hostname(node)
 
+    def set_vpp_logfile(self, logfile):
+        """Set VPP logfile location.
+
+        :param logfile: VPP logfile location.
+        :type logfile: str
+        """
+        self._vpp_logfile = logfile
+
+    def set_vpp_startup_conf_backup(self, backup='/etc/vpp/startup.backup'):
+        """Set VPP startup configuration backup.
+
+        :param backup: VPP logfile location.
+        :type backup: str
+        """
+        self._vpp_startup_conf_backup = backup
+
     def get_config_str(self):
         """Get dumped startup configuration in VPP config format.
 
@@ -105,24 +127,35 @@ class VppConfigGenerator(object):
         if level >= 0:
             self._vpp_config += '{}}}\n'.format(level * indent)
 
-    def add_unix_log(self, value='/tmp/vpe.log'):
+    def add_unix_log(self, value=None):
         """Add UNIX log configuration.
 
         :param value: Log file.
         :type value: str
         """
         path = ['unix', 'log']
+        if value is None:
+            value = self._vpp_logfile
         self.add_config_item(self._nodeconfig, value, path)
 
     def add_unix_cli_listen(self, value='localhost:5002'):
         """Add UNIX cli-listen configuration.
 
-        :param value: CLI listen address and port.
+        :param value: CLI listen address and port or path to CLI socket.
         :type value: str
         """
         path = ['unix', 'cli-listen']
         self.add_config_item(self._nodeconfig, value, path)
 
+    def add_unix_gid(self, value='vpp'):
+        """Add UNIX gid configuration.
+
+        :param value: Gid.
+        :type value: str
+        """
+        path = ['unix', 'gid']
+        self.add_config_item(self._nodeconfig, value, path)
+
     def add_unix_nodaemon(self):
         """Add UNIX nodaemon configuration."""
         path = ['unix', 'nodaemon']
@@ -138,6 +171,15 @@ class VppConfigGenerator(object):
         path = ['unix', 'exec']
         self.add_config_item(self._nodeconfig, value, path)
 
+    def add_api_segment_gid(self, value='vpp'):
+        """Add API-SEGMENT gid configuration.
+
+        :param value: Gid.
+        :type value: str
+        """
+        path = ['api-segment', 'gid']
+        self.add_config_item(self._nodeconfig, value, path)
+
     def add_dpdk_dev(self, *devices):
         """Add DPDK PCI device configuration.
 
@@ -158,7 +200,7 @@ class VppConfigGenerator(object):
     def add_dpdk_cryptodev(self, count):
         """Add DPDK Crypto PCI device configuration.
 
-        :param count: Number of crypto devices to add.
+        :param count: Number of HW crypto devices to add.
         :type count: int
         """
         cryptodev = Topology.get_cryptodev(self._node)
@@ -169,6 +211,18 @@ class VppConfigGenerator(object):
             self.add_config_item(self._nodeconfig, '', path)
         self.add_dpdk_uio_driver('igb_uio')
 
+    def add_dpdk_sw_cryptodev(self, count):
+        """Add DPDK Crypto SW device configuration.
+
+        :param count: Number of crypto SW devices to add.
+        :type count: int
+        """
+        for i in range(count):
+            cryptodev_config = 'vdev cryptodev_aesni_mb_pmd,socket_id={0}'.\
+                format(str(i))
+            path = ['dpdk', cryptodev_config]
+            self.add_config_item(self._nodeconfig, '', path)
+
     def add_dpdk_dev_default_rxq(self, value):
         """Add DPDK dev default rxq configuration.
 
@@ -297,7 +351,7 @@ class VppConfigGenerator(object):
         path = ['nat']
         self.add_config_item(self._nodeconfig, value, path)
 
-    def apply_config(self, filename='/etc/vpp/startup.conf', waittime=5,
+    def apply_config(self, filename=None, waittime=5,
                      retries=12, restart_vpp=True):
         """Generate and apply VPP configuration for node.
 
@@ -312,14 +366,26 @@ class VppConfigGenerator(object):
         :type waittime: int
         :type retries: int
         :type restart_vpp: bool.
-        :raises RuntimeError: If writing config file failed, or restarting of
-        VPP failed.
+        :raises RuntimeError: If writing config file failed or restart of VPP
+            failed or backup of VPP startup.conf failed.
         """
         self.dump_config(self._nodeconfig)
 
         ssh = SSH()
         ssh.connect(self._node)
 
+        if filename is None:
+            filename = self._vpp_startup_conf
+
+        if self._vpp_startup_conf_backup is not None:
+            (ret, _, _) = \
+                ssh.exec_command('sudo cp {0} {1}'.
+                                 format(self._vpp_startup_conf,
+                                        self._vpp_startup_conf_backup))
+            if ret != 0:
+                raise RuntimeError('Backup of config file failed on node {}'.
+                                   format(self._hostname))
+
         (ret, _, _) = \
             ssh.exec_command('echo "{config}" | sudo tee {filename}'.
                              format(config=self._vpp_config,
@@ -346,11 +412,27 @@ class VppConfigGenerator(object):
             # and verify if VPP is running.
             for _ in range(retries):
                 time.sleep(waittime)
-                (ret, _, _) = \
+                (ret, stdout, _) = \
                     ssh.exec_command('echo show hardware-interfaces | '
                                      'nc 0 5002 || echo "VPP not yet running"')
-                if ret == 0:
+                if ret == 0 and stdout != 'VPP not yet running':
                     break
             else:
                 raise RuntimeError('VPP failed to restart on node {}'.
                                    format(self._hostname))
+
+    def restore_config(self):
+        """Restore VPP startup.conf from backup.
+
+        :raises RuntimeError: When restoration of startup.conf file failed.
+        """
+
+        ssh = SSH()
+        ssh.connect(self._node)
+
+        (ret, _, _) = ssh.exec_command('sudo cp {0} {1}'.
+                                       format(self._vpp_startup_conf_backup,
+                                              self._vpp_startup_conf))
+        if ret != 0:
+            raise RuntimeError('Restoration of config file failed on node {}'.
+                               format(self._hostname))
diff --git a/resources/libraries/robot/crypto/ipsec.robot b/resources/libraries/robot/crypto/ipsec.robot
index 74a1a53f25..80d2937e37 100644
--- a/resources/libraries/robot/crypto/ipsec.robot
+++ b/resources/libraries/robot/crypto/ipsec.robot
@@ -254,21 +254,21 @@
 
 | Set up IPv4 IPSec functional test
 | | [Documentation]
-| | ... | Set up IPv4 IPSec functional test
+| | ... | Set up IPv4 IPSec functional test.
 | | ...
 | | Set up functional test
 | | Configure topology for IPv4 IPsec testing
 
 | Set up IPv6 IPSec functional test
 | | [Documentation]
-| | ... | Set up IPv6 IPSec functional test
+| | ... | Set up IPv6 IPSec functional test.
 | | ...
 | | Set up functional test
 | | Configure topology for IPv6 IPsec testing
 
 | Tear down IPSec functional test
 | | [Documentation]
-| | ... | Tear down IPSec functional test
+| | ... | Tear down IPSec functional test.
 | | ...
 | | ... | *Example:*
 | | ...
@@ -278,3 +278,44 @@
 | | ...
 | | VPP IPsec Show | ${dut_node}
 | | Tear down functional test
+
+| Set up IPSec SW device functional test
+| | [Documentation]
+| | ... | Set up IPSec SW device functional test for required IP version.
+| | ...
+| | ... | *Arguments:*
+| | ... | - ${ip_version} - IP version: IPv4 or IPv6. Type: string
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Set up IPSec SW device functional test \| IPv4 \|
+| | ...
+| | [Arguments] | ${ip_version}
+| | ...
+| | ${duts}= | Get Matches | ${nodes} | DUT*
+| | :FOR | ${dut} | IN | @{duts}
+| | | Import Library | resources.libraries.python.VppConfigGenerator
+| | | ... | WITH NAME | ${dut}
+| | | Run keyword | ${dut}.Set Node | ${nodes['${dut}']}
+| | | Run keyword | ${dut}.Set Vpp Startup Conf Backup
+| | | Run keyword | ${dut}.Set Vpp Logfile | /tmp/vpp.log
+| | | Run keyword | ${dut}.Add Unix Nodaemon
+| | | Run keyword | ${dut}.Add Unix Log
+| | | Run keyword | ${dut}.Add Unix Coredump
+| | | Run keyword | ${dut}.Add Unix CLI Listen | /run/vpp/cli.sock
+| | | Run keyword | ${dut}.Add Unix Gid
+| | | Run keyword | ${dut}.Add Api Segment Gid
+| | | Run keyword | ${dut}.Add DPDK SW Cryptodev | ${1}
+| | Apply startup configuration on all VPP DUTs | restart_vpp=${FALSE}
+| | Set up functional test
+| | Run Keyword | Configure topology for ${ip_version} IPsec testing
+
+| Tear down IPSec SW device functional test
+| | [Documentation]
+| | ... | Tear down IPSec SW device functional test.
+| | ...
+| | ${duts}= | Get Matches | ${nodes} | DUT*
+| | :FOR | ${dut} | IN | @{duts}
+| | | VPP IPsec Show | ${nodes['${dut}']}
+| | | Run keyword | ${dut}.Restore Config
+| | Tear down functional test
diff --git a/resources/libraries/robot/shared/default.robot b/resources/libraries/robot/shared/default.robot
index 6c80f9827d..74ad8d3f09 100644
--- a/resources/libraries/robot/shared/default.robot
+++ b/resources/libraries/robot/shared/default.robot
@@ -24,7 +24,6 @@
 | Library | resources.libraries.python.TGSetup
 | Library | resources.libraries.python.L2Util
 | Library | resources.libraries.python.Tap
-| Library | resources.libraries.python.VppConfigGenerator
 | Library | resources.libraries.python.VppCounters
 | Library | resources.libraries.python.VPPUtil
 | Library | resources.libraries.python.Trace
@@ -265,13 +264,38 @@
 | | :FOR | ${dut} | IN | @{duts}
 | | | Run keyword | ${dut}.Add DPDK Cryptodev | ${count}
 
+| Add crypto SW device on all DUTs
+| | [Documentation] | Add required number of crypto SW devices to VPP startup
+| | ... | configuration on all DUTs.
+| | ...
+| | ... | *Arguments:*
+| | ... | - ${count} - Number of SW crypto devices. Type: integer
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Add SW cryptodev on all DUTs \| ${4} \|
+| | ...
+| | [Arguments] | ${count}
+| | ${duts}= | Get Matches | ${nodes} | DUT*
+| | :FOR | ${dut} | IN | @{duts}
+| | | Run keyword | ${dut}.Add DPDK SW Cryptodev | ${count}
+
 | Apply startup configuration on all VPP DUTs
 | | [Documentation] | Write startup configuration and restart VPP on all DUTs.
 | | ...
+| | ... | *Arguments:*
+| | ... | - ${restart_vpp} - Whether to restart VPP (Optional). Type: boolean
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Apply startup configuration on all VPP DUTs \| ${False} \|
+| | ...
+| | [Arguments] | ${restart_vpp}=${True}
+| | ...
 | | ${duts}= | Get Matches | ${nodes} | DUT*
 | | :FOR | ${dut} | IN | @{duts}
-| | | Run keyword | ${dut}.Apply Config
-| | Update All Interface Data On All Nodes | ${nodes} | skip_tg=${TRUE}
+| | | Run keyword | ${dut}.Apply Config | restart_vpp=${restart_vpp}
+| | Update All Interface Data On All Nodes | ${nodes} | skip_tg=${True}
 
 | Save VPP PIDs
 | | [Documentation] | Get PIDs of VPP processes from all DUTs in topology and\