Add price estimation endpoint in SDK (#171)

nekhtiari · Christoph Rieke · web-flow · commit 9ffd1aa3fde9 · 2020-12-07T10:39:56.000+01:00
* Add price estimation endpoint in SDK

* Update the tests

* Add reviewer cm

* Bump the version

* correct the version

* Add reviewer cm

* add to docs structure

* rename

* example in docstring

* add livetest

* Add estimation in the 30 seconds example

* revert version

Co-authored-by: Christoph Rieke &lt;christoph.rieke@up42.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,9 @@ pip show up42-py
 ```
 
 ## Versions
+### [0.14.0](https://pypi.org/project/up42-py/) (2020-11-18)
+- Add `workflow.estimate_job` for getting estimation the cost of running a workflow.
+- Add boolean `get_estimation` parameter to `workflow.test_job` for getting cost's estimation when running test job. By default is set to false.
 
 ### [0.13.1](https://pypi.org/project/up42-py/) (2020-11-18)
 - Handle request rate limits via retry mechanism.
diff --git a/docs/structure.md b/docs/structure.md
@@ -50,6 +50,7 @@ function.
         - `.workflow_tasks`
         - `.add_workflow_tasks()`
         - `.construct_parameters()`
+        - `.estimate_job()`
         - `.test_job()`
         - `.run_job()`
         - `.construct_parameters_parallel()`
diff --git a/examples/guides/30-seconds-example.ipynb b/examples/guides/30-seconds-example.ipynb
@@ -57,6 +57,16 @@
     "input_parameters"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Get the estimation of credits for running the job\n",
+    "estimate_job = workflow.estimate_job(input_parameters)"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -99,9 +109,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "up42-py",
+   "display_name": "up42-pydev",
    "language": "python",
-   "name": "up42-py"
+   "name": "up42-pydev"
   },
   "language_info": {
    "codemirror_mode": {
@@ -113,7 +123,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.5"
+   "version": "3.7.7"
   }
  },
  "nbformat": 4,
diff --git a/tests/context.py b/tests/context.py
@@ -21,6 +21,7 @@
 from up42.jobcollection import JobCollection
 from up42.jobtask import JobTask
 from up42.catalog import Catalog
+from up42.estimation import Estimation
 from up42.__init__ import (
     authenticate,
     initialize_project,
diff --git a/tests/fixtures.py b/tests/fixtures.py
@@ -12,6 +12,7 @@
     JobTask,
     Tools,
     Catalog,
+    Estimation,
 )
 
 
@@ -36,36 +37,48 @@
 
 
 JSON_WORKFLOW_TASKS = {
+    "error": "None",
     "data": [
         {
-            "id": "c0d04ec3-98d7-4183-902f-5bcb2a176d89",
+            "id": "aa2cba17-d35c-4395-ab01-a0fd8191a4b3",
             "name": "sobloo-s2-l1c-aoiclipped:1",
-            "blockVersionTag": "2.2.2",
+            "parentsIds": [],
+            "blockName": "sobloo-s2-l1c-aoiclipped",
+            "blockVersionTag": "2.3.0",
             "block": {
+                "id": "3a381e6b-acb7-4cec-ae65-50798ce80e64",
                 "name": "sobloo-s2-l1c-aoiclipped",
+                "displayName": "Sentinel-2 L1C MSI AOI clipped",
                 "parameters": {
-                    "nodata": {
-                        "type": "number",
-                    },
+                    "ids": {"type": "array", "default": "None"},
+                    "bbox": {"type": "array", "default": "None"},
                     "time": {
                         "type": "dateRange",
                         "default": "2018-01-01T00:00:00+00:00/2020-12-31T23:59:59+00:00",
                     },
                 },
+                "type": "DATA",
+                "isDryRunSupported": True,
+                "version": "2.3.0",
             },
+            "environment": "None",
         },
         {
-            "id": "af626c54-156e-4f13-a743-55efd27de533",
+            "id": "24375b2a-288b-46c8-b404-53e48d4e7b25",
             "name": "tiling:1",
-            "blockVersionTag": "1.0.0",
+            "parentsIds": ["aa2cba17-d35c-4395-ab01-a0fd8191a4b3"],
+            "blockName": "tiling",
+            "blockVersionTag": "2.2.3",
             "block": {
+                "id": "3e146dd6-2b67-4d6e-a422-bb3d973e32ff",
                 "name": "tiling",
+                "displayName": "Raster Tiling",
                 "parameters": {
                     "nodata": {
                         "type": "number",
-                        "default": None,
+                        "default": "None",
                         "required": False,
-                        "description": "Value representing..",
+                        "description": "Value representing ...",
                     },
                     "tile_width": {
                         "type": "number",
@@ -74,10 +87,13 @@
                         "description": "Width of a tile in pixels",
                     },
                 },
+                "type": "PROCESSING",
+                "isDryRunSupported": False,
+                "version": "2.2.3",
             },
+            "environment": "None",
         },
     ],
-    "error": {},
 }
 
 JSON_BLOCKS = {
@@ -101,6 +117,32 @@
     "error": {},
 }
 
+JSON_WORKFLOW_ESTIMATION = {
+    "data": {
+        "sobloo-s2-l1c-aoiclipped:1": {
+            "blockConsumption": {
+                "resources": {"unit": "MEGABYTE", "min": 3.145728, "max": 3.145728},
+                "credit": {"min": 0, "max": 0},
+            },
+            "machineConsumption": {
+                "duration": {"min": 4041, "max": 26380},
+                "credit": {"min": 3, "max": 3},
+            },
+        },
+        "tiling:1": {
+            "blockConsumption": {
+                "resources": {"unit": "MEGABYTE", "min": 3.145728, "max": 3.145728},
+                "credit": {"min": 0, "max": 0},
+            },
+            "machineConsumption": {
+                "duration": {"min": 80930, "max": 428927},
+                "credit": {"min": 2, "max": 9},
+            },
+        },
+    },
+    "error": {},
+}
+
 
 # TODO: Use patch.dict instead of 2 fictures?
 @pytest.fixture()
@@ -426,6 +468,63 @@ def jobs_live(auth_live):
     return [job_1, job_2]
 
 
+@pytest.fixture()
+def estimation_mock(auth_mock):
+    input_parameters = {
+        "sobloo-s2-l1c-aoiclipped:1": {
+            "time": "2018-01-01T00:00:00+00:00/2020-12-31T23:59:59+00:00",
+            "limit": 1,
+            "bbox": [13.33409, 52.474922, 13.38547, 52.500398],
+        },
+        "tiling:1": {"tile_width": 768},
+    }
+
+    input_tasks = [
+        {
+            "name": "sobloo-s2-l1c-aoiclipped:1",
+            "parentName": None,
+            "blockId": "3a381e6b-acb7-4cec-ae65-50798ce80e64",
+            "blockVersionTag": "2.3.0",
+        },
+        {
+            "name": "tiling:1",
+            "parentName": "sobloo-s2-l1c-aoiclipped:1",
+            "blockId": "3e146dd6-2b67-4d6e-a422-bb3d973e32ff",
+            "blockVersionTag": "2.2.3",
+        },
+    ]
+
+    return Estimation(auth_mock, input_parameters, input_tasks)
+
+
+@pytest.fixture()
+def estimation_live(auth_live):
+    input_parameters = {
+        "sobloo-s2-l1c-aoiclipped:1": {
+            "time": "2018-01-01T00:00:00+00:00/2020-12-31T23:59:59+00:00",
+            "limit": 1,
+            "bbox": [13.33409, 52.474922, 13.38547, 52.500398],
+        },
+        "tiling:1": {"tile_width": 768},
+    }
+
+    input_tasks = [
+        {
+            "name": "sobloo-s2-l1c-aoiclipped:1",
+            "parentName": None,
+            "blockId": "3a381e6b-acb7-4cec-ae65-50798ce80e64",
+            "blockVersionTag": "2.3.0",
+        },
+        {
+            "name": "tiling:1",
+            "parentName": "sobloo-s2-l1c-aoiclipped:1",
+            "blockId": "3e146dd6-2b67-4d6e-a422-bb3d973e32ff",
+            "blockVersionTag": "2.2.3",
+        },
+    ]
+    return Estimation(auth_live, input_parameters, input_tasks)
+
+
 @pytest.fixture()
 def jobcollection_single_mock(auth_mock, job_mock):
     return JobCollection(
diff --git a/tests/test_estimation.py b/tests/test_estimation.py
@@ -0,0 +1,68 @@
+import pytest
+
+# pylint: disable=unused-import,wrong-import-order
+from .context import Estimation
+from .fixtures import (
+    auth_mock,
+    auth_live,
+    estimation_mock,
+    JSON_WORKFLOW_ESTIMATION,
+)
+
+
+def test_estimate_price(requests_mock, auth_mock, estimation_mock):
+    input_tasks = [
+        {
+            "name": "sobloo-s2-l1c-aoiclipped:1",
+            "parentName": None,
+            "blockId": "3a381e6b-acb7-4cec-ae65-50798ce80e64",
+            "blockVersionTag": "2.3.0",
+        },
+        {
+            "name": "tiling:1",
+            "parentName": "sobloo-s2-l1c-aoiclipped:1",
+            "blockId": "3e146dd6-2b67-4d6e-a422-bb3d973e32ff",
+            "blockVersionTag": "2.2.3",
+        },
+    ]
+
+    url_workflow_estimation = f"{auth_mock._endpoint()}/estimate/job"
+    requests_mock.post(url=url_workflow_estimation, json=JSON_WORKFLOW_ESTIMATION)
+    _ = estimation_mock.estimate()
+    assert list(estimation_mock.payload.keys()) == ["tasks", "inputs"]
+    assert estimation_mock.payload["tasks"] == input_tasks
+
+
+@pytest.mark.live
+def test_estimate_price_live(auth_live):
+    input_parameters = {
+        "sobloo-s2-l1c-aoiclipped:1": {
+            "time": "2018-01-01T00:00:00+00:00/2020-12-31T23:59:59+00:00",
+            "limit": 1,
+            "bbox": [13.33409, 52.474922, 13.38547, 52.500398],
+        },
+        "tiling:1": {"tile_width": 768},
+    }
+
+    input_tasks = [
+        {
+            "name": "sobloo-s2-l1c-aoiclipped:1",
+            "parentName": None,
+            "blockId": "3a381e6b-acb7-4cec-ae65-50798ce80e64",
+            "blockVersionTag": "2.3.0",
+        },
+        {
+            "name": "tiling:1",
+            "parentName": "sobloo-s2-l1c-aoiclipped:1",
+            "blockId": "3e146dd6-2b67-4d6e-a422-bb3d973e32ff",
+            "blockVersionTag": "2.2.3",
+        },
+    ]
+    estimation = Estimation(auth_live, input_parameters, input_tasks).estimate()
+    assert isinstance(estimation, dict)
+    assert len(estimation) == 2
+    assert list(estimation.keys()) == ["sobloo-s2-l1c-aoiclipped:1", "tiling:1"]
+    assert list(estimation["sobloo-s2-l1c-aoiclipped:1"].keys()) == [
+        "blockConsumption",
+        "machineConsumption",
+    ]
diff --git a/tests/test_workflow.py b/tests/test_workflow.py
diff --git a/up42/estimation.py b/up42/estimation.py
diff --git a/up42/workflow.py b/up42/workflow.py
