Add more tests, fix test config paths

Author: mkstratos

tests/conftest.py

@@ -0,0 +1,10 @@
+from livvkit import __main__
+import pytest
+from pathlib import Path
+
+
+@pytest.fixture(scope="session")
+def generate_livv_output():
+    outdir = "simple_extn_output"
+    __main__.main(["-V", "tests/simple_test.yml", "-o", outdir])
+    return Path(outdir, "index.json")

tests/extension_simple.py

@@ -0,0 +1,85 @@
+# Copyright (c) 2015-2025, UT-BATTELLE, LLC
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# 3. Neither the name of the copyright holder nor the names of its contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+"""
+This template provides an example of a minimal LIVVkit extension.
+"""
+
+from livvkit import elements as el
+# Don't remove summarize_result...this is used by livvkit.components.validation
+# to have the summaries appear on the main LIVVkit output page
+from lex.common import summarize_result as sum_common
+
+def run(name, config):
+    """
+    Runs the extension.
+
+    Args:
+        name: The name of the extension
+        config: A dictionary representation of the configuration file
+
+    Returns:
+       A LIVVkit page element containing the LIVVkit elements to display on a webpage
+    """
+    # TODO: Put your analysis here
+    element_list = [
+        el.Error("Unimplemented test", "This test contains no analysis code!"),
+        el.Table(
+            title="Sample Table",
+            data={"row1": [1, 2, 3], "row2": [4, 5, 6]},
+            transpose=True,
+        ),
+    ]
+
+    return el.Page(
+        name,
+        config["description"],
+        elements=element_list,
+    )
+
+
+def print_summary(summary):
+    """
+    Print out a summary generated by this module's summarize_result method
+    """
+    raise NotImplementedError
+
+
+def summarize_result(result):
+    """
+    Provides a snapshot of the extension's results to be provided on the
+    summary webpage and printed to STDOUT via the print_summary method
+    """
+    return sum_common(result)
+
+def populate_metadata():
+    """
+    Generates the metadata needed for the output summary page
+    """
+    raise NotImplementedError

tests/simple_test.yml

@@ -0,0 +1,4 @@
+---
+ExtensionTest:
+    module: tests/extension_simple.py
+    description: A minimal LIVVkit extensions test.

tests/test_convert.py

@@ -5,15 +5,15 @@
 
 
 def test_convert_to_yaml():
-    in_file = "json_to_convert.json"
-    out_file = "yml_to_convert.yml"
-    ref_file = "yml_reference.yml"
+    in_file = Path("tests", "json_to_convert.json")
+    out_file = Path("tests", "yml_to_convert.yml")
+    ref_file = Path("tests", "yml_reference.yml")
 
-    assert not Path(out_file).exists()
-    lconvert.json_to_yaml(Path(in_file))
-    assert Path(out_file).exists()
-    ref_yml = fcn.read_yaml(Path(ref_file))
-    test_yml = fcn.read_yaml(Path(out_file))
+    assert not out_file.exists()
+    lconvert.json_to_yaml(in_file)
+    assert out_file.exists()
+    ref_yml = fcn.read_yaml(ref_file)
+    test_yml = fcn.read_yaml(out_file)
     assert ref_yml == test_yml
     os.remove(out_file)
-    assert not Path(out_file).exists()
+    assert not out_file.exists()

tests/test_simple.py

@@ -0,0 +1,16 @@
+from livvkit import __main__
+from pathlib import Path
+import json
+
+
+def test_simple_extn(generate_livv_output):
+    with open(generate_livv_output, "r") as _fin:
+        test_data = json.loads(_fin.read())
+
+    assert "Page" in test_data, "LIVVkit Page not found in extn output"
+    test_fields = ['elements', 'title', 'description', '_ref_list', 'Data', '__module__', '_html_template', '_latex_template']
+    for _field in test_fields:
+        assert _field in test_data["Page"], f"{_field} not found in Page data"
+
+    assert len(test_data["Page"]["elements"][0]["Table"]["data"]) > 0, "NOT ENOUGH ELEMENTS FOR NAV TO BE GENERATED"
+    assert test_data["Page"]["elements"][0]["Table"]["title"] == "Validation", "TABLE TITLE INCORRECT"