Ensure listings are generated to a build folder.

Author: windelbouwman

.gitignore

@@ -5,12 +5,5 @@ __pycache__/
 *.profile
 .cache
 
-*.bin
-*.elf
-*.exe
-*.hex
-*.oj
-*report.html
-
 dist
-test/listings
+build/

examples/.gitignore

@@ -0,0 +1,7 @@
+
+*.bin
+*.elf
+*.exe
+*.hex
+*.oj
+*report.html

test/helper_util.py

@@ -1,37 +1,39 @@
+import logging
 import os
 import re
-import sys
-import subprocess
-import socket
-import time
 import shutil
-import logging
+import socket
 import string
+import subprocess
+import sys
+import time
 from contextlib import suppress
 from functools import lru_cache
+from pathlib import Path
 
 # Store testdir for safe switch back to directory:
 testdir = os.path.dirname(os.path.abspath(__file__))
+test_path = Path(testdir)
 logger = logging.getLogger("util")
 
 
-def make_filename(s):
+def make_filename(s) -> Path:
     """Remove all invalid characters from a string for a valid filename.
 
     And create a directory if none present.
     """
-    folders = ["listings"]
+    folders = ["..", "build", "listings"]
     parts = list(map(only_valid_chars, s.split(".")))
     assert parts
     folders.extend(parts[:-1])
     basename = parts[-1]
     assert basename.startswith("test_")
     basename = basename[5:]
     assert basename
-    output_dir = relpath(*folders)
-    if not os.path.exists(output_dir):
-        os.makedirs(output_dir)
-    return os.path.join(output_dir, basename)
+    output_dir = Path(relpath(*folders))
+    if not output_dir.exists():
+        output_dir.mkdir(parents=True)
+    return output_dir / basename
 
 
 def only_valid_chars(s):
@@ -43,10 +45,10 @@ def relpath(*args):
     return os.path.normpath(os.path.join(testdir, *args))
 
 
-def source_files(folder, extension):
-    for filename in os.listdir(folder):
-        if filename.endswith(extension):
-            yield os.path.join(folder, filename)
+def source_files(folder: Path, extension):
+    for filename in folder.iterdir():
+        if str(filename).endswith(extension):
+            yield folder / filename
 
 
 qemu_app = "qemu-system-arm"

test/lang/__init__.py

@@ -21,13 +21,13 @@
 """
 
 import unittest
-import glob
 import fnmatch
 import argparse
 import io
 import os
 import logging
 import subprocess
+from pathlib import Path
 
 from ppci.common import CompilerError, logformat
 from ppci import api
@@ -36,18 +36,18 @@
 from ppci.format.elf import write_elf
 
 
-this_dir = os.path.dirname(os.path.abspath(__file__))
+this_dir = Path(__file__).resolve().parent
+root_folder = this_dir.parent.parent.parent
+build_folder = root_folder / "build" / "c_test_suite"
 logger = logging.getLogger("c-test-suite")
 
 
 def c_test_suite_populate(cls):
     """Enrich a unittest.TestCase with a function for each test snippet."""
     if "C_TEST_SUITE_DIR" in os.environ:
-        c_test_suite_directory = os.path.normpath(
-            os.environ["C_TEST_SUITE_DIR"]
-        )
+        suite_folder = Path(os.environ["C_TEST_SUITE_DIR"]).resolve()
 
-        for filename in get_test_snippets(c_test_suite_directory):
+        for filename in get_test_snippets(suite_folder):
             create_test_function(cls, filename)
     else:
 
@@ -60,26 +60,21 @@ def test_stub(self):
     return cls
 
 
-def get_test_snippets(c_test_suite_directory, name_filter="*"):
-    snippet_folder = os.path.join(
-        c_test_suite_directory, "tests", "single-exec"
-    )
+def get_test_snippets(suite_folder: Path, name_filter="*"):
+    snippet_folder = suite_folder / "tests" / "single-exec"
 
     # Check if we have a folder:
-    if not os.path.isdir(snippet_folder):
+    if not snippet_folder.is_dir():
         raise ValueError(f"{snippet_folder} is not a directory")
 
-    for filename in sorted(glob.iglob(os.path.join(snippet_folder, "*.c"))):
-        base_name = os.path.splitext(os.path.split(filename)[1])[0]
-
-        if fnmatch.fnmatch(base_name, name_filter):
+    for filename in sorted(snippet_folder.glob("*.c")):
+        if fnmatch.fnmatch(filename.stem, name_filter):
             yield filename
 
 
-def create_test_function(cls, filename):
+def create_test_function(cls, filename: Path):
     """Create a test function for a single snippet"""
-    snippet_filename = os.path.split(filename)[1]
-    test_name = os.path.splitext(snippet_filename)[0]
+    test_name = filename.stem
     test_name = test_name.replace(".", "_").replace("-", "_")
     test_function_name = "test_" + test_name
 
@@ -91,24 +86,25 @@ def test_function(self):
     setattr(cls, test_function_name, test_function)
 
 
-def perform_test(filename):
+def perform_test(filename: Path):
     """Try to compile the given snippet."""
     logger.info("Step 1: Compile %s!", filename)
     march = "x86_64"
 
-    html_report = os.path.splitext(filename)[0] + "_report.html"
+    build_folder.mkdir(parents=True, exist_ok=True)
+
+    html_report = build_folder / (filename.stem + "_report.html")
 
     coptions = COptions()
-    root_folder = os.path.join(this_dir, "..", "..", "..")
-    libc_folder = os.path.join(root_folder, "librt", "libc")
-    libc_include = os.path.join(libc_folder, "include")
-    coptions.add_include_path(libc_include)
+    libc_folder = root_folder / "librt" / "libc"
+    libc_include = libc_folder / "include"
+    coptions.add_include_path(str(libc_include))
 
     # TODO: this should be injected elsewhere?
     coptions.add_define("__LP64__", "1")
     # coptions.enable('freestanding')
 
-    with html_reporter(html_report) as reporter, open(filename) as f:
+    with html_reporter(html_report) as reporter, filename.open() as f:
         try:
             obj1 = api.cc(f, march, coptions=coptions, reporter=reporter)
         except CompilerError as ex:
@@ -118,15 +114,19 @@ def perform_test(filename):
 
     obj0 = api.asm(io.StringIO(STARTERCODE), march)
     obj2 = api.c3c([io.StringIO(BSP_C3_SRC)], [], march)
-    with open(os.path.join(libc_include, "lib.c")) as f:
+    with (libc_folder / "lib.c").open() as f:
         obj3 = api.cc(f, march, coptions=coptions)
 
-    obj = api.link([obj0, obj1, obj2, obj3], layout=io.StringIO(ARCH_MMAP))
+    # with (libc_folder / "src" / "string" / "string.c").open() as f:
+    #     obj4 = api.cc(f, march, coptions=coptions)
+
+    objs = [obj0, obj1, obj2, obj3]
+    obj = api.link(objs, layout=io.StringIO(ARCH_MMAP))
 
     logger.info("Step 2: Run it!")
 
-    exe_filename = os.path.splitext(filename)[0] + "_executable.elf"
-    with open(exe_filename, "wb") as f:
+    exe_filename = build_folder / (filename.stem + "_executable.elf")
+    with exe_filename.open("wb") as f:
         write_elf(obj, f, type="executable")
     api.chmod_x(exe_filename)
 
@@ -136,7 +136,8 @@ def perform_test(filename):
     assert exit_code == 0
     captured_stdout = test_prog.stdout.read().decode("ascii")
 
-    with open(filename + ".expected") as f:
+    expected_filename = filename.parent / (filename.stem + ".c.expected")
+    with expected_filename.open() as f:
         expected_stdout = f.read()
 
     # Compare stdout:
@@ -213,18 +214,18 @@ def main():
     logging.basicConfig(level=loglevel, format=logformat)
 
     if args.folder is not None:
-        suite_folder = args.folder
+        suite_folder = Path(args.folder)
     elif "C_TEST_SUITE_DIR" in os.environ:
-        suite_folder = os.environ["C_TEST_SUITE_DIR"]
+        suite_folder = Path(os.environ["C_TEST_SUITE_DIR"])
     else:
         parser.print_help()
-        print("ERROR: Specify where the c test suite is located!")
+        logger.error("ERROR: Specify where the c test suite is located!")
         return 1
 
     for filename in get_test_snippets(suite_folder, name_filter=args.filter):
         perform_test(filename)
 
-    print("OK.")
+    logger.info("OK.")
 
 
 if __name__ == "__main__":

test/lang/c/test_c_test_suite.py

@@ -9,21 +9,20 @@
 
 """
 
+import os
 import unittest
-import glob
-import os.path
+from pathlib import Path
 
 from ppci.api import fortrancompile, get_arch
 
 
-def create_test_function(cls, filename):
+def create_test_function(cls, filename: Path):
     """Create a test function for a single snippet"""
-    _, snippet_filename = os.path.split(filename)
-    test_function_name = "test_" + snippet_filename.replace(".", "_")
+    test_function_name = "test_" + filename.stem.replace(".", "_")
 
     def test_function(self):
         march = get_arch("arm")
-        with open(filename) as f:
+        with filename.open() as f:
             fortrancompile([f.read()], march)
         # TODO: check output for correct values:
 
@@ -35,8 +34,8 @@ def test_function(self):
 
 def populate(cls):
     if "FCVS_DIR" in os.environ:
-        directory = os.path.normpath(os.environ["FCVS_DIR"])
-        for filename in sorted(glob.iglob(os.path.join(directory, "*.FOR"))):
+        path = Path(os.environ["FCVS_DIR"]).resolve()
+        for filename in sorted(path.glob("*.FOR")):
             create_test_function(cls, filename)
     return cls
 

test/lang/fortran/test_fortran_test_suite.py

@@ -5,6 +5,7 @@
 from ppci.lang.python import load_py, python_to_ir
 from ppci.utils.reporting import html_reporter
 
+from ..helper_util import make_filename
 
 src1 = """
 def a(x: int, y: int) -> int:
@@ -71,7 +72,8 @@ def test_load_py(self):
         d = {}
         exec(src1, d)
         a = d["a"]
-        with html_reporter("p2p_report.html") as reporter:
+        html_filename = make_filename(self.id()).with_suffix(".html")
+        with html_reporter(html_filename) as reporter:
             m2 = load_py(io.StringIO(src1), reporter=reporter)
 
         for x in range(20):
@@ -88,7 +90,8 @@ def myprint(x: int) -> None:
         imports = {
             "myprint": myprint,
         }
-        with html_reporter("p2p_callback_report.html") as reporter:
+        html_filename = make_filename(self.id()).with_suffix(".html")
+        with html_reporter(html_filename) as reporter:
             m2 = load_py(io.StringIO(src2), imports=imports, reporter=reporter)
         # Segfaults:
         m2.a(2)