chore: add more tests for reporters and add handling of TemplateSyntaxError when loading a template in HTMLReporter

tromai · tromai · commit f6700b663258 · 2023-04-21T15:43:00.000+10:00
Signed-off-by: Trong Nhan Mai &lt;trong.nhan.mai@oracle.com&gt;
diff --git a/src/macaron/output_reporter/reporter.py b/src/macaron/output_reporter/reporter.py
@@ -174,6 +174,12 @@ def __init__(
             self.template = self.env.get_template(target_template)
         except TemplateNotFound:
             logger.error("Cannot find the template to load.")
+        except TemplateSyntaxError as error:
+            location = f"line {error.lineno}"
+            name = error.filename or error.name
+            if name:
+                location = f'File "{name}", {location}'
+            logger.info("jinja2.TemplateSyntaxError: \n\t%s\n\t%s", error.message, location)
 
     def _init_extensions(self) -> None:
         """Dynamically add Jinja2 extension filters and tests."""
diff --git a/tests/output_reporter/resources/runtime_err.html b/tests/output_reporter/resources/runtime_err.html
@@ -0,0 +1,7 @@
+{#
+    Copyright (c) 2023 - 2023, Oracle and/or its affiliates. All rights reserved.
+    Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+#}
+
+{# Trying to extract the undefined field will cause Jinja2 to raise a Runtime Exception. #}
+{{ data.undefined_key }}
diff --git a/tests/output_reporter/resources/syntax_err.html b/tests/output_reporter/resources/syntax_err.html
@@ -0,0 +1,8 @@
+{#
+    Copyright (c) 2023 - 2023, Oracle and/or its affiliates. All rights reserved.
+    Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+#}
+
+{# Missing a % #}
+{% if a }
+{% endif %}
diff --git a/tests/output_reporter/resources/template.html b/tests/output_reporter/resources/template.html
@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html lang='en'>
 
-<!-- Copyright (c) 2022 - 2022, Oracle and/or its affiliates. All rights reserved. -->
+<!-- Copyright (c) 2022 - 2023, Oracle and/or its affiliates. All rights reserved. -->
 <!-- Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/. -->
 
 <head>
diff --git a/tests/output_reporter/test_reporter.py b/tests/output_reporter/test_reporter.py
@@ -6,6 +6,7 @@
 """
 
 import os
+from pathlib import Path
 from typing import Any
 from unittest.mock import MagicMock, call, patch
 
@@ -20,8 +21,6 @@
 
 from ..st import JINJA_CONTEXT_DICT
 
-ROOT_PATH = os.path.dirname(os.path.abspath(__file__))
-
 
 class MockRecord(Record):
     """A mock class for the record."""
@@ -43,41 +42,52 @@ def get_dict(self) -> dict:
         return self.mock_data
 
 
-def test_no_html_template_found() -> None:
+@pytest.fixture(scope="module", name="custom_jinja_env")
+def fixture_custom_jinja_env() -> Environment:
+    """Return the custom Jinja2 environment for testing.
+
+    Returns
+    -------
+    Environment
+        The custom Jinja2 environment.
+    """
+    root_path = Path(__file__).parent.joinpath("resources")
+    return Environment(
+        loader=FileSystemLoader(root_path),
+        autoescape=select_autoescape(enabled_extensions=["html", "j2"]),
+        trim_blocks=True,
+        lstrip_blocks=True,
+    )
+
+
+def test_no_html_template_found(custom_jinja_env: Environment) -> None:
     """Test initializing a HTMLReporter instance with a non-existing template."""
-    no_template_reporter = HTMLReporter(target_template="not_exist_template.html")
+    no_template_reporter = HTMLReporter(env=custom_jinja_env, target_template="not_exist_template.html")
     assert not no_template_reporter.template
 
 
-@given(mock_data=JINJA_CONTEXT_DICT, num_dep=st.integers(min_value=0, max_value=3))
-def test_gen_json_reports(mock_data: Any, num_dep: int) -> None:
-    """Test if JSONReporter can print JSON files without errors."""
-    report = Report(MockRecord(mock_data))
-    for _ in range(num_dep):
-        report.root_record.dependencies.append(MockRecord(mock_data))
+def test_syntax_err_template(custom_jinja_env: Environment) -> None:
+    """Test generating the HTML report from a template with syntax errors."""
+    syntax_err = HTMLReporter(env=custom_jinja_env, target_template="syntax_err.html")
+    assert not syntax_err.template
 
-    reporter = JSONReporter()
 
+def test_runtime_err_template(custom_jinja_env: Environment) -> None:
+    """Test generating the HTML report from a template with runtime errors."""
+    report = Report(MockRecord({}))
+    runtime_err = HTMLReporter(env=custom_jinja_env, target_template="runtime_err.html")
     with patch("builtins.open") as mock_open:
-        reporter.generate("report_paths", report)
-        calls = [call(os.path.join("report_paths", "dependencies.json"), mode="w", encoding="utf-8")]
-        mock_open.assert_has_calls(calls)
+        runtime_err.generate("report_paths", report)
+        mock_open.assert_not_called()
 
 
 @given(mock_data=JINJA_CONTEXT_DICT, num_dep=st.integers(min_value=0, max_value=3))
-def test_gen_html_reports(mock_data: Any, num_dep: int) -> None:
+def test_gen_html_reports(custom_jinja_env: Environment, mock_data: Any, num_dep: int) -> None:
     """Test if HTMLReporter can print HTML files without errors."""
     report = Report(MockRecord(mock_data))
     for _ in range(num_dep):
         report.root_record.dependencies.append(MockRecord(mock_data))
 
-    custom_jinja_env = Environment(
-        loader=FileSystemLoader(ROOT_PATH),
-        autoescape=select_autoescape(enabled_extensions=["html", "j2"]),
-        trim_blocks=True,
-        lstrip_blocks=True,
-    )
-
     reporter = HTMLReporter(env=custom_jinja_env, target_template="template.html")
     with patch("builtins.open") as mock_open:
         reporter.generate("report_paths", report)
@@ -97,8 +107,10 @@ def test_gen_html_reports(mock_data: Any, num_dep: int) -> None:
         (SCMStatus.AVAILABLE, True, False),
     ],
 )
-def test_main_target_status(main_status: SCMStatus, has_deps: bool, gen_empty_main: bool) -> None:
-    """WIP"""
+def test_main_target_status(
+    custom_jinja_env: Environment, main_status: SCMStatus, has_deps: bool, gen_empty_main: bool
+) -> None:
+    """Test the different scenarios for the main target's analysis status."""
     main_record: Record = Record(
         record_id="record",
         description="sample_desc",
@@ -110,28 +122,21 @@ def test_main_target_status(main_status: SCMStatus, has_deps: bool, gen_empty_ma
         policies_passed=[],
     )
 
-    dep_record: Record = Record(
-        record_id="dep",
-        description="sample_desc",
-        pre_config=Configuration({}),
-        status=SCMStatus.AVAILABLE,
-        context=MagicMock(),
-        dependencies=[],
-        policies_failed=[],
-        policies_passed=[],
-    )
-
     report = Report(main_record)
 
     if has_deps:
-        report.add_dep_record(dep_record)
+        dep_record: Record = Record(
+            record_id="dep",
+            description="sample_desc",
+            pre_config=Configuration({}),
+            status=SCMStatus.AVAILABLE,
+            context=MagicMock(),
+            dependencies=[],
+            policies_failed=[],
+            policies_passed=[],
+        )
+        report.root_record.dependencies.append(dep_record)
 
-    custom_jinja_env = Environment(
-        loader=FileSystemLoader(ROOT_PATH),
-        autoescape=select_autoescape(enabled_extensions=["html", "j2"]),
-        trim_blocks=True,
-        lstrip_blocks=True,
-    )
     reporter = HTMLReporter(env=custom_jinja_env, target_template="template.html")
     empty_main_call = call(os.path.join("report_paths", "index.html"), mode="w", encoding="utf-8")
     with patch("builtins.open") as mock_open:
@@ -140,3 +145,18 @@ def test_main_target_status(main_status: SCMStatus, has_deps: bool, gen_empty_ma
             mock_open.assert_has_calls([empty_main_call])
         else:
             assert empty_main_call.args not in mock_open.call_args_list
+
+
+@given(mock_data=JINJA_CONTEXT_DICT, num_dep=st.integers(min_value=0, max_value=3))
+def test_gen_json_reports(mock_data: Any, num_dep: int) -> None:
+    """Test if JSONReporter can print JSON files without errors."""
+    report = Report(MockRecord(mock_data))
+    for _ in range(num_dep):
+        report.root_record.dependencies.append(MockRecord(mock_data))
+
+    reporter = JSONReporter()
+
+    with patch("builtins.open") as mock_open:
+        reporter.generate("report_paths", report)
+        calls = [call(os.path.join("report_paths", "dependencies.json"), mode="w", encoding="utf-8")]
+        mock_open.assert_has_calls(calls)
