git: 89ffac3b01fb - main - testing: allow custom test cleanup handlers in pytest

The branch main has been updated by melifaro:

URL: https://cgit.FreeBSD.org/src/commit/?id=89ffac3b01fb3f6749799ac67b7d94056a36778e

commit 89ffac3b01fb3f6749799ac67b7d94056a36778e
Author:     Alexander V. Chernikov <melifaro@FreeBSD.org>
AuthorDate: 2022-12-31 16:22:30 +0000
Commit:     Alexander V. Chernikov <melifaro@FreeBSD.org>
CommitDate: 2022-12-31 16:27:27 +0000

    testing: allow custom test cleanup handlers in pytest
    
    In order to provide more flexibility for the test writers,
    add per-test-method cleanups in addition to the per-class cleanups.
    
    Now the test 'test_one' can perform cleanup by either defining
    per-class 'cleanup' method (typically used in VNET classes) and
    per-test method 'cleanup_test_one'. The latter has preference.
    In order to handle paramatrization, testid is passed as a single
     argument to both of the methods.
    
    MFC after:      2 weeks
---
 tests/atf_python/atf_pytest.py | 31 +++++++++++++++++++++++--------
 1 file changed, 23 insertions(+), 8 deletions(-)

diff --git a/tests/atf_python/atf_pytest.py b/tests/atf_python/atf_pytest.py
index f72122fb740e..d530c7b4515c 100644
--- a/tests/atf_python/atf_pytest.py
+++ b/tests/atf_python/atf_pytest.py
@@ -9,11 +9,21 @@ import pytest
 import os
 
 
+def nodeid_to_method_name(nodeid: str) -> str:
+    """file_name.py::ClassName::method_name[parametrize] -> method_name"""
+    return nodeid.split("::")[-1].split("[")[0]
+
+
 class ATFCleanupItem(pytest.Item):
     def runtest(self):
-        """Runs cleanup procedure for the test instead of the test"""
+        """Runs cleanup procedure for the test instead of the test itself"""
         instance = self.parent.cls()
-        instance.cleanup(self.nodeid)
+        cleanup_name = "cleanup_{}".format(nodeid_to_method_name(self.nodeid))
+        if hasattr(instance, cleanup_name):
+            cleanup = getattr(instance, cleanup_name)
+            cleanup(self.nodeid)
+        elif hasattr(instance, "cleanup"):
+            instance.cleanup(self.nodeid)
 
     def setup_method_noop(self, method):
         """Overrides runtest setup method"""
@@ -91,15 +101,20 @@ class ATFHandler(object):
         obj.parent.cls.setup_method = ATFCleanupItem.setup_method_noop
         obj.parent.cls.teardown_method = ATFCleanupItem.teardown_method_noop
 
-    def get_object_cleanup_class(self, obj):
+    @staticmethod
+    def get_test_class(obj):
         if hasattr(obj, "parent") and obj.parent is not None:
-            if hasattr(obj.parent, "cls") and obj.parent.cls is not None:
-                if hasattr(obj.parent.cls, "cleanup"):
-                    return obj.parent.cls
-        return None
+            if hasattr(obj.parent, "cls"):
+                return obj.parent.cls
 
     def has_object_cleanup(self, obj):
-        return self.get_object_cleanup_class(obj) is not None
+        cls = self.get_test_class(obj)
+        if cls is not None:
+            method_name = nodeid_to_method_name(obj.nodeid)
+            cleanup_name = "cleanup_{}".format(method_name)
+            if hasattr(cls, "cleanup") or hasattr(cls, cleanup_name):
+                return True
+        return False
 
     def list_tests(self, tests: List[str]):
         print('Content-Type: application/X-atf-tp; version="1"')