Using addCleanup() instead of TearDown().

flacky_net/test_sockets.py

@@ -8,12 +8,11 @@
 from testers import stress
 
 __author__ = "Tempesta Technologies, Inc."
-__copyright__ = "Copyright (C) 2017 Tempesta Technologies, Inc."
+__copyright__ = "Copyright (C) 2017-2024 Tempesta Technologies, Inc."
 __license__ = "GPL2"
 
 
 class CloseOnShutdown(stress.StressTest):
-
  timeout = 180
 
  config = "cache 0;\n" "\n"
@@ -75,18 +74,21 @@ def check_sockets(self, allow_conns=True):
  self.check_after_stop()
 
  def setUp(self):
- stress.StressTest.setUp(self)
+ super().setUp()
  self.filter = None
+ # Cleanup part
+ self.addCleanup(self.cleanup_stop_tempesta)
+ self.addCleanup(self.cleanup_filter)
 
- def tearDown(self):
+ def cleanup_filter(self):
  if self.filter:
  self.filter.clean_up()
+
+ def cleanup_stop_tempesta(self):
  if hasattr(self, "dummy_servers"):
  # No need to stop servers.
  if self.tempesta:
  self.tempesta.stop()
- else:
- stress.StressTest.tearDown(self)
 
  def init_filter(self):
  node = self.servers[0].node

framework/mixins.py

@@ -13,6 +13,11 @@ def setUp(self):
  self.skipTest("This is an abstract class")
  self._nf_mark = None
  super().setUp()
+ self.addCleanup(self.cleanup_del_nf_mark)
+
+ def cleanup_del_nf_mark(self):
+ if self._nf_mark:
+ self.del_nf_mark(self._nf_mark)
 
  def set_nf_mark(self, mark):
  cmd = "iptables -t mangle -A PREROUTING -p tcp -j MARK --set-mark %s" % mark
@@ -25,8 +30,3 @@ def del_nf_mark(self, mark):
  tf_cfg.dbg(3, f"Delete Netfiler mark: {mark}")
  remote.tempesta.run_cmd(cmd, timeout=30)
  self._nf_mark = None
-
- def tearDown(self):
- super().tearDown()
- if self._nf_mark:
- self.del_nf_mark(self._nf_mark)

framework/tester.py

@@ -20,7 +20,7 @@
 from helpers import control, dmesg, remote, sysnet, tf_cfg
 
 __author__ = "Tempesta Technologies, Inc."
-__copyright__ = "Copyright (C) 2018-2023 Tempesta Technologies, Inc."
+__copyright__ = "Copyright (C) 2018-2024 Tempesta Technologies, Inc."
 __license__ = "GPL2"
 
 from helpers.deproxy import dbg
@@ -247,7 +247,7 @@ def get_servers_id(self):
 
  def __create_clients(self):
  if not remote.wait_available():
- raise Exception("Client node is unavaliable")
+ raise Exception("Client node is unavailable")
  for client in self.clients:
  # Copy description to keep it clean between several tests.
  self.__create_client(client.copy())
@@ -333,33 +333,48 @@ def setUp(self):
 
  tf_cfg.dbg(3, "\tInit test case...")
  if not remote.wait_available():
- raise Exception("Tempesta node is unavaliable")
+ raise Exception("Tempesta node is unavailable")
  self.oops = dmesg.DmesgFinder()
  self.oops_ignore = []
  self.__create_servers()
  self.__create_tempesta()
  self.__create_clients()
  self.__run_tcpdump()
-
- def tearDown(self):
- tf_cfg.dbg(3, "\tTeardown")
-
+ # Cleanup part
+ self.addCleanup(self.cleanup_check_dmesg)
+ self.addCleanup(self.cleanup_stop_tcpdump)
+ self.addCleanup(self.cleanup_interfaces)
+ self.addCleanup(self.cleanup_deproxy)
+ self.addCleanup(self.cleanup_services)
+
+ def cleanup_services(self):
+ tf_cfg.dbg(3, "\tCleanup: services")
  for service in self.get_all_services():
  service.stop()
 
+ def cleanup_deproxy(self):
+ tf_cfg.dbg(3, "\tCleanup: deproxy")
  try:
  deproxy_manager.finish_all_deproxy()
  except Exception as e:
  dbg(
  self.deproxy_manager, 1, f"Unknown exception in stopping deproxy - {e}", prefix="\t"
  )
+ self.deproxy_manager.check_exceptions()
 
- tf_cfg.dbg(3, "Removing interfaces")
+ def cleanup_interfaces(self):
+ tf_cfg.dbg(3, "\tCleanup: Removing interfaces")
  interface = tf_cfg.cfg.get("Server", "aliases_interface")
  sysnet.remove_routes(interface, self.__ips)
  sysnet.remove_interfaces(interface, self.__ips)
  self.__ips = []
 
+ def cleanup_stop_tcpdump(self):
+ tf_cfg.dbg(3, "\tCleanup: stopping tcpdump")
+ self.__stop_tcpdump()
+
+ def cleanup_check_dmesg(self):
+ tf_cfg.dbg(3, "\tCleanup: checking dmesg")
  self.oops.update()
 
  tf_cfg.dbg(
@@ -377,15 +392,10 @@ def tearDown(self):
  if len(self.oops.log_findall(err)) > 0:
  self.oops.show()
  self.oops_ignore = []
- raise Exception("%s happened during test on Tempesta" % err)
+ raise Exception(f"{err} happened during test on Tempesta")
  # Drop the list of ignored errors to allow set different errors masks
  # for different tests.
  self.oops_ignore = []
- del self.oops
- self.__stop_tcpdump()
-
- # TODO it should be change after #534 issue
- self.deproxy_manager.check_exceptions()
 
  def wait_while_busy(self, *items, timeout=20):
  if items is None:

reconf/reconf_stress.py

@@ -9,16 +9,25 @@
 from testers import stress
 
 __author__ = "Tempesta Technologies, Inc."
-__copyright__ = "Copyright (C) 2017 Tempesta Technologies, Inc."
+__copyright__ = "Copyright (C) 2017-2024 Tempesta Technologies, Inc."
 __license__ = "GPL2"
 
 
 class LiveReconfStress(stress.StressTest):
-
  defconfig = ""
  sg_name = "default"
  auto_vhosts = True
 
+ def setUp(self):
+ super().setUp()
+ self.addCleanup(self.cleanup_reconfig_thread)
+
+ def cleanup_reconfig_thread(self):
+ # Wait for reconfig thread if it's not finished (exception was thrown
+ # during stress_reconfig_generic()
+ if hasattr(self, "r_thread"):
+ self.r_thread.join()
+
  def create_servers(self):
  port = tempesta.upstream_port_start_from()
  rm_srv_n = tempesta.servers_in_group() / 3
@@ -77,7 +86,7 @@ def assert_clients(self):
  self.assertLess(err, max_err)
 
  def stress_reconfig_generic(self, configure_func, reconfigure_func):
- """Generic test routinr for reconfig."""
+ """Generic test routine for reconfig."""
  self.reconfigure_func = reconfigure_func
  control.servers_start(self.servers)
  configure_func()
@@ -93,13 +102,6 @@ def stress_reconfig_generic(self, configure_func, reconfigure_func):
  self.r_thread.join()
  self.assert_clients()
 
- def tearDown(self):
- # Wait for reconfig thread if it's not finished (exception was thrown
- # during stress_reconfig_generic()
- if hasattr(self, "r_thread"):
- self.r_thread.join()
- stress.StressTest.tearDown(self)
-
  def configure_srvs_start(self):
  srvs = self.const_srvs + self.rm_srvs
  config = self.make_config(self.sg_name, srvs)

regression/test_reboot.py

@@ -11,7 +11,7 @@
 from testers import stress
 
 __author__ = "Tempesta Technologies, Inc."
-__copyright__ = "Copyright (C) 2017 Tempesta Technologies, Inc."
+__copyright__ = "Copyright (C) 2017-2024 Tempesta Technologies, Inc."
 __license__ = "GPL2"
 
 
@@ -25,6 +25,14 @@ class RebootUnderLoadTest(stress.StressTest):
  # Timeout before first reboot.
  warm_timeout = 0
 
+ def setUp(self):
+ super().setUp()
+ self.addCleanup(self.cleanup_r_thread)
+
+ def cleanup_r_thread(self):
+ if hasattr(self, "r_thread"):
+ self.r_thread.join()
+
  def create_clients(self):
  self.wrk = control.Wrk()
  self.wrk.set_script("foo", content="")
@@ -56,11 +64,6 @@ def reboot_routine(self, config):
  control.client_run_blocking(self.wrk)
  self.show_performance()
 
- def tearDown(self):
- if hasattr(self, "r_thread"):
- self.r_thread.join()
- stress.StressTest.tearDown(self)
-
  def test_proxy(self):
  config = "cache 0;\n"
  self.reboot_routine(config)

selftests/test_deproxy_message.py

@@ -8,8 +8,10 @@
 class TestDeproxyMessage(unittest.TestCase):
  def setUp(self):
  deproxy.HeaderCollection._disable_report_wrong_is_expected = True
+ # Cleanup part
+ self.addCleanup(self.cleanup_deproxy)
 
- def tearDown(self):
+ def cleanup_deproxy(self):
  deproxy.HeaderCollection._disable_report_wrong_is_expected = False
 
  def test_incomplite(self):
@@ -78,7 +80,7 @@ def test_incomplite(self):
  (message_6, "body: too short"),
  ]
  for message, reason in incomplite:
- msg = "Message parsed, but it has incomplite %s. Message:\n%s" % (reason, message)
+ msg = "Message parsed, but it has incomplete %s. Message:\n%s" % (reason, message)
  parsed = True
  try:
  deproxy.Response(message)

selftests/test_headercollection.py

@@ -6,17 +6,19 @@
 from helpers import deproxy
 
 __author__ = "Tempesta Technologies, Inc."
-__copyright__ = "Copyright (C) 2017 Tempesta Technologies, Inc."
+__copyright__ = "Copyright (C) 2017-2024 Tempesta Technologies, Inc."
 __license__ = "GPL2"
 
 
 class TestHeaderCollection(unittest.TestCase):
  def setUp(self):
  deproxy.HeaderCollection._disable_report_wrong_is_expected = True
  self.headers = deproxy.HeaderCollection()
+ self.addCleanup(self.clenup_header_collection)
 
- def tearDown(self):
+ def clenup_header_collection(self):
  deproxy.HeaderCollection._disable_report_wrong_is_expected = False
+ self.headers = None
 
  def test_length(self):
  self.assertEqual(len(self.headers), 0)

selftests/test_requests.py

@@ -5,7 +5,7 @@
 from helpers import deproxy
 
 __author__ = "Tempesta Technologies, Inc."
-__copyright__ = "Copyright (C) 2017 Tempesta Technologies, Inc."
+__copyright__ = "Copyright (C) 2017-2024 Tempesta Technologies, Inc."
 __license__ = "GPL2"
 
 
@@ -15,8 +15,10 @@ def setUp(self):
  self.plain = deproxy.Request(PLAIN)
  self.reordered = deproxy.Request(REORDERED)
  self.duplicated = deproxy.Request(DUPLICATED)
+ # Cleanup part
+ self.addCleanup(self.cleanup_deproxy)
 
- def tearDown(self):
+ def cleanup_deproxy(self):
  deproxy.HeaderCollection._disable_report_wrong_is_expected = False
 
  def test_equal(self):

selftests/test_responses.py

@@ -5,7 +5,7 @@
 from helpers import deproxy
 
 __author__ = "Tempesta Technologies, Inc."
-__copyright__ = "Copyright (C) 2017 Tempesta Technologies, Inc."
+__copyright__ = "Copyright (C) 2017-2024 Tempesta Technologies, Inc."
 __license__ = "GPL2"
 
 
@@ -20,8 +20,10 @@ def setUp(self):
 
  self.trailer = deproxy.Response(TRAILER)
  self.o_trailer = deproxy.Response(OTHER_TRAILER)
+ # Cleanup part
+ self.addCleanup(self.cleanup_HeaderCollection)
 
- def tearDown(self):
+ def cleanup_HeaderCollection(self):
  deproxy.HeaderCollection._disable_report_wrong_is_expected = False
 
  def test_equal(self):

selftests/test_x509.py

@@ -5,7 +5,7 @@
 from framework.x509 import CertGenerator
 
 __author__ = "Tempesta Technologies, Inc."
-__copyright__ = "Copyright (C) 2022 Tempesta Technologies, Inc."
+__copyright__ = "Copyright (C) 2022-2024 Tempesta Technologies, Inc."
 __license__ = "GPL2"
 
 
@@ -19,10 +19,8 @@ def cert_text(self) -> str:
 
  def setUp(self):
  self.cgen = CertGenerator()
- self.remove_certs()
-
- def tearDown(self):
- self.remove_certs()
+ self.remove_certs() # initial certs cleanup before testing
+ self.addCleanup(self.remove_certs)
 
  def remove_certs(self):
  for path in self.cgen.get_file_paths():

t_frang/frang_test_case.py

@@ -1,7 +1,7 @@
 """Basic file for frang functional tests."""
 
 __author__ = "Tempesta Technologies, Inc."
-__copyright__ = "Copyright (C) 2022-2023 Tempesta Technologies, Inc."
+__copyright__ = "Copyright (C) 2022-2024 Tempesta Technologies, Inc."
 __license__ = "GPL2"
 
 
@@ -68,10 +68,12 @@ def setUp(self):
  super().setUp()
  self.klog = dmesg.DmesgFinder(disable_ratelimit=True)
  self.assert_msg = "Expected nums of warnings in `journalctl`: {exp}, but got {got}"
+ # Cleanup part
+ self.addCleanup(self.cleanup_klog)
 
- def tearDown(self):
- super().tearDown()
- del self.klog
+ def cleanup_klog(self):
+ if hasattr(self, "klog"):
+  del self.klog
 
  # TODO: rename to set_frang_cfg_and_start
  def set_frang_config(self, frang_config: str):