Let's try test reporting

terrapower · Feb 5, 2025 · e3f8e60 · e3f8e60
1 parent 477b9ed
commit e3f8e60
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 2 deletions.
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -33,6 +33,7 @@ jobs:
       - name: Make HTML Docs
         run: |
           pip install -e .[memprof,mpi,test,docs]
+          pytest --junit-xml=test_results.xml -n 4 armi
           cd doc
           git submodule init
           git submodule update

diff --git a/.gitignore b/.gitignore
@@ -7,7 +7,6 @@
 # No build artifacts
 *.dll
 *.lib
-.apidocs/
 /bin
 armi/tests/tutorials/case-suite
 bin/*
@@ -17,6 +16,7 @@ coverage.xml
 coverage_results.*
 dist-*/
 dist/
+doc/.apidocs
 doc/_build
 doc/anl-afci-177
 doc/gallery
@@ -26,6 +26,7 @@ doc/tutorials/case-suite
 doc/user/tutorials
 htmlcov/
 monkeytype.*
+test_results.*
 wheelhouse
 
 # No workspace crumbs

diff --git a/doc/conf.py b/doc/conf.py
@@ -351,6 +351,7 @@ def setup(app):
     "sphinx.ext.viewcode",
     "sphinx_gallery.gen_gallery",
     "sphinx_needs",  # needed for requirements tracking
+    "sphinxcontrib.test_reports",
     "sphinx_rtd_theme",  # needed here for loading jquery in sphinx 6
     "sphinx_simplepdf",
     "sphinxcontrib.apidoc",
@@ -614,8 +615,8 @@ def setup(app):
     dict(option="implements", incoming="implementations", outgoing="requirements"),
 ]
 
+# TODO: JOHN Do I need or like these templates and layouts?
 needs_template_folder = os.path.join(STATIC_DIR, "needs_templates")
-
 needs_layouts = {
     "test_layout": {
         "grid": "simple",

diff --git a/doc/qa_docs/str.rst b/doc/qa_docs/str.rst
@@ -2,3 +2,7 @@ Software Test Report (STR)
 ==========================
 
 TBD
+
+.. test-results:: ../test_results.xml
+
+TODO
diff --git a/pyproject.toml b/pyproject.toml
@@ -108,7 +108,9 @@ docs = [
     "sphinxcontrib-apidoc==0.3.0", # More easily document our API
     "sphinxext-opengraph==0.8.2", # Generates OpenGraph metadata to make good-looking cards on social media
     "sphinx-needs==2.1.0", # Requirements traceability matrices for QA
+    "sphinx-test-reports",
     "sphinxcontrib-plantuml==0.25", # UML support in sphinx-needs
+    "unittest-xml-reporting",
     "pandoc", # Must be in the path (to convert file formats)
     "ipykernel==6.25.1", # iPython kernel to run Jupyter notebooks
     "pylint==2.17.5", # Generates UML diagrams
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,3 +2,7 @@ Software Test Report (STR) @@
     ==========================
     TBD
+    .. test-results:: ../test_results.xml
+    TODO