Add fixture load_kllvm (#4843)

Direct imports of `pyk.kllvm.load` are removed by relying on the fixture
where needed. This eliminates the 5-10s startup delay in the integration
test harness, as the `kllvm` Python module is now generated during test
execution rather than at test collection.

Author: tothtamas28

pyk/src/pyk/testing/_kompiler.py

@@ -352,7 +352,7 @@ class RuntimeTest(KompiledTest):
     KOMPILE_BACKEND = 'llvm'
 
     @pytest.fixture(scope='class')
-    def runtime(self, definition_dir: Path) -> Runtime:
+    def runtime(self, load_kllvm: None, definition_dir: Path) -> Runtime:
         compile_runtime(definition_dir)
         return import_runtime(definition_dir)
 

pyk/src/pyk/testing/plugin.py

@@ -60,3 +60,28 @@ def profile(tmp_path: Path) -> Profiler:
 @pytest.fixture(scope='session')
 def kompile(tmp_path_factory: TempPathFactory) -> Kompiler:
     return Kompiler(tmp_path_factory)
+
+
+@pytest.fixture(scope='session')
+def load_kllvm(tmp_path_factory: TempPathFactory) -> None:
+    """Generate and import the ``_kllvm`` bindings module.
+
+    Use this fixture in all tests that import from ``pyk.kllvm``.
+    It ensures transitive imports of ``_kllvm`` are successful.
+
+    Example:
+        .. code-block:: python
+
+            def test_symbol_name(load_kllvm: None) -> None:
+                from pyk.kllvm.ast import Symbol
+
+                name = "Lbl'UndsPlus'Int'Unds'"
+                symbol = Symbol(name)
+                assert symbol.name == name
+    """
+    from ..kllvm.compiler import compile_kllvm
+    from ..kllvm.importer import import_kllvm
+
+    tmp_dir = tmp_path_factory.mktemp('kllvm')
+    module_file = compile_kllvm(tmp_dir)
+    import_kllvm(module_file)

pyk/src/tests/integration/kllvm/test_convert.py

@@ -4,8 +4,6 @@
 
 import pytest
 
-import pyk.kllvm.load  # noqa: F401
-from pyk.kllvm.convert import definition_to_llvm, llvm_to_definition, llvm_to_pattern, pattern_to_llvm
 from pyk.kore.parser import KoreParser
 
 if TYPE_CHECKING:
@@ -66,7 +64,9 @@ def _in_module(kore_text: str) -> str:
 
 
 @pytest.mark.parametrize('test_id,kore_text', PAT_TEST_DATA, ids=[test_id for test_id, *_ in PAT_TEST_DATA])
-def test_pattern_to_llvm(test_id: str, kore_text: str) -> None:
+def test_pattern_to_llvm(load_kllvm: None, test_id: str, kore_text: str) -> None:
+    from pyk.kllvm.convert import llvm_to_pattern, pattern_to_llvm
+
     # Given
     expected = KoreParser(kore_text).pattern()
 
@@ -85,7 +85,9 @@ def test_pattern_to_llvm(test_id: str, kore_text: str) -> None:
 
 
 @pytest.mark.parametrize('test_id,kore_text', DEF_TEST_DATA, ids=[test_id for test_id, *_ in DEF_TEST_DATA])
-def test_definition_to_llvm(test_id: str, kore_text: str) -> None:
+def test_definition_to_llvm(load_kllvm: None, test_id: str, kore_text: str) -> None:
+    from pyk.kllvm.convert import definition_to_llvm, llvm_to_definition
+
     # Given
     expected = KoreParser(kore_text).definition()
 

pyk/src/tests/integration/kllvm/test_desugar_associative.py

@@ -5,8 +5,6 @@
 
 import pytest
 
-import pyk.kllvm.load  # noqa: F401
-from pyk.kllvm.convert import pattern_to_llvm
 from pyk.kore.parser import KoreParser
 
 if TYPE_CHECKING:
@@ -37,7 +35,9 @@
 
 
 @pytest.mark.parametrize('kore_text,expected_text', TEST_DATA, ids=count())
-def test_desugar_associative(kore_text: str, expected_text: str) -> None:
+def test_desugar_associative(load_kllvm: None, kore_text: str, expected_text: str) -> None:
+    from pyk.kllvm.convert import pattern_to_llvm
+
     # Given
     kore = pattern_to_llvm(KoreParser(kore_text).pattern())
     expected = pattern_to_llvm(KoreParser(expected_text).pattern())

pyk/src/tests/integration/kllvm/test_evaluate.py

@@ -4,8 +4,6 @@
 
 import pytest
 
-import pyk.kllvm.load  # noqa: F401
-from pyk.kllvm import parser
 from pyk.testing import RuntimeTest
 
 from ..utils import K_FILES
@@ -39,6 +37,8 @@ class TestEvaluate(RuntimeTest):
         ids=[test_id for test_id, *_ in EVALUATE_TEST_DATA],
     )
     def test_simplify(self, runtime: Runtime, test_id: str, pattern_text: str, expected: str) -> None:
+        from pyk.kllvm import parser
+
         # Given
         pattern = parser.parse_pattern(pattern_text)
 

pyk/src/tests/integration/kllvm/test_internal_term.py

@@ -4,8 +4,6 @@
 
 import pytest
 
-import pyk.kllvm.load  # noqa: F401
-from pyk.kllvm.parser import Parser
 from pyk.testing import RuntimeTest
 
 from ..utils import K_FILES
@@ -21,15 +19,18 @@
 class TestInternalTerm(RuntimeTest):
     KOMPILE_MAIN_FILE = K_FILES / 'imp.k'
 
-    def test_str_llvm_backend_issue_724(self, runtime: Runtime) -> None:
+    def test_str_llvm_backend_issue_724(self, runtime: Runtime, start_pattern: Pattern) -> None:
         for _ in range(10000):
-            term = runtime._module.InternalTerm(start_pattern())
+            term = runtime._module.InternalTerm(start_pattern)
             term.step(-1)
             # just checking that str doesn't crash
             str(term)
 
 
-def start_pattern() -> Pattern:
+@pytest.fixture
+def start_pattern(load_kllvm: None) -> Pattern:
+    from pyk.kllvm.parser import Parser
+
     """
     <k> int x ; x = 1 </k>
     """

pyk/src/tests/integration/kllvm/test_load.py

@@ -2,15 +2,14 @@
 
 from typing import TYPE_CHECKING
 
-import pyk.kllvm.load  # noqa: F401
-import pyk.kllvm.load_static  # noqa: F401
-from pyk.kllvm.compiler import compile_kllvm
-
 if TYPE_CHECKING:
     from typing import Final
 
 
 def test_kllvm_module() -> None:
+    import pyk.kllvm.load  # noqa: F401
+    import pyk.kllvm.load_static  # noqa: F401
+    from pyk.kllvm.compiler import compile_kllvm
 
     # Given
     kllvm_module_dir: Final = pyk.kllvm.load.KLLVM_MODULE_DIR

pyk/src/tests/integration/kllvm/test_parser.py

@@ -2,14 +2,13 @@
 
 from typing import TYPE_CHECKING
 
-import pyk.kllvm.load  # noqa: F401
-from pyk.kllvm import parser
-
 if TYPE_CHECKING:
     from pathlib import Path
 
 
-def test_parse_pattern_file(tmp_path: Path) -> None:
+def test_parse_pattern_file(load_kllvm: None, tmp_path: Path) -> None:
+    from pyk.kllvm import parser
+
     # Given
     kore_text = 'A{}(B{}(),C{}())'
     kore_file = tmp_path / 'test.kore'
@@ -22,7 +21,9 @@ def test_parse_pattern_file(tmp_path: Path) -> None:
     assert str(actual) == kore_text
 
 
-def test_parse_pattern() -> None:
+def test_parse_pattern(load_kllvm: None) -> None:
+    from pyk.kllvm import parser
+
     # Given
     kore_text = 'A{}(X : S,Y : Z,Int{}())'
 
@@ -33,7 +34,9 @@ def test_parse_pattern() -> None:
     assert str(actual) == kore_text
 
 
-def test_parse_sort_file(tmp_path: Path) -> None:
+def test_parse_sort_file(load_kllvm: None, tmp_path: Path) -> None:
+    from pyk.kllvm import parser
+
     # Given
     kore_text = 'Foo{Bar,Baz}'
     kore_file = tmp_path / 'test.kore'
@@ -46,7 +49,9 @@ def test_parse_sort_file(tmp_path: Path) -> None:
     assert str(actual) == kore_text
 
 
-def test_parse_sort() -> None:
+def test_parse_sort(load_kllvm: None) -> None:
+    from pyk.kllvm import parser
+
     # Given
     kore_text = 'Foo{Bar,Baz}'
 
@@ -57,9 +62,10 @@ def test_parse_sort() -> None:
     assert str(actual) == kore_text
 
 
-def test_parse_definition_file(tmp_path: Path) -> None:
-    # Given
+def test_parse_definition_file(load_kllvm: None, tmp_path: Path) -> None:
+    from pyk.kllvm import parser
 
+    # Given
     # fmt: off
     kore_text = (
         '[]\n'
@@ -81,10 +87,10 @@ def test_parse_definition_file(tmp_path: Path) -> None:
     assert str(actual) == kore_text
 
 
-def test_parse_definition() -> None:
-    # Given
+def test_parse_definition(load_kllvm: None) -> None:
+    from pyk.kllvm import parser
 
-    # fmt: off
+    # Given
     kore_text = (
         '[]\n'
         '\n'
@@ -93,7 +99,6 @@ def test_parse_definition() -> None:
         'endmodule\n'
         '[concrete{}()]\n'
     )
-    # fmt: on
 
     # When
     actual = parser.parse_definition(kore_text)

pyk/src/tests/integration/kllvm/test_patterns.py

@@ -4,9 +4,6 @@
 
 import pytest
 
-import pyk.kllvm.load  # noqa: F401
-from pyk.kllvm.ast import CompositePattern, CompositeSort, Pattern, StringPattern, VariablePattern
-
 if TYPE_CHECKING:
     from pathlib import Path
 
@@ -19,7 +16,9 @@
         'XYZ : ABC',
     ),
 )
-def test_file_load(tmp_path: Path, kore_text: str) -> None:
+def test_file_load(load_kllvm: None, tmp_path: Path, kore_text: str) -> None:
+    from pyk.kllvm.ast import Pattern
+
     # Given
     kore_file = tmp_path / 'test.kore'
     kore_file.write_text(kore_text)
@@ -31,7 +30,9 @@ def test_file_load(tmp_path: Path, kore_text: str) -> None:
     assert str(actual) == kore_text
 
 
-def test_composite() -> None:
+def test_composite(load_kllvm: None) -> None:
+    from pyk.kllvm.ast import CompositePattern, CompositeSort, VariablePattern
+
     # Given
     pattern = CompositePattern('F')
     pattern.add_argument(CompositePattern('A'))
@@ -44,7 +45,9 @@ def test_composite() -> None:
     assert str(actual) == 'F{}(A{}(),B{}())'
 
 
-def test_string() -> None:
+def test_string(load_kllvm: None) -> None:
+    from pyk.kllvm.ast import StringPattern
+
     # Given
     pattern = StringPattern('abc')
 
@@ -53,7 +56,9 @@ def test_string() -> None:
     assert pattern.contents.decode('latin-1') == 'abc'
 
 
-def test_variable() -> None:
+def test_variable(load_kllvm: None) -> None:
+    from pyk.kllvm.ast import CompositePattern, CompositeSort, VariablePattern
+
     # Given
     pattern = VariablePattern('X', CompositeSort('S'))
 

pyk/src/tests/integration/kllvm/test_serialize.py

@@ -4,10 +4,6 @@
 
 import pytest
 
-import pyk.kllvm.load  # noqa: F401
-from pyk.kllvm import parser
-from pyk.kllvm.ast import Pattern
-from pyk.kllvm.convert import pattern_to_llvm
 from pyk.kore.parser import KoreParser
 from pyk.testing import RuntimeTest
 
@@ -31,7 +27,10 @@
 
 
 @pytest.mark.parametrize('kore_text', TEST_DATA)
-def test_serialize(kore_text: str) -> None:
+def test_serialize(load_kllvm: None, kore_text: str) -> None:
+    from pyk.kllvm.ast import Pattern
+    from pyk.kllvm.convert import pattern_to_llvm
+
     # Given
     _pattern = KoreParser(kore_text).pattern()
     pattern = pattern_to_llvm(_pattern)
@@ -49,6 +48,9 @@ class TestSerializeRaw(RuntimeTest):
     KOMPILE_MAIN_FILE = K_FILES / 'imp.k'
 
     def test_serialize_raw(self, runtime: Runtime, tmp_path: Path) -> None:
+        from pyk.kllvm import parser
+        from pyk.kllvm.ast import Pattern
+
         # Given
         kore_text = r"""Lbl'UndsPlus'Int'Unds'{}(\dv{SortInt{}}("1"),\dv{SortInt{}}("2"))"""
         pattern = parser.parse_pattern(kore_text)