Merge pull request #152 from release-engineering/diff

feature: Add "offline" diff for AzureService

Author: JAVGan

cloudpub/ms_azure/service.py

@@ -437,6 +437,21 @@ def diff_offer(self, product: Product, target: str) -> DeepDiff:
         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:

tests/ms_azure/test_service.py

@@ -578,6 +578,25 @@ def test_diff_offer_changed(
             },
         }
 
+    def test_diff_two_offers_changed(
+        self,
+        azure_service: AzureService,
+        product_obj: Product,
+    ) -> None:
+        data_product = deepcopy(product_obj.to_json())
+        data_product["resources"][0]["id"] = "product/foo/bar"
+        last_offer = Product.from_json(data_product)
+
+        diff = azure_service.diff_two_offers(last_offer, product_obj)
+        assert diff == {
+            'values_changed': {
+                "root['resources'][0]['id']": {
+                    'new_value': 'product/foo/bar',
+                    'old_value': 'product/ffffffff-ffff-ffff-ffff-ffffffffffff',
+                },
+            },
+        }
+
     @pytest.mark.parametrize("target", ["preview", "live", "draft"])
     @mock.patch("cloudpub.ms_azure.AzureService.get_product")
     @mock.patch("cloudpub.ms_azure.AzureService.products")
@@ -594,6 +613,13 @@ def test_diff_offer_no_change(
         mock_getpr.return_value = product_obj
         assert azure_service.diff_offer(product_obj, target=target) == {}
 
+    def test_diff_two_offers_no_change(
+        self,
+        azure_service: AzureService,
+        product_obj: Product,
+    ) -> None:
+        assert azure_service.diff_two_offers(product_obj, product_obj) == {}
+
     @mock.patch("cloudpub.ms_azure.AzureService._assert_dict")
     def test_get_submissions(
         self,