Adds ability to handle error messages that are URLs.

Author: jajreidy

cloudpub/aws/service.py

@@ -11,10 +11,13 @@
 from tenacity.wait import wait_fixed
 
 from cloudpub.aws.utils import (
+    convert_error_list_str,
     create_version_tree,
     get_restricted_major_versions,
     get_restricted_minor_versions,
     get_restricted_patch_versions,
+    get_text_url,
+    is_str_url,
     pprint_debug_logging,
 )
 from cloudpub.common import BaseService, PublishingMetadata
@@ -386,8 +389,15 @@ def check_publish_status(self, change_set_id: str) -> str:
             # the first one should be the one we want.
             failure_list = rsp.change_set[0].error_details
             pprint_debug_logging(log, rsp, "The response from the status was: ")
+            # Check if message is a URL and download the message.
+            added_messages = []
+            for failure in failure_list:
+                if is_str_url(failure.message):
+                    added_messages.extend(get_text_url(failure.message))
+            failure_list.extend(added_messages)
+            error_list_str = convert_error_list_str(failure_list)
             error_message = (
-                f"Changeset {change_set_id} failed with code {failure_code}: \n {failure_list}"
+                f"Changeset {change_set_id} failed with code {failure_code}: \n {error_list_str}"
             )
             self._raise_error(InvalidStateError, error_message)
 

cloudpub/aws/utils.py

@@ -1,12 +1,15 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
+import json
 import logging
+import re
 from pprint import pformat
 from typing import Any, Dict, List, Mapping, Tuple
 
 import dateutil.parser
+import requests
 from packaging.version import InvalidVersion, Version
 
-from cloudpub.models.aws import GroupedVersions
+from cloudpub.models.aws import ErrorDetail, GroupedVersions
 
 
 def create_version_tree(versions: Dict[str, GroupedVersions]) -> Dict[str, Any]:
@@ -141,3 +144,52 @@ def pprint_debug_logging(
     """
     if log.isEnabledFor(logging.DEBUG):
         log.debug("%s\n%s", log_tag, pformat(rsp_log))
+
+
+def is_str_url(url_str: str) -> bool:
+    """
+    Check if string is a URL.
+
+    Args:
+        url_str (str)
+            A string represenation of a URL.
+    Returns:
+        Bool
+    """
+    pattern = r"^https:\/\/[0-9A-z.]+.[0-9A-z.]+.[a-z]+$"
+    result = re.match(pattern, url_str)
+    return result
+
+
+def get_text_url(url: str) -> List[ErrorDetail]:
+    """
+    Get text from remote URL.
+
+    Args:
+        url (str)
+            The url that the messsage is stored at.
+    Returns:
+        List[ErrorDetail]
+    """
+    resp = requests.get(url)
+    data = json.loads(resp.text)
+    error_list = []
+    for e in data:
+        error_list.append(ErrorDetail.from_json(e))
+    return error_list
+
+
+def convert_error_list_str(error_list: List[ErrorDetail]) -> List[Dict[str, Any]]:
+    """
+    Convert a list of ErrorDetail to json str.
+
+    Args:
+        error_list (List[ErrorDetail])
+            A list of ErrorDetails.
+    Returns:
+        List[Dict[str, Any]]
+    """
+    error_str_list = []
+    for e in error_list:
+        error_str_list.append(e.to_json())
+    return error_str_list

tests/aws/test_service.py

@@ -6,6 +6,7 @@
 
 import pytest
 from _pytest.logging import LogCaptureFixture
+from httmock import HTTMock, urlmatch
 
 from cloudpub.aws import AWSProductService, AWSVersionMetadata
 from cloudpub.error import InvalidStateError, NotFoundError, Timeout
@@ -477,6 +478,43 @@ def test_check_publish_status_failed(
         with pytest.raises(InvalidStateError):
             _ = aws_service.check_publish_status("fake-change-set-id")
 
+    def test_check_publish_status_failed_url(
+        self, mock_describe_change_set: mock.MagicMock, aws_service: AWSProductService
+    ) -> None:
+        @urlmatch(netloc=r'(.*\.)?fake\.com$')
+        def request_mock(url, request):
+            error_list = [{"ErrorCode": "EOL", "ErrorMessage": "some text"}]
+            return json.dumps(error_list)
+
+        failure_list = [
+            {
+                "ErrorCode": "SCAN_ERROR",
+                "ErrorMessage": "https://www.fake.com/error-message",
+            }
+        ]
+        change_set = [
+            {
+                "ChangeType": "RestrictDeliveryOptions",
+                "Details": r"{}",
+                "ErrorDetailList": failure_list,
+            }
+        ]
+        ret = {
+            "ChangeSetId": "change",
+            "ChangeSetArn": "fake-arn",
+            "Status": "Failed",
+            "FailureCode": "fake-code",
+            "ChangeSet": change_set,
+            "StartTime": "fake-start-time",
+            "EndTime": "fake-end-time",
+        }
+        mock_describe_change_set.return_value = ret
+        with HTTMock(request_mock):
+            with pytest.raises(InvalidStateError) as error:
+                aws_service.check_publish_status("fake-change-set-id")
+            assert "https://www.fake.com/error-message" in str(error)
+            assert "EOL" in str(error)
+
     def test_wait_for_changeset(
         self, mock_describe_change_set: mock.MagicMock, aws_service: AWSProductService
     ) -> None: