Skip to content

Commit

Permalink
Make survey optional in PipelinesConfig.
Browse files Browse the repository at this point in the history
No longer requiring a survey makes it possible to naturally add in other
optional constraints, such as position.
  • Loading branch information
kfindeisen committed Nov 25, 2024
1 parent e527b2c commit 46a0f27
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 5 deletions.
13 changes: 8 additions & 5 deletions python/activator/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,16 @@ class PipelinesConfig:
A sequence of mappings ("nodes"), each with the following keys:
``"survey"``
The survey that triggers the pipelines (`str`).
The survey that triggers the pipelines (`str`, optional).
``"pipelines"``
A list of zero or more pipelines (sequence [`str`] or `None`). Each
pipeline path may contain environment variables, and the list of
pipelines may be replaced by `None` to mean no pipeline should
be run.
Nodes are arranged by precedence, i.e., the first node that matches a
visit is used.
visit is used. A node containing only ``pipelines`` is unconstrained
and matches *any* visit.
Examples
--------
Expand Down Expand Up @@ -112,8 +113,8 @@ def __init__(self, config: collections.abc.Mapping[str, typing.Any]):
raise ValueError(f"Pipelines spec must be list or None, got {pipelines_value}")
self._check_pipelines(self._filenames)

survey_value = specs.pop('survey')
if isinstance(survey_value, str):
survey_value = specs.pop('survey', None)
if isinstance(survey_value, str) or survey_value is None:
self._survey = survey_value
else:
raise ValueError(f"{survey_value} is not a valid survey name.")
Expand Down Expand Up @@ -158,7 +159,9 @@ def matches(self, visit: FannedOutVisit) -> bool:
matches : `bool`
`True` if the visit meets all conditions, `False` otherwise.
"""
return self._survey == visit.survey
if self._survey is not None and self._survey != visit.survey:
return False
return True

@property
def pipeline_files(self) -> collections.abc.Sequence[str]:
Expand Down
28 changes: 28 additions & 0 deletions tests/test_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,12 @@ def test_duplicates(self):
PipelinesConfig([{"survey": "TestSurvey",
"pipelines": ["/etc/pipelines/ApPipe.yaml", "/etc/pipelines/ApPipe.yaml#isr"]}])

def test_needpipeline(self):
with self.assertRaises(ValueError):
PipelinesConfig([{"survey": "TestSurvey"}])
with self.assertRaises(ValueError):
PipelinesConfig([{}])

def test_order(self):
config = PipelinesConfig([{"survey": "TestSurvey",
"pipelines": ["/etc/pipelines/SingleFrame.yaml"],
Expand All @@ -165,3 +171,25 @@ def test_order(self):
config.get_pipeline_files(self.visit),
[os.path.normpath(os.path.join("/etc", "pipelines", "SingleFrame.yaml"))]
)

def test_unconstrained(self):
config = PipelinesConfig([{"survey": "TestSurvey",
"pipelines": ["/etc/pipelines/SingleFrame.yaml"],
},
{"pipelines": ["${AP_PIPE_DIR}/pipelines/Isr.yaml"]},
{"survey": "", "pipelines": ["Default.yaml"]},
])
self.assertEqual(
config.get_pipeline_files(self.visit),
[os.path.normpath(os.path.join("/etc", "pipelines", "SingleFrame.yaml"))]
)
self.assertEqual(
# Matches the second node, which has no constraints
config.get_pipeline_files(dataclasses.replace(self.visit, survey="CameraTest")),
[os.path.normpath(os.path.join(getPackageDir("ap_pipe"), "pipelines", "Isr.yaml"))]
)
self.assertEqual(
# Matches the second node, which has no constraints
config.get_pipeline_files(dataclasses.replace(self.visit, survey="")),
[os.path.normpath(os.path.join(getPackageDir("ap_pipe"), "pipelines", "Isr.yaml"))]
)

0 comments on commit 46a0f27

Please sign in to comment.