Support assert reporting from test helper module

edalize_common is a helper module that contains the asserts used
in most tests. pytest however normally only support asserts used
in the actual test module.

This patch adds an __init__.py for the tests that enables pytest
asserts in edalize_common, together with related changes.

tests/__init__.py

@@ -0,0 +1,3 @@
+import pytest
+
+pytest.register_assert_rewrite("tests.edalize_common")

tests/test_apicula.py

@@ -1,6 +1,6 @@
 import os
 import pytest
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 
 
 def run_apicula_test(tf):

tests/test_ascentlint.py

@@ -1,4 +1,4 @@
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 
 
 def test_ascentlint_defaults(make_edalize_test):

tests/test_diamond.py

@@ -1,4 +1,4 @@
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 
 
 def test_diamond(make_edalize_test):
@@ -26,9 +26,8 @@ def test_diamond_minimal(tmpdir):
 
     from edalize import get_edatool
 
-    from edalize_common import compare_files, tests_dir
+    from .edalize_common import compare_files, tests_dir
 
-    ref_dir = os.path.join(tests_dir, __name__, "minimal")
     os.environ["PATH"] = (
         os.path.join(tests_dir, "mock_commands") + ":" + os.environ["PATH"]
     )
@@ -44,6 +43,7 @@ def test_diamond_minimal(tmpdir):
     backend = get_edatool(tool)(edam=edam, work_root=work_root)
     backend.configure()
 
+    ref_dir = os.path.join(tests_dir, "test_" + tool, "minimal")
     compare_files(
         ref_dir,
         work_root,

tests/test_gatemate.py

@@ -1,6 +1,6 @@
 import os
 import pytest
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 
 
 def run_gatemate_test(tf):

tests/test_ghdl.py

@@ -1,5 +1,5 @@
 import os
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 
 
 def test_ghdl_01(make_edalize_test):

tests/test_icarus.py

@@ -1,4 +1,4 @@
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 
 
 def test_icarus(make_edalize_test):
@@ -28,9 +28,8 @@ def test_icarus_minimal(tmpdir):
 
     from edalize import get_edatool
 
-    from edalize_common import compare_files, tests_dir
+    from .edalize_common import compare_files, tests_dir
 
-    ref_dir = os.path.join(tests_dir, __name__, "minimal")
     os.environ["PATH"] = (
         os.path.join(tests_dir, "mock_commands") + ":" + os.environ["PATH"]
     )
@@ -43,6 +42,7 @@ def test_icarus_minimal(tmpdir):
     backend = get_edatool(tool)(edam=edam, work_root=work_root)
     backend.configure()
 
+    ref_dir = os.path.join(tests_dir, "test_" + tool, "minimal")
     compare_files(
         ref_dir,
         work_root,

tests/test_icestorm.py

@@ -1,6 +1,6 @@
 import os
 import pytest
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 
 
 def run_icestorm_test(tf, pnr_cmdfile="nextpnr-ice40.cmd"):

tests/test_ise.py

@@ -1,4 +1,4 @@
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 import pytest
 
 

tests/test_isim.py

@@ -1,4 +1,4 @@
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 
 
 def test_isim(make_edalize_test):

tests/test_libero.py

@@ -1,4 +1,4 @@
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 
 
 def test_libero(make_edalize_test):

tests/test_mistral.py

@@ -2,7 +2,7 @@
 import pytest
 
 
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 
 
 def run_mistral_test(tf):

tests/test_modelsim.py

@@ -1,6 +1,6 @@
 import filecmp
 import os
-from edalize_common import make_edalize_test, tests_dir
+from .edalize_common import make_edalize_test, tests_dir
 
 
 def test_modelsim(make_edalize_test):

tests/test_morty.py

@@ -1,4 +1,4 @@
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 import os
 
 

tests/test_openfpga.py

@@ -1,5 +1,5 @@
 import os
-from edalize_common import make_edalize_test, tests_dir
+from .edalize_common import make_edalize_test, tests_dir
 
 
 def test_openfpga(make_edalize_test):

tests/test_openlane.py

@@ -1,4 +1,4 @@
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 import os
 
 

tests/test_oxide.py

@@ -1,6 +1,6 @@
 import os
 import pytest
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 
 
 def run_oxide_test(tf):

tests/test_quartus.py

@@ -1,5 +1,5 @@
 import os
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 
 qsys_file = """<?xml version="1.0" encoding="UTF-8"?>
 <system name="test">

tests/test_radiant.py

@@ -1,4 +1,4 @@
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 
 
 def test_radiant(make_edalize_test):
@@ -26,9 +26,8 @@ def test_radiant_minimal(tmpdir):
 
     from edalize import get_edatool
 
-    from edalize_common import compare_files, tests_dir
+    from .edalize_common import compare_files, tests_dir
 
-    ref_dir = os.path.join(tests_dir, __name__, "minimal")
     os.environ["PATH"] = (
         os.path.join(tests_dir, "mock_commands") + ":" + os.environ["PATH"]
     )
@@ -44,6 +43,7 @@ def test_radiant_minimal(tmpdir):
     backend = get_edatool(tool)(edam=edam, work_root=work_root)
     backend.configure()
 
+    ref_dir = os.path.join(tests_dir, "test_" + tool, "minimal")
     compare_files(
         ref_dir,
         work_root,

tests/test_reporting.py

@@ -3,7 +3,7 @@
 import pytest
 import pandas as pd
 
-from edalize_common import tests_dir
+from .edalize_common import tests_dir
 
 
 def check_types(s, allowed=[int, float]):

tests/test_rivierapro.py

@@ -1,6 +1,6 @@
 import filecmp
 import os
-from edalize_common import make_edalize_test, tests_dir
+from .edalize_common import make_edalize_test, tests_dir
 
 
 def test_rivierapro(make_edalize_test):

tests/test_spyglass.py

@@ -1,4 +1,4 @@
-from edalize_common import make_edalize_test, tests_dir
+from .edalize_common import make_edalize_test, tests_dir
 
 
 def run_spyglass_test(tf):

tests/test_symbiflow.py

@@ -1,6 +1,6 @@
 import os
 import pytest
-from edalize_common import make_edalize_test, tests_dir
+from .edalize_common import make_edalize_test, tests_dir
 
 
 def run_symbiflow_test(tf, config_files=list()):

tests/test_symbiyosys.py

@@ -1,4 +1,4 @@
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 
 
 def test_symbiyosys(make_edalize_test):

tests/test_trellis.py

@@ -1,6 +1,6 @@
 import os
 import pytest
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 
 
 def run_trellis_test(tf, pnr_cmdfile="nextpnr-ice40.cmd"):

tests/test_vcs.py

@@ -1,4 +1,4 @@
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 
 
 def run_vcs_test(tf):
@@ -37,9 +37,8 @@ def test_vcs_minimal(tmpdir):
 
     from edalize import get_edatool
 
-    from edalize_common import compare_files, tests_dir
+    from .edalize_common import compare_files, tests_dir
 
-    ref_dir = os.path.join(tests_dir, __name__, "minimal")
     os.environ["PATH"] = (
         os.path.join(tests_dir, "mock_commands") + ":" + os.environ["PATH"]
     )
@@ -52,6 +51,7 @@ def test_vcs_minimal(tmpdir):
     backend = get_edatool(tool)(edam=edam, work_root=work_root)
     backend.configure()
 
+    ref_dir = os.path.join(tests_dir, "test_" + tool, "minimal")
     compare_files(ref_dir, work_root, ["Makefile", name + ".scr"])
 
     backend.build()

tests/test_veribleformat.py

@@ -1,4 +1,4 @@
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 
 
 def test_veribleformat_default(make_edalize_test):

tests/test_veriblelint.py

@@ -1,4 +1,4 @@
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 
 
 def test_veriblelint_default(make_edalize_test):

tests/test_verilator.py

@@ -1,4 +1,4 @@
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 
 
 def test_verilator_cc(make_edalize_test):

tests/test_vivado.py

@@ -1,5 +1,5 @@
 import pytest
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 
 
 def test_vivado(make_edalize_test):
@@ -28,11 +28,10 @@ def test_vivado_minimal(params, tmpdir, make_edalize_test):
     import os
 
     import edalize
-    from edalize_common import compare_files, tests_dir
+    from .edalize_common import compare_files, tests_dir
 
     test_name, synth_tool = params
 
-    ref_dir = os.path.join(tests_dir, __name__, test_name)
     os.environ["PATH"] = (
         os.path.join(tests_dir, "mock_commands") + ":" + os.environ["PATH"]
     )
@@ -63,6 +62,7 @@ def test_vivado_minimal(params, tmpdir, make_edalize_test):
     else:
         config_file_list.append(name + "_synth.tcl")
 
+    ref_dir = os.path.join(tests_dir, "test_" + tool, test_name)
     compare_files(ref_dir, work_root, config_file_list)
 
     build_file_list = ["vivado.cmd"]

tests/test_vpr.py

@@ -1,16 +1,15 @@
 import os
 import pytest
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 
 
 @pytest.mark.parametrize("params", [("minimal", "vpr")])
 def test_vpr(params, tmpdir):
     import os
     import edalize
-    from edalize_common import compare_files, tests_dir
+    from .edalize_common import compare_files, tests_dir
 
     test_name = "vpr"
-    ref_dir = os.path.join(tests_dir, __name__, test_name)
     os.environ["PATH"] = (
         os.path.join(tests_dir, "mock_commands") + ":" + os.environ["PATH"]
     )
@@ -33,4 +32,5 @@ def test_vpr(params, tmpdir):
     config_file_list = [
         "Makefile",
     ]
+    ref_dir = os.path.join(tests_dir, "test_" + tool, test_name)
     compare_files(ref_dir, work_root, config_file_list)

tests/test_vunit.py

@@ -1,7 +1,7 @@
 import pytest
 import os.path
 from unittest.mock import patch, MagicMock
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 import edalize.edatool
 
 
@@ -12,17 +12,17 @@ def test_vunit_codegen(make_edalize_test):
 
 
 def test_vunit_hooks(tmpdir):
-    from edalize_common import tests_dir
+    from .edalize_common import tests_dir
 
     import subprocess
     import sys
     import importlib.util
     from unittest import mock
     from edalize import get_edatool
 
-    sys.path = [os.path.join(tests_dir, __name__, "vunit_mock")] + sys.path
+    sys.path = [os.path.join(tests_dir, "test_vunit", "vunit_mock")] + sys.path
 
-    ref_dir = os.path.join(tests_dir, __name__, "minimal")
+    ref_dir = os.path.join(tests_dir, "test_vunit", "minimal")
     tool = "vunit"
     name = "test_" + tool + "_minimal_0"
     work_root = str(tmpdir)

tests/test_xcelium.py

@@ -1,5 +1,5 @@
 import os
-from edalize_common import make_edalize_test, tests_dir
+from .edalize_common import make_edalize_test, tests_dir
 
 
 def test_xcelium(make_edalize_test):

tests/test_xsim.py

@@ -1,4 +1,4 @@
-from edalize_common import make_edalize_test
+from .edalize_common import make_edalize_test
 import os