Merge pull request #751 from boriel-basic/refact/move_preproc_test_to_their_own_folder

refact: move zxbpp test to zxbpp/ subfolder

Author: boriel

.pre-commit-config.yaml

@@ -3,11 +3,11 @@ repos:
     rev: v4.6.0
     hooks:
       - id: check-yaml
-        exclude: \.bin$
+        exclude: \.(bin|out)$
       - id: end-of-file-fixer
-        exclude: \.bin$
+        exclude: \.(bin|out)$
       - id: trailing-whitespace
-        exclude: \.bin$
+        exclude: \.(bin|out)$
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.

src/zxbpp/zxbpp.py

@@ -974,6 +974,7 @@ def entry_point(args=None):
     if options.arch not in arch.AVAILABLE_ARCHITECTURES:
         parser.error(f"Invalid architecture '{options.arch}'")
         return 2
+
     config.OPTIONS.architecture = options.arch
 
     if options.stderr:
@@ -991,6 +992,7 @@ def entry_point(args=None):
                 output_file.write(OUTPUT)
         else:
             config.OPTIONS.stdout.write(OUTPUT)
+
     return result
 
 

tests/functional/Makefile

@@ -12,7 +12,7 @@ test_:
 	pytest . -k 'test_errmsg or test_cmdline'
 
 prepro:
-	./test.py *.bi
+	./test.py zxbpp/*.bi
 
 asm:
 	./test.py asm/*.asm

tests/functional/prepro21.bi

@@ -271,13 +271,16 @@ def updateTest(tfname: str, pattern_: str | None, strip_blanks: bool = True) ->
 
 @src.api.utils.timeout(_timeout)
 def testPREPRO(
-    fname: str, pattern_: str | None = None, inline: bool | None = None, cmdline_args: list[str] | None = None
+    preproc_file_path: str,
+    pattern_: str | None = None,
+    inline: bool | None = None,
+    cmdline_args: list[str] | None = None,
 ) -> bool | None:
     """Test preprocessing file. Test is done by preprocessing the file and then
     comparing the output against an expected one. The output file can optionally be filtered
     using a filter_ regexp (see above).
 
-    :param fname: Filename (usually a .bi file) to test.
+    :param preproc_file_path: Filename (usually a .bi file) to test.
     :param pattern_: regexp for filtering output before comparing. It will be ignored for binary (tzx, tap, etc) files
     :param inline: whether the test should be run inline or using the system shell
     :return: True on success false if not
@@ -290,21 +293,19 @@ def testPREPRO(
     if cmdline_args is None:
         cmdline_args = []
 
-    tfname = os.path.join(TEMP_DIR, "test" + getName(fname) + os.extsep + "out")
-    okfile = os.path.join(os.path.dirname(fname), getName(fname) + os.extsep + "out")
+    file_dir = os.path.dirname(preproc_file_path)
 
-    if UPDATE:
-        tfname = okfile
-        if os.path.exists(okfile):
-            os.unlink(okfile)
+    # For the zxbpp, we *must* test from the same folder, so we remove the folder from the path.
+    fname = f"{getName(preproc_file_path)}{os.extsep}{getExtension(preproc_file_path) or ''}"
+
+    tfname = os.path.join(TEMP_DIR, f"test{fname}{os.extsep}out")
+    okfile = os.path.join(f"{getName(preproc_file_path)}{os.extsep}out")
 
     prep = ["-e", "/dev/null"] if CLOSE_STDERR else ["-e", STDERR]
     if UPDATE:
         tfname = okfile
-        if os.path.exists(okfile):
-            os.unlink(okfile)
 
-    options = [os.path.basename(fname), "-o", tfname] + prep
+    options = [fname, "-o", tfname] + prep
     options.extend(cmdline_args)
 
     if inline:
@@ -317,7 +318,10 @@ def testPREPRO(
     current_path: str = os.getcwd()
 
     try:
-        os.chdir(os.path.dirname(fname) or os.curdir)
+        os.chdir(file_dir or os.curdir)
+        if UPDATE:
+            if os.path.exists(okfile):
+                os.unlink(okfile)
 
         with TempTestFile(func, tfname, keep_file=UPDATE):
             if not UPDATE:

tests/functional/prepro72.bi

@@ -18,13 +18,13 @@ dowhile1.bas:1: warning: Empty loop
 subcall1.bas:6: error: 'test' is a SUB not a FUNCTION
 >>> process_file('zx48k/subcall2.bas')
 subcall2.bas:6: error: 'test' is a SUB, not a FUNCTION
->>> process_file('prepro05.bi')
+>>> process_file('zxbpp/prepro05.bi')
 prepro05.bi:2: warning: [W510] "test" redefined (previous definition at prepro05.bi:2)
->>> process_file('prepro07.bi')
+>>> process_file('zxbpp/prepro07.bi')
 prepro07.bi:2: error: Duplicated name parameter "x"
->>> process_file('prepro28.bi')
+>>> process_file('zxbpp/prepro28.bi')
 prepro28.bi:3: error: invalid directive #defien
->>> process_file('builtin.bi')
+>>> process_file('zxbpp/builtin.bi')
 builtin.bi:5: warning: [W520] missing whitespace after macro name
 builtin.bi:16: warning: [W500] builtin macro "__FILE__" redefined
 builtin.bi:17: warning: [W500] builtin macro "__LINE__" redefined
@@ -176,9 +176,9 @@ due_par.bas:2: error: Syntax error. Unexpected end of line
 due_par.bas:4: error: Syntax error. Unexpected end of file
 >>> process_file('zx48k/error_array.bas')
 error_array.bas:3: error: Invalid assignment. Variable z$() is an array
->>> process_file('prepro76.bi')
+>>> process_file('zxbpp/prepro76.bi')
 prepro76.bi:2: error: this is an intended error
->>> process_file('line_asm.bi')
+>>> process_file('zxbpp/line_asm.bi')
 line_asm.bi:26: warning: this should be line 26
 >>> process_file('zx48k/line_err.bas')
 line_err.bas:5: error: Variable 'q' already declared at line_err.bas:1
@@ -224,7 +224,7 @@ do_err.bas:3: error: DO loop not closed
 # Test warning silencing
 >>> process_file('zx48k/mcleod3.bas', ['-S', '-q', '-O --expect-warnings=2'])
 mcleod3.bas:3: error: 'GenerateSpaces' is neither an array nor a function.
->>> process_file('prepro77.bi', ['-S', '-q', '-O --expect-warnings=1'])
+>>> process_file('zxbpp/prepro77.bi', ['-S', '-q', '-O --expect-warnings=1'])
 >>> process_file('zx48k/doloop2.bas', ['-S', '-q', '-O -W110'])
 doloop2.bas:4: warning: [W100] Using default implicit type 'ubyte' for 'a'
 doloop2.bas:4: warning: [W150] Variable 'a' is never used

tests/functional/test.py

@@ -7,7 +7,7 @@
 import pytest
 import test
 
-TEST_PATH = os.path.dirname(os.path.realpath(__file__))
+TEST_PATH = os.path.join(os.path.dirname(os.path.realpath(__file__)), "zxbpp")
 
 
 @pytest.mark.parametrize("fname", [os.path.join(TEST_PATH, f) for f in os.listdir(TEST_PATH) if f.endswith(".bi")])