azure-cli-diff-tool 0.0.8__tar.gz → 0.1.0__tar.gz

{azure_cli_diff_tool-0.0.8 → azure_cli_diff_tool-0.1.0}/PKG-INFO

@@ -1,12 +1,18 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: azure-cli-diff-tool
-Version: 0.0.8
+Version: 0.1.0
 Summary: A tool for cli metadata management
 Author: Microsoft Corporation
 Author-email: azpycli@microsoft.com
 License: MIT
 Requires-Dist: deepdiff==6.3.0
-Requires-Dist: requests
+Requires-Dist: requests~=2.32.3
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
 
 Microsoft Azure CLI Diff Tools (azure-cli-diff-tool)
 =======================================================
@@ -98,6 +104,14 @@ License
 
 Release History
 ===============
+0.1.0
+++++++
+* Enable meta-diff with `module_name` excluded
+
+0.0.9
+++++++
+* Use dynamic metadata whitelist
+
 0.0.8
 ++++++
 * Set `deepDiff` un-breaking version

{azure_cli_diff_tool-0.0.8 → azure_cli_diff_tool-0.1.0}/azure_cli_diff_tool/__init__.py

@@ -18,7 +18,7 @@ from .utils import get_blob_config, load_blob_config_file, get_target_version_mo
     extract_module_name_from_meta_file, export_meta_changes_to_csv, export_meta_changes_to_json, \
     export_meta_changes_to_dict, expand_deprecate_obj
 
-__VERSION__ = '0.0.8'
+__VERSION__ = '0.1.0'
 
 logger = logging.getLogger(__name__)
 
@@ -63,7 +63,7 @@ def meta_diff(base_meta_file, diff_meta_file, only_break=False, output_type="tex
         raise Exception("Please update your azure cli diff tool")
     expand_deprecate_obj(command_tree_before)
     expand_deprecate_obj(command_tree_after)
-    diff = DeepDiff(command_tree_before, command_tree_after)
+    diff = DeepDiff(command_tree_before, command_tree_after, exclude_paths=["root['module_name']"])
     if not diff:
         print(f"No meta diffs from {diff_meta_file} to {base_meta_file}")
         return export_meta_changes_to_json(None, output_file)

{azure_cli_diff_tool-0.0.8 → azure_cli_diff_tool-0.1.0}/azure_cli_diff_tool/_const.py

@@ -11,7 +11,7 @@ CONFIG_FILE_PATH = f"{script_directory}/{BLOB_SETTING_CONFIG_FILE}"
 
 META_CHANDE_WHITELIST_FILE = "./data/meta_change_whitelist.txt"
 META_CHANDE_WHITELIST_FILE_PATH = f"{script_directory}/{META_CHANDE_WHITELIST_FILE}"
-
+META_CHANDE_WHITELIST_FILE_URL = "https://azcmdchangemgmt.blob.core.windows.net/azure-cli-diff-tool-config/meta_change_whitelist.txt"
 DOWNLOAD_THREADS = 30
 
 BREAKING_CHANE_RULE_LINK_URL_PREFIX = "https://github.com/Azure/azure-cli/blob/dev/doc/breaking_change_rules/"

{azure_cli_diff_tool-0.0.8 → azure_cli_diff_tool-0.1.0}/azure_cli_diff_tool/data/meta_change_whitelist.txt

@@ -1,9 +1,10 @@
 1010	ams asset get-sas-urls	expiry_time	default
+1010	mariadb server create	administrator_login	default
 1010	mysql flexible-server create	administrator_login	default
 1010	mysql flexible-server restore	restore_point_in_time	default
 1010	mysql flexible-server import create	administrator_login	default
+1010	mysql flexible-server maintenance reschedule	maintenance_start_time	default
+1010	mysql server create	administrator_login	default
 1010	postgres flexible-server create	administrator_login	default
 1010	postgres flexible-server restore	restore_point_in_time	default
-1010	mysql server create	administrator_login	default
-1010	postgres server create	administrator_login	default
-1010	mariadb server create	administrator_login	default
+1010	postgres server create	administrator_login	default

{azure_cli_diff_tool-0.0.8 → azure_cli_diff_tool-0.1.0}/azure_cli_diff_tool/meta_change_detect.py

@@ -5,6 +5,7 @@
 # -----------------------------------------------------------------------------
 
 import logging
+import requests
 import os.path
 
 from .utils import get_command_tree, ChangeType, extract_cmd_name, extract_subgroup_name, extract_subgroup_property, \
@@ -22,6 +23,7 @@ from ._const import (SUBGROUP_PROPERTY_ADD_BREAK_LIST, SUBGROUP_PROPERTY_ADD_WAR
                      PARA_PROPERTY_ADD_BREAK_LIST, PARA_PROPERTY_ADD_WARN_LIST,
                      PARA_PROPERTY_UPDATE_BREAK_LIST, PARA_PROPERTY_UPDATE_WARN_LIST,
                      CMD_REMOVE_SUFFIX_WARN_LIST,
+                     META_CHANDE_WHITELIST_FILE_URL,
                      META_CHANDE_WHITELIST_FILE_PATH)
 
 logger = logging.getLogger(__name__)
@@ -43,8 +45,10 @@ class MetaChangeDetect:
             self.deep_diff = deep_diff
         else:
             logger.info("None diffs from cmd meta json")
-        assert base_meta["module_name"] == diff_meta["module_name"]
-        self.module_name = base_meta["module_name"]
+        if base_meta["module_name"] != diff_meta["module_name"]:
+            print(f'Comparing two modules with different name, base mod: {base_meta["module_name"]},'
+                  f' diff mod: {diff_meta["module_name"]}')
+        self.module_name = diff_meta["module_name"]
         self.base_meta = base_meta
         self.diff_meta = diff_meta
         self.diff_objs = []
@@ -53,14 +57,24 @@ class MetaChangeDetect:
         self.__get_meta_change_whitelist__()
 
     def __get_meta_change_whitelist__(self):
-        if not os.path.exists(META_CHANDE_WHITELIST_FILE_PATH):
-            logger.info("meta_change_whitelist.txt not exist, skipped")
-            return
-        with open(META_CHANDE_WHITELIST_FILE_PATH, "r") as f_in:
-            for line in f_in:
+        remote_res = requests.get(META_CHANDE_WHITELIST_FILE_URL)
+        if remote_res.status_code != 200:
+            logger.warning("remote meta change whitelist fetch error, use local dict")
+            if not os.path.exists(META_CHANDE_WHITELIST_FILE_PATH):
+                logger.info("meta_change_whitelist.txt not exist, skipped")
+                return
+            with open(META_CHANDE_WHITELIST_FILE_PATH, "r") as f_in:
+                for line in f_in:
+                    white_key = line.rstrip()
+                    self.meta_change_whitelist.add(white_key)
+        else:
+            logger.info("remote meta change whitelist fetch success")
+            content = remote_res.text
+            for line in content.split("\n"):
                 white_key = line.rstrip()
                 self.meta_change_whitelist.add(white_key)
 
+
     @staticmethod
     def __search_cmd_obj(cmd_name, search_meta):
         command_tree = get_command_tree(cmd_name)

{azure_cli_diff_tool-0.0.8 → azure_cli_diff_tool-0.1.0}/azure_cli_diff_tool.egg-info/PKG-INFO

@@ -1,12 +1,18 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: azure-cli-diff-tool
-Version: 0.0.8
+Version: 0.1.0
 Summary: A tool for cli metadata management
 Author: Microsoft Corporation
 Author-email: azpycli@microsoft.com
 License: MIT
 Requires-Dist: deepdiff==6.3.0
-Requires-Dist: requests
+Requires-Dist: requests~=2.32.3
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
 
 Microsoft Azure CLI Diff Tools (azure-cli-diff-tool)
 =======================================================
@@ -98,6 +104,14 @@ License
 
 Release History
 ===============
+0.1.0
+++++++
+* Enable meta-diff with `module_name` excluded
+
+0.0.9
+++++++
+* Use dynamic metadata whitelist
+
 0.0.8
 ++++++
 * Set `deepDiff` un-breaking version

{azure_cli_diff_tool-0.0.8 → azure_cli_diff_tool-0.1.0}/azure_cli_diff_tool.egg-info/SOURCES.txt

@@ -1,4 +1,5 @@
 README.rst
+pyproject.toml
 setup.py
 azure_cli_diff_tool/__init__.py
 azure_cli_diff_tool/_const.py

azure_cli_diff_tool-0.1.0/azure_cli_diff_tool.egg-info/requires.txt

@@ -0,0 +1,2 @@
+deepdiff==6.3.0
+requests~=2.32.3

azure_cli_diff_tool-0.1.0/pyproject.toml

@@ -0,0 +1,9 @@
+# -----------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# -----------------------------------------------------------------------------
+
+[build-system]
+# Minimum requirements for the build system to execute.
+requires = ["setuptools", "wheel"]

{azure_cli_diff_tool-0.0.8 → azure_cli_diff_tool-0.1.0}/setup.py

@@ -30,7 +30,7 @@ setup(name="azure-cli-diff-tool",
       author_email='azpycli@microsoft.com',
       packages=find_packages(),
       include_package_data=True,
-      install_requires=["deepdiff==6.3.0", "requests"],
+      install_requires=["deepdiff==6.3.0", "requests~=2.32.3"],
       package_data={
         "azure_cli_diff_tool": ["data/*"]
       }

{azure_cli_diff_tool-0.0.8 → azure_cli_diff_tool-0.1.0}/tests/test_break_change.py

@@ -10,9 +10,10 @@ import os
 from azure_cli_diff_tool import meta_diff
 from azure_cli_diff_tool.utils import get_command_tree, extract_cmd_name, extract_cmd_property, extract_para_info, \
     extract_subgroup_name, extract_subgroup_deprecate_property, expand_deprecate_obj, extract_subgroup_property
+TEST_DIR = os.path.abspath(os.path.join(os.path.abspath(__file__), '..'))
 
 
-class MyTestCase(unittest.TestCase):
+class CLIDiffToolTestCase(unittest.TestCase):
 
     def test_parse_cmd_tree(self):
         cmd_name = "monitor log-profiles create"
@@ -65,12 +66,15 @@ class MyTestCase(unittest.TestCase):
         self.assertEqual(subgroup_prop, "deprecate_info_hide", "sub group prop extract failed")
 
     def test_diff_meta(self):
-        if not os.path.exists("./jsons/az_monitor_meta_before.json") \
-                or not os.path.exists("./jsons/az_monitor_meta_after.json"):
-            return
-        result = meta_diff(base_meta_file="./jsons/az_monitor_meta_before.json",
-                           diff_meta_file="./jsons/az_monitor_meta_after.json",
+        base_meta_file = os.path.join(TEST_DIR, "jsons", "az_monitor_meta_before.json")
+        diff_meta_file = os.path.join(TEST_DIR, "jsons", "az_monitor_meta_after.json")
+        if not os.path.exists(base_meta_file) or not os.path.exists(diff_meta_file):
+            raise ValueError("Meta file not found, please check testing package")
+
+        result = meta_diff(base_meta_file=base_meta_file,
+                           diff_meta_file=diff_meta_file,
                            output_type="text")
+
         target_message = [
             "please confirm cmd `monitor private-link-scope scoped-resource show` removed",
             "sub group `monitor private-link-scope private-endpoint-connection cust` removed",
@@ -97,11 +101,22 @@ class MyTestCase(unittest.TestCase):
             self.assertTrue(ignored, "ignored message found")
 
     def test_diff_meta_whitelist(self):
-        if not os.path.exists("./jsons/az_ams_meta_before.json") \
-                or not os.path.exists("./jsons/az_ams_meta_after.json"):
-            return
-        result = meta_diff(base_meta_file="./jsons/az_ams_meta_before.json",
-                           diff_meta_file="./jsons/az_ams_meta_after.json",
+        base_meta_file = os.path.join(TEST_DIR, "jsons", "az_ams_meta_before.json")
+        diff_meta_file = os.path.join(TEST_DIR, "jsons", "az_ams_meta_after.json")
+        if not os.path.exists(base_meta_file) or not os.path.exists(diff_meta_file):
+            raise ValueError("Meta file not found, please check testing package")
+        result = meta_diff(base_meta_file=base_meta_file,
+                           diff_meta_file=diff_meta_file,
+                           output_type="text")
+        self.assertEqual(result, [], "returned change isn't empty")
+
+    def test_dynamic_diff_meta_whitelist(self):
+        base_meta_file = os.path.join(TEST_DIR, "jsons", "az_mysql_meta_before.json")
+        diff_meta_file = os.path.join(TEST_DIR, "jsons", "az_mysql_meta_after.json")
+        if not os.path.exists(base_meta_file) or not os.path.exists(diff_meta_file):
+            raise ValueError("Meta file not found, please check testing package")
+        result = meta_diff(base_meta_file=base_meta_file,
+                           diff_meta_file=diff_meta_file,
                            output_type="text")
         self.assertEqual(result, [], "returned change isn't empty")
 
@@ -149,11 +164,12 @@ class MyTestCase(unittest.TestCase):
         self.assertEqual(example_obj["sub_groups"]["acr"]["commands"]["acr helm list"]["parameters"][0]["deprecate_info_redirect"], "resource_group_name2", "deprecate info expand not working properly")
 
     def test_diff_meta_for_deprecate_info(self):
-        if not os.path.exists("./jsons/az_acr_meta_before.json") or not os.path.exists("./jsons/az_acr_meta_after.json"):
-            return
-        result = meta_diff(base_meta_file="./jsons/az_acr_meta_before.json",
-                           diff_meta_file="./jsons/az_acr_meta_after.json",
-                           output_type="text")
+        base_meta_file = os.path.join(TEST_DIR, "jsons", "az_acr_meta_before.json")
+        diff_meta_file = os.path.join(TEST_DIR, "jsons", "az_acr_meta_after.json")
+        if not os.path.exists(base_meta_file) or not os.path.exists(diff_meta_file):
+            raise ValueError("Meta file not found, please check testing package")
+
+        result = meta_diff(base_meta_file=base_meta_file, diff_meta_file=diff_meta_file, output_type="text")
         target_message = [
             "sub group `acr` added property `deprecate_info_hide` | diff_level: 2",
             "sub group `acr` updated property `deprecate_info_redirect` from `acr2` to `acr3` | diff_level: 1",
@@ -174,6 +190,23 @@ class MyTestCase(unittest.TestCase):
             print(mes)
             self.assertTrue(found, "target message not found")
 
+    def test_diff_meta_with_different_mod_name(self):
+        base_meta_file = os.path.join(TEST_DIR, "jsons", "az_virtual-network-manager_meta_before.json")
+        diff_meta_file = os.path.join(TEST_DIR, "jsons", "az_network-manager_meta_after.json")
+        if not os.path.exists(base_meta_file) or not os.path.exists(diff_meta_file):
+            raise ValueError("Meta file not found, please check testing package")
+        result = meta_diff(base_meta_file=base_meta_file, diff_meta_file=diff_meta_file, output_type="text")
+        target_message = [
+            "updated property `name` from `network_manager_scopes` to `module_name`",
+        ]
+        for mes in target_message:
+            found = False
+            for line in result:
+                if line.find(mes) > -1:
+                    found = True
+                    break
+            self.assertTrue(found, "target message not found")
+
 
 if __name__ == '__main__':
     unittest.main()

azure_cli_diff_tool-0.0.8/azure_cli_diff_tool.egg-info/requires.txt

@@ -1,2 +0,0 @@
-deepdiff==6.3.0
-requests