diff --git a/requirements-swh.txt b/requirements-swh.txt --- a/requirements-swh.txt +++ b/requirements-swh.txt @@ -1,3 +1,3 @@ swh.core[http] >= 0.3 -swh.deposit +swh.deposit >= 0.3 swh.storage >= 0.0.162 diff --git a/swh/icinga_plugins/deposit.py b/swh/icinga_plugins/deposit.py --- a/swh/icinga_plugins/deposit.py +++ b/swh/icinga_plugins/deposit.py @@ -1,4 +1,4 @@ -# Copyright (C) 2019 The Software Heritage developers +# Copyright (C) 2019-2020 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information @@ -6,6 +6,7 @@ import datetime import sys import time +from typing import Any, Dict, Optional from swh.deposit.client import PublicApiDepositClient @@ -23,6 +24,7 @@ self._archive_path = obj["archive"] self._metadata_path = obj["metadata"] self._collection = obj["collection"] + self._slug: Optional[str] = None self._client = PublicApiDepositClient( { @@ -32,16 +34,35 @@ ) def upload_deposit(self): + slug = "check-deposit-%s" % datetime.datetime.now().isoformat() result = self._client.deposit_create( archive=self._archive_path, metadata=self._metadata_path, collection=self._collection, in_progress=False, - slug="check-deposit-%s" % datetime.datetime.now().isoformat(), + slug=slug, ) + self._slug = slug self._deposit_id = result["deposit_id"] return result + def update_deposit_with_metadata(self) -> Dict[str, Any]: + """Trigger a metadata update on the deposit once it's completed. + + """ + deposit = self.get_deposit_status() + swhid = deposit["deposit_swh_id"] + assert deposit["deposit_id"] == self._deposit_id + + # We can reuse the initial metadata file we already sent + return self._client.deposit_update( + self._collection, + self._deposit_id, + self._slug, + metadata=self._metadata_path, + swhid=swhid, + ) + def get_deposit_status(self): return self._client.deposit_status( collection=self._collection, deposit_id=self._deposit_id @@ -125,4 +146,36 @@ f'Deposit took {metrics["total_time"]:.2f}s and succeeded.', **metrics, ) + + if status_code != 0: # Stop if any problem in the initial scenario + return status_code + + # Initial deposit is now completed, now we can update the deposit with metadata + result = self.update_deposit_with_metadata() + total_time = time.time() - start_time + metrics_update = { + "total_time": total_time, + "update_time": ( + total_time + - metrics["upload_time"] + - metrics["validation_time"] + - metrics["load_time"] + ), + } + + if "error" in result: + self.print_result( + "CRITICAL", + f'Deposit Metadata update failed: {result["error"]} ', + **metrics_update, + ) + return 2 + + (status_code, status) = self.get_status(metrics_update["total_time"]) + self.print_result( + status, + f'Deposit Metadata update took {metrics_update["update_time"]:.2f}s ' + "and succeeded.", + **metrics_update, + ) return status_code diff --git a/swh/icinga_plugins/tests/test_deposit.py b/swh/icinga_plugins/tests/test_deposit.py --- a/swh/icinga_plugins/tests/test_deposit.py +++ b/swh/icinga_plugins/tests/test_deposit.py @@ -170,11 +170,38 @@ def test_deposit_immediate_success( requests_mock, mocker, sample_archive, sample_metadata, mocked_time ): + """Both deposit creation and deposit metadata update passed without delays + + """ scenario = WebScenario() + status_xml = status_template( + status="done", + status_detail="", + swhid="swh:1:dir:02ed6084fb0e8384ac58980e07548a547431cf74", + ) + + # Initial deposit scenario.add_step( "post", f"{BASE_URL}/testcol/", ENTRY_TEMPLATE.format(status="done") ) + # Then metadata update + status_xml = status_template( + status="done", + status_detail="", + swhid="swh:1:dir:02ed6084fb0e8384ac58980e07548a547431cf74", + ) + scenario.add_step("get", f"{BASE_URL}/testcol/42/status/", status_xml) + # internal deposit client does call status, then update metadata then status api + scenario.add_step( + "get", f"{BASE_URL}/testcol/42/status/", status_xml, + ) + scenario.add_step( + "put", f"{BASE_URL}/testcol/42/metadata/", status_xml, + ) + scenario.add_step( + "get", f"{BASE_URL}/testcol/42/status/", status_xml, + ) scenario.install_mock(requests_mock) @@ -196,6 +223,9 @@ "| 'total_time' = 0.00s\n" "| 'upload_time' = 0.00s\n" "| 'validation_time' = 0.00s\n" + "DEPOSIT OK - Deposit Metadata update took 0.00s and succeeded.\n" + "| 'total_time' = 0.00s\n" + "| 'update_time' = 0.00s\n" ) assert result.exit_code == 0, f"Unexpected output: {result.output}" @@ -203,6 +233,10 @@ def test_deposit_delays( requests_mock, mocker, sample_archive, sample_metadata, mocked_time ): + """Deposit creation passed with some delays, deposit metadata update passed without + delay + + """ scenario = WebScenario() scenario.add_step( @@ -217,6 +251,23 @@ scenario.add_step( "get", f"{BASE_URL}/testcol/42/status/", status_template(status="done"), ) + # Then metadata update + status_xml = status_template( + status="done", + status_detail="", + swhid="swh:1:dir:02ed6084fb0e8384ac58980e07548a547431cf74", + ) + scenario.add_step("get", f"{BASE_URL}/testcol/42/status/", status_xml) + # internal deposit client does call status, then update metadata then status api + scenario.add_step( + "get", f"{BASE_URL}/testcol/42/status/", status_xml, + ) + scenario.add_step( + "put", f"{BASE_URL}/testcol/42/metadata/", status_xml, + ) + scenario.add_step( + "get", f"{BASE_URL}/testcol/42/status/", status_xml, + ) scenario.install_mock(requests_mock) @@ -238,13 +289,77 @@ "| 'total_time' = 30.00s\n" "| 'upload_time' = 0.00s\n" "| 'validation_time' = 10.00s\n" + "DEPOSIT OK - Deposit Metadata update took 0.00s and succeeded.\n" + "| 'total_time' = 30.00s\n" + "| 'update_time' = 0.00s\n" ) assert result.exit_code == 0, f"Unexpected output: {result.output}" +def test_deposit_then_metadata_update_failed( + requests_mock, mocker, sample_archive, sample_metadata, mocked_time +): + """Deposit creation passed, deposit metadata update failed + + """ + scenario = WebScenario() + + scenario.add_step( + "post", f"{BASE_URL}/testcol/", ENTRY_TEMPLATE.format(status="deposited") + ) + scenario.add_step( + "get", f"{BASE_URL}/testcol/42/status/", status_template(status="verified"), + ) + scenario.add_step( + "get", f"{BASE_URL}/testcol/42/status/", status_template(status="loading"), + ) + scenario.add_step( + "get", f"{BASE_URL}/testcol/42/status/", status_template(status="done"), + ) + # Then metadata update calls + failed_status_xml = status_template( + status="failed", # lying here + status_detail="Failure to ingest", + swhid="swh:1:dir:02ed6084fb0e8384ac58980e07548a547431cf74", + ) + scenario.add_step("get", f"{BASE_URL}/testcol/42/status/", failed_status_xml) + scenario.add_step("get", f"{BASE_URL}/testcol/42/status/", failed_status_xml) + + scenario.install_mock(requests_mock) + + result = invoke( + [ + "check-deposit", + *COMMON_OPTIONS, + "single", + "--archive", + sample_archive, + "--metadata", + sample_metadata, + ], + catch_exceptions=True, + ) + + assert result.output == ( + "DEPOSIT OK - Deposit took 30.00s and succeeded.\n" + "| 'load_time' = 20.00s\n" + "| 'total_time' = 30.00s\n" + "| 'upload_time' = 0.00s\n" + "| 'validation_time' = 10.00s\n" + "DEPOSIT CRITICAL - Deposit Metadata update failed: You can only update " + "metadata on deposit with status 'done' \n" + "| 'total_time' = 30.00s\n" + "| 'update_time' = 0.00s\n" + ) + assert result.exit_code == 2, f"Unexpected output: {result.output}" + + def test_deposit_delay_warning( requests_mock, mocker, sample_archive, sample_metadata, mocked_time ): + """Deposit creation exceeded delays, no deposit update occurred. + + """ scenario = WebScenario() scenario.add_step(