cloudpub 1.6.0__py3-none-any.whl → 1.7.0__py3-none-any.whl

cloudpub/error.py

@@ -21,5 +21,9 @@ class NotFoundError(ValueError):
     """Represent a missing resource."""
 
 
+class ConflictError(RuntimeError):
+    """Report a submission conflict error."""
+
+
 class Timeout(Exception):
     """Represent a missing resource."""

cloudpub/models/ms_azure.py

@@ -711,11 +711,21 @@ class ProductProperty(AzureProductLinkedResource):
     `Schema definition for ProductProperty <https://schema.mp.microsoft.com/schema/property/2022-03-01-preview2>`_
     """  # noqa E501
 
+    schema: str = field(
+        validator=instance_of(str),
+        metadata={
+            "alias": MS_SCHEMA,
+            "const": "https://schema.mp.microsoft.com/schema/property/2022-03-01-preview2",
+        },
+    )
+    """
+    The `resource schema`_ for Graph API."""
+
     kind: str
     """Expected to be ``azureVM``"""
 
     terms_of_use: Optional[str] = field(
-        validator=optional(instance_of(str)), metadata={"alias": "termsOfUse"}
+        validator=optional(instance_of(str)), metadata={"alias": "termsOfUseUrl"}
     )
     """The product terms of use."""
 

cloudpub/ms_azure/service.py

@@ -7,13 +7,13 @@ from typing import Any, Dict, Iterator, List, Optional, Tuple, Union, cast
 
 from deepdiff import DeepDiff
 from requests import HTTPError
-from tenacity import retry
-from tenacity.retry import retry_if_result
+from tenacity import RetryError, Retrying, retry
+from tenacity.retry import retry_if_exception_type, retry_if_result
 from tenacity.stop import stop_after_attempt, stop_after_delay
-from tenacity.wait import wait_chain, wait_fixed
+from tenacity.wait import wait_fixed
 
 from cloudpub.common import BaseService
-from cloudpub.error import InvalidStateError, NotFoundError
+from cloudpub.error import ConflictError, InvalidStateError, NotFoundError, Timeout
 from cloudpub.models.ms_azure import (
     RESOURCE_MAPING,
     AzureResource,
@@ -92,18 +92,31 @@ class AzureService(BaseService[AzurePublishingMetadata]):
     CONFIGURE_SCHEMA = "https://schema.mp.microsoft.com/schema/configure/{AZURE_API_VERSION}"
     DIFF_EXCLUDES = [r"root\['resources'\]\[[0-9]+\]\['url'\]"]
 
-    def __init__(self, credentials: Dict[str, str]):
+    def __init__(
+        self,
+        credentials: Dict[str, str],
+        retry_interval: Union[int, float] = 300,
+        retry_timeout: Union[int, float] = 3600 * 24 * 7,
+    ):
         """
         Create a new AuzureService object.
 
         Args:
             credentials (dict)
                 Dictionary with Azure credentials to authenticate on Product Ingestion API.
+            retry_interval (int, float)
+                The wait time interval in seconds for retrying jobs.
+                Defaults to 300
+            retry_timeout (int, float)
+                The max time in seconds to attempt retries.
+                Defaults to 7 days.
         """
         self.session = PartnerPortalSession.make_graph_api_session(
             auth_keys=credentials, schema_version=self.AZURE_SCHEMA_VERSION
         )
         self._products: List[ProductSummary] = []
+        self.retry_interval = retry_interval
+        self.retry_timeout = retry_timeout
 
     def _configure(self, data: Dict[str, Any]) -> ConfigureStatus:
         """
@@ -162,15 +175,27 @@ class AzureService(BaseService[AzurePublishingMetadata]):
         log.debug("Query Job details response: %s", parsed_resp)
         return parsed_resp
 
-    @retry(
-        retry=retry_if_result(predicate=is_azure_job_not_complete),
-        wait=wait_chain(
-            *[wait_fixed(wait=60)]  # First wait for 1 minute  # noqa: W503
-            + [wait_fixed(wait=10 * 60)]  # Then wait for 10 minutes  # noqa: W503
-            + [wait_fixed(wait=30 * 60)]  # Finally wait each 30 minutes  # noqa: W503
-        ),
-        stop=stop_after_delay(max_delay=60 * 60 * 24 * 7),  # Give up after retrying for 7 days
-    )
+    def query_job_status(self, job_id: str) -> ConfigureStatus:
+        """Query the job status for a given Job ID.
+
+        It will raise error if any invalid state is detected.
+
+        Args:
+            job_id (str): The job ID to query details from.
+
+        Returns:
+            ConfigureStatus: The ConfigureStatus from JobID
+        Raises:
+            InvalidStateError: If the job has failed.
+        """
+        job_details = self._query_job_details(job_id=job_id)
+        if job_details.job_result == "failed":
+            error_message = f"Job {job_id} failed: \n{job_details.errors}"
+            self._raise_error(InvalidStateError, error_message)
+        elif job_details.job_result == "succeeded":
+            log.debug("Job %s succeeded", job_id)
+        return job_details
+
     def _wait_for_job_completion(self, job_id: str) -> ConfigureStatus:
         """
         Wait until the specified job ID is complete.
@@ -189,13 +214,15 @@ class AzureService(BaseService[AzurePublishingMetadata]):
         Raises:
             InvalidStateError if the job failed
         """
-        job_details = self._query_job_details(job_id=job_id)
-        if job_details.job_result == "failed":
-            error_message = f"Job {job_id} failed: \n{job_details.errors}"
-            self._raise_error(InvalidStateError, error_message)
-        elif job_details.job_result == "succeeded":
-            log.debug("Job %s succeeded", job_id)
-        return job_details
+        r = Retrying(
+            retry=retry_if_result(predicate=is_azure_job_not_complete),
+            wait=wait_fixed(self.retry_interval),
+            stop=stop_after_delay(max_delay=self.retry_timeout),
+        )
+        try:
+            return r(self.query_job_status, job_id)
+        except RetryError:
+            self._raise_error(Timeout, f"Time out waiting for job {job_id}")
 
     def configure(self, resources: List[AzureResource]) -> ConfigureStatus:
         """
@@ -437,6 +464,21 @@ class AzureService(BaseService[AzurePublishingMetadata]):
         remote = self.get_product(product.id, target=target)
         return DeepDiff(remote.to_json(), product.to_json(), exclude_regex_paths=self.DIFF_EXCLUDES)
 
+    def diff_two_offers(self, last_offer: Product, prev_offer: Product) -> DeepDiff:
+        """Compute the difference between two provided products.
+
+        Args:
+            last_offer (Product)
+                The lastest offer state to diff
+            prev_offer (Product)
+                The previous offer state to diff
+        Returns:
+            DeepDiff: The diff data.
+        """
+        return DeepDiff(
+            prev_offer.to_json(), last_offer.to_json(), exclude_regex_paths=self.DIFF_EXCLUDES
+        )
+
     def submit_to_status(
         self, product_id: str, status: str, resources: Optional[List[AzureResource]] = None
     ) -> ConfigureStatus:
@@ -477,31 +519,48 @@ class AzureService(BaseService[AzurePublishingMetadata]):
         log.debug("Set the status \"%s\" to submission.", status)
         return self.configure(resources=cfg_res)
 
-    @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.
+        It will raise ConflictError if a publish is already in progress in any submission target.
 
         Args:
             product_id (str)
                 The product ID to check the offer's publishing status
         Raises:
-            RuntimeError: whenever a publishing is already in progress.
+            ConflictError: whenever a publishing is already in progress for any submission target.
         """
         log.info("Ensuring no other publishing jobs are in progress for \"%s\"", product_id)
-        submission_targets = ["preview", "live"]
 
-        for target in submission_targets:
-            sub = self.get_submission_state(product_id, state=target)
-            if sub and sub.status and sub.status == "running":
-                raise RuntimeError(f"The offer {product_id} is already being published to {target}")
+        for sub in self.get_submissions(product_id):
+            if sub and sub.status and sub.status != "completed":
+                msg = (
+                    f"The offer {product_id} is already being published to "
+                    f"{sub.target.targetType}: {sub.status}/{sub.result}"
+                )
+                log.error(msg)
+                raise ConflictError(msg)
+
+    def wait_active_publishing(self, product_id: str) -> None:
+        """
+        Wait when there's an existing submission in progress.
+
+        Args:
+            product_id (str)
+                The product ID of to verify the submissions state.
+        """
+        r = Retrying(
+            retry=retry_if_exception_type(ConflictError),
+            wait=wait_fixed(self.retry_interval),
+            stop=stop_after_delay(max_delay=self.retry_timeout),
+        )
+        log.info("Checking for active changes on %s.", product_id)
+
+        try:
+            r(self.ensure_can_publish, product_id)
+        except RetryError:
+            self._raise_error(Timeout, f"Timed out waiting for {product_id} to be unlocked")
 
     def get_plan_tech_config(self, product: Product, plan: PlanSummary) -> VMIPlanTechConfig:
         """
@@ -548,14 +607,13 @@ class AzureService(BaseService[AzurePublishingMetadata]):
         # The following resources shouldn't be required:
         # -> customer-leads
         # -> test-drive
-        # -> property
         # -> *listing*
         # -> reseller
         # -> price-and-availability-*
         # NOTE: The "submission" resource will be already added by the "submit_to_status" method
         #
-        # With that it needs only the related "product" and "plan" resources alongisde the
-        # updated tech_config
+        # With that it needs only the related "product", "property" and "plan" resources alongisde
+        # the updated tech_config
         product_id = tech_config.product_id
         plan_id = tech_config.plan_id
         prod_res = cast(
@@ -566,6 +624,14 @@ class AzureService(BaseService[AzurePublishingMetadata]):
                 if prd.id == product_id
             ],
         )[0]
+        property = cast(
+            List[ProductProperty],
+            [
+                prop
+                for prop in self.filter_product_resources(product=product, resource="property")
+                if prop.product_id == product_id  # type: ignore [union-attr]
+            ],
+        )[0]
         plan_res = cast(
             List[PlanSummary],
             [
@@ -574,7 +640,7 @@ class AzureService(BaseService[AzurePublishingMetadata]):
                 if pln.id == plan_id
             ],
         )[0]
-        return [prod_res, plan_res, tech_config]
+        return [prod_res, property, plan_res, tech_config]
 
     def compute_targets(self, product_id: str) -> List[str]:
         """List all the possible publishing targets order to seek data from Azure.
@@ -815,6 +881,7 @@ class AzureService(BaseService[AzurePublishingMetadata]):
         plan_name = metadata.destination.split("/")[-1]
         product_id = self.get_productid(product_name)
         sas_in_target = SasFoundStatus.missing
+        self.wait_active_publishing(product_id=product_id)
         log.info(
             "Preparing to associate the image \"%s\" with the plan \"%s\" from product \"%s\"",
             metadata.image_path,

cloudpub/ms_azure/utils.py

@@ -1,7 +1,7 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 import logging
 from operator import attrgetter
-from typing import Any, Dict, List, Optional, Tuple, TypedDict
+from typing import Any, Dict, List, Optional, TypedDict
 
 from deepdiff import DeepDiff
 
@@ -241,56 +241,6 @@ def is_legacy_gen_supported(metadata: AzurePublishingMetadata) -> bool:
     return metadata.architecture == "x64" and metadata.support_legacy
 
 
-def prepare_vm_images(
-    metadata: AzurePublishingMetadata,
-    gen1: Optional[VMImageDefinition],
-    gen2: Optional[VMImageDefinition],
-    source: VMImageSource,
-) -> List[VMImageDefinition]:
-    """
-    Update the vm_images list with the proper SAS based in existing generation(s).
-
-    Args:
-        metadata (AzurePublishingMetadata)
-            The VHD publishing metadata.
-        gen1 (VMImageDefinition, optional)
-            The VMImageDefinition for Gen1 VHD.
-            If not set the argument `gen2` must be set.
-        gen2 (VMImageDefinition, optional)
-            The VMImageDefinition for Gen2 VHD.
-            If not set the argument `gen1` must be set.
-        source (VMImageSource):
-            The VMImageSource with the updated SAS URI.
-    Returns:
-        list: A new list containing the expected VMImageDefinition(s)
-    """
-    if not gen1 and not gen2:
-        msg = "At least one argument of \"gen1\" or \"gen2\" must be set."
-        log.error(msg)
-        raise ValueError(msg)
-
-    raw_source = source.to_json()
-    json_gen1 = {
-        "imageType": get_image_type_mapping(metadata.architecture, "V1"),
-        "source": raw_source,
-    }
-    json_gen2 = {
-        "imageType": get_image_type_mapping(metadata.architecture, "V2"),
-        "source": raw_source,
-    }
-
-    if metadata.generation == "V2":
-        # In this case we need to set a V2 SAS URI
-        gen2_new = VMImageDefinition.from_json(json_gen2)
-        if is_legacy_gen_supported(metadata):  # and in this case a V1 as well
-            gen1_new = VMImageDefinition.from_json(json_gen1)
-            return [gen2_new, gen1_new]
-        return [gen2_new]
-    else:
-        # It's expected to be a Gen1 only, let's get rid of Gen2
-        return [VMImageDefinition.from_json(json_gen1)]
-
-
 def _all_skus_present(old_skus: List[VMISku], disk_versions: List[DiskVersion]) -> bool:
     image_types = set()
     for sku in old_skus:
@@ -485,47 +435,6 @@ def seek_disk_version(
     return None
 
 
-def vm_images_by_generation(
-    disk_version: DiskVersion, architecture: str
-) -> Tuple[Optional[VMImageDefinition], ...]:
-    """
-    Return a tuple containing the Gen1 and Gen2 VHD images in this order.
-
-    If one of the images doesn't exist it will return None in the expected tuple position.
-
-    Args:
-        disk_version
-            The disk version to retrieve the VMImageDefinitions from
-        architecture
-            The expected architecture for the VMImageDefinition.
-    Returns:
-        Gen1 and Gen2 VMImageDefinitions when they exist.
-    """
-    log.debug("Sorting the VMImageDefinition by generation.")
-    # Here we have 3 possibilities:
-    # 1. vm_images => "Gen1" only
-    # 2. vm_images => "Gen2" only
-    # 3. vm_images => "Gen1" and "Gen2"
-
-    # So let's get the first image whatever it is
-    img = disk_version.vm_images.pop(0)
-
-    # If first `img` is Gen2 we set the other one as `img_legacy`
-    if img.image_type == get_image_type_mapping(architecture, "V2"):
-        img_legacy = disk_version.vm_images.pop(0) if len(disk_version.vm_images) > 0 else None
-
-    else:  # Otherwise we set it as `img_legacy` and get the gen2
-        img_legacy = img
-        img = (
-            disk_version.vm_images.pop(0)  # type: ignore
-            if len(disk_version.vm_images) > 0
-            else None
-        )
-    log.debug("Image for current generation: %s", img)
-    log.debug("Image for legacy generation: %s", img_legacy)
-    return img, img_legacy
-
-
 def create_vm_image_definitions(
     metadata: AzurePublishingMetadata, source: VMImageSource
 ) -> List[VMImageDefinition]:
@@ -580,21 +489,41 @@ def set_new_sas_disk_version(
     # If we already have a VMImageDefinition let's use it
     if disk_version.vm_images:
         log.debug("The DiskVersion \"%s\" contains inner images.", disk_version.version_number)
-        img, img_legacy = vm_images_by_generation(disk_version, metadata.architecture)
-
-        # Now we replace the SAS URI for the vm_images
         log.info(
             "Adjusting the VMImages from existing DiskVersion \"%s\""
-            "to fit the new image with SAS \"%s\".",
+            " to fit the new image with SAS \"%s\".",
             disk_version.version_number,
             metadata.image_path,
         )
-        disk_version.vm_images = prepare_vm_images(
-            metadata=metadata,
-            gen1=img_legacy,
-            gen2=img,
-            source=source,
-        )
+        # Verify whether the arch is present for the new image
+        is_arch_present = False
+        # If the arch is present, update the SAS URI
+        for img in disk_version.vm_images:
+            if (
+                img.image_type == get_image_type_mapping(metadata.architecture, metadata.generation)
+            ) or (
+                metadata.support_legacy
+                and img.image_type == get_image_type_mapping(metadata.architecture, "V1")  # noqa
+            ):
+                is_arch_present = True
+                img.source.os_disk.uri = source.os_disk.uri
+
+        # If the arch is not present, add it to the DiskVersion
+        if not is_arch_present:
+            if metadata.support_legacy:
+                disk_version.vm_images.append(
+                    VMImageDefinition(
+                        image_type=get_image_type_mapping(metadata.architecture, "V1"),
+                        source=source.to_json(),
+                    )
+                )
+            disk_version.vm_images.append(
+                VMImageDefinition(
+                    image_type=get_image_type_mapping(metadata.architecture, metadata.generation),
+                    source=source.to_json(),
+                )
+            )
+        return disk_version
 
     # If no VMImages, we need to create them from scratch
     else:

{cloudpub-1.6.0.dist-info → cloudpub-1.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: cloudpub
-Version: 1.6.0
+Version: 1.7.0
 Summary: Services for publishing products in cloud environments
 Home-page: https://github.com/release-engineering/cloudpub
 Author: Jonathan Gangi
@@ -19,4 +19,12 @@ Requires-Dist: requests
 Requires-Dist: tenacity
 Requires-Dist: packaging
 Requires-Dist: boto3>=1.34.117
-
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary

{cloudpub-1.6.0.dist-info → cloudpub-1.7.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
 cloudpub/__init__.py,sha256=OcXNPwjDybWtcxAL0IhFtKiMErHP4xugUgpMKPbpYGM,44
 cloudpub/common.py,sha256=fnMEVyf4M4hV2MGFKv59wy4C591jp6kji_sq0T6MRlA,3990
-cloudpub/error.py,sha256=5rMBJ3pPcbG92swnDlMtIKDVw60FeW37vFHcu58trcI,578
+cloudpub/error.py,sha256=Tof439r4Ei2mM-BnP1zI1sC2IBzUpbhFd2xIZdyg_k8,661
 cloudpub/utils.py,sha256=HTFVlYOb7nTw6BTTv_migod7cQMXzpSlBzsC8aCfQdQ,1097
 cloudpub/aws/__init__.py,sha256=bQbgPTq-S3IrUkZpBNAZ6-2FQ3KiRg87Al5muXh8pmc,117
 cloudpub/aws/service.py,sha256=h-nsTE1mldjQD1nqlUCX0OQiAwnDTVJlI92X13fK8GU,19337
@@ -8,13 +8,13 @@ cloudpub/aws/utils.py,sha256=qlZ9R7J8AArR3tFYW47cJ0dgdqYc7kPJUEn24HtzeGI,6453
 cloudpub/models/__init__.py,sha256=OcXNPwjDybWtcxAL0IhFtKiMErHP4xugUgpMKPbpYGM,44
 cloudpub/models/aws.py,sha256=arzFqLmFw8O9Otk_VatLR5dmQ9FsdWT3f0Ibap7EW0o,42850
 cloudpub/models/common.py,sha256=iZ503VVFL9y0P_wXiK0f3flXV32VWBs9i-9NoYfJZUg,4970
-cloudpub/models/ms_azure.py,sha256=nzTp9IvAW-WEJuN20IAc93yY6YPHCTE0j116EfQUsPg,55974
+cloudpub/models/ms_azure.py,sha256=f-r6Fic5zFyOGIZHUe1BK2iK7dzjXK1rqsZjn3Xvr5M,56252
 cloudpub/ms_azure/__init__.py,sha256=eeYXPd_wzDBmh0Hmzd5o4yzocFzM6n4r8qpCDy00kYk,117
-cloudpub/ms_azure/service.py,sha256=ySc3ktibNhMw-ZvTgTIB1EZjliYu0OYSBi8sRBlpslg,36250
+cloudpub/ms_azure/service.py,sha256=izO6vrC-xEYpnUrxMDmMo9ZKlUoAGtK4EmN6o_2dPWc,38634
 cloudpub/ms_azure/session.py,sha256=PXCSJ1dFkx43lQV0WFPnRxbpyOBccdtrMiWGPORT3Ro,6356
-cloudpub/ms_azure/utils.py,sha256=goADEmIZBFuIDG5sH9dAZed_EWIUWUAtjzDTw9HyNsI,21512
-cloudpub-1.6.0.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-cloudpub-1.6.0.dist-info/METADATA,sha256=bXsSCTG8RdWlsD5SjlqYrWgxsOQKOL5bRwk-fVVVP6Y,754
-cloudpub-1.6.0.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-cloudpub-1.6.0.dist-info/top_level.txt,sha256=YnnJuTiWBpRI9zMkYUVcZNuvjzzJYblASj-7Q8m3Gzg,9
-cloudpub-1.6.0.dist-info/RECORD,,
+cloudpub/ms_azure/utils.py,sha256=pYDcpSuL-FDLbXANakTY7M70hARGAjQ3rVPLZbCRjo4,19180
+cloudpub-1.7.0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+cloudpub-1.7.0.dist-info/METADATA,sha256=ObxvkEd-CxzYbntbKDR2vW9hfgLntBxNtZWj3uHAJZY,927
+cloudpub-1.7.0.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
+cloudpub-1.7.0.dist-info/top_level.txt,sha256=YnnJuTiWBpRI9zMkYUVcZNuvjzzJYblASj-7Q8m3Gzg,9
+cloudpub-1.7.0.dist-info/RECORD,,

{cloudpub-1.6.0.dist-info → cloudpub-1.7.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.45.1)
+Generator: setuptools (79.0.1)
 Root-Is-Purelib: true
 Tag: py3-none-any