Add/Update unit tests for Azure

This commit updates and creates new tests to make sure the new
implemented exception handlers for retrying on in progress
submission/conflict are properly working.

Assisted-by: Cursor
Signed-off-by: Jonathan Gangi <jgangi@redhat.com>

Author: JAVGan

tests/ms_azure/conftest.py

@@ -91,12 +91,49 @@ def job_details_completed_failure(errors: List[Dict[str, Any]]) -> Dict[str, Any
     return job_details(status="completed", result="failed", errors=errors)
 
 
+@pytest.fixture
+def job_details_completed_conflict(errors_conflict: List[Dict[str, Any]]) -> Dict[str, Any]:
+    return job_details(status="completed", result="failed", errors=errors_conflict)
+
+
+@pytest.fixture
+def job_details_completed_running_submission(
+    errors_running_submission: List[Dict[str, Any]],
+) -> Dict[str, Any]:
+    return job_details(status="completed", result="failed", errors=errors_running_submission)
+
+
 @pytest.fixture
 def errors() -> List[Dict[str, Any]]:
     return [
         {
+            "resourceId": "resource-id",
+            "code": "internalServerError",
+            "message": "A catastrophic error occurred.",
+            "details": [{"code": "invalidResource", "message": "Failure for resource"}],
+        }
+    ]
+
+
+@pytest.fixture
+def errors_running_submission() -> List[Dict[str, Any]]:
+    return [
+        {
+            "resourceId": "resource-id",
+            "code": "internalServerError",
+            "message": "An In Progress submission 1234567890 already exists.",
+            "details": [{"code": "invalidResource", "message": "Failure for resource"}],
+        }
+    ]
+
+
+@pytest.fixture
+def errors_conflict() -> List[Dict[str, Any]]:
+    return [
+        {
+            "resourceId": "resource-id",
             "code": "conflict",
-            "message": "Error message",
+            "message": "The submission cannot be pushed to live as its not the latest submission.",
             "details": [{"code": "invalidResource", "message": "Failure for resource"}],
         }
     ]
@@ -119,6 +156,7 @@ def configure_success_response() -> Dict[str, Any]:
 def configure_failure_response() -> Dict[str, Any]:
     return {
         "error": {
+            "resourceId": "resource-id",
             "code": "badRequest",
             "message": "Invalid configuration: schema validation failed",
             "details": [
@@ -599,3 +637,17 @@ def job_details_completed_failure_obj(
     job_details_completed_failure: Dict[str, Any],
 ) -> ConfigureStatus:
     return ConfigureStatus.from_json(job_details_completed_failure)
+
+
+@pytest.fixture
+def job_details_completed_conflict_obj(
+    job_details_completed_conflict: Dict[str, Any],
+) -> ConfigureStatus:
+    return ConfigureStatus.from_json(job_details_completed_conflict)
+
+
+@pytest.fixture
+def job_details_completed_running_submission_obj(
+    job_details_completed_running_submission: Dict[str, Any],
+) -> ConfigureStatus:
+    return ConfigureStatus.from_json(job_details_completed_running_submission)

tests/ms_azure/test_service.py

@@ -1,7 +1,7 @@
 import json
 import logging
 from copy import deepcopy
-from typing import Any, Dict, List
+from typing import Any, Dict
 from unittest import mock
 
 import pytest
@@ -12,7 +12,7 @@
 from tenacity.stop import stop_after_attempt
 
 from cloudpub.common import BaseService
-from cloudpub.error import InvalidStateError, NotFoundError
+from cloudpub.error import ConflictError, InvalidStateError, NotFoundError, RunningSubmissionError
 from cloudpub.models.ms_azure import (
     ConfigureStatus,
     CustomerLeads,
@@ -213,6 +213,14 @@ def test_wait_for_job_completion_successful_completion(
             assert f"Job {job_id} failed" not in caplog.text
             assert f"Job {job_id} succeeded" in caplog.text
 
+    @pytest.mark.parametrize(
+        "error_name",
+        [
+            "job_details_completed_failure_obj",
+            "job_details_completed_conflict_obj",
+            "job_details_completed_running_submission_obj",
+        ],
+    )
     @mock.patch("cloudpub.ms_azure.utils.is_azure_job_not_complete")
     @mock.patch("cloudpub.ms_azure.AzureService._query_job_details")
     def test_get_job_details_after_failed_completion(
@@ -223,20 +231,26 @@ def test_get_job_details_after_failed_completion(
         caplog: LogCaptureFixture,
         job_details_running_obj: ConfigureStatus,
         job_details_completed_failure_obj: ConfigureStatus,
-        errors: List[Dict[str, Any]],
+        job_details_completed_conflict_obj: ConfigureStatus,
+        job_details_completed_running_submission_obj: ConfigureStatus,
+        error_name: str,
+        request: pytest.FixtureRequest,
     ) -> None:
+
         mock_job_details.side_effect = [
             job_details_running_obj,
             job_details_running_obj,
             job_details_running_obj,
-            job_details_completed_failure_obj,
+            request.getfixturevalue(error_name),
             job_details_running_obj,
         ]
 
         azure_service._wait_for_job_completion.retry.sleep = mock.Mock()  # type: ignore
         job_id = "job_id_111"
         with caplog.at_level(logging.ERROR):
-            with pytest.raises(InvalidStateError) as e_info:
+            with pytest.raises(
+                (InvalidStateError, RunningSubmissionError, ConflictError)
+            ) as e_info:
                 azure_service._wait_for_job_completion(job_id=job_id)
                 assert f"Job {job_id} failed: \n" in str(e_info.value)
             assert mock_job_details.call_count == 4
@@ -858,7 +872,7 @@ def test_publish_preview_success_on_retry(
             None,
             mock.MagicMock(),  # Success on 3rd call
         ]
-        # Remove the retry sleep
+        # Remove the retry sleeptest_publish_preview_fail_on_retry
         azure_service._publish_preview.retry.sleep = mock.Mock()  # type: ignore
 
         # Test
@@ -888,7 +902,18 @@ def test_publish_preview_fail_on_retry(
                 "jobId": "1",
                 "jobStatus": "completed",
                 "jobResult": "failed",
-                "errors": ["failure1", "failure2"],
+                "errors": [
+                    {
+                        "resourceId": "resource-id",
+                        "code": "internalServerError",
+                        "message": "failure1",
+                    },
+                    {
+                        "resourceId": "resource-id",
+                        "code": "internalServerError",
+                        "message": "failure2",
+                    },
+                ],
             }
         )
         mock_is_sbpreview.return_value = False
@@ -898,7 +923,7 @@ def test_publish_preview_fail_on_retry(
         azure_service._publish_preview.retry.sleep = mock.Mock()  # type: ignore
         expected_err = (
             f"Failed to submit the product {product_obj.id} to preview. "
-            "Status: failed Errors: failure1\nfailure2"
+            "Status: failed Errors: internalServerError: failure1\ninternalServerError: failure2"
         )
 
         # Test
@@ -949,7 +974,18 @@ def test_publish_live_fail_on_retry(
                 "jobId": "1",
                 "jobStatus": "completed",
                 "jobResult": "failed",
-                "errors": ["failure1", "failure2"],
+                "errors": [
+                    {
+                        "resourceId": "resource-id",
+                        "code": "internalServerError",
+                        "message": "failure1",
+                    },
+                    {
+                        "resourceId": "resource-id",
+                        "code": "internalServerError",
+                        "message": "failure2",
+                    },
+                ],
             }
         )
         mock_subst.side_effect = [err_resp for _ in range(3)]
@@ -958,7 +994,7 @@ def test_publish_live_fail_on_retry(
         azure_service._publish_live.retry.sleep = mock.Mock()  # type: ignore
         expected_err = (
             f"Failed to submit the product {product_obj.id} to live. "
-            "Status: failed Errors: failure1\nfailure2"
+            "Status: failed Errors: internalServerError: failure1\ninternalServerError: failure2"
         )
 
         # Test

tests/ms_azure/test_utils.py

@@ -15,6 +15,8 @@
 )
 from cloudpub.ms_azure.utils import (
     AzurePublishingMetadata,
+    check_for_conflict,
+    check_for_running_submission,
     create_disk_version_from_scratch,
     get_image_type_mapping,
     is_azure_job_not_complete,
@@ -580,3 +582,76 @@ def test_create_disk_version_from_scratch_arm64(
         res.vm_images = sorted(res.vm_images, key=attrgetter("image_type"))
 
         assert res == disk_version_arm64_obj
+
+    @pytest.mark.parametrize(
+        "error,expected_result",
+        [
+            (
+                {
+                    "code": "conflict",
+                    "message": "The submission cannot be pushed to live as its not the latest submission.",  # noqa: E501
+                },
+                True,
+            ),
+            (
+                {
+                    "code": "internalServerError",
+                    "message": "An In Progress submission 1234567890 already exists.",
+                },
+                False,
+            ),
+            (
+                {
+                    "code": "unknownError",
+                    "message": "An In Progress submission 1234567890 already exists.",
+                },
+                False,
+            ),
+            ({"code": "conflict", "message": "Something else happened"}, False),
+        ],
+    )
+    def test_check_for_conflict(self, error: Dict[str, Any], expected_result: bool) -> None:
+        err_obj = ConfigureStatus.from_json(
+            {
+                "jobId": "1",
+                "jobStatus": "completed",
+                "jobResult": "failed",
+                "errors": [error],
+            }
+        )
+        assert err_obj
+        assert check_for_conflict(err_obj) == expected_result
+
+    @pytest.mark.parametrize(
+        "error,expected_result",
+        [
+            (
+                {
+                    "code": "internalServerError",
+                    "message": "An In Progress submission 1234567890 already exists.",
+                },
+                True,
+            ),
+            (
+                {
+                    "code": "unknownError",
+                    "message": "An In Progress submission 1234567890 already exists.",
+                },
+                False,
+            ),
+            ({"code": "conflict", "message": "Something else happened"}, False),
+        ],
+    )
+    def test_check_for_running_submission(
+        self, error: Dict[str, Any], expected_result: bool
+    ) -> None:
+        err_obj = ConfigureStatus.from_json(
+            {
+                "jobId": "1",
+                "jobStatus": "completed",
+                "jobResult": "failed",
+                "errors": [error],
+            }
+        )
+        assert err_obj
+        assert check_for_running_submission(err_obj) == expected_result