Fix #652 preserve job title in execute_batch

soxofaan · soxofaan · commit 4ce7d78004a9 · 2024-10-31T12:01:30.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
+- Fixed support for `title` and `description` in `execute_batch()` ([#652](https://github.com/Open-EO/openeo-python-client/issues/652))
+
 
 ## [0.33.0] - 2024-10-18
 
diff --git a/openeo/rest/_testing.py b/openeo/rest/_testing.py
@@ -87,6 +87,9 @@ def _handle_post_jobs(self, request, context):
         pg = post_data["process"]["process_graph"]
         job_id = f"job-{len(self.batch_jobs):03d}"
         job_data = {"job_id": job_id, "pg": pg, "status": "created"}
+        for field in ["title", "description"]:
+            if field in post_data:
+                job_data[field] = post_data[field]
         for field in self.extra_job_metadata_fields:
             job_data[field] = post_data.get(field)
         self.batch_jobs[job_id] = job_data
diff --git a/openeo/rest/datacube.py b/openeo/rest/datacube.py
@@ -2361,6 +2361,10 @@ def execute_batch(
         outputfile: Optional[Union[str, pathlib.Path]] = None,
         out_format: Optional[str] = None,
         *,
+        title: Optional[str] = None,
+        description: Optional[str] = None,
+        plan: Optional[str] = None,
+        budget: Optional[float] = None,
         print: typing.Callable[[str], None] = print,
         max_poll_interval: float = 60,
         connection_retry_interval: float = 30,
@@ -2402,7 +2406,15 @@ def execute_batch(
                 method="DataCube.execute_batch()",
             )
 
-        job = cube.create_job(job_options=job_options, validate=validate, auto_add_save_result=False)
+        job = cube.create_job(
+            title=title,
+            description=description,
+            plan=plan,
+            budget=budget,
+            job_options=job_options,
+            validate=validate,
+            auto_add_save_result=False,
+        )
         return job.run_synchronous(
             outputfile=outputfile,
             print=print, max_poll_interval=max_poll_interval, connection_retry_interval=connection_retry_interval
diff --git a/openeo/rest/mlmodel.py b/openeo/rest/mlmodel.py
@@ -59,10 +59,17 @@ def load_ml_model(connection: Connection, id: Union[str, BatchJob]) -> MlModel:
         return MlModel(graph=PGNode(process_id="load_ml_model", id=id), connection=connection)
 
     def execute_batch(
-            self,
-            outputfile: Union[str, pathlib.Path],
-            print=print, max_poll_interval=60, connection_retry_interval=30,
-            job_options=None,
+        self,
+        outputfile: Union[str, pathlib.Path],
+        *,
+        title: Optional[str] = None,
+        description: Optional[str] = None,
+        plan: Optional[str] = None,
+        budget: Optional[float] = None,
+        print=print,
+        max_poll_interval=60,
+        connection_retry_interval=30,
+        job_options=None,
     ) -> BatchJob:
         """
         Evaluate the process graph by creating a batch job, and retrieving the results when it is finished.
@@ -75,7 +82,7 @@ def execute_batch(
         :param out_format: (optional) Format of the job result.
         :param format_options: String Parameters for the job result format
         """
-        job = self.create_job(job_options=job_options)
+        job = self.create_job(title=title, description=description, plan=plan, budget=budget, job_options=job_options)
         return job.run_synchronous(
             # TODO #135 support multi file result sets too
             outputfile=outputfile,
diff --git a/openeo/rest/vectorcube.py b/openeo/rest/vectorcube.py
@@ -248,6 +248,10 @@ def execute_batch(
         outputfile: Optional[Union[str, pathlib.Path]] = None,
         out_format: Optional[str] = None,
         *,
+        title: Optional[str] = None,
+        description: Optional[str] = None,
+        plan: Optional[str] = None,
+        budget: Optional[float] = None,
         print=print,
         max_poll_interval: float = 60,
         connection_retry_interval: float = 30,
@@ -287,7 +291,15 @@ def execute_batch(
                 default_format=self._DEFAULT_VECTOR_FORMAT,
                 method="VectorCube.execute_batch()",
             )
-        job = cube.create_job(job_options=job_options, validate=validate, auto_add_save_result=False)
+        job = cube.create_job(
+            title=title,
+            description=description,
+            plan=plan,
+            budget=budget,
+            job_options=job_options,
+            validate=validate,
+            auto_add_save_result=False,
+        )
         return job.run_synchronous(
             # TODO #135 support multi file result sets too
             outputfile=outputfile,
diff --git a/tests/extra/test_job_management.py b/tests/extra/test_job_management.py
@@ -1089,6 +1089,8 @@ def test_minimal(self, con, dummy_backend, remote_process_definitions):
                     }
                 },
                 "status": "created",
+                "title": "Process '3plus5' with {}",
+                "description": "Process '3plus5' (namespace https://remote.test/3plus5.json) with {}",
             }
         }
 
@@ -1150,6 +1152,8 @@ def test_basic_parameterization(self, con, dummy_backend, parameter_defaults, ro
                     }
                 },
                 "status": "created",
+                "title": dirty_equals.IsStr(regex="Process 'increment' with .*"),
+                "description": dirty_equals.IsStr(regex="Process 'increment' .*"),
             }
         }
 
@@ -1199,6 +1203,8 @@ def test_process_references_in_constructor(
                 "job_id": "job-000",
                 "pg": {"3plus51": {**expected, "arguments": {}, "result": True}},
                 "status": "created",
+                "title": "Process '3plus5' with {}",
+                "description": f"Process '3plus5' (namespace {namespace}) with {{}}",
             }
         }
 
@@ -1251,6 +1257,8 @@ def test_with_job_manager_remote_basic(
                     }
                 },
                 "status": "finished",
+                "title": "Process 'increment' with {'data': 1, 'increment': 5}",
+                "description": "Process 'increment' (namespace https://remote.test/increment.json) with {'data': 1, 'increment': 5}",
             },
             "job-001": {
                 "job_id": "job-001",
@@ -1263,6 +1271,8 @@ def test_with_job_manager_remote_basic(
                     }
                 },
                 "status": "finished",
+                "title": "Process 'increment' with {'data': 2, 'increment': 5}",
+                "description": "Process 'increment' (namespace https://remote.test/increment.json) with {'data': 2, 'increment': 5}",
             },
             "job-002": {
                 "job_id": "job-002",
@@ -1275,6 +1285,8 @@ def test_with_job_manager_remote_basic(
                     }
                 },
                 "status": "finished",
+                "title": "Process 'increment' with {'data': 3, 'increment': 5}",
+                "description": "Process 'increment' (namespace https://remote.test/increment.json) with {'data': 3, 'increment': 5}",
             },
         }
 
@@ -1353,6 +1365,8 @@ def test_with_job_manager_remote_parameter_handling(
                     }
                 },
                 "status": "finished",
+                "title": dirty_equals.IsStr(regex="Process 'increment' with .*"),
+                "description": dirty_equals.IsStr(regex="Process 'increment'.*"),
             },
             "job-001": {
                 "job_id": "job-001",
@@ -1365,6 +1379,8 @@ def test_with_job_manager_remote_parameter_handling(
                     }
                 },
                 "status": "finished",
+                "title": dirty_equals.IsStr(regex="Process 'increment' with .*"),
+                "description": dirty_equals.IsStr(regex="Process 'increment'.*"),
             },
             "job-002": {
                 "job_id": "job-002",
@@ -1377,6 +1393,8 @@ def test_with_job_manager_remote_parameter_handling(
                     }
                 },
                 "status": "finished",
+                "title": dirty_equals.IsStr(regex="Process 'increment' with .*"),
+                "description": dirty_equals.IsStr(regex="Process 'increment'.*"),
             },
         }
 
@@ -1436,6 +1454,8 @@ def test_with_job_manager_remote_geometry(self, tmp_path, requests_mock, dummy_b
                     }
                 },
                 "status": "finished",
+                "title": "Process 'offset_polygon' with {'data': 123, 'polygons': {'type': 'Point', 'coordinates': (1...",
+                "description": "Process 'offset_polygon' (namespace https://remote.test/offset_polygon.json) with {'data': 123, 'polygons': {'type': 'Point', 'coordinates': (1.0, 2.0)}, 'offset': 11}",
             },
             "job-001": {
                 "job_id": "job-001",
@@ -1452,6 +1472,8 @@ def test_with_job_manager_remote_geometry(self, tmp_path, requests_mock, dummy_b
                     }
                 },
                 "status": "finished",
+                "title": "Process 'offset_polygon' with {'data': 123, 'polygons': {'type': 'Point', 'coordinates': (3...",
+                "description": "Process 'offset_polygon' (namespace https://remote.test/offset_polygon.json) with {'data': 123, 'polygons': {'type': 'Point', 'coordinates': (3.0, 4.0)}, 'offset': 22}",
             },
         }
 
@@ -1527,6 +1549,8 @@ def test_with_job_manager_remote_geometry_after_resume(
                     }
                 },
                 "status": "finished",
+                "title": dirty_equals.IsStr(regex="Process 'offset_polygon' with.*"),
+                "description": dirty_equals.IsStr(regex="Process 'offset_polygon' .*"),
             },
             "job-001": {
                 "job_id": "job-001",
@@ -1543,6 +1567,8 @@ def test_with_job_manager_remote_geometry_after_resume(
                     }
                 },
                 "status": "finished",
+                "title": dirty_equals.IsStr(regex="Process 'offset_polygon' with.*"),
+                "description": dirty_equals.IsStr(regex="Process 'offset_polygon' .*"),
             },
         }
 
@@ -1586,6 +1612,8 @@ def test_with_job_manager_udp_basic(
                     }
                 },
                 "status": "finished",
+                "title": "Process 'increment' with {'data': 3, 'increment': 5}",
+                "description": "Process 'increment' (namespace None) with {'data': 3, 'increment': 5}",
             },
             "job-001": {
                 "job_id": "job-001",
@@ -1597,6 +1625,8 @@ def test_with_job_manager_udp_basic(
                     }
                 },
                 "status": "finished",
+                "title": "Process 'increment' with {'data': 5, 'increment': 5}",
+                "description": "Process 'increment' (namespace None) with {'data': 5, 'increment': 5}",
             },
         }
 
@@ -1638,6 +1668,8 @@ def test_with_job_manager_parameter_column_map(
                     }
                 },
                 "status": "finished",
+                "title": "Process 'increment' with {'data': 3, 'increment': 100}",
+                "description": "Process 'increment' (namespace https://remote.test/increment.json) with {'data': 3, 'increment': 100}",
             },
             "job-001": {
                 "job_id": "job-001",
@@ -1650,5 +1682,7 @@ def test_with_job_manager_parameter_column_map(
                     }
                 },
                 "status": "finished",
+                "title": "Process 'increment' with {'data': 5, 'increment': 200}",
+                "description": "Process 'increment' (namespace https://remote.test/increment.json) with {'data': 5, 'increment': 200}",
             },
         }
diff --git a/tests/rest/datacube/test_datacube.py b/tests/rest/datacube/test_datacube.py
@@ -1236,3 +1236,30 @@ def test_cube_execute_batch_validation(self, dummy_backend, connection, validate
         else:
             assert dummy_backend.validation_requests == []
             assert caplog.messages == []
+
+
+def test_execute_batch_with_title(s2cube, dummy_backend):
+    """
+    Support title/description in execute_batch
+    https://github.com/Open-EO/openeo-python-client/issues/652
+    """
+    s2cube.execute_batch(title="S2 job", description="Lorem ipsum dolor S2 amet")
+    assert dummy_backend.batch_jobs == {
+        "job-000": {
+            "job_id": "job-000",
+            "pg": {
+                "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,
+                },
+            },
+            "status": "finished",
+            "title": "S2 job",
+            "description": "Lorem ipsum dolor S2 amet",
+        }
+    }
diff --git a/tests/rest/datacube/test_vectorcube.py b/tests/rest/datacube/test_vectorcube.py
@@ -829,3 +829,30 @@ def test_vector_to_raster(s2cube, vector_cube, requests_mock, target_parameter,
             "result": True,
         },
     }
+
+
+def test_execute_batch_with_title(vector_cube, dummy_backend):
+    """
+    Support title/description in execute_batch
+    https://github.com/Open-EO/openeo-python-client/issues/652
+    """
+    vector_cube.execute_batch(title="S2 job", description="Lorem ipsum dolor S2 amet")
+    assert dummy_backend.batch_jobs == {
+        "job-000": {
+            "job_id": "job-000",
+            "pg": {
+                "loadgeojson1": {
+                    "process_id": "load_geojson",
+                    "arguments": {"data": {"coordinates": [1, 2], "type": "Point"}, "properties": []},
+                },
+                "saveresult1": {
+                    "process_id": "save_result",
+                    "arguments": {"data": {"from_node": "loadgeojson1"}, "format": "GeoJSON", "options": {}},
+                    "result": True,
+                },
+            },
+            "status": "finished",
+            "title": "S2 job",
+            "description": "Lorem ipsum dolor S2 amet",
+        }
+    }

Original file line number	Diff line number	Diff line change
`@@ -1089,6 +1089,8 @@ def test_minimal(self, con, dummy_backend, remote_process_definitions):`
`1089`	`1089`	`}`
`1090`	`1090`	`},`
`1091`	`1091`	`"status": "created",`
	`1092`	`+ "title": "Process '3plus5' with {}",`
	`1093`	`+ "description": "Process '3plus5' (namespace https://remote.test/3plus5.json) with {}",`
`1092`	`1094`	`}`
`1093`	`1095`	`}`
`1094`	`1096`
`@@ -1150,6 +1152,8 @@ def test_basic_parameterization(self, con, dummy_backend, parameter_defaults, ro`
`1150`	`1152`	`}`
`1151`	`1153`	`},`
`1152`	`1154`	`"status": "created",`
	`1155`	`+ "title": dirty_equals.IsStr(regex="Process 'increment' with .*"),`
	`1156`	`+ "description": dirty_equals.IsStr(regex="Process 'increment' .*"),`
`1153`	`1157`	`}`
`1154`	`1158`	`}`
`1155`	`1159`
`@@ -1199,6 +1203,8 @@ def test_process_references_in_constructor(`
`1199`	`1203`	`"job_id": "job-000",`
`1200`	`1204`	`"pg": {"3plus51": {**expected, "arguments": {}, "result": True}},`
`1201`	`1205`	`"status": "created",`
	`1206`	`+ "title": "Process '3plus5' with {}",`
	`1207`	`+ "description": f"Process '3plus5' (namespace {namespace}) with {{}}",`
`1202`	`1208`	`}`
`1203`	`1209`	`}`
`1204`	`1210`
`@@ -1251,6 +1257,8 @@ def test_with_job_manager_remote_basic(`
`1251`	`1257`	`}`
`1252`	`1258`	`},`
`1253`	`1259`	`"status": "finished",`
	`1260`	`+ "title": "Process 'increment' with {'data': 1, 'increment': 5}",`
	`1261`	`+ "description": "Process 'increment' (namespace https://remote.test/increment.json) with {'data': 1, 'increment': 5}",`
`1254`	`1262`	`},`
`1255`	`1263`	`"job-001": {`
`1256`	`1264`	`"job_id": "job-001",`
`@@ -1263,6 +1271,8 @@ def test_with_job_manager_remote_basic(`
`1263`	`1271`	`}`
`1264`	`1272`	`},`
`1265`	`1273`	`"status": "finished",`
	`1274`	`+ "title": "Process 'increment' with {'data': 2, 'increment': 5}",`
	`1275`	`+ "description": "Process 'increment' (namespace https://remote.test/increment.json) with {'data': 2, 'increment': 5}",`
`1266`	`1276`	`},`
`1267`	`1277`	`"job-002": {`
`1268`	`1278`	`"job_id": "job-002",`
`@@ -1275,6 +1285,8 @@ def test_with_job_manager_remote_basic(`
`1275`	`1285`	`}`
`1276`	`1286`	`},`
`1277`	`1287`	`"status": "finished",`
	`1288`	`+ "title": "Process 'increment' with {'data': 3, 'increment': 5}",`
	`1289`	`+ "description": "Process 'increment' (namespace https://remote.test/increment.json) with {'data': 3, 'increment': 5}",`
`1278`	`1290`	`},`
`1279`	`1291`	`}`
`1280`	`1292`
`@@ -1353,6 +1365,8 @@ def test_with_job_manager_remote_parameter_handling(`
`1353`	`1365`	`}`
`1354`	`1366`	`},`
`1355`	`1367`	`"status": "finished",`
	`1368`	`+ "title": dirty_equals.IsStr(regex="Process 'increment' with .*"),`
	`1369`	`+ "description": dirty_equals.IsStr(regex="Process 'increment'.*"),`
`1356`	`1370`	`},`
`1357`	`1371`	`"job-001": {`
`1358`	`1372`	`"job_id": "job-001",`
`@@ -1365,6 +1379,8 @@ def test_with_job_manager_remote_parameter_handling(`
`1365`	`1379`	`}`
`1366`	`1380`	`},`
`1367`	`1381`	`"status": "finished",`
	`1382`	`+ "title": dirty_equals.IsStr(regex="Process 'increment' with .*"),`
	`1383`	`+ "description": dirty_equals.IsStr(regex="Process 'increment'.*"),`
`1368`	`1384`	`},`
`1369`	`1385`	`"job-002": {`
`1370`	`1386`	`"job_id": "job-002",`
`@@ -1377,6 +1393,8 @@ def test_with_job_manager_remote_parameter_handling(`
`1377`	`1393`	`}`
`1378`	`1394`	`},`
`1379`	`1395`	`"status": "finished",`
	`1396`	`+ "title": dirty_equals.IsStr(regex="Process 'increment' with .*"),`
	`1397`	`+ "description": dirty_equals.IsStr(regex="Process 'increment'.*"),`
`1380`	`1398`	`},`
`1381`	`1399`	`}`
`1382`	`1400`
`@@ -1436,6 +1454,8 @@ def test_with_job_manager_remote_geometry(self, tmp_path, requests_mock, dummy_b`
`1436`	`1454`	`}`
`1437`	`1455`	`},`
`1438`	`1456`	`"status": "finished",`
	`1457`	`+ "title": "Process 'offset_polygon' with {'data': 123, 'polygons': {'type': 'Point', 'coordinates': (1...",`
	`1458`	`+ "description": "Process 'offset_polygon' (namespace https://remote.test/offset_polygon.json) with {'data': 123, 'polygons': {'type': 'Point', 'coordinates': (1.0, 2.0)}, 'offset': 11}",`
`1439`	`1459`	`},`
`1440`	`1460`	`"job-001": {`
`1441`	`1461`	`"job_id": "job-001",`
`@@ -1452,6 +1472,8 @@ def test_with_job_manager_remote_geometry(self, tmp_path, requests_mock, dummy_b`
`1452`	`1472`	`}`
`1453`	`1473`	`},`
`1454`	`1474`	`"status": "finished",`
	`1475`	`+ "title": "Process 'offset_polygon' with {'data': 123, 'polygons': {'type': 'Point', 'coordinates': (3...",`
	`1476`	`+ "description": "Process 'offset_polygon' (namespace https://remote.test/offset_polygon.json) with {'data': 123, 'polygons': {'type': 'Point', 'coordinates': (3.0, 4.0)}, 'offset': 22}",`
`1455`	`1477`	`},`
`1456`	`1478`	`}`
`1457`	`1479`
`@@ -1527,6 +1549,8 @@ def test_with_job_manager_remote_geometry_after_resume(`
`1527`	`1549`	`}`
`1528`	`1550`	`},`
`1529`	`1551`	`"status": "finished",`
	`1552`	`+ "title": dirty_equals.IsStr(regex="Process 'offset_polygon' with.*"),`
	`1553`	`+ "description": dirty_equals.IsStr(regex="Process 'offset_polygon' .*"),`
`1530`	`1554`	`},`
`1531`	`1555`	`"job-001": {`
`1532`	`1556`	`"job_id": "job-001",`
`@@ -1543,6 +1567,8 @@ def test_with_job_manager_remote_geometry_after_resume(`
`1543`	`1567`	`}`
`1544`	`1568`	`},`
`1545`	`1569`	`"status": "finished",`
	`1570`	`+ "title": dirty_equals.IsStr(regex="Process 'offset_polygon' with.*"),`
	`1571`	`+ "description": dirty_equals.IsStr(regex="Process 'offset_polygon' .*"),`
`1546`	`1572`	`},`
`1547`	`1573`	`}`
`1548`	`1574`
`@@ -1586,6 +1612,8 @@ def test_with_job_manager_udp_basic(`
`1586`	`1612`	`}`
`1587`	`1613`	`},`
`1588`	`1614`	`"status": "finished",`
	`1615`	`+ "title": "Process 'increment' with {'data': 3, 'increment': 5}",`
	`1616`	`+ "description": "Process 'increment' (namespace None) with {'data': 3, 'increment': 5}",`
`1589`	`1617`	`},`
`1590`	`1618`	`"job-001": {`
`1591`	`1619`	`"job_id": "job-001",`
`@@ -1597,6 +1625,8 @@ def test_with_job_manager_udp_basic(`
`1597`	`1625`	`}`
`1598`	`1626`	`},`
`1599`	`1627`	`"status": "finished",`
	`1628`	`+ "title": "Process 'increment' with {'data': 5, 'increment': 5}",`
	`1629`	`+ "description": "Process 'increment' (namespace None) with {'data': 5, 'increment': 5}",`
`1600`	`1630`	`},`
`1601`	`1631`	`}`
`1602`	`1632`
`@@ -1638,6 +1668,8 @@ def test_with_job_manager_parameter_column_map(`
`1638`	`1668`	`}`
`1639`	`1669`	`},`
`1640`	`1670`	`"status": "finished",`
	`1671`	`+ "title": "Process 'increment' with {'data': 3, 'increment': 100}",`
	`1672`	`+ "description": "Process 'increment' (namespace https://remote.test/increment.json) with {'data': 3, 'increment': 100}",`
`1641`	`1673`	`},`
`1642`	`1674`	`"job-001": {`
`1643`	`1675`	`"job_id": "job-001",`
`@@ -1650,5 +1682,7 @@ def test_with_job_manager_parameter_column_map(`
`1650`	`1682`	`}`
`1651`	`1683`	`},`
`1652`	`1684`	`"status": "finished",`
	`1685`	`+ "title": "Process 'increment' with {'data': 5, 'increment': 200}",`
	`1686`	`+ "description": "Process 'increment' (namespace https://remote.test/increment.json) with {'data': 5, 'increment': 200}",`
`1653`	`1687`	`},`
`1654`	`1688`	`}`