Skip to content

support results_metadata_uri in job registry #413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ and start a new "In Progress" section above it.

- Have `integrations.s3` for interaction with Object Storage that follows the S3 API.
- `ElasticJobRegistry`: add support for pre-serialization of process graph ([Open-EO/openeo-geopyspark-driver#1232](https://github.com/Open-EO/openeo-geopyspark-driver/issues/1232))
- Support persisting results metadata URI in job registry ([Open-EO/openeo-geopyspark-driver#1255](https://github.com/Open-EO/openeo-geopyspark-driver/issues/1255))

## 0.134.0

Expand Down
10 changes: 10 additions & 0 deletions openeo_driver/jobregistry.py
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,11 @@ def set_results_metadata(
) -> None:
raise NotImplementedError

def set_results_metadata_uri(
self, job_id: str, *, user_id: Optional[str] = None, results_metadata_uri: str
) -> None:
raise NotImplementedError

def list_user_jobs(
self,
user_id: str,
Expand Down Expand Up @@ -610,6 +615,11 @@ def set_proxy_user(self, job_id: str, *, user_id: Optional[str] = None, proxy_us
def set_application_id(self, job_id: str, *, user_id: Optional[str] = None, application_id: str) -> None:
self._update(job_id=job_id, data={"application_id": application_id})

def set_results_metadata_uri(
self, job_id: str, *, user_id: Optional[str] = None, results_metadata_uri: str
) -> None:
self._update(job_id=job_id, data={"results_metadata_uri": results_metadata_uri})

def _search(self, query: dict, fields: Optional[List[str]] = None) -> List[JobDict]:
# TODO: sorting, pagination?
fields = set(fields or [])
Expand Down
21 changes: 21 additions & 0 deletions tests/test_jobregistry.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
EjrApiResponseError,
EjrError,
ElasticJobRegistry,
ejr_job_info_to_metadata,
get_ejr_credentials_from_env,
)
from openeo_driver.testing import (
Expand Down Expand Up @@ -98,6 +99,17 @@ def test_get_partial_job_status():
assert PARTIAL_JOB_STATUS.for_job_status(JOB_STATUS.CANCELED) == 'canceled'


def test_ejr_job_info_to_metadata():
job_info = {
"job_id": "j-123",
"status": "running",
"results_metadata_uri": "s3://bucket/path/to/job_metadata.json",
}

metadata = ejr_job_info_to_metadata(job_info)
assert metadata.status == JOB_STATUS.RUNNING


class TestElasticJobRegistry:
EJR_API_URL = "https://ejr.test"

Expand Down Expand Up @@ -992,6 +1004,15 @@ def test_set_application_id(self, requests_mock, oidc_mock, ejr):
ejr.set_application_id(job_id="job-123", application_id="app-456")
assert patch_mock.call_count == 1

def test_set_results_metadata_uri(self, requests_mock, oidc_mock, ejr):
handler = self._handle_patch_jobs(
oidc_mock=oidc_mock, expected_data={"results_metadata_uri": "s3://bucket/path/to/job_metadata.json"}
)
patch_mock = requests_mock.patch(f"{self.EJR_API_URL}/jobs/job-123", json=handler)

ejr.set_results_metadata_uri(job_id="job-123", results_metadata_uri="s3://bucket/path/to/job_metadata.json")
assert patch_mock.call_count == 1

def test_set_results_metadata(self, requests_mock, oidc_mock, ejr):
handler = self._handle_patch_jobs(
oidc_mock=oidc_mock, expected_data={
Expand Down