Merge pull request #14 from release-engineering/azure_wait_publish

Azure: Wait to publish during publish collision

Author: JAVGan

Diff for: cloudpub/ms_azure/service.py

@@ -440,10 +440,18 @@ def submit_to_status(self, product_id: str, status: str) -> ConfigureStatus:
 
         return self.configure(resource=submission)
 
+    @retry(
+        wait=wait_fixed(300),
+        stop=stop_after_delay(max_delay=60 * 60 * 24 * 7),  # Give up after retrying for 7 days,
+        reraise=True,
+    )
     def ensure_can_publish(self, product_id: str) -> None:
         """
         Ensure the offer is not already being published.
 
+        It will wait for up to 7 days retrying to make sure it's possible to publish before
+        giving up and raising.
+
         Args:
             product_id (str)
                 The product ID to check the offer's publishing status

Diff for: tests/ms_azure/test_service.py

@@ -8,6 +8,7 @@
 from httmock import response
 from requests import Response
 from requests.exceptions import HTTPError
+from tenacity.stop import stop_after_attempt
 
 from cloudpub.common import BaseService
 from cloudpub.error import InvalidStateError, NotFoundError
@@ -730,6 +731,8 @@ def test_ensure_can_publish_success(
             "created": "2024-07-04T22:06:16.2895521Z",
         }
         mock_getsubst.return_value = ProductSubmission.from_json(submission)
+        azure_service.ensure_can_publish.retry.sleep = mock.MagicMock()  # type: ignore
+        azure_service.ensure_can_publish.retry.stop = stop_after_attempt(1)  # type: ignore
 
         azure_service.ensure_can_publish("ffffffff-ffff-ffff-ffff-ffffffffffff")
 
@@ -741,6 +744,48 @@ def test_ensure_can_publish_success(
             ]
         )
 
+    @pytest.mark.parametrize("target", ["preview", "live"])
+    @mock.patch("cloudpub.ms_azure.AzureService.get_submission_state")
+    def test_ensure_can_publish_success_after_retry(
+        self,
+        mock_getsubst: mock.MagicMock,
+        target: str,
+        azure_service: AzureService,
+    ) -> None:
+        running = {
+            "$schema": "https://product-ingestion.azureedge.net/schema/submission/2022-03-01-preview2",  # noqa: E501
+            "id": "submission/ffffffff-ffff-ffff-ffff-ffffffffffff/0",
+            "product": "product/ffffffff-ffff-ffff-ffff-ffffffffffff",
+            "target": {"targetType": target},
+            "lifecycleState": "generallyAvailable",
+            "status": "running",
+            "result": "pending",
+            "created": "2024-07-04T22:06:16.2895521Z",
+        }
+        complete = {
+            "$schema": "https://product-ingestion.azureedge.net/schema/submission/2022-03-01-preview2",  # noqa: E501
+            "id": "submission/ffffffff-ffff-ffff-ffff-ffffffffffff/0",
+            "product": "product/ffffffff-ffff-ffff-ffff-ffffffffffff",
+            "target": {"targetType": target},
+            "lifecycleState": "generallyAvailable",
+            "status": "completed",
+            "result": "succeeded",
+            "created": "2024-07-04T22:06:16.2895521Z",
+        }
+        mock_getsubst.side_effect = [
+            ProductSubmission.from_json(running),
+            ProductSubmission.from_json(running),
+            ProductSubmission.from_json(complete),
+            ProductSubmission.from_json(complete),
+        ]
+        azure_service.ensure_can_publish.retry.sleep = mock.MagicMock()  # type: ignore
+        azure_service.ensure_can_publish.retry.stop = stop_after_attempt(3)  # type: ignore
+
+        azure_service.ensure_can_publish("ffffffff-ffff-ffff-ffff-ffffffffffff")
+
+        # Calls for "live" and "preview" for 2 times before success == 4
+        assert mock_getsubst.call_count == 4
+
     @pytest.mark.parametrize("target", ["preview", "live"])
     @mock.patch("cloudpub.ms_azure.AzureService.get_submission_state")
     def test_ensure_can_publish_raises(
@@ -782,6 +827,8 @@ def test_ensure_can_publish_raises(
         err = (
             f"The offer ffffffff-ffff-ffff-ffff-ffffffffffff is already being published to {target}"
         )
+        azure_service.ensure_can_publish.retry.sleep = mock.MagicMock()  # type: ignore
+        azure_service.ensure_can_publish.retry.stop = stop_after_attempt(1)  # type: ignore
 
         with pytest.raises(RuntimeError, match=err):
             azure_service.ensure_can_publish("ffffffff-ffff-ffff-ffff-ffffffffffff")