Merge pull request #19 from geo-engine/retrieve-workflow

query workflow definition

Author: michaelmattig

geoengine/workflow.py

@@ -3,7 +3,7 @@
 '''
 
 from __future__ import annotations
-from typing import Dict, List
+from typing import Any, Dict, List
 
 from uuid import UUID
 from logging import debug
@@ -95,6 +95,18 @@ def get_result_descriptor(self) -> ResultDescriptor:
 
         return self.__result_descriptor
 
+    def workflow_definition(self) -> Dict[str, Any]:
+        '''Return the workflow definition for this workflow'''
+
+        session = get_session()
+
+        response = req.get(
+            f'{session.server_url}/workflow/{self.__workflow_id}',
+            headers=session.auth_header
+        ).json()
+
+        return response
+
     def __get_wfs_url(self, bbox: QueryRectangle) -> str:
         '''Build a WFS url from a workflow and a `QueryRectangle`'''
 
@@ -383,7 +395,7 @@ def get_provenance(self) -> List[ProvenanceOutput]:
         return [ProvenanceOutput.from_response(item) for item in response]
 
 
-def register_workflow(workflow: str) -> Workflow:
+def register_workflow(workflow: Dict[str, Any]) -> Workflow:
     '''
     Register a workflow in Geo Engine and receive a `WorkflowId`
     '''

tests/test_wfs.py

@@ -506,6 +506,86 @@ def test_result_descriptor(self):
             self.assertEqual(str(exception.exception),
                              'NotFound: Not Found')
 
+    def test_workflow_retrieval(self):
+        workflow_definition = {
+            "type": "Vector",
+            "operator": {
+                "type": "RasterVectorJoin",
+                "params": {
+                    "names": [
+                        "NDVI"
+                    ],
+                    "featureAggregation": "first",
+                    "temporalAggregation": "none"
+                },
+                "sources": {
+                    "vector": {
+                        "type": "OgrSource",
+                        "params": {
+                            "dataset": {
+                                "type": "internal",
+                                "datasetId": "a9623a5b-b6c5-404b-bc5a-313ff72e4e75"
+                            },
+                            "attributeProjection": None
+                        }
+                    },
+                    "rasters": [
+                        {
+                            "type": "GdalSource",
+                            "params": {
+                                "dataset": {
+                                    "type": "internal",
+                                    "datasetId": "36574dc3-560a-4b09-9d22-d5945f2b8093"
+                                }
+                            }
+                        }
+                    ]
+                }
+            }
+        }
+
+        with requests_mock.Mocker() as m:
+            m.post('http://mock-instance/anonymous', json={
+                "id": "c4983c3e-9b53-47ae-bda9-382223bd5081",
+                "project": None,
+                "view": None
+            })
+
+            m.post('http://mock-instance/workflow',
+                   json={
+                       "id": "4a2cb6e0-a3e3-53e4-9a0f-ed1cf2e4c3b7"
+                   },
+                   request_headers={'Authorization': 'Bearer c4983c3e-9b53-47ae-bda9-382223bd5081'})
+
+            m.get('http://mock-instance/workflow/4a2cb6e0-a3e3-53e4-9a0f-ed1cf2e4c3b7/metadata',
+                  json={
+                      "type": "vector",
+                      "dataType": "MultiPoint",
+                      "spatialReference": "EPSG:4326",
+                      "columns": {
+                          "name": "text",
+                          "scalerank": "int",
+                          "NDVI": "int",
+                          "natlscale": "float",
+                          "featurecla": "text",
+                          "website": "text"
+                      }
+                  },
+                  request_headers={'Authorization': 'Bearer c4983c3e-9b53-47ae-bda9-382223bd5081'})
+
+            m.get('http://mock-instance/workflow/4a2cb6e0-a3e3-53e4-9a0f-ed1cf2e4c3b7',
+                  json=workflow_definition,
+                  request_headers={'Authorization': 'Bearer c4983c3e-9b53-47ae-bda9-382223bd5081'})
+
+            ge.initialize("http://mock-instance")
+
+            workflow = ge.register_workflow(workflow_definition)
+
+            self.assertEqual(
+                workflow.workflow_definition(),
+                workflow_definition
+            )
+
 
 if __name__ == '__main__':
     unittest.main()