Refactor cpyext tests

Author: msimacek

graalpython/com.oracle.graal.python.test/src/tests/cpyext/__init__.py

@@ -36,14 +36,17 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
-import os
+
 from importlib import invalidate_caches
-from io import StringIO
-from pathlib import Path
-from string import Formatter
 
 import gc
+import os
 import sys
+import unittest
+from copy import deepcopy
+from io import StringIO
+from pathlib import Path
+from string import Formatter
 
 DIR = Path(__file__).parent.absolute()
 
@@ -81,23 +84,14 @@ def unhandled_error_compare_with_message(x, y):
     else:
         return x == y
 
-class CPyExtTestCase():
 
-    def setUpClass(self):
-        for typ in type(self).mro():
-            for k, v in typ.__dict__.items():
-                if k.startswith("test_"):
-                    modname = k.replace("test_", "")
-                    if k.startswith("test_graalpython_"):
-                        if not GRAALPYTHON:
-                            continue
-                        else:
-                            modname = k.replace("test_graalpython_", "")
-                    self.compile_module(modname)
+class CPyExtTestCase(unittest.TestCase):
+    pass
 
 
 compiled_registry = set()
 
+
 def ccompile(self, name, check_duplicate_name=True):
     from distutils.core import setup, Extension
     from distutils.sysconfig import get_config_var
@@ -115,7 +109,7 @@ def ccompile(self, name, check_duplicate_name=True):
             m.update(block)
     cur_checksum = m.hexdigest()
 
-    install_dir = _install_dir_for(name)
+    install_dir = DIR / 'build' / name
 
     # see if there is already a checksum file
     checksum_file = install_dir / f'{name}{EXT_SUFFIX}.sha256'
@@ -141,8 +135,11 @@ def ccompile(self, name, check_duplicate_name=True):
     # manually deleted the shared library file.
     if available_checksum != cur_checksum or not lib_file.exists():
         module = Extension(name, sources=[str(source_file)])
-        verbosity = '--verbose' if sys.flags.verbose else '--quiet'
-        args = [verbosity, 'build', 'install_lib', '-f', f'--install-dir={install_dir}', 'clean']
+        args = [
+            '--verbose' if sys.flags.verbose else '--quiet',
+            'build', f'--build-base={install_dir}',
+            'install_lib', '-f', f'--install-dir={install_dir}',
+        ]
         setup(
             script_name='setup',
             script_args=args,
@@ -166,6 +163,8 @@ def ccompile(self, name, check_duplicate_name=True):
     if GRAALPYTHON:
         file_not_empty(lib_file)
 
+    return str(install_dir)
+
 
 def file_not_empty(path):
     for i in range(3):
@@ -342,13 +341,13 @@ def file_not_empty(path):
 """
 
 
-class CPyExtFunction():
+class CPyExtFunction:
 
     def __init__(self, pfunc, parameters, template=c_template, cmpfunc=None, stderr_validator=None, **kwargs):
         self.template = template
         self.pfunc = pfunc
         self.parameters = parameters
-        kwargs["name"] = kwargs["name"] if "name" in kwargs else None
+        kwargs.setdefault("name", None)
         self.name = kwargs["name"]
         if "code" in kwargs:
             kwargs["customcode"] = kwargs["code"]
@@ -403,12 +402,28 @@ def _insert(self, d, name, default_value):
     def __repr__(self):
         return "<CPyExtFunction %s>" % self.name
 
-    def test(self):
-        sys.path.insert(0, str(_install_dir_for(self.name)))
+    def __set_name__(self, owner, name):
+        if self.name:
+            raise RuntimeError(f"{type(self)} already assigned to a test suite. Use copy() method to duplicate a test")
+        self.name = name.removeprefix('test_')
+        self.__name__ = name
+        self.__qualname__ = f'{owner.__qualname__}.{name}'
+
+    def copy(self):
+        inst = deepcopy(self)
+        inst.name = None
+        return inst
+
+    @property
+    def __code__(self):
+        return type(self).__call__.__code__
+
+    def __call__(self):
         try:
-            cmodule = __import__(self.name)
-        finally:
-            sys.path.pop(0)
+            self.create_module(self.name)
+            cmodule = compile_module_from_file(self.name)
+        except Exception as e:
+            raise RuntimeError(f"{self.__qualname__}: Failed to create module") from e
         ctest = getattr(cmodule, "test_%s" % self.name)
         cargs = self.parameters()
         pargs = self.parameters()
@@ -418,7 +433,7 @@ def test(self):
                 sys.stderr = StringIO()
             try:
                 cresult = ctest(cargs[i])
-            except BaseException as e:
+            except Exception as e:
                 cresult = e
             else:
                 if self.stderr_validator:
@@ -432,20 +447,13 @@ def test(self):
             except BaseException as e:
                 presult = e
 
-            if not self.cmpfunc:
-                assert cresult == presult, ("%r == %r in %s(%s)" % (cresult, presult, self.name, pargs[i]))
+            if self.cmpfunc:
+                success = self.cmpfunc(cresult, presult)
             else:
-                assert self.cmpfunc(cresult, presult), ("%r == %r in %s(%s)" % (cresult, presult, self.name, pargs[i]))
+                success = cresult == presult
+            assert success, f"{self.__qualname__}: C result not equal to python reference implementation result.\n\tArguments: {pargs[i]!r}\n\tExpected result: {presult!r}\n\tActual C result: {cresult!r}"
         gc.collect()
 
-    def __get__(self, instance, typ=None):
-        if typ is None:
-            return self
-        else:
-            CPyExtFunction.test.__name__ = self.name
-            CPyExtFunction.test.__qualname__ = f'{CPyExtFunction.__name__}.test_{self.name}'
-            return self.test
-
 
 class CPyExtFunctionOutVars(CPyExtFunction):
     '''
@@ -511,25 +519,18 @@ def get_value(self, key, args, kwds):
             return Formatter.get_value(key, args, kwds)
 
 
-def _install_dir_for(name):
-    return DIR / 'build' / name
-
-
-def _compile_module(c_source, name):
+def compile_module_from_string(c_source: str, name: str):
     source_file = DIR / f'{name}.c'
     with open(source_file, "wb", buffering=0) as f:
         f.write(bytes(c_source, 'utf-8'))
-    # ensure file was really written
-    try:
-        stat_result = os.stat(source_file)
-        if stat_result[6] == 0:
-            raise SystemError("empty source file %s" % (source_file,))
-    except FileNotFoundError:
-        raise SystemError("source file %s not available" % (source_file,))
-    ccompile(None, name)
-    sys.path.insert(0, str(_install_dir_for(name)))
+    return compile_module_from_file(name)
+
+
+def compile_module_from_file(module_name: str):
+    install_dir = ccompile(None, module_name)
+    sys.path.insert(0, install_dir)
     try:
-        cmodule = __import__(name)
+        cmodule = __import__(module_name)
     finally:
         sys.path.pop(0)
     return cmodule
@@ -570,7 +571,7 @@ def CPyExtType(name, code='', **kwargs):
     kwargs.setdefault("post_ready_code", "")
     c_source = type_decl + UnseenFormatter().format(mod_template, **kwargs)
 
-    cmodule = _compile_module(c_source, name)
+    cmodule = compile_module_from_string(c_source, name)
     return getattr(cmodule, name)
 
 
@@ -787,7 +788,7 @@ def CPyExtHeapType(name, bases=(object), code='', slots=None, **kwargs):
     kwargs.setdefault("ready_code", "")
     kwargs.setdefault("post_ready_code", "")
     code = UnseenFormatter().format(template, **kwargs)
-    mod = _compile_module(code, name)
+    mod = compile_module_from_string(code, name)
     return mod.create(bases)
 
 

graalpython/com.oracle.graal.python.test/src/tests/cpyext/test_abstract.py

@@ -37,8 +37,12 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-import sys, array, collections
-from . import CPyExtTestCase, CPyExtFunction, CPyExtFunctionOutVars, CPyExtType, unhandled_error_compare, GRAALPYTHON
+import array
+import collections
+import sys
+
+from . import CPyExtTestCase, CPyExtFunction, CPyExtType, unhandled_error_compare
+
 __dir__ = __file__.rpartition("/")[0]
 
 
@@ -659,10 +663,6 @@ def test___name__(self):
 
 class TestAbstract(CPyExtTestCase):
 
-    def compile_module(self, name):
-        type(self).mro()[1].__dict__["test_%s" % name].create_module(name)
-        super(TestAbstract, self).compile_module(name)
-
     test_PyNumber_Absolute = CPyExtFunction(
         lambda args: abs(args[0]),
         _default_unarop_args,
@@ -1158,7 +1158,7 @@ def compile_module(self, name):
     )
 
     # 'PySequence_Length' is just a redefinition of 'PySequence_Size'
-    test_PySequence_Length = test_PySequence_Size
+    test_PySequence_Length = test_PySequence_Size.copy()
 
     test_PySequence_GetItem = CPyExtFunction(
         _reference_getitem,
@@ -1565,4 +1565,4 @@ def _reference_delslice(args):
         cmpfunc=unhandled_error_compare
     )
 
-    test_PyObject_Length = test_PyObject_Size
+    test_PyObject_Length = test_PyObject_Size.copy()

graalpython/com.oracle.graal.python.test/src/tests/cpyext/test_array.py

@@ -61,10 +61,6 @@ def reference_getbuffer(args):
 
 class TestPyArray(CPyExtTestCase):
 
-    def compile_module(self, name):
-        type(self).mro()[1].__dict__["test_%s" % name].create_module(name)
-        super().compile_module(name)
-
     if sys.implementation.name == 'graalpy':
         test__PyArray_Resize = CPyExtFunction(
             reference_array_resize,

graalpython/com.oracle.graal.python.test/src/tests/cpyext/test_bool.py

@@ -37,8 +37,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-import sys
-from . import CPyExtTestCase, CPyExtFunction, CPyExtFunctionOutVars, unhandled_error_compare, GRAALPYTHON
+from . import CPyExtTestCase, CPyExtFunction, unhandled_error_compare
+
 __dir__ = __file__.rpartition("/")[0]
 
 
@@ -47,9 +47,6 @@ class DummyNonInt():
 
 
 class TestPyBool(CPyExtTestCase):
-    def compile_module(self, name):
-        type(self).mro()[1].__dict__["test_%s" % name].create_module(name)
-        super(TestPyBool, self).compile_module(name)
 
     # (tfel): This test actually checks that the wrapped booleans that are
     # stored as sulong globals are singletons

graalpython/com.oracle.graal.python.test/src/tests/cpyext/test_bytes.py

@@ -108,10 +108,6 @@ def __iter__(self):
 
 class TestPyBytes(CPyExtTestCase):
 
-    def compile_module(self, name):
-        type(self).mro()[1].__dict__["test_%s" % name].create_module(name)
-        super(TestPyBytes, self).compile_module(name)
-
     # Below are the PyBytes_* identifiers that we know are used in numpy
 
     # PyBytes_FromStringAndSize

graalpython/com.oracle.graal.python.test/src/tests/cpyext/test_capsule.py

@@ -37,17 +37,13 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-import sys
-from . import CPyExtTestCase, CPyExtFunction, CPyExtFunctionOutVars, unhandled_error_compare, GRAALPYTHON
+from . import CPyExtTestCase, CPyExtFunction, unhandled_error_compare
+
 __dir__ = __file__.rpartition("/")[0]
 
 
 class TestPyCapsule(CPyExtTestCase):
 
-    def compile_module(self, name):
-        type(self).mro()[1].__dict__["test_%s" % name].create_module(name)
-        super(TestPyCapsule, self).compile_module(name)
-
     test_PyCapsule_CheckExact = CPyExtFunction(
         lambda args: True,
         lambda: (

graalpython/com.oracle.graal.python.test/src/tests/cpyext/test_classobject.py

@@ -38,7 +38,9 @@
 # SOFTWARE.
 
 import sys
-from . import CPyExtTestCase, CPyExtFunction, CPyExtFunctionOutVars, unhandled_error_compare, GRAALPYTHON
+
+from . import CPyExtTestCase, CPyExtFunction
+
 __dir__ = __file__.rpartition("/")[0]
 
 
@@ -51,9 +53,6 @@ def foo(self):
 
 
 class TestClassobject(CPyExtTestCase):
-    def compile_module(self, name):
-        type(self).mro()[1].__dict__["test_%s" % name].create_module(name)
-        super().compile_module(name)
 
     testmod = type(sys)("foo")
 

graalpython/com.oracle.graal.python.test/src/tests/cpyext/test_codec.py

@@ -44,10 +44,6 @@
 
 class TestPyCodec(CPyExtTestCase):
 
-    def compile_module(self, name):
-        type(self).mro()[1].__dict__["test_%s" % name].create_module(name)
-        super().compile_module(name)
-
     test_PyCodec_Encoder = CPyExtFunction(
         lambda args: codecs.lookup(args[0])[0],
         lambda: (

graalpython/com.oracle.graal.python.test/src/tests/cpyext/test_codeobject.py

@@ -79,9 +79,6 @@ def foo(self):
 
 
 class TestCodeobject(CPyExtTestCase):
-    def compile_module(self, name):
-        type(self).mro()[1].__dict__["test_%s" % name].create_module(name)
-        super().compile_module(name)
 
     testmod = type(sys)("foo")
 

graalpython/com.oracle.graal.python.test/src/tests/cpyext/test_complex.py

@@ -86,10 +86,6 @@ class DummyComplexSubclass(complex):
 
 class TestPyComplex(CPyExtTestCase):
 
-    def compile_module(self, name):
-        type(self).mro()[1].__dict__["test_%s" % name].create_module(name)
-        super(TestPyComplex, self).compile_module(name)
-
     test_PyComplex_AsCComplex = CPyExtFunction(
         lambda args: True,
         lambda: (