feat(parsing): warn when acceptance tests found without conformance tests script

Author: zanjonke

plain2code.py

@@ -158,6 +158,31 @@ def _check_connection(codeplainAPI: codeplain_api.CodeplainAPI):
         )
 
 
+def warn_if_acceptance_tests_without_conformance_script(plain_module, args) -> None:
+    """Warn when acceptance tests are specified but no conformance tests script is configured.
+
+    Acceptance tests are treated as conformance tests, so a conformance tests script is required
+    to actually run them. Without it, the acceptance tests cannot be executed.
+    """
+    if args.conformance_tests_script:
+        return
+
+    modules_with_acceptance_tests = [
+        module
+        for module in plain_module.all_required_modules + [plain_module]
+        if plain_spec.has_acceptance_tests(module.plain_source)
+    ]
+    if not modules_with_acceptance_tests:
+        return
+
+    module_names = ", ".join(module.module_name for module in modules_with_acceptance_tests)
+    console.warning(
+        f"Acceptance tests were found ({module_names}) but no conformance tests script is configured. "
+        "Acceptance tests are treated as conformance tests and require a conformance tests script "
+        "(--conformance-tests-script or 'conformance_tests_script' in config) to be executed."
+    )
+
+
 def render(args, run_state: RunState, event_bus: EventBus, default_log_level: str = "INFO"):  # noqa: C901
     template_dirs = file_utils.get_template_directories(args.filename, args.template_dir, DEFAULT_TEMPLATE_DIRS)
 
@@ -185,6 +210,8 @@ def render(args, run_state: RunState, event_bus: EventBus, default_log_level: st
         template_dirs,
     )
 
+    warn_if_acceptance_tests_without_conformance_script(plain_module, args)
+
     render_choice = None
     if render_range is None:
         plain_module_render_state = get_plain_module_render_state(plain_module)

plain_spec.py

@@ -25,6 +25,15 @@
 ALLOWED_IMPORT_SPECIFICATION_HEADINGS = [DEFINITIONS, NON_FUNCTIONAL_REQUIREMENTS, TEST_REQUIREMENTS]
 
 
+def has_acceptance_tests(plain_source_tree) -> bool:
+    """Return True if any functional requirement in the plain source defines acceptance tests."""
+    functional_requirements = plain_source_tree.get(FUNCTIONAL_REQUIREMENTS) or []
+    for functional_requirement in functional_requirements:
+        if functional_requirement.get(ACCEPTANCE_TESTS):
+            return True
+    return False
+
+
 def collect_specification_linked_resources(specification, specification_heading, linked_resources_list):
     linked_resources = []
     if "linked_resources" in specification:

tests/test_plain2code.py

@@ -0,0 +1,70 @@
+from argparse import Namespace
+from types import SimpleNamespace
+from unittest.mock import patch
+
+import plain2code
+import plain_spec
+
+
+def _make_module(module_name, has_acceptance_tests, required_modules=None):
+    """Build a minimal stand-in for a PlainModule.
+
+    The functional requirements only need an `acceptance_tests` key when the module
+    is expected to contain acceptance tests, because that is all
+    `plain_spec.has_acceptance_tests` inspects.
+    """
+    functional_requirement = {"markdown": f"- {module_name} functionality."}
+    if has_acceptance_tests:
+        functional_requirement[plain_spec.ACCEPTANCE_TESTS] = [{"markdown": "- Test it."}]
+
+    return SimpleNamespace(
+        module_name=module_name,
+        plain_source={plain_spec.FUNCTIONAL_REQUIREMENTS: [functional_requirement]},
+        all_required_modules=required_modules or [],
+    )
+
+
+def test_warns_when_acceptance_tests_present_and_no_conformance_script():
+    plain_module = _make_module("top", has_acceptance_tests=True)
+    args = Namespace(conformance_tests_script=None)
+
+    with patch("plain2code.console") as mock_console:
+        plain2code.warn_if_acceptance_tests_without_conformance_script(plain_module, args)
+
+    mock_console.warning.assert_called_once()
+    warning_message = mock_console.warning.call_args.args[0]
+    assert "top" in warning_message
+    assert "conformance tests script" in warning_message
+
+
+def test_no_warning_when_conformance_script_configured():
+    plain_module = _make_module("top", has_acceptance_tests=True)
+    args = Namespace(conformance_tests_script="run_conformance_tests.sh")
+
+    with patch("plain2code.console") as mock_console:
+        plain2code.warn_if_acceptance_tests_without_conformance_script(plain_module, args)
+
+    mock_console.warning.assert_not_called()
+
+
+def test_no_warning_when_no_acceptance_tests():
+    plain_module = _make_module("top", has_acceptance_tests=False)
+    args = Namespace(conformance_tests_script=None)
+
+    with patch("plain2code.console") as mock_console:
+        plain2code.warn_if_acceptance_tests_without_conformance_script(plain_module, args)
+
+    mock_console.warning.assert_not_called()
+
+
+def test_warns_when_acceptance_tests_only_in_required_module():
+    required_module = _make_module("dependency", has_acceptance_tests=True)
+    plain_module = _make_module("top", has_acceptance_tests=False, required_modules=[required_module])
+    args = Namespace(conformance_tests_script=None)
+
+    with patch("plain2code.console") as mock_console:
+        plain2code.warn_if_acceptance_tests_without_conformance_script(plain_module, args)
+
+    mock_console.warning.assert_called_once()
+    warning_message = mock_console.warning.call_args.args[0]
+    assert "dependency" in warning_message

tests/test_plainspec.py

@@ -9,6 +9,42 @@ def test_get_linked_resources_invalid_input():
         plain_spec.collect_linked_resources([], [], None, True)
 
 
+def test_has_acceptance_tests_true():
+    plain_source = {
+        plain_spec.FUNCTIONAL_REQUIREMENTS: [
+            {"markdown": "- First functionality."},
+            {
+                "markdown": "- Second functionality.",
+                plain_spec.ACCEPTANCE_TESTS: [{"markdown": "- Test the second functionality."}],
+            },
+        ]
+    }
+    assert plain_spec.has_acceptance_tests(plain_source) is True
+
+
+def test_has_acceptance_tests_false_when_no_acceptance_tests():
+    plain_source = {
+        plain_spec.FUNCTIONAL_REQUIREMENTS: [
+            {"markdown": "- First functionality."},
+            {"markdown": "- Second functionality."},
+        ]
+    }
+    assert plain_spec.has_acceptance_tests(plain_source) is False
+
+
+def test_has_acceptance_tests_false_when_empty_acceptance_tests():
+    plain_source = {
+        plain_spec.FUNCTIONAL_REQUIREMENTS: [
+            {"markdown": "- First functionality.", plain_spec.ACCEPTANCE_TESTS: []},
+        ]
+    }
+    assert plain_spec.has_acceptance_tests(plain_source) is False
+
+
+def test_has_acceptance_tests_false_when_no_functional_requirements():
+    assert plain_spec.has_acceptance_tests({}) is False
+
+
 def test_get_frids_simple(get_test_data_path):
     _, plain_source, _ = plain_file.plain_file_parser("simple.plain", [get_test_data_path("data/")])