add tests

Author: viseshrp

doc/source/serverless/templates.rst

@@ -412,7 +412,7 @@ Example using the ADR entrypoint:
     # Export the report as a directory with linked assets
     output_path = adr.export_report_as_html(
         output_directory=export_dir,
-        name="Wing Simulation Report", # kwarg to find the template
+        name="Wing Simulation Report",  # kwarg to find the template
         context={"key": "value"},
         item_filter="A|i_tags|cont|project=wing_sim;",
     )

tests/serverless/test_adr.py

@@ -1024,6 +1024,136 @@ def fake_render_pptx_fails(self, context, item_filter, request):
         adr_serverless.render_report_as_pptx(name="FailingPPTXReport")
 
 
+@pytest.mark.ado_test
+def test_export_report_as_html(adr_serverless, tmp_path, monkeypatch):
+    """
+    Tests the successful export of a report to a directory, ensuring all arguments
+    are correctly passed to the underlying exporter class.
+    """
+    from ansys.dynamicreporting.core.serverless import BasicLayout
+    from ansys.dynamicreporting.core.serverless.adr import ServerlessReportExporter
+
+    # 1. Arrange: Create a dummy template that the export method can find.
+    adr_serverless.create_template(BasicLayout, name="TestExportReport", parent=None)
+
+    # Define the context and filter to be used in the export call.
+    test_context = {"key": "value"}
+    test_filter = "A|i_tags|cont|project=wing_sim;"
+
+    # 2. Mock: Patch the ServerlessReportExporter's export method to intercept its call.
+    # This avoids the overhead of actual file operations and lets us verify the inputs.
+    def mock_export(self):
+        # Assert that the exporter was initialized with the correct, expected values.
+        assert self._output_dir == tmp_path
+        assert self._static_dir == adr_serverless.static_directory
+        assert "<h1>" in self._html_content  # A simple check for rendered HTML
+        assert self._single_file is False
+        # Verify that context and filter were passed through correctly during render
+        # Note: We can't directly check the context/filter on the exporter, but we
+        # can infer it was used because the render call would fail otherwise.
+
+    monkeypatch.setattr(ServerlessReportExporter, "export", mock_export)
+
+    # 3. Act: Call the method under test with a full set of arguments.
+    output_path = adr_serverless.export_report_as_html(
+        output_directory=tmp_path,
+        name="TestExportReport",  # kwarg to find the template
+        context=test_context,
+        item_filter=test_filter,
+    )
+
+    # 4. Assert: Verify the returned path is correctly constructed.
+    assert output_path == tmp_path / "index.html"
+
+
+@pytest.mark.ado_test
+def test_export_report_no_static_dir_fails(adr_serverless, tmp_path, monkeypatch):
+    """
+    Ensures that the export fails with a configuration error if the
+    static directory has not been set on the ADR instance.
+    """
+    # Temporarily remove the static_directory attribute to simulate the error condition.
+    monkeypatch.setattr(adr_serverless, "_static_directory", None)
+
+    with pytest.raises(
+        ImproperlyConfiguredError, match="The 'static_directory' must be configured"
+    ):
+        adr_serverless.export_report_as_html(
+            output_directory=tmp_path,
+            name="AnyReport",
+        )
+
+
+@pytest.mark.ado_test
+def test_export_report_no_kwarg_fails(adr_serverless, tmp_path):
+    """
+    Ensures that the export fails if no keyword argument (like 'name' or 'guid')
+    is provided to find the template.
+    """
+    with pytest.raises(ADRException, match="At least one keyword argument must be provided"):
+        adr_serverless.export_report_as_html(output_directory=tmp_path)
+
+
+@pytest.mark.ado_test
+def test_export_report_as_html_directory_mode(adr_serverless, tmp_path, monkeypatch):
+    """
+    Tests the successful export of a report to a directory.
+    """
+    from ansys.dynamicreporting.core.serverless import BasicLayout
+    from ansys.dynamicreporting.core.serverless.adr import ServerlessReportExporter
+
+    # Create a dummy template to be exported
+    adr_serverless.create_template(BasicLayout, name="TestExportReport", parent=None)
+
+    # Mock the ServerlessReportExporter's export method to prevent actual file operations
+    # during the test, making it faster and more isolated.
+    def mock_export(self):
+        # Verify that the exporter was initialized with the correct directories
+        assert self._output_dir == tmp_path
+        assert self._static_dir == adr_serverless.static_directory
+        assert "<h1>" in self._html_content  # Check if some HTML content was passed
+        assert self._single_file is False
+
+    monkeypatch.setattr(ServerlessReportExporter, "export", mock_export)
+
+    # Call the method under test
+    output_path = adr_serverless.export_report_as_html(
+        output_directory=tmp_path,
+        single_file=False,
+        name="TestExportReport",
+    )
+
+    # Verify the returned path is correct
+    assert output_path == tmp_path / "index.html"
+
+
+@pytest.mark.ado_test
+def test_export_report_as_html_single_file_mode(adr_serverless, tmp_path, monkeypatch):
+    """
+    Tests the successful export of a report in single-file mode.
+    """
+    from ansys.dynamicreporting.core.serverless import BasicLayout
+    from ansys.dynamicreporting.core.serverless.adr import ServerlessReportExporter
+
+    adr_serverless.create_template(BasicLayout, name="TestExportSingleFile", parent=None)
+
+    def mock_export(self):
+        # Verify the exporter is correctly configured for single-file mode
+        assert self._single_file is True
+        assert self._filename == "report.html"
+
+    monkeypatch.setattr(ServerlessReportExporter, "export", mock_export)
+
+    output_path = adr_serverless.export_report_as_html(
+        output_directory=tmp_path,
+        filename="report.html",
+        single_file=True,
+        name="TestExportSingleFile",
+    )
+
+    assert output_path == tmp_path / "report.html"
+
+
 @pytest.mark.ado_test
 def test_copy_sessions(adr_serverless):
     from ansys.dynamicreporting.core.serverless import Session

tests/serverless/test_common_utils.py

@@ -1,6 +1,7 @@
 from pathlib import Path
 
 import pytest
+
 from ansys.dynamicreporting.core import DEFAULT_ANSYS_VERSION
 from ansys.dynamicreporting.core.common_utils import get_install_info, get_install_version
 from ansys.dynamicreporting.core.exceptions import InvalidAnsysPath