Issue #270 to_scl_dilation_mask: raise error when input has multiple …

…bands

CHANGELOG.md

@@ -20,6 +20,10 @@ and start a new "In Progress" section above it.
 
 ## In progress
 
+# 0.94.2
+
+- `to_scl_dilation_mask`: raise error when input cube has more than one band ([#270](https://github.com/Open-EO/openeo-python-driver/issues/270))
+
 ## 0.94.1
 
 - Improve resilience by retrying EJR search requests ([Open-EO/openeo-geopyspark-driver#720](https://github.com/Open-EO/openeo-geopyspark-driver/issues/720)).

openeo_driver/ProcessGraphDeserializer.py

@@ -45,7 +45,7 @@
 )
 from openeo_driver.datastructs import SarBackscatterArgs, ResolutionMergeArgs
 from openeo_driver.delayed_vector import DelayedVector
-from openeo_driver.dry_run import DryRunDataTracer, SourceConstraint
+from openeo_driver.dry_run import DryRunDataTracer, SourceConstraint, DryRunDataCube
 from openeo_driver.errors import (
     ProcessParameterRequiredException,
     ProcessParameterInvalidException,
@@ -2005,6 +2005,14 @@ def mask_scl_dilation(args: Dict, env: EvalEnv):
 @process_registry_2xx.add_function(spec=read_spec("openeo-processes/experimental/to_scl_dilation_mask.json"))
 def to_scl_dilation_mask(args: ProcessArgs, env: EvalEnv):
     cube: DriverDataCube = args.get_required("data", expected_type=DriverDataCube)
+    if not isinstance(cube, DryRunDataCube) and len(cube.metadata.band_names) != 1:
+        # TODO: make sure `len(cube.metadata.band_names)` check also works in the DryRunDataTracer phase
+        raise ProcessParameterInvalidException(
+            parameter="data",
+            process="to_scl_dilation_mask",
+            reason=f"The source data cube should only contain a single (SCL) band, but got {cube.metadata.band_names}.",
+        )
+
     # Get default values for other args from spec
     spec = read_spec("openeo-processes/experimental/to_scl_dilation_mask.json")
     defaults = {param["name"]: param["default"] for param in spec["parameters"] if "default" in param}

openeo_driver/_version.py

@@ -1 +1 @@
-__version__ = "0.94.1a1"
+__version__ = "0.94.2a1"

openeo_driver/dry_run.py

@@ -508,7 +508,8 @@ def filter_spatial(self, geometries):
         cube = self.filter_bbox(**bbox, operation="_weak_spatial_extent")
         return cube._process(operation="filter_spatial", arguments={"geometries": geometries})
 
-    def filter_bands(self, bands) -> 'DryRunDataCube':
+    def filter_bands(self, bands) -> DryRunDataCube:
+        # TODO: Ideally, bands in metadata are filtered here, but this breaks too many tests at the moment
         return self._process("bands", bands)
 
     def filter_properties(self, properties) -> 'DryRunDataCube':

openeo_driver/dummy/dummy_backend.py

@@ -1,3 +1,4 @@
+from __future__ import annotations
 import json
 import numbers
 from datetime import datetime
@@ -193,6 +194,10 @@ def __init__(self, metadata: CollectionMetadata = None):
         for name in [n for n, m in DummyDataCube.__dict__.items() if getattr(m, '_mock_side_effect', False)]:
             setattr(self, name, Mock(side_effect=getattr(self, name)))
 
+    @mock_side_effect
+    def filter_bands(self, bands) -> DummyDataCube:
+        return DummyDataCube(self.metadata.filter_bands(bands))
+
     @mock_side_effect
     def reduce_dimension(
         self, reducer, *, dimension: str, context: Optional[dict] = None, env: EvalEnv

tests/test_views_execute.py

@@ -4235,3 +4235,26 @@ def test_to_scl_dilation_mask_defaults(api, arguments, expected):
     assert args == ()
     assert kwargs == expected
 
+
+def test_to_scl_dilation_mask_multiple_bands(api):
+    """
+    input raster cube with multiple bands should raise error
+    """
+    res = api.result(
+        {
+            "loadcollection1": {
+                "process_id": "load_collection",
+                "arguments": {"id": "SENTINEL2_L2A_SENTINELHUB", "bands": ["B02", "B03", "SCL"]},
+            },
+            "to_scl_dilation_mask": {
+                "process_id": "to_scl_dilation_mask",
+                "arguments": {"data": {"from_node": "loadcollection1"}},
+                "result": True,
+            },
+        }
+    )
+    res.assert_error(
+        400,
+        "ProcessParameterInvalid",
+        message="The source data cube should only contain a single (SCL) band, but got ['B02', 'B03', 'SCL']",
+    )