[Python-checkins] gh-94751: Install, import and run the test C++ extension (MVP) (GH-94754)

[encukou]

https://github.com/python/cpython/commit/ec5db539b9df99c8b96149768dc2e8598dce2afa
commit: ec5db539b9df99c8b96149768dc2e8598dce2afa
branch: main
author: Petr Viktorin <encukou at gmail.com>
committer: encukou <encukou at gmail.com>
date: 2022-07-12T17:06:05+02:00
summary:

gh-94751: Install, import and run the test C++ extension (MVP) (GH-94754)

This is a quick-and-dirty way to run the C++ tests.
It can definitely be improved in the future, but it should fail when things go wrong.

- Run test functions on import (yes, this can definitely be improved)
- Fudge setuptools metadata (name & version) to make the extension installable
- Install and import the extension in test_cppext

files:
M Lib/test/_testcppext.cpp
M Lib/test/setup_testcppext.py
M Lib/test/test_cppext.py

diff --git a/Lib/test/_testcppext.cpp b/Lib/test/_testcppext.cpp
index b6d35407a61ed..be7538826b6c4 100644
--- a/Lib/test/_testcppext.cpp
+++ b/Lib/test/_testcppext.cpp
@@ -128,6 +128,9 @@ static PyMethodDef _testcppext_methods[] = {
     {"add", _testcppext_add, METH_VARARGS, _testcppext_add_doc},
     {"test_api_casts", test_api_casts, METH_NOARGS, _Py_NULL},
     {"test_unicode", test_unicode, METH_NOARGS, _Py_NULL},
+    // Note: _testcppext_exec currently runs all test functions directly.
+    // When adding a new one, add a call there.
+
     {_Py_NULL, _Py_NULL, 0, _Py_NULL}  /* sentinel */
 };
 
@@ -138,6 +141,17 @@ _testcppext_exec(PyObject *module)
     if (PyModule_AddIntMacro(module, __cplusplus) < 0) {
         return -1;
     }
+
+    PyObject *result;
+
+    result = PyObject_CallMethod(module, "test_api_casts", "");
+    if (!result) return -1;
+    Py_DECREF(result);
+
+    result = PyObject_CallMethod(module, "test_unicode", "");
+    if (!result) return -1;
+    Py_DECREF(result);
+
     return 0;
 }
 
diff --git a/Lib/test/setup_testcppext.py b/Lib/test/setup_testcppext.py
index 892e24a6376c5..ae81e33e23b6b 100644
--- a/Lib/test/setup_testcppext.py
+++ b/Lib/test/setup_testcppext.py
@@ -46,7 +46,7 @@ def main():
         sources=[SOURCE],
         language='c++',
         extra_compile_args=cppflags)
-    setup(name=name, ext_modules=[cpp_ext])
+    setup(name='internal' + name, version='0.0', ext_modules=[cpp_ext])
 
 
 if __name__ == "__main__":
diff --git a/Lib/test/test_cppext.py b/Lib/test/test_cppext.py
index 8673911ecfae5..2c54d33711691 100644
--- a/Lib/test/test_cppext.py
+++ b/Lib/test/test_cppext.py
@@ -17,22 +17,22 @@
 @support.requires_subprocess()
 class TestCPPExt(unittest.TestCase):
     def test_build_cpp11(self):
-        self.check_build(False)
+        self.check_build(False, '_testcpp11ext')
 
     def test_build_cpp03(self):
-        self.check_build(True)
+        self.check_build(True, '_testcpp03ext')
 
     # With MSVC, the linker fails with: cannot open file 'python311.lib'
     # https://github.com/python/cpython/pull/32175#issuecomment-1111175897
     @unittest.skipIf(MS_WINDOWS, 'test fails on Windows')
     # the test uses venv+pip: skip if it's not available
     @support.requires_venv_with_pip()
-    def check_build(self, std_cpp03):
+    def check_build(self, std_cpp03, extension_name):
         # Build in a temporary directory
         with os_helper.temp_cwd():
-            self._check_build(std_cpp03)
+            self._check_build(std_cpp03, extension_name)
 
-    def _check_build(self, std_cpp03):
+    def _check_build(self, std_cpp03, extension_name):
         venv_dir = 'env'
         verbose = support.verbose
 
@@ -52,22 +52,47 @@ def _check_build(self, std_cpp03):
         else:
             python = os.path.join(venv_dir, 'bin', python_exe)
 
+        def run_cmd(operation, cmd):
+            if verbose:
+                print('Run:', ' '.join(cmd))
+                subprocess.run(cmd, check=True)
+            else:
+                proc = subprocess.run(cmd,
+                                      stdout=subprocess.PIPE,
+                                      stderr=subprocess.STDOUT,
+                                      text=True)
+                if proc.returncode:
+                    print(proc.stdout, end='')
+                    self.fail(
+                        f"{operation} failed with exit code {proc.returncode}")
+
         # Build the C++ extension
         cmd = [python, '-X', 'dev',
                SETUP_TESTCPPEXT, 'build_ext', '--verbose']
         if std_cpp03:
             cmd.append('-std=c++03')
-        if verbose:
-            print('Run:', ' '.join(cmd))
-            subprocess.run(cmd, check=True)
-        else:
-            proc = subprocess.run(cmd,
-                                  stdout=subprocess.PIPE,
-                                  stderr=subprocess.STDOUT,
-                                  text=True)
-            if proc.returncode:
-                print(proc.stdout, end='')
-                self.fail(f"Build failed with exit code {proc.returncode}")
+        run_cmd('Build', cmd)
+
+        # Install the C++ extension
+        cmd = [python, '-X', 'dev',
+               SETUP_TESTCPPEXT, 'install']
+        run_cmd('Install', cmd)
+
+        # Do a reference run. Until we test that running python
+        # doesn't leak references (gh-94755), run it so one can manually check
+        # -X showrefcount results against this baseline.
+        cmd = [python,
+               '-X', 'dev',
+               '-X', 'showrefcount',
+               '-c', 'pass']
+        run_cmd('Reference run', cmd)
+
+        # Import the C++ extension
+        cmd = [python,
+               '-X', 'dev',
+               '-X', 'showrefcount',
+               '-c', f"import {extension_name}"]
+        run_cmd('Import', cmd)
 
 
 if __name__ == "__main__":