From 1630385d26c4dc1e4cdc43b112ecaca201c7d4cf Mon Sep 17 00:00:00 2001 From: Johan Berggren Date: Wed, 15 Oct 2025 11:23:21 +0200 Subject: [PATCH 1/3] Add workflow report retrieval to API client --- openrelik_api_client/workflows.py | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/openrelik_api_client/workflows.py b/openrelik_api_client/workflows.py index f2767b8..e001e74 100644 --- a/openrelik_api_client/workflows.py +++ b/openrelik_api_client/workflows.py @@ -1,4 +1,4 @@ -# Copyright 2024 Google LLC +# Copyright 2024-2025 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -158,3 +158,21 @@ def run_workflow(self, folder_id: int, workflow_id: int) -> dict[str, Any] | Non if response.status_code == 200: workflow = response.json() return workflow + + def get_workflow_report(self, workflow_id: int) -> dict[str, Any] | None: + """Retrieves a workflow report. + + Args: + workflow_id: The ID of the workflow to retrieve the report from. + + Returns: + The workflow report data. + + Raises: + HTTPError: If the API request failed. + """ + endpoint = f"{self.api_client.base_url}/workflows/{workflow_id}/report/" + response = self.api_client.session.get(endpoint) + response.raise_for_status() + if response.status_code == 200: + return response.json() From cc414970768c807b359d659ebdb0e53d7fc17bd4 Mon Sep 17 00:00:00 2001 From: Johan Berggren Date: Wed, 15 Oct 2025 12:06:36 +0200 Subject: [PATCH 2/3] Add tests --- tests/workflows_api_test.py | 67 +++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 tests/workflows_api_test.py diff --git a/tests/workflows_api_test.py b/tests/workflows_api_test.py new file mode 100644 index 0000000..937f6fd --- /dev/null +++ b/tests/workflows_api_test.py @@ -0,0 +1,67 @@ +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from unittest.mock import MagicMock + +from openrelik_api_client.api_client import APIClient, TokenRefreshSession +from openrelik_api_client.workflows import WorkflowsAPI + + +class TestWorkflowAPI: + def setup_method(self): + """Set up test fixtures.""" + self.api_client = MagicMock(spec=APIClient) + self.api_client.session = MagicMock(spec=TokenRefreshSession) + self.api_client.base_url = "https://api.example.com/api/v1" + self.workflows_api = WorkflowsAPI(self.api_client) + + def test_init(self): + """Test initialization.""" + assert self.workflows_api.api_client == self.api_client + + def test_create_workflow_reports(self): + """Test create_workflow_reports method.""" + + def test_get_workflow_report(self): + """Test get_workflow_report method.""" + workflow_id = 123 + mock_response = MagicMock() + mock_response.status_code = 200 + expected_report = {"id": workflow_id, "status": "completed", "data": {}} + mock_response.json.return_value = expected_report + self.api_client.session.get.return_value = mock_response + + report = self.workflows_api.get_workflow_report(workflow_id) + + self.api_client.session.get.assert_called_once_with( + f"{self.api_client.base_url}/workflows/{workflow_id}/report/" + ) + mock_response.raise_for_status.assert_called_once() + assert report == expected_report + + def test_get_workflow_report_no_content(self): + """Test get_workflow_report method when no content is returned.""" + workflow_id = 456 + mock_response = MagicMock() + mock_response.status_code = 204 + self.api_client.session.get.return_value = mock_response + + report = self.workflows_api.get_workflow_report(workflow_id) + + self.api_client.session.get.assert_called_once_with( + f"{self.api_client.base_url}/workflows/{workflow_id}/report/" + ) + mock_response.raise_for_status.assert_called_once() + mock_response.json.assert_not_called() + assert report is None From 7118a6be6cd9153f629333ea35cdeaff85eecce6 Mon Sep 17 00:00:00 2001 From: Johan Berggren Date: Wed, 15 Oct 2025 12:09:20 +0200 Subject: [PATCH 3/3] Add tests --- tests/workflows_api_test.py | 59 ++++++++++++++++++------------------- 1 file changed, 28 insertions(+), 31 deletions(-) diff --git a/tests/workflows_api_test.py b/tests/workflows_api_test.py index 937f6fd..49e40fd 100644 --- a/tests/workflows_api_test.py +++ b/tests/workflows_api_test.py @@ -18,7 +18,7 @@ from openrelik_api_client.workflows import WorkflowsAPI -class TestWorkflowAPI: +class TestWorkflowsAPI: def setup_method(self): """Set up test fixtures.""" self.api_client = MagicMock(spec=APIClient) @@ -30,38 +30,35 @@ def test_init(self): """Test initialization.""" assert self.workflows_api.api_client == self.api_client - def test_create_workflow_reports(self): - """Test create_workflow_reports method.""" + def test_get_workflow_report(self): + """Test get_workflow_report method.""" + workflow_id = 123 + mock_response = MagicMock() + mock_response.status_code = 200 + expected_report = {"id": workflow_id, "status": "completed", "data": {}} + mock_response.json.return_value = expected_report + self.api_client.session.get.return_value = mock_response - def test_get_workflow_report(self): - """Test get_workflow_report method.""" - workflow_id = 123 - mock_response = MagicMock() - mock_response.status_code = 200 - expected_report = {"id": workflow_id, "status": "completed", "data": {}} - mock_response.json.return_value = expected_report - self.api_client.session.get.return_value = mock_response + report = self.workflows_api.get_workflow_report(workflow_id) - report = self.workflows_api.get_workflow_report(workflow_id) + self.api_client.session.get.assert_called_once_with( + f"{self.api_client.base_url}/workflows/{workflow_id}/report/" + ) + mock_response.raise_for_status.assert_called_once() + assert report == expected_report - self.api_client.session.get.assert_called_once_with( - f"{self.api_client.base_url}/workflows/{workflow_id}/report/" - ) - mock_response.raise_for_status.assert_called_once() - assert report == expected_report + def test_get_workflow_report_no_content(self): + """Test get_workflow_report method when no content is returned.""" + workflow_id = 456 + mock_response = MagicMock() + mock_response.status_code = 204 + self.api_client.session.get.return_value = mock_response - def test_get_workflow_report_no_content(self): - """Test get_workflow_report method when no content is returned.""" - workflow_id = 456 - mock_response = MagicMock() - mock_response.status_code = 204 - self.api_client.session.get.return_value = mock_response + report = self.workflows_api.get_workflow_report(workflow_id) - report = self.workflows_api.get_workflow_report(workflow_id) - - self.api_client.session.get.assert_called_once_with( - f"{self.api_client.base_url}/workflows/{workflow_id}/report/" - ) - mock_response.raise_for_status.assert_called_once() - mock_response.json.assert_not_called() - assert report is None + self.api_client.session.get.assert_called_once_with( + f"{self.api_client.base_url}/workflows/{workflow_id}/report/" + ) + mock_response.raise_for_status.assert_called_once() + mock_response.json.assert_not_called() + assert report is None