dkist-processing-test 1.18.4__tar.gz → 1.18.5rc1__tar.gz

{dkist-processing-test-1.18.4/dkist_processing_test.egg-info → dkist-processing-test-1.18.5rc1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dkist-processing-test
-Version: 1.18.4
+Version: 1.18.5rc1
 Summary: Example Instrument code that is used by the DKIST Science Data Processing pipelines to test processing infrastructure.
 Home-page: https://bitbucket.org/dkistdc/dkist-processing-test/src/main/
 Author: NSO / AURA

dkist-processing-test-1.18.5rc1/dkist_processing_test/models/constants.py

@@ -0,0 +1,18 @@
+from dkist_processing_common.models.constants import BudName
+from dkist_processing_common.models.constants import ConstantsBase
+
+
+class TestConstants(ConstantsBase):
+    """
+    Constants for the test instrument.
+
+    This class is only used on the `TestQualityL0Metrics` task to allow us to check for `num_modstates`.
+    """
+
+    @property
+    def num_modstates(self) -> int:
+        """Return the number of modstates."""
+        # Use .get with default because integration tests use VBI, which doesn't have a modstate key and thus the db
+        # entry won't be there.
+        # In other words, we get the actual db value in unit tests and 1 in integration tests
+        return self._db_dict.get(BudName.num_modstates, 1)

dkist-processing-test-1.18.5rc1/dkist_processing_test/tasks/quality.py

@@ -0,0 +1,30 @@
+"""Quality task definition."""
+from typing import Iterable
+from typing import Type
+
+from dkist_processing_common.models.constants import ConstantsBase
+from dkist_processing_common.tasks import AssembleQualityData
+from dkist_processing_common.tasks import QualityL0Metrics
+
+__all__ = ["TestQualityL0Metrics", "TestAssembleQualityData"]
+
+from dkist_processing_test.models.constants import TestConstants
+
+
+class TestQualityL0Metrics(QualityL0Metrics):
+    @property
+    def constants_model_class(self) -> Type[ConstantsBase]:
+        return TestConstants
+
+    @property
+    def modstate_list(self) -> Iterable[int] | None:
+        if self.constants.num_modstates > 1:
+            return range(1, self.constants.num_modstates + 1)
+
+        return None
+
+
+class TestAssembleQualityData(AssembleQualityData):
+    @property
+    def polcal_label_list(self) -> list[str] | None:
+        return ["Beam 1"]

{dkist-processing-test-1.18.4 → dkist-processing-test-1.18.5rc1}/dkist_processing_test/tests/test_tasks.py

@@ -7,6 +7,7 @@ from dataclasses import dataclass
 from dataclasses import is_dataclass
 from datetime import datetime
 from random import randint
+from typing import Type
 from uuid import uuid4
 
 import numpy as np
@@ -17,12 +18,16 @@ from dkist_header_validator import spec122_validator
 from dkist_processing_common._util.scratch import WorkflowFileSystem
 from dkist_processing_common.codecs.fits import fits_hdu_decoder
 from dkist_processing_common.codecs.fits import fits_hdulist_encoder
+from dkist_processing_common.models.constants import BudName
 from dkist_processing_common.models.constants import ConstantsBase
 from dkist_processing_common.models.tags import Tag
+from dkist_processing_common.models.task_name import TaskName
+from dkist_processing_common.tasks import QualityL0Metrics
 from dkist_processing_common.tests.conftest import FakeGQLClient
 from dkist_service_configuration.logging import logger
 
 from dkist_processing_test.models.parameters import TestParameters
+from dkist_processing_test.tasks import TestQualityL0Metrics
 from dkist_processing_test.tasks.exercise_numba import ExerciseNumba
 from dkist_processing_test.tasks.fail import FailTask
 from dkist_processing_test.tasks.fake_science import GenerateCalibratedData
@@ -360,6 +365,133 @@ def test_write_l1_task(write_l1_task, mocker):
         assert file.exists
 
 
+class BaseSpec214l0Dataset(Spec122Dataset):
+    def __init__(self, num_tasks: int, instrument: str = "vbi"):
+        super().__init__(
+            dataset_shape=(num_tasks, 4, 4),
+            array_shape=(1, 4, 4),
+            time_delta=1,
+            instrument=instrument,
+            file_schema="level0_spec214",
+        )
+
+    @property
+    def data(self):
+        return np.ones(shape=self.array_shape)
+
+
+@pytest.fixture()
+def test_l0_quality_metrics_task_class(quality_l0_task_types):
+    # Just to override `quality_task_types` to make testing more precise
+    class TestingL0QualityMetrics(TestQualityL0Metrics):
+        @property
+        def quality_task_types(self) -> list[str]:
+            return quality_l0_task_types
+
+    return TestingL0QualityMetrics
+
+
+@pytest.fixture(params=[pytest.param(1, id="no_modstates"), pytest.param(4, id="with_modstates")])
+def num_modstates(request):
+    return request.param
+
+
+@pytest.fixture()
+def quality_l0_task_types() -> list[str]:
+    # The tasks types we want to build l0 metrics for
+    return [TaskName.lamp_gain.value, TaskName.dark.value]
+
+
+@pytest.fixture()
+def dataset_task_types(quality_l0_task_types) -> list[str]:
+    # The task types that exist in the dataset. I.e., a larger set than we want to build metrics for.
+    return quality_l0_task_types + [TaskName.solar_gain.value, TaskName.observe.value]
+
+
+@pytest.fixture()
+def quality_l0_task(
+    test_l0_quality_metrics_task_class,
+    tmp_path,
+    num_modstates,
+    dataset_task_types,
+    link_constants_db,
+    recipe_run_id,
+):
+    link_constants_db(
+        recipe_run_id=recipe_run_id, constants_obj={BudName.num_modstates.value: num_modstates}
+    )
+    with test_l0_quality_metrics_task_class(
+        recipe_run_id=recipe_run_id, workflow_name="TestTasks", workflow_version="vX.Y"
+    ) as task:
+        task.scratch = WorkflowFileSystem(scratch_base_path=tmp_path, recipe_run_id=recipe_run_id)
+        ds = BaseSpec214l0Dataset(num_tasks=len(dataset_task_types) * num_modstates)
+        for modstate in range(1, num_modstates + 1):
+            for frame, task_type in zip(ds, dataset_task_types):
+                hdu = frame.hdu()
+                hdul = fits.HDUList([hdu])
+                task.write(
+                    data=hdul,
+                    tags=[Tag.input(), Tag.task(task_type), Tag.modstate(modstate)],
+                    encoder=fits_hdulist_encoder,
+                )
+
+        yield task
+        task._purge()
+
+
+def test_quality_l0_metrics(quality_l0_task, quality_l0_task_types, num_modstates):
+    """
+    Given: A sublcassed `QualityL0Metrics` task and some data frames
+    When: Running the task
+    Then: The correct metrics are produced
+    """
+    task = quality_l0_task
+    task()
+
+    task_metric_names = ["FRAME_RMS", "FRAME_AVERAGE"]
+
+    for modstate in range(1, num_modstates + 1):
+        for metric_name in task_metric_names:
+            for task_type in quality_l0_task_types:
+                tags = [Tag.quality(metric_name), Tag.quality_task(task_type)]
+                if num_modstates > 1:
+                    tags.append(Tag.modstate(modstate))
+                files = list(task.read(tags=tags))
+                assert files  # there are some
+                for file in files:
+                    with file.open() as f:
+                        data = json.load(f)
+                        assert isinstance(data, dict)
+                        assert data["x_values"]
+                        assert data["y_values"]
+                        assert all(isinstance(item, str) for item in data["x_values"])
+                        assert all(isinstance(item, float) for item in data["y_values"])
+                        assert len(data["x_values"]) == len(data["y_values"])
+
+    global_metric_names = ["DATASET_AVERAGE", "DATASET_RMS"]
+    for metric_name in global_metric_names:
+        files = list(task.read(tags=[Tag.quality(metric_name)]))
+        assert files
+        for file in files:
+            with file.open() as f:
+                data = json.load(f)
+                assert isinstance(data, dict)
+
+
+def test_quality_l0_metrics_task_integration_run(recipe_run_id):
+    """
+    Given: A base `TestQualityL0Metrics` task with no constants or data
+    When: Running the task
+    Then: No error is raised
+    """
+    # I.e., this tests that the fixturization needed to get good testing on the quality L0 task aren't hiding
+    # an inability to run in integration tests where the setup is much more minimal
+    task = TestQualityL0Metrics(
+        recipe_run_id=recipe_run_id, workflow_name="integration-style", workflow_version="vX.Y"
+    )
+    task()
+
+
 @pytest.fixture()
 def make_movie_frames_task(tmp_path, recipe_run_id):
     with MakeTestMovieFrames(

{dkist-processing-test-1.18.4 → dkist-processing-test-1.18.5rc1/dkist_processing_test.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dkist-processing-test
-Version: 1.18.4
+Version: 1.18.5rc1
 Summary: Example Instrument code that is used by the DKIST Science Data Processing pipelines to test processing infrastructure.
 Home-page: https://bitbucket.org/dkistdc/dkist-processing-test/src/main/
 Author: NSO / AURA

{dkist-processing-test-1.18.4 → dkist-processing-test-1.18.5rc1}/dkist_processing_test.egg-info/SOURCES.txt

@@ -12,6 +12,7 @@ dkist_processing_test.egg-info/dependency_links.txt
 dkist_processing_test.egg-info/requires.txt
 dkist_processing_test.egg-info/top_level.txt
 dkist_processing_test/models/__init__.py
+dkist_processing_test/models/constants.py
 dkist_processing_test/models/parameters.py
 dkist_processing_test/tasks/__init__.py
 dkist_processing_test/tasks/exercise_numba.py

{dkist-processing-test-1.18.4 → dkist-processing-test-1.18.5rc1}/dkist_processing_test.egg-info/requires.txt

@@ -1,4 +1,4 @@
-dkist-processing-common==8.2.2
+dkist-processing-common==9.0.0rc2
 dkist-header-validator==5.1.1
 dkist-service-configuration==2.2
 dkist-fits-specifications==4.6.0

{dkist-processing-test-1.18.4 → dkist-processing-test-1.18.5rc1}/setup.cfg

@@ -17,7 +17,7 @@ setup_requires = setuptools_scm
 packages = find:
 include_package_data = True
 install_requires = 
-	dkist-processing-common == 8.2.2
+	dkist-processing-common == 9.0.0rc2
 	dkist-header-validator == 5.1.1
 	dkist-service-configuration == 2.2
 	dkist-fits-specifications == 4.6.0

dkist-processing-test-1.18.4/dkist_processing_test/tasks/quality.py

@@ -1,18 +0,0 @@
-"""Quality task definition."""
-from dkist_processing_common.models.tags import Tag
-from dkist_processing_common.tasks import AssembleQualityData
-from dkist_processing_common.tasks import QualityL0Metrics
-
-__all__ = ["TestQualityL0Metrics", "TestAssembleQualityData"]
-
-
-class TestQualityL0Metrics(QualityL0Metrics):
-    def run(self) -> None:
-        paths = self.read(tags=[Tag.input()])
-        self.calculate_l0_metrics(paths=paths)
-
-
-class TestAssembleQualityData(AssembleQualityData):
-    @property
-    def polcal_label_list(self) -> list[str] | None:
-        return ["Beam 1"]