Changing FIA-API vesuvio script to allow summing multiple runs (#596)

* Changing FIA-API vesuvio script to allow summing multiple runs

* Formatting and linting commit

* adding type ignore so that mypy doesn't get confused

* Formatting and linting commit

* test cases for vesuvio summing of runs

* add back in removed comments

* fix for runno_str input

---------

Co-authored-by: github-actions <github-actions@github.com>
Co-authored-by: Samuel Jones <samjones714@gmail.com>

Author: 3 people

fia_api/scripts/transforms/vesuvio_transform.py

@@ -27,14 +27,28 @@ def apply(self, script: PreScript, job: Job) -> None:  # type: ignore
         lines = script.value.splitlines()
         # MyPY does not believe ColumnElement[JSONB] is indexable, despite JSONB implementing the Indexable mixin
         # If you get here in the future, try removing the type ignore and see if it passes with newer mypy
+
+        runno = job.inputs["runno"]  # type: ignore
+        if isinstance(runno, list):
+            if len(runno) > 1:
+                # Convert list to range string if contiguous, otherwise comma-separated
+                if all(runno[i] == runno[i - 1] + 1 for i in range(1, len(runno))):
+                    runno_str = f"{runno[0]}-{runno[-1]}"
+                else:
+                    runno_str = ",".join(map(str, runno))
+            else:
+                runno_str = str(runno[0])
+        else:
+            runno_str = str(runno)
+
         for index, line in enumerate(lines):
             if self._replace_input(line, lines, index, "ip", f'"{job.inputs["ip_file"]}"'):
                 continue
             if self._replace_input(
                 line, lines, index, "diff_ip", f'"{job.inputs.get("diff_ip_file", job.inputs["ip_file"])}"'
             ):
                 continue
-            if self._replace_input(line, lines, index, "runno", f'"{job.inputs["runno"]}"'):
+            if self._replace_input(line, lines, index, "runno", f'"{runno_str}"'):  # type: ignore
                 continue
             if self._replace_input(line, lines, index, "empty_runs", f'"{job.inputs["empty_runs"]}"'):
                 continue

test/scripts/transforms/test_vesuvio_transforms.py

@@ -69,3 +69,42 @@ def test_vesuvio_transform_apply(script, reduction):
             assert line == 'diff_ip_file = "IP0001.par"'
         else:
             assert line == original_lines[index]
+
+
+def test_vesuvio_transform_multi_contiguous(script, reduction):
+    """
+    Test vesuvio transform with contiguous runs
+    """
+    transform = VesuvioTransform()
+    reduction.inputs["runno"] = [55956, 55957, 55958]
+    transform.apply(script, reduction)
+    updated_lines = script.value.splitlines()
+    for line in updated_lines:
+        if line.startswith("runno"):
+            assert line == 'runno = "55956-55958"'
+
+
+def test_vesuvio_transform_multi_non_contiguous(script, reduction):
+    """
+    Test vesuvio transform with non-contiguous runs
+    """
+    transform = VesuvioTransform()
+    reduction.inputs["runno"] = [55956, 55958, 55960]
+    transform.apply(script, reduction)
+    updated_lines = script.value.splitlines()
+    for line in updated_lines:
+        if line.startswith("runno"):
+            assert line == 'runno = "55956,55958,55960"'
+
+
+def test_vesuvio_transform_single_list(script, reduction):
+    """
+    Test vesuvio transform with a single run in a list
+    """
+    transform = VesuvioTransform()
+    reduction.inputs["runno"] = [55956]
+    transform.apply(script, reduction)
+    updated_lines = script.value.splitlines()
+    for line in updated_lines:
+        if line.startswith("runno"):
+            assert line == 'runno = "55956"'