smoketest: add shim for every test to re-use common tasts

Currently every smoketest does the setup and destruction of the configsession
on its own durin setUp(). This creates a lot of overhead and one configsession
should be re-used during execution of every smoketest script.

In addiion a test that failed will leaf the system in an unconsistent state.
For this reason before the test is executed we will save the running config
to /tmp and the will re-load the config after the test has passed, always
ensuring a clean environment for the next test.

(cherry picked from commit 0f3def974fbaa4a26e6ad590ee37dd965bc2358f)

1 files changed, 74 insertions, 68 deletions

diff --git a/smoketest/scripts/cli/test_interfaces_tunnel.py b/smoketest/scripts/cli/test_interfaces_tunnel.py
index e65d83840..3aed498b4 100755
--- a/smoketest/scripts/cli/test_interfaces_tunnel.py
+++ b/smoketest/scripts/cli/test_interfaces_tunnel.py
@@ -16,20 +16,18 @@
 
 import unittest
 
-from vyos.configsession import ConfigSession
+from base_interfaces_test import BasicInterfaceTest
+
 from vyos.configsession import ConfigSessionError
 from vyos.util import get_interface_config
 from vyos.template import inc_ip
-from vyos.util import cmd
-
-from base_interfaces_test import BasicInterfaceTest
 
 remote_ip4 = '192.0.2.100'
 remote_ip6 = '2001:db8::ffff'
 source_if = 'dum2222'
 mtu = 1476
 
-class TunnelInterfaceTest(BasicInterfaceTest.BaseTest):
+class TunnelInterfaceTest(BasicInterfaceTest.TestCase):
     @classmethod
     def setUpClass(cls):
         cls._test_ip = True
@@ -43,17 +41,18 @@ class TunnelInterfaceTest(BasicInterfaceTest.BaseTest):
             'tun20': ['encapsulation gre',  'remote 192.0.2.20', 'source-address ' + cls.local_v4],
         }
         cls._interfaces = list(cls._options)
+        # call base-classes classmethod
+        super(cls, cls).setUpClass()
 
     def setUp(self):
         super().setUp()
-        self.session.set(['interfaces', 'dummy', source_if, 'address', self.local_v4 + '/32'])
-        self.session.set(['interfaces', 'dummy', source_if, 'address', self.local_v6 + '/128'])
+        self.cli_set(['interfaces', 'dummy', source_if, 'address', self.local_v4 + '/32'])
+        self.cli_set(['interfaces', 'dummy', source_if, 'address', self.local_v6 + '/128'])
 
     def tearDown(self):
-        self.session.delete(['interfaces', 'dummy', source_if])
+        self.cli_delete(['interfaces', 'dummy', source_if])
         super().tearDown()
 
-
     def test_ipv4_encapsulations(self):
         # When running tests ensure that for certain encapsulation types the
         # local and remote IP address is actually an IPv4 address
@@ -61,31 +60,30 @@ class TunnelInterfaceTest(BasicInterfaceTest.BaseTest):
         interface = f'tun1000'
         local_if_addr = f'10.10.200.1/24'
         for encapsulation in ['ipip', 'sit', 'gre', 'gretap']:
-            self.session.set(self._base_path + [interface, 'address', local_if_addr])
-            self.session.set(self._base_path + [interface, 'encapsulation', encapsulation])
-            self.session.set(self._base_path + [interface, 'source-address', self.local_v6])
-            self.session.set(self._base_path + [interface, 'remote', remote_ip6])
+            self.cli_set(self._base_path + [interface, 'address', local_if_addr])
+            self.cli_set(self._base_path + [interface, 'encapsulation', encapsulation])
+            self.cli_set(self._base_path + [interface, 'source-address', self.local_v6])
+            self.cli_set(self._base_path + [interface, 'remote', remote_ip6])
 
             # Encapsulation mode requires IPv4 source-address
             with self.assertRaises(ConfigSessionError):
-                self.session.commit()
-            self.session.set(self._base_path + [interface, 'source-address', self.local_v4])
+                self.cli_commit()
+            self.cli_set(self._base_path + [interface, 'source-address', self.local_v4])
 
-            # Encapsulation mode requires IPv4 remote address
+            # Encapsulation mode requires IPv4 remote
             with self.assertRaises(ConfigSessionError):
-                self.session.commit()
-            self.session.set(self._base_path + [interface, 'remote', remote_ip4])
-
-            self.session.set(self._base_path + [interface, 'source-interface', source_if])
+                self.cli_commit()
+            self.cli_set(self._base_path + [interface, 'remote', remote_ip4])
+            self.cli_set(self._base_path + [interface, 'source-interface', source_if])
 
             # Source interface can not be used with sit and gretap
             if encapsulation in ['sit', 'gretap']:
                 with self.assertRaises(ConfigSessionError):
-                    self.session.commit()
-                self.session.delete(self._base_path + [interface, 'source-interface'])
+                    self.cli_commit()
+                self.cli_delete(self._base_path + [interface, 'source-interface'])
 
             # Check if commit is ok
-            self.session.commit()
+            self.cli_commit()
 
             conf = get_interface_config(interface)
             if encapsulation not in ['sit', 'gretap']:
@@ -93,12 +91,14 @@ class TunnelInterfaceTest(BasicInterfaceTest.BaseTest):
 
             self.assertEqual(interface, conf['ifname'])
             self.assertEqual(mtu, conf['mtu'])
+            self.assertEqual(encapsulation, conf['linkinfo']['info_kind'])
             self.assertEqual(self.local_v4, conf['linkinfo']['info_data']['local'])
             self.assertEqual(remote_ip4,    conf['linkinfo']['info_data']['remote'])
+            self.assertTrue(conf['linkinfo']['info_data']['pmtudisc'])
 
             # cleanup this instance
-            self.session.delete(self._base_path + [interface])
-            self.session.commit()
+            self.cli_delete(self._base_path + [interface])
+            self.cli_commit()
 
     def test_ipv6_encapsulations(self):
         # When running tests ensure that for certain encapsulation types the
@@ -107,31 +107,38 @@ class TunnelInterfaceTest(BasicInterfaceTest.BaseTest):
         interface = f'tun1010'
         local_if_addr = f'10.10.200.1/24'
         for encapsulation in ['ipip6', 'ip6ip6', 'ip6gre']:
-            self.session.set(self._base_path + [interface, 'address', local_if_addr])
-            self.session.set(self._base_path + [interface, 'encapsulation', encapsulation])
-            self.session.set(self._base_path + [interface, 'source-address', self.local_v4])
-            self.session.set(self._base_path + [interface, 'remote', remote_ip4])
+            self.cli_set(self._base_path + [interface, 'address', local_if_addr])
+            self.cli_set(self._base_path + [interface, 'encapsulation', encapsulation])
+            self.cli_set(self._base_path + [interface, 'source-address', self.local_v4])
+            self.cli_set(self._base_path + [interface, 'remote', remote_ip4])
 
             # Encapsulation mode requires IPv6 source-address
             with self.assertRaises(ConfigSessionError):
-                self.session.commit()
-            self.session.set(self._base_path + [interface, 'source-address', self.local_v6])
+                self.cli_commit()
+            self.cli_set(self._base_path + [interface, 'source-address', self.local_v6])
 
-            # Encapsulation mode requires IPv6 remote address
+            # Encapsulation mode requires IPv6 remote
             with self.assertRaises(ConfigSessionError):
-                self.session.commit()
-            self.session.set(self._base_path + [interface, 'remote', remote_ip6])
+                self.cli_commit()
+            self.cli_set(self._base_path + [interface, 'remote', remote_ip6])
 
             # Configure Tunnel Source interface
-            self.session.set(self._base_path + [interface, 'source-interface', source_if])
+            self.cli_set(self._base_path + [interface, 'source-interface', source_if])
+            # Source interface can not be used with ip6gretap
+            if encapsulation in ['ip6gretap']:
+                with self.assertRaises(ConfigSessionError):
+                    self.cli_commit()
+                self.cli_delete(self._base_path + [interface, 'source-interface'])
 
             # Check if commit is ok
-            self.session.commit()
+            self.cli_commit()
 
             conf = get_interface_config(interface)
+            if encapsulation not in ['ip6gretap']:
+                self.assertEqual(source_if, conf['link'])
+
             self.assertEqual(interface, conf['ifname'])
             self.assertEqual(mtu, conf['mtu'])
-            self.assertEqual(source_if, conf['link'])
 
             # Not applicable for ip6gre
             if 'proto' in conf['linkinfo']['info_data']:
@@ -146,46 +153,46 @@ class TunnelInterfaceTest(BasicInterfaceTest.BaseTest):
             self.assertEqual(remote_ip6,    conf['linkinfo']['info_data']['remote'])
 
             # cleanup this instance
-            self.session.delete(self._base_path + [interface])
-            self.session.commit()
+            self.cli_delete(self._base_path + [interface])
+            self.cli_commit()
 
     def test_tunnel_verify_local_dhcp(self):
-        # We can not use local-ip and dhcp-interface at the same time
+        # We can not use source-address and dhcp-interface at the same time
 
         interface = f'tun1020'
         local_if_addr = f'10.0.0.1/24'
 
-        self.session.set(self._base_path + [interface, 'address', local_if_addr])
-        self.session.set(self._base_path + [interface, 'encapsulation', 'gre'])
-        self.session.set(self._base_path + [interface, 'source-address', self.local_v4])
-        self.session.set(self._base_path + [interface, 'remote', remote_ip4])
-        self.session.set(self._base_path + [interface, 'dhcp-interface', 'eth0'])
+        self.cli_set(self._base_path + [interface, 'address', local_if_addr])
+        self.cli_set(self._base_path + [interface, 'encapsulation', 'gre'])
+        self.cli_set(self._base_path + [interface, 'source-address', self.local_v4])
+        self.cli_set(self._base_path + [interface, 'remote', remote_ip4])
+        self.cli_set(self._base_path + [interface, 'dhcp-interface', 'eth0'])
 
         # source-address and dhcp-interface can not be used at the same time
         with self.assertRaises(ConfigSessionError):
-            self.session.commit()
-        self.session.delete(self._base_path + [interface, 'dhcp-interface'])
+            self.cli_commit()
+        self.cli_delete(self._base_path + [interface, 'dhcp-interface'])
 
         # Check if commit is ok
-        self.session.commit()
+        self.cli_commit()
 
     def test_tunnel_parameters_gre(self):
         interface = f'tun1030'
         gre_key = '10'
         encapsulation = 'gre'
         tos = '20'
-        ttl = 0
 
-        self.session.set(self._base_path + [interface, 'encapsulation', encapsulation])
-        self.session.set(self._base_path + [interface, 'source-address', self.local_v4])
-        self.session.set(self._base_path + [interface, 'remote', remote_ip4])
+        self.cli_set(self._base_path + [interface, 'encapsulation', encapsulation])
+        self.cli_set(self._base_path + [interface, 'source-address', self.local_v4])
+        self.cli_set(self._base_path + [interface, 'remote', remote_ip4])
 
-        self.session.set(self._base_path + [interface, 'parameters', 'ip', 'key', gre_key])
-        self.session.set(self._base_path + [interface, 'parameters', 'ip', 'tos', tos])
-        self.session.set(self._base_path + [interface, 'parameters', 'ip', 'ttl', str(ttl)])
+        self.cli_set(self._base_path + [interface, 'parameters', 'ip', 'no-pmtu-discovery'])
+        self.cli_set(self._base_path + [interface, 'parameters', 'ip', 'key', gre_key])
+        self.cli_set(self._base_path + [interface, 'parameters', 'ip', 'tos', tos])
+        self.cli_set(self._base_path + [interface, 'parameters', 'ip', 'ttl', '0'])
 
         # Check if commit is ok
-        self.session.commit()
+        self.cli_commit()
 
         conf = get_interface_config(interface)
         self.assertEqual(mtu,           conf['mtu'])
@@ -193,7 +200,8 @@ class TunnelInterfaceTest(BasicInterfaceTest.BaseTest):
         self.assertEqual(encapsulation, conf['linkinfo']['info_kind'])
         self.assertEqual(self.local_v4, conf['linkinfo']['info_data']['local'])
         self.assertEqual(remote_ip4,    conf['linkinfo']['info_data']['remote'])
-        self.assertEqual(ttl,           conf['linkinfo']['info_data']['ttl'])
+        self.assertEqual(0,             conf['linkinfo']['info_data']['ttl'])
+        self.assertFalse(               conf['linkinfo']['info_data']['pmtudisc'])
 
     def test_gretap_parameters_change(self):
         interface = f'tun1040'
@@ -201,31 +209,29 @@ class TunnelInterfaceTest(BasicInterfaceTest.BaseTest):
         encapsulation = 'gretap'
         tos = '20'
 
-        self.session.set(self._base_path + [interface, 'encapsulation', encapsulation])
-        self.session.set(self._base_path + [interface, 'source-address', self.local_v4])
-        self.session.set(self._base_path + [interface, 'remote', remote_ip4])
+        self.cli_set(self._base_path + [interface, 'encapsulation', encapsulation])
+        self.cli_set(self._base_path + [interface, 'source-address', self.local_v4])
+        self.cli_set(self._base_path + [interface, 'remote', remote_ip4])
 
         # Check if commit is ok
-        self.session.commit()
+        self.cli_commit()
 
         conf = get_interface_config(interface)
         self.assertEqual(mtu,           conf['mtu'])
         self.assertEqual(interface,     conf['ifname'])
-        self.assertEqual('gretap',      conf['linkinfo']['info_kind'])
+        self.assertEqual(encapsulation, conf['linkinfo']['info_kind'])
         self.assertEqual(self.local_v4, conf['linkinfo']['info_data']['local'])
         self.assertEqual(remote_ip4,    conf['linkinfo']['info_data']['remote'])
-        # TTL uses a default value
-        self.assertEqual(64,            conf['linkinfo']['info_data']['ttl'])
+        self.assertEqual(64,           conf['linkinfo']['info_data']['ttl'])
 
         # Change remote ip address (inc host by 2
         new_remote = inc_ip(remote_ip4, 2)
-        self.session.set(self._base_path + [interface, 'remote', new_remote])
-
+        self.cli_set(self._base_path + [interface, 'remote', new_remote])
         # Check if commit is ok
-        self.session.commit()
+        self.cli_commit()
 
         conf = get_interface_config(interface)
         self.assertEqual(new_remote,    conf['linkinfo']['info_data']['remote'])
 
 if __name__ == '__main__':
-    unittest.main(verbosity=2, failfast=True)
+    unittest.main(verbosity=2)