Update resultssummary to use new resultsstore

Author: loganharbour

pyproject.toml

@@ -5,15 +5,19 @@ include = '''
 (
   ^\/python\/moosecontrol\/.*.py$ |
   ^\/python\/TestHarness\/resultsstore\/.*.py$ |
-  ^\/python\/TestHarness/tests/resultsstore\/.*.py$
+  ^\/python\/TestHarness\/resultssummary\/.*.py$ |
+  ^\/python\/TestHarness/tests/resultsstore\/.*.py$ |
+  ^\/python\/TestHarness/tests/resultssummary\/.*.py$
 )
 '''
 
 [tool.ruff]
 include = [
   "python/moosecontrol/**/*.py",
   "python/TestHarness/resultsstore/**/*.py",
-  "python/TestHarness/tests/resultsstore/**/*.py"
+  "python/TestHarness/resultssummary/**/*.py",
+  "python/TestHarness/tests/resultsstore/**/*.py",
+  "python/TestHarness/tests/resultssummary/**/*.py"
 ]
 exclude = ["python/moosecontrol/requests_unixsocket/*.py"]
 

python/TestHarness/.coveragerc

@@ -3,6 +3,7 @@ concurrency = thread
 branch = True
 source =
     resultsstore/*
+    resultssummary/*
 omit =
     resultsstore/*/tests
 parallel = False

python/TestHarness/pytest.ini

@@ -2,10 +2,12 @@
 addopts =
     -vvv
     --cov=TestHarness.resultsstore
+    --cov=TestHarness.resultssummary
     --cov-config=.coveragerc
     --durations=20
 testpaths =
     tests/resultsstore
+    tests/resultssummary
 markers =
     moose: marks tests as requiring moose (use --no-moose to skip)
     live_db: marks tests as using a live database (use --no-live-db to skip)

python/TestHarness/resultsstore/reader.py

@@ -20,7 +20,10 @@
     Authentication,
     load_authentication,
 )
-from TestHarness.resultsstore.resultcollection import ResultCollection
+from TestHarness.resultsstore.resultcollection import (
+    ResultCollection,
+    ResultsCollection,
+)
 from TestHarness.resultsstore.storedresult import StoredResult
 
 NoneType = type(None)
@@ -337,7 +340,7 @@ def get_pipeline(batch_size):
                 self._found_final_push_event = True
                 return
 
-    def get_latest_push_results(self, num: int) -> ResultCollection:
+    def get_latest_push_results(self, num: int) -> ResultsCollection:
         """Get the latest results from push events, newest to oldest."""
         assert isinstance(num, int)
         assert num > 0
@@ -348,7 +351,7 @@ def get_latest_push_results(self, num: int) -> ResultCollection:
             if len(results) == num:
                 break
 
-        return ResultCollection(results, self.get_database)
+        return ResultsCollection(results, self.get_database)
 
     def get_cached_result(self, index: str, value) -> Optional[ResultCollection]:
         """Get a result given a filter and store it in the cache."""
@@ -357,7 +360,7 @@ def get_cached_result(self, index: str, value) -> Optional[ResultCollection]:
         # Value exists in the cache
         cached_value = cache.get(value)
         if cached_value is not None:
-            return ResultCollection([cached_value], self.get_database)
+            return ResultCollection(cached_value, self.get_database)
 
         # Search for the value
         docs = self._find_results({index: {"$eq": value}}, limit=1)
@@ -377,7 +380,7 @@ def get_cached_result(self, index: str, value) -> Optional[ResultCollection]:
         # Build it and return
         result = self._build_result(data)
         cache[value] = result
-        return ResultCollection([result], self.get_database)
+        return ResultCollection(result, self.get_database)
 
     def get_event_result(self, event_id: int) -> Optional[ResultCollection]:
         """Get the latest result for the given event, if any."""

python/TestHarness/resultsstore/resultcollection.py

@@ -10,7 +10,7 @@
 """Implements the ResultCollection, storage for multiple test results."""
 
 from collections import defaultdict
-from typing import Callable, Iterable, Tuple
+from typing import Callable, Iterable, Optional, Tuple
 
 from bson.objectid import ObjectId
 from pymongo import DESCENDING
@@ -22,11 +22,13 @@
 from TestHarness.resultsstore.utils import TestName, results_test_iterator
 
 
-class ResultCollection:
+class ResultsCollectionBase:
     """
-    Stores multiple test results and exposes methods to loading tests.
+    Base for a collection of results.
 
-    These objects wrap the results returned by the ResultsReader.
+    Enables having a collection that contains multiple
+    results and a collection that has a single result,
+    with the same underlying getters.
     """
 
     def __init__(
@@ -56,28 +58,22 @@ def __init__(
         # Method to call to get the database
         self._database_getter = database_getter
 
-    @property
-    def results(self) -> list[StoredResult]:
-        """Get the underlying results."""
-        return self._results
-
     @property
     def result_ids(self) -> list[ObjectId]:
         """Get the IDs of the results in the collection."""
-        return [r.id for r in self.results]
+        return [r.id for r in self._results]
 
     def get_database(self) -> Database:
         """Get the database."""
         return self._database_getter()
 
-    def get_all_tests(
+    def _get_all_tests(
         self, filters: Iterable[TestDataFilter]
     ) -> dict[TestName, list[StoredTestResult]]:
         """
         Get all test results.
 
-        This can be particularly expensive! Best to do it on a
-        per-test basis with get_tests() if possible.
+        Used in derived classes.
 
         Arguments:
         ---------
@@ -98,7 +94,7 @@ def get_all_tests(
 
         # Load the full documents; this is generally quicker
         # than trying to load just the data we need
-        result_it = iter(self.results)
+        result_it = iter(self._results)
         with self.get_database().results.find(
             {"_id": {"$in": self.result_ids}},
             {"tests": 1},
@@ -159,12 +155,14 @@ def get_all_tests(
 
         return tests
 
-    def get_tests(
+    def _get_tests(
         self, name: TestName, filters: Iterable[TestDataFilter]
     ) -> list[StoredTestResult]:
         """
         Get the results for the test with the given name.
 
+        Used in derived classes.
+
         Arguments:
         ---------
         name : TestName
@@ -224,7 +222,7 @@ def get_tests(
 
         # Build test results from documents
         tests = []
-        result_it = iter(self.results)
+        result_it = iter(self._results)
         with self.get_database().results.aggregate(pipeline) as cursor:
             for doc in cursor:
                 id = doc["_id"]
@@ -296,3 +294,133 @@ def get_test_names(self) -> set[TestName]:
                     )
 
         return names
+
+
+class ResultCollection(ResultsCollectionBase):
+    """Store a single test result and exposes methods to loading tests."""
+
+    def __init__(
+        self,
+        result: StoredResult,
+        database_getter: Callable[[], Database],
+    ):
+        """
+        Initialize state.
+
+        Arguments:
+        ---------
+        result : StoredResult
+            The result in the collection.
+        database_getter : Callable[[], Database]
+            Function to be called to get the database.
+
+        """
+        super().__init__([result], database_getter)
+
+    @property
+    def result(self) -> StoredResult:
+        """Get the underlying result."""
+        assert len(self._results) == 1
+        return self._results[0]
+
+    def get_all_tests(
+        self, filters: Iterable[TestDataFilter]
+    ) -> dict[TestName, StoredTestResult]:
+        """
+        Get all test results for the result in the collection.
+
+        This can be particularly expensive! Best to do it on a
+        per-test basis with get_test() if possible.
+
+        Arguments:
+        ---------
+        filters : Iterable[TestDataFilter]
+            The TestDataFilter objects that represent which data
+            to obtain for the tests.
+
+        """
+        # Convert a value of list[StoredTestResult] to a single result
+        return {k: v[0] for k, v in self._get_all_tests(filters).items()}
+
+    def get_test(
+        self, name: TestName, filters: Iterable[TestDataFilter]
+    ) -> Optional[StoredTestResult]:
+        """
+        Get the test result for the given test name, if any.
+
+        Arguments:
+        ---------
+        name : TestName
+            The name of the test.
+        filters : Iterable[TestDataFilter]
+            The TestDataFilter objects that represent which data
+            to obtain for the tests.
+
+        """
+        tests = self._get_tests(name, filters)
+        if tests:
+            assert len(tests) == 1
+            return tests[0]
+        return None
+
+
+class ResultsCollection(ResultsCollectionBase):
+    """Store multiple test results and exposes methods to loading tests."""
+
+    def __init__(
+        self,
+        results: list[StoredResult],
+        database_getter: Callable[[], Database],
+    ):
+        """
+        Initialize state.
+
+        Arguments:
+        ---------
+        results : list[StoredResult]
+            The results in the collection.
+        database_getter : Callable[[], Database]
+            Function to be called to get the database.
+
+        """
+        super().__init__(results, database_getter)
+
+    @property
+    def results(self) -> list[StoredResult]:
+        """Get the underlying results."""
+        return self._results
+
+    def get_all_tests(
+        self, filters: Iterable[TestDataFilter]
+    ) -> dict[TestName, list[StoredTestResult]]:
+        """
+        Get all test results across all results in the collection.
+
+        This can be particularly expensive! Best to do it on a
+        per-test basis with get_tests() if possible.
+
+        Arguments:
+        ---------
+        filters : Iterable[TestDataFilter]
+            The TestDataFilter objects that represent which data
+            to obtain for the tests.
+
+        """
+        return self._get_all_tests(filters)
+
+    def get_tests(
+        self, name: TestName, filters: Iterable[TestDataFilter]
+    ) -> list[StoredTestResult]:
+        """
+        Get the test results for a test across all results in the collection.
+
+        Arguments:
+        ---------
+        name : TestName
+            The name of the test.
+        filters : Iterable[TestDataFilter]
+            The TestDataFilter objects that represent which data
+            to obtain for the tests.
+
+        """
+        return self._get_tests(name, filters)

python/TestHarness/resultssummary/__init__.py

@@ -1,8 +1,10 @@
-#* This file is part of the MOOSE framework
-#* https://mooseframework.inl.gov
-#*
-#* All rights reserved, see COPYRIGHT for full restrictions
-#* https://github.com/idaholab/moose/blob/master/COPYRIGHT
-#*
-#* Licensed under LGPL 2.1, please see LICENSE for details
-#* https://www.gnu.org/licenses/lgpl-2.1.html
+# This file is part of the MOOSE framework
+# https://mooseframework.inl.gov
+#
+# All rights reserved, see COPYRIGHT for full restrictions
+# https://github.com/idaholab/moose/blob/master/COPYRIGHT
+#
+# Licensed under LGPL 2.1, please see LICENSE for details
+# https://www.gnu.org/licenses/lgpl-2.1.html
+
+"""Implement tools for building summaries from result."""