Error on adding dimension with existing name (Open-EO/openeo-geopyspark-driver#205)

Author: soxofaan

CHANGELOG.md

@@ -13,7 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   `Connection.execute()` and `Connection.create_job()`
 - Add support for reverse math operators on DataCube in `apply` mode ([#323](https://github.com/Open-EO/openeo-python-client/issues/323))
 - Add `DataCube.print_json()` to simplify exporting process graphs in Jupyter or other interactive environments ([#324](https://github.com/Open-EO/openeo-python-client/issues/324))
-
+- Raise `DimensionAlreadyExistsException` when trying to `add_dimension()` a dimension with existing name ([Open-EO/openeo-geopyspark-driver#205](https://github.com/Open-EO/openeo-geopyspark-driver/issues/205))
 
 ### Changed
 

openeo/metadata.py

@@ -10,6 +10,10 @@ class MetadataException(Exception):
     pass
 
 
+class DimensionAlreadyExistsException(MetadataException):
+    pass
+
+
 class Dimension:
     """Base class for dimensions."""
 
@@ -412,6 +416,8 @@ def reduce_dimension(self, dimension_name: str) -> 'CollectionMetadata':
 
     def add_dimension(self, name: str, label: Union[str, float], type: str = None) -> 'CollectionMetadata':
         """Create new metadata object with added dimension"""
+        if any(d.name == name for d in self._dimensions):
+            raise DimensionAlreadyExistsException(f"Dimension with name {name!r} already exists")
         if type == "bands":
             dim = BandDimension(name=name, bands=[Band(label, None, None)])
         elif type == "spatial":

tests/rest/datacube/test_bandmath.py

@@ -342,13 +342,13 @@ def test_fuzzy_mask(connection, api_version):
     assert mask.flat_graph() == load_json_resource('data/%s/fuzzy_mask.json' % api_version)
 
 
-def test_fuzzy_mask_band_math(connection, api_version):
-    s2 = connection.load_collection("SENTINEL2_SCF")
+def test_fuzzy_mask_band_math(con100):
+    s2 = con100.load_collection("SENTINEL2_SCF")
     scf_band = s2.band("SCENECLASSIFICATION")
     clouds = scf_band == 4
     fuzzy = clouds.apply_kernel(kernel=0.1 * np.ones((3, 3)))
     mask = fuzzy.add_dimension("bands", "mask", "bands").band("mask") > 0.3
-    assert mask.flat_graph() == load_json_resource('data/%s/fuzzy_mask_add_dim.json' % api_version)
+    assert mask.flat_graph() == load_json_resource('data/1.0.0/fuzzy_mask_add_dim.json')
 
 
 def test_normalized_difference(connection, api_version):

tests/test_metadata.py

@@ -4,7 +4,7 @@
 import pytest
 
 from openeo.metadata import CollectionMetadata, Band, SpatialDimension, Dimension, TemporalDimension, BandDimension, \
-    MetadataException
+    MetadataException, DimensionAlreadyExistsException
 
 
 def test_metadata_get():
@@ -478,6 +478,17 @@ def test_metadata_add_band_dimension():
     assert new.band_names == ["red"]
 
 
+def test_metadata_add_band_dimension_duplicate():
+    metadata = CollectionMetadata({
+        "cube:dimensions": {
+            "t": {"type": "temporal"}
+        }
+    })
+    metadata = metadata.add_dimension("layer", "red", "bands")
+    with pytest.raises(DimensionAlreadyExistsException, match="Dimension with name 'layer' already exists"):
+        _ = metadata.add_dimension("layer", "red", "bands")
+
+
 def test_metadata_add_temporal_dimension():
     metadata = CollectionMetadata({
         "cube:dimensions": {
@@ -495,6 +506,17 @@ def test_metadata_add_temporal_dimension():
     assert new.temporal_dimension.extent == ["2020-05-15", "2020-05-15"]
 
 
+def test_metadata_add_temporal_dimension_duplicate():
+    metadata = CollectionMetadata({
+        "cube:dimensions": {
+            "x": {"type": "spatial"}
+        }
+    })
+    metadata = metadata.add_dimension("date", "2020-05-15", "temporal")
+    with pytest.raises(DimensionAlreadyExistsException, match="Dimension with name 'date' already exists"):
+        _ = metadata.add_dimension("date", "2020-05-15", "temporal")
+
+
 def test_metadata_drop_dimension():
     metadata = CollectionMetadata({
         "cube:dimensions": {