Add validate() to SaveResult, VectorCube, MlModel and StacResource

ref: #766

Author: soxofaan

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Support `collection_property` based property filtering in `load_stac` ([#246](https://github.com/Open-EO/openeo-python-client/issues/246))
+- Add `validate()` method to `SaveResult`, `VectorCube`, `MlModel` and `StacResource` classes ([#766](https://github.com/Open-EO/openeo-python-client/issues/766))
 
 ### Changed
 

openeo/rest/_datacube.py

@@ -19,6 +19,7 @@
 )
 from openeo.internal.warnings import UserDeprecationWarning
 from openeo.rest import OpenEoClientException
+from openeo.rest.models.general import ValidationResponse
 from openeo.util import dict_no_none, str_truncate
 
 if typing.TYPE_CHECKING:
@@ -104,6 +105,16 @@ def _build_pgnode(
 
     # TODO #278 also move process graph "execution" methods here: `download`, `execute`, `execute_batch`, `create_job`, `save_udf`,  ...
 
+    def validate(self) -> ValidationResponse:
+        """
+        Validate a process graph without executing it.
+
+        :return: container of validation of errors (dictionaries with "code" and "message" fields)
+
+        .. versionadded:: 0.41.0
+        """
+        return self._connection.validate_process_graph(self)
+
     def _repr_html_(self):
         process = {"process_graph": self.flat_graph()}
         parameters = {

openeo/rest/connection.py

@@ -994,7 +994,11 @@ def validate_process_graph(
             a local file path or URL to a JSON representation,
             a :py:class:`~openeo.rest.multiresult.MultiResult` object, ...
 
-        :return: list of errors (dictionaries with "code" and "message" fields)
+        :return: container of validation errors (dictionaries with "code" and "message" fields)
+
+        .. versionchanged:: 0.38.0
+            returns a :py:class:`~openeo.rest.models.general.ValidationResponse` object
+            instead of a simple list of error dictionaries.
         """
         pg_with_metadata = self._build_request_with_process_graph(process_graph)["process"]
         data = self.post(path="/validation", json=pg_with_metadata, expected_status=200).json()

openeo/rest/datacube.py

@@ -74,6 +74,7 @@
 from openeo.rest.graph_building import CollectionProperty
 from openeo.rest.job import BatchJob, RESTJob
 from openeo.rest.mlmodel import MlModel
+from openeo.rest.models.general import ValidationResponse
 from openeo.rest.result import SaveResult
 from openeo.rest.service import Service
 from openeo.rest.udp import RESTUserDefinedProcess
@@ -2499,13 +2500,20 @@ def download(
             on_response_headers=on_response_headers,
         )
 
-    def validate(self) -> List[dict]:
+    def validate(self) -> ValidationResponse:
         """
         Validate a process graph without executing it.
 
-        :return: list of errors (dictionaries with "code" and "message" fields)
+        :return: container of validation of errors (dictionaries with "code" and "message" fields)
+
+        .. versionchanged:: 0.38.0
+            returns a :py:class:`~openeo.rest.models.general.ValidationResponse` object
+            instead of a simple list of error dictionaries.
         """
-        return self._connection.validate_process_graph(self.flat_graph())
+        # TODO this method implementation does not really override something
+        #       it is just kept to override the doc.
+        #       At some point this should be removed for simplicity.
+        return super().validate()
 
     def tiled_viewing_service(self, type: str, **kwargs) -> Service:
         return self._connection.create_service(self.flat_graph(), type=type, **kwargs)

tests/internal/test_documentation.py

@@ -61,13 +61,16 @@ def test_extract_main_description():
         (DataCube.create_job, VectorCube.create_job),
         (DataCube.execute_batch, VectorCube.execute_batch),
         (DataCube.save_result, VectorCube.save_result),
+        (DataCube.validate, VectorCube.validate),
         # DataCube vs MlModel
         (DataCube.create_job, MlModel.create_job),
         (DataCube.execute_batch, MlModel.execute_batch),
+        (DataCube.validate, MlModel.validate),
         # DataCube vs StacResource
         (DataCube.download, StacResource.download),
         (DataCube.create_job, StacResource.create_job),
         (DataCube.execute_batch, StacResource.execute_batch),
+        (DataCube.validate, StacResource.validate),
     ],
 )
 def test_cube_processing_params_and_return(method_a, method_b):

tests/rest/datacube/test_datacube.py

@@ -26,6 +26,7 @@
 from openeo.rest._testing import build_capabilities
 from openeo.rest.connection import Connection
 from openeo.rest.datacube import DataCube
+from openeo.rest.models.general import ValidationResponse
 from openeo.testing.stac import StacDummyBuilder
 from openeo.util import dict_no_none
 
@@ -1595,3 +1596,21 @@ def test_execute_batch_with_title(s2cube, dummy_backend):
             "description": "Lorem ipsum dolor S2 amet",
         }
     }
+
+
+def test_cube_validate(con120, dummy_backend):
+    dummy_backend.next_validation_errors = [{"code": "OddSupport", "message": "Odd values are not supported."}]
+    cube = con120.load_collection("S2")
+    result = cube.validate()
+
+    assert dummy_backend.validation_requests == [
+        {
+            "loadcollection1": {
+                "process_id": "load_collection",
+                "arguments": {"id": "S2", "spatial_extent": None, "temporal_extent": None},
+                "result": True,
+            },
+        }
+    ]
+    assert isinstance(result, ValidationResponse)
+    assert result == [{"code": "OddSupport", "message": "Odd values are not supported."}]

tests/rest/datacube/test_vectorcube.py

@@ -10,6 +10,7 @@
 from openeo.rest import OpenEoClientException
 from openeo.rest._testing import DummyBackend, build_capabilities
 from openeo.rest.connection import Connection
+from openeo.rest.models.general import ValidationResponse
 from openeo.rest.vectorcube import VectorCube
 from openeo.util import InvalidBBoxException, dict_no_none
 
@@ -854,3 +855,21 @@ def test_execute_batch_with_title(vector_cube, dummy_backend):
             "description": "Lorem ipsum dolor S2 amet",
         }
     }
+
+
+def test_vector_cube_validate(vector_cube, dummy_backend):
+    dummy_backend.next_validation_errors = [{"code": "OfflineRequired", "message": "Turn off your smartphone"}]
+
+    result = vector_cube.validate()
+
+    assert dummy_backend.validation_requests == [
+        {
+            "loadgeojson1": {
+                "process_id": "load_geojson",
+                "arguments": {"data": {"coordinates": [1, 2], "type": "Point"}, "properties": []},
+                "result": True,
+            }
+        }
+    ]
+    assert isinstance(result, ValidationResponse)
+    assert result == [{"code": "OfflineRequired", "message": "Turn off your smartphone"}]

tests/rest/test_connection.py

@@ -46,7 +46,7 @@
     extract_connections,
     paginate,
 )
-from openeo.rest.models.general import Link
+from openeo.rest.models.general import Link, ValidationResponse
 from openeo.rest.vectorcube import VectorCube
 from openeo.testing.stac import StacDummyBuilder
 from openeo.util import ContextTimer, deep_get, dict_no_none
@@ -4865,6 +4865,17 @@ def test_validate_process_graph(con120, dummy_backend):
     dummy_backend.next_validation_errors = [{"code": "OddSupport", "message": "Odd values are not supported."}]
     cube = con120.load_collection("S2")
     res = con120.validate_process_graph(cube)
+
+    assert dummy_backend.validation_requests == [
+        {
+            "loadcollection1": {
+                "arguments": {"id": "S2", "spatial_extent": None, "temporal_extent": None},
+                "process_id": "load_collection",
+                "result": True,
+            }
+        }
+    ]
+    assert isinstance(res, ValidationResponse)
     assert res == [{"code": "OddSupport", "message": "Odd values are not supported."}]
 
 

tests/rest/test_result.py

@@ -1,4 +1,5 @@
 from openeo.rest.datacube import THIS
+from openeo.rest.models.general import ValidationResponse
 from openeo.rest.result import SaveResult
 
 
@@ -24,3 +25,27 @@ def test_legacy_save_result_export_workspace(dummy_backend):
             "result": True,
         },
     }
+
+
+def test_save_result_validate(dummy_backend):
+    dummy_backend.next_validation_errors = [{"code": "OfflineRequired", "message": "Turn off your smartphone"}]
+
+    s2 = dummy_backend.connection.load_collection("S2")
+    saved = s2.save_result(format="GTiff")
+    result = saved.validate()
+
+    assert dummy_backend.validation_requests == [
+        {
+            "loadcollection1": {
+                "process_id": "load_collection",
+                "arguments": {"id": "S2", "spatial_extent": None, "temporal_extent": None},
+            },
+            "saveresult1": {
+                "process_id": "save_result",
+                "arguments": {"data": {"from_node": "loadcollection1"}, "format": "GTiff", "options": {}},
+                "result": True,
+            },
+        }
+    ]
+    assert isinstance(result, ValidationResponse)
+    assert result == [{"code": "OfflineRequired", "message": "Turn off your smartphone"}]