Testsuite: switch to Python3 and e3-testsuite

Also introduce a Mypy setup, to type-check the testsuite code (only that
for now).

Change-Id: Ib90b1ac7e344fb34c7560dc0ff32ca95e0705cd7
TN: U622-042

Author: pmderodat

mypy.ini

@@ -0,0 +1,26 @@
+[mypy]
+python_version=3.7
+
+# TODO: create a stub for the gdb modules and then enable type-checking on the
+# gnatdbg package.
+files=
+  testsuite/run.py,
+  testsuite/support
+
+no_implicit_optional = True
+
+[mypy-run]
+disallow_untyped_defs = True
+disallow_incomplete_defs = True
+disallow_untyped_decorators = True
+
+[mypy-support.*]
+disallow_untyped_defs = True
+disallow_incomplete_defs = True
+disallow_untyped_decorators = True
+
+[mypy-coverage.*]
+ignore_missing_imports = True
+
+[mypy-pexpect.*]
+ignore_missing_imports = True

testsuite/coverage.ini

@@ -8,4 +8,4 @@ exclude_lines =
     def __repr__
     raise NotImplementedError()
     assert False
-    # no-code-coverage
+    no-code-coverage

testsuite/run-test

@@ -1,17 +1,92 @@
 #! /usr/bin/env python
 
-"""
-Usage::
+from __future__ import annotations
 
-    run.py [OPTIONS]
+import argparse
+import os
+import sys
 
-Run the gnatdbg testsuite.
-"""
+from e3.testsuite import Testsuite as BaseTestsuite
 
-import os
+from support.gdb import GDBSession
+from support.python_driver import PythonDriver
+from support.utils import TestsuiteConfig
+
+
+class Testsuite(BaseTestsuite):
+
+    tests_subdir = "tests"
+    test_driver_map = {
+        "python": PythonDriver,
+    }
+
+    def add_options(self, parser: argparse.ArgumentParser) -> None:
+        parser.add_argument(
+            "--coverage", "-C", action="store_true",
+            help="Compute gnatdbg code coverage"
+        )
+        parser.add_argument(
+            "--no-auto-pythonpath", "-A", action="store_true",
+            help="Do not update PYTHONPATH to reach gnatdbg"
+        )
+
+    def set_up(self) -> None:
+        super().set_up()
+
+        assert self.main.args
+        ts_config = TestsuiteConfig(
+            no_auto_pythonpath=self.main.args.no_auto_pythonpath,
+            coverage=self.main.args.coverage,
+            coverage_dir=os.path.join(self.output_dir, "coverage"),
+            coverage_rcfile=os.path.join(self.root_dir, "coverage.ini"),
+        )
+        self.env.ts_config = ts_config
+
+        if ts_config.coverage:
+            # Create a directory that we"ll use to:
+            #
+            #   1) collect coverage data for each testcase;
+            #   2) generate the HTML report.
+            os.mkdir(ts_config.coverage_dir)
+            os.environ["COVERAGE_DIR"] = ts_config.coverage_dir
+            os.environ["COVERAGE_RCFILE"] = ts_config.coverage_rcfile
+
+    def tear_down(self) -> None:
+        ts_config: TestsuiteConfig = self.env.ts_config
+        if ts_config.coverage:
+            # Process coverage data with the same Python interpreter and
+            # "coverage" package that was used to produce them. To achieve
+            # this, spawn GDB just like testcases.
+            gdb = GDBSession(
+                log_file=os.path.join(ts_config.coverage_dir, "gdb.log"),
+                load_gnatdbg=False
+            )
+            gdb.import_coverage()
+            gdb.execute("python import glob")
+
+            # Consolidate coverage data for each testcase and generate both a
+            # sumary textual report on the standard output and a detailed HTML
+            # report.
+            gdb.execute("""python
+c = coverage.Coverage(data_file={data_file!r}, config_file={config_file!r})
+c.combine(glob.glob({data_files_glob!r}))
+c.html_report(directory={coverage_dir!r}, title="gnatdbg coverage report")
+end""".format(
+                data_file=os.path.join(ts_config.coverage_dir, ".coverage"),
+                data_files_glob=os.path.join(
+                    ts_config.coverage_dir, "*.coverage"
+                ),
+                config_file=ts_config.coverage_rcfile,
+                coverage_dir=ts_config.coverage_dir
+            ))
+
+            html_index = os.path.join(ts_config.coverage_dir, "index.html")
+            assert os.path.exists(html_index)
+            print("Detailed HTML coverage report available at:"
+                  " {}".format(html_index))
 
-from support import Testsuite
+        super().tear_down()
 
 
-if __name__ == '__main__':
-    Testsuite(os.path.dirname(__file__)).testsuite_main()
+if __name__ == "__main__":
+    sys.exit(Testsuite().testsuite_main())

testsuite/run.py

@@ -1,88 +0,0 @@
-import os.path
-
-from gnatpython.testsuite import Testsuite as BaseTestsuite
-
-from support.gdb import GDBSession
-from support.python_driver import PythonDriver
-
-
-class Testsuite(BaseTestsuite):
-
-    CROSS_SUPPORT = True
-    TEST_SUBDIR = 'tests'
-    DRIVERS = {
-        'python': PythonDriver,
-    }
-
-    def add_options(self):
-        self.main.add_option(
-            '--coverage', '-C', action='store_true',
-            help='Compute gnatdbg code coverage'
-        )
-        self.main.add_option(
-            '--no-auto-pythonpath', '-A', action='store_true',
-            help='Do not update PYTHONPATH to reach gnatdbg'
-        )
-
-    @property
-    def coverage_enabled(self):
-        return self.global_env['options'].coverage
-
-    @property
-    def coverage_dir(self):
-        return os.path.join(self.global_env['output_dir'], 'coverage')
-
-    @property
-    def coverage_rcfile(self):
-        return os.path.join(
-            os.path.dirname(os.path.abspath(__file__)),
-            '..',
-            'coverage.ini'
-        )
-
-    def tear_up(self):
-        super(Testsuite, self).tear_up()
-
-        if self.coverage_enabled:
-            # Create a directory that we'll use to:
-            #
-            #   1) collect coverage data for each testcase;
-            #   2) generate the HTML report.
-            os.mkdir(self.coverage_dir)
-
-            self.global_env['coverage_dir'] = self.coverage_dir
-            os.environ['COVERAGE_DIR'] = self.coverage_dir
-            os.environ['COVERAGE_RCFILE'] = self.coverage_rcfile
-
-    def tear_down(self):
-        if self.coverage_enabled:
-            # Process coverage data with the same Python interpreter and
-            # "coverage" package that was used to produce them. To achieve
-            # this, spawn GDB just like testcases.
-            gdb = GDBSession(
-                log_file=os.path.join(self.coverage_dir, 'gdb.log'),
-                load_gnatdbg=False
-            )
-            gdb.import_coverage()
-            gdb.execute('python import glob')
-
-            # Consolidate coverage data for each testcase and generate both a
-            # sumary textual report on the standard output and a detailed HTML
-            # report.
-            gdb.execute('''python
-c = coverage.Coverage(data_file={data_file!r}, config_file={config_file!r})
-c.combine(glob.glob({data_files_glob!r}))
-c.html_report(directory={coverage_dir!r}, title='gnatdbg coverage report')
-end'''.format(
-                data_file=os.path.join(self.coverage_dir, '.coverage'),
-                data_files_glob=os.path.join(self.coverage_dir, '*.coverage'),
-                config_file=self.coverage_rcfile,
-                coverage_dir=self.coverage_dir
-            ))
-
-            html_index = os.path.join(self.coverage_dir, 'index.html')
-            assert os.path.exists(html_index)
-            print('Detailed HTML coverage report available at:'
-                  ' {}'.format(html_index))
-
-        super(Testsuite, self).tear_down()

testsuite/support/__init__.py

@@ -1,9 +1,12 @@
+from __future__ import annotations
+
 import sys
+from typing import List
 
-from gnatpython.ex import Run
+from e3.os.process import Run
 
 
-def gnatmake(main, debug=True, cargs=[]):
+def gnatmake(main: str, debug: bool = True, cargs: List[str] = []) -> None:
     """
     Run GNATmake on the given main source file.