Azure: log the target name from get_product_plan_by_name

This commit changes `get_product_plan_by_name` to return the target of
the product and plan whenever these are found.

It also changes the `publish` method to log the target from
`get_product_plan_by_name`.

Refers to SPSTRAT-583

Signed-off-by: Jonathan Gangi <[email protected]>

Author: JAVGan

cloudpub/ms_azure/service.py

@@ -378,15 +378,15 @@ def get_plan_by_name(self, product: Product, plan_name: str) -> PlanSummary:
 
     def get_product_plan_by_name(
         self, product_name: str, plan_name: str
-    ) -> Tuple[Product, PlanSummary]:
+    ) -> Tuple[Product, PlanSummary, str]:
         """Return a tuple with the desired Product and Plan after iterating over all targets.
 
         Args:
             product_name (str): The name of the product to search for
             plan_name (str): The name of the plan to search for
 
         Returns:
-            Tuple[Product, PlanSummary]: The Product and PlanSummary when fonud
+            Tuple[Product, PlanSummary, str]: The Product, PlanSummary and target when fonud
         Raises:
             NotFoundError whenever all targets are exhausted and no information was found
         """
@@ -396,7 +396,7 @@ def get_product_plan_by_name(
             try:
                 product = self.get_product_by_name(product_name, first_target=tgt)
                 plan = self.get_plan_by_name(product, plan_name)
-                return product, plan
+                return product, plan, tgt
             except NotFoundError:
                 continue
         self._raise_error(
@@ -605,16 +605,17 @@ def publish(self, metadata: AzurePublishingMetadata) -> None:
         #   "product-name/plan-name"
         product_name = metadata.destination.split("/")[0]
         plan_name = metadata.destination.split("/")[-1]
-        product, plan = self.get_product_plan_by_name(product_name, plan_name)
+        product, plan, tgt = self.get_product_plan_by_name(product_name, plan_name)
         log.info(
-            "Preparing to associate the image \"%s\" with the plan \"%s\" from product \"%s\"",
+            "Preparing to associate the image \"%s\" with the plan \"%s\" from product \"%s\" on \"%s\"",  # noqa: E501
             metadata.image_path,
             plan_name,
             product_name,
+            tgt,
         )
 
         # 2. Retrieve the VM Technical configuration for the given plan
-        log.info("Retrieving the technical config for \"%s\".", metadata.destination)
+        log.info("Retrieving the technical config for \"%s\" on \"%s\".", metadata.destination, tgt)
         tech_config = self.get_plan_tech_config(product, plan)
 
         # 3. Prepare the Disk Version
@@ -627,8 +628,9 @@ def publish(self, metadata: AzurePublishingMetadata) -> None:
         disk_version = None  # just to make mypy happy
         if metadata.overwrite is True:
             log.warning(
-                "Overwriting the plan \"%s\" with the given image: \"%s\".",
+                "Overwriting the plan \"%s\" on \"%s\" with the given image: \"%s\".",
                 plan_name,
+                tgt,
                 metadata.image_path,
             )
             disk_version = create_disk_version_from_scratch(metadata, source)
@@ -639,18 +641,20 @@ def publish(self, metadata: AzurePublishingMetadata) -> None:
             # Here we can have the metadata.disk_version set or empty.
             # When set we want to get the existing disk_version which matches its value.
             log.info(
-                "Scanning the disk versions from \"%s\" for the image \"%s\"",
+                "Scanning the disk versions from \"%s\" on \"%s\" for the image \"%s\"",
                 metadata.destination,
+                tgt,
                 metadata.image_path,
             )
             disk_version = seek_disk_version(tech_config, metadata.disk_version)
 
             # Check the images of the selected DiskVersion if it exists
             if disk_version:
                 log.info(
-                    "DiskVersion \"%s\" exists in \"%s\" for the image \"%s\".",
+                    "DiskVersion \"%s\" exists in \"%s\" on \"%s\" for the image \"%s\".",
                     disk_version.version_number,
                     metadata.destination,
+                    tgt,
                     metadata.image_path,
                 )
                 disk_version = set_new_sas_disk_version(disk_version, metadata, source)
@@ -661,21 +665,26 @@ def publish(self, metadata: AzurePublishingMetadata) -> None:
                 tech_config.disk_versions.append(disk_version)
         else:
             log.info(
-                "The destination \"%s\" already contains the SAS URI: \"%s\".",
+                "The destination \"%s\" on \"%s\" already contains the SAS URI: \"%s\".",
                 metadata.destination,
+                tgt,
                 metadata.image_path,
             )
 
         # 4. With the updated disk_version we should adjust the SKUs and submit the changes
         if disk_version:
-            log.info("Updating SKUs for \"%s\".", metadata.destination)
+            log.info("Updating SKUs for \"%s\" on \"%s\".", metadata.destination, tgt)
             tech_config.skus = update_skus(
                 disk_versions=tech_config.disk_versions,
                 generation=metadata.generation,
                 plan_name=plan_name,
                 old_skus=tech_config.skus,
             )
-            log.info("Updating the technical configuration for \"%s\".", metadata.destination)
+            log.info(
+                "Updating the technical configuration for \"%s\" on \"%s\".",
+                metadata.destination,
+                tgt,
+            )
             self.configure(resource=tech_config)
 
         # 5. Proceed to publishing if it was requested.

tests/ms_azure/test_service.py

@@ -463,10 +463,11 @@ def test_get_product_plan_by_name_success_first_attempt(
         mock_getpr.return_value = product_obj
         mock_getpl.return_value = plan_summary_obj
 
-        product, plan = azure_service.get_product_plan_by_name("product", "plan")
+        product, plan, tgt = azure_service.get_product_plan_by_name("product", "plan")
 
         assert product == product_obj
         assert plan == plan_summary_obj
+        assert tgt == "preview"
         mock_getpr.assert_called_once_with("product", first_target="preview")
         mock_getpl.assert_called_once_with(product_obj, "plan")
 
@@ -484,10 +485,11 @@ def test_get_product_plan_by_name_success_next_attempt(
         mock_getpr.return_value = product_obj
         mock_getpl.side_effect = [NotFoundError("Not found"), plan_summary_obj]
 
-        product, plan = azure_service.get_product_plan_by_name("product", "plan")
+        product, plan, tgt = azure_service.get_product_plan_by_name("product", "plan")
 
         assert product == product_obj
         assert plan == plan_summary_obj
+        assert tgt == "draft"
         mock_getpr.assert_has_calls(
             [
                 mock.call("product", first_target="preview"),
@@ -994,7 +996,7 @@ def test_publish_overwrite(
         metadata_azure_obj.overwrite = True
         metadata_azure_obj.keepdraft = True
         metadata_azure_obj.destination = "example-product/plan-1"
-        mock_getprpl_name.return_value = product_obj, plan_summary_obj
+        mock_getprpl_name.return_value = product_obj, plan_summary_obj, "preview"
         mock_filter.return_value = [technical_config_obj]
         mock_disk_scratch.return_value = disk_version_obj
         mock_upd_sku.return_value = technical_config_obj
@@ -1053,7 +1055,7 @@ def test_publish_nodiskversion(
         metadata_azure_obj.keepdraft = True
         metadata_azure_obj.disk_version = "1.0.0"
         metadata_azure_obj.destination = "example-product/plan-1"
-        mock_getprpl_name.return_value = product_obj, plan_summary_obj
+        mock_getprpl_name.return_value = product_obj, plan_summary_obj, "preview"
         technical_config_obj.disk_versions = []
         mock_filter.return_value = [technical_config_obj]
         mock_is_sas.return_value = False
@@ -1124,7 +1126,7 @@ def test_publish_saspresent(
         metadata_azure_obj.keepdraft = keepdraft
         metadata_azure_obj.destination = "example-product/plan-1"
         metadata_azure_obj.disk_version = "2.0.0"
-        mock_getprpl_name.return_value = product_obj, plan_summary_obj
+        mock_getprpl_name.return_value = product_obj, plan_summary_obj, "preview"
         mock_filter.return_value = [technical_config_obj]
         mock_is_sas.return_value = True
         mock_disk_scratch.return_value = disk_version_obj
@@ -1181,7 +1183,7 @@ def test_publish_novmimages(
         metadata_azure_obj.destination = "example-product/plan-1"
         metadata_azure_obj.disk_version = "2.0.0"
         technical_config_obj.disk_versions[0].vm_images = []
-        mock_getprpl_name.return_value = product_obj, plan_summary_obj
+        mock_getprpl_name.return_value = product_obj, plan_summary_obj, "preview"
         mock_filter.return_value = [technical_config_obj]
         mock_is_sas.return_value = False
         mock_disk_scratch.return_value = disk_version_obj
@@ -1248,7 +1250,7 @@ def test_publish_disk_has_images(
         metadata_azure_obj.support_legacy = True
         metadata_azure_obj.destination = "example-product/plan-1"
         metadata_azure_obj.disk_version = "2.0.0"
-        mock_getprpl_name.return_value = product_obj, plan_summary_obj
+        mock_getprpl_name.return_value = product_obj, plan_summary_obj, "preview"
         mock_filter.return_value = [technical_config_obj]
         mock_is_sas.return_value = False
         expected_source = VMImageSource(
@@ -1365,7 +1367,7 @@ def test_publish_live_x64_only(
         metadata_azure_obj.support_legacy = True
         metadata_azure_obj.destination = "example-product/plan-1"
         metadata_azure_obj.disk_version = "2.0.0"
-        mock_getprpl_name.return_value = product_obj, plan_summary_obj
+        mock_getprpl_name.return_value = product_obj, plan_summary_obj, "preview"
         mock_filter.side_effect = [
             [technical_config_obj],
             [submission_obj],
@@ -1458,7 +1460,7 @@ def test_publish_live_arm64_only(
         metadata_azure_obj.disk_version = "2.1.0"
         metadata_azure_obj.architecture = "aarch64"
         technical_config_obj.disk_versions = [disk_version_arm64_obj]
-        mock_getprpl_name.return_value = product_obj, plan_summary_obj
+        mock_getprpl_name.return_value = product_obj, plan_summary_obj, "preview"
         mock_filter.side_effect = [
             [technical_config_obj],
             [submission_obj],
@@ -1583,15 +1585,18 @@ def test_publish_live_when_state_is_preview(
             in caplog.text
         )
         assert (
-            'Preparing to associate the image "https://uri.test.com" with the plan "plan-1" from product "example-product"'  # noqa: E501
+            'Preparing to associate the image "https://uri.test.com" with the plan "plan-1" from product "example-product" on "preview"'  # noqa: E501
+            in caplog.text
+        )
+        assert (
+            'Retrieving the technical config for "example-product/plan-1" on "preview".'
             in caplog.text
         )
-        assert 'Retrieving the technical config for "example-product/plan-1".' in caplog.text
         assert (
             'Creating the VMImageResource with SAS for image: "https://uri.test.com"' in caplog.text
         )
         assert (
-            'The destination "example-product/plan-1" already contains the SAS URI: "https://uri.test.com".'  # noqa: E501
+            'The destination "example-product/plan-1" on "preview" already contains the SAS URI: "https://uri.test.com".'  # noqa: E501
             in caplog.text
         )
         assert 'Publishing the new changes for "example-product" on plan "plan-1"' in caplog.text
@@ -1623,11 +1628,12 @@ def test_publish_live_when_state_is_preview(
 
         # Absent messages
         assert (
-            'Scanning the disk versions from "example-product/plan-1" for the image "https://uri.test.com"'  # noqa: E501
+            'Scanning the disk versions from "example-product/plan-1" on "preview" for the image "https://uri.test.com"'  # noqa: E501
             not in caplog.text
         )
         assert 'The DiskVersion doesn\'t exist, creating one from scratch.' not in caplog.text
-        assert 'Updating SKUs for "example-product/plan-1".' not in caplog.text
+        assert 'Updating SKUs for "example-product/plan-1" on "preview".' not in caplog.text
         assert (
-            'Updating the technical configuration for "example-product/plan-1".' not in caplog.text
+            'Updating the technical configuration for "example-product/plan-1" on "preview".'
+            not in caplog.text
         )