azdev 0.1.81__tar.gz → 0.1.82__tar.gz

{azdev-0.1.81 → azdev-0.1.82}/HISTORY.rst

@@ -2,6 +2,10 @@
 
 Release History
 ===============
+0.1.82
+++++++
+* `azdev generate-breaking-change-report`: New command to collect upcoming breaking changes from codebase.
+
 0.1.81
 ++++++
 * `azdev scan/mask`: Add `--confidence-level` to support secret pattern levels

{azdev-0.1.81/azdev.egg-info → azdev-0.1.82}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: azdev
-Version: 0.1.81
+Version: 0.1.82
 Summary: Microsoft Azure CLI Developer Tools
 Home-page: https://github.com/Azure/azure-cli-dev-tools
 Author: Microsoft Corporation
@@ -148,6 +148,10 @@ License
 
 Release History
 ===============
+0.1.82
+++++++
+* `azdev generate-breaking-change-report`: New command to collect upcoming breaking changes from codebase.
+
 0.1.81
 ++++++
 * `azdev scan/mask`: Add `--confidence-level` to support secret pattern levels

{azdev-0.1.81 → azdev-0.1.82}/azdev/__init__.py

@@ -4,4 +4,4 @@
 # license information.
 # -----------------------------------------------------------------------------
 
-__VERSION__ = '0.1.81'
+__VERSION__ = '0.1.82'

{azdev-0.1.81 → azdev-0.1.82}/azdev/commands.py

@@ -84,3 +84,6 @@ def load_command_table(self, _):
 
     with CommandGroup(self, 'extension', operation_group('help')) as g:
         g.command('generate-docs', 'generate_extension_ref_docs')
+
+    with CommandGroup(self, '', operation_group('breaking_change')) as g:
+        g.command('generate-breaking-change-report', 'collect_upcoming_breaking_changes')

{azdev-0.1.81 → azdev-0.1.82}/azdev/help.py

@@ -377,3 +377,14 @@ helps['cmdcov'] = """
         - name: Check CLI modules command test coverage in argument level.
           text: azdev cmdcov CLI --level argument
 """
+
+helps['generate-breaking-change-report'] = """
+    short-summary: Collect pre-announced breaking changes items and generate the report.
+    examples:
+        - name: Collect all pre-announced breaking changes, including any that did not specify a target version and group them by target version.
+          text: azdev generate-breaking-change-report CLI --group-by-version --target-version None
+        - name: Collect all pre-announced breaking changes target before next breaking change window, and display them in markdown.
+          text: azdev generate-breaking-change-report CLI --output-format markdown
+        - name: Collect all pre-announced breaking changes in vm, including those failed to specify a target version, and display them in json
+          text: azdev generate-breaking-change-report vm --target-version None
+"""

{azdev-0.1.81 → azdev-0.1.82}/azdev/operations/command_change/__init__.py

@@ -10,7 +10,8 @@ import time
 
 from knack.log import get_logger
 import azure_cli_diff_tool
-from azdev.utilities import display, require_azure_cli, heading, get_path_table, filter_by_git_diff
+from azdev.utilities import display, require_azure_cli, heading, get_path_table, filter_by_git_diff, \
+    calc_selected_mod_names
 from .custom import DiffExportFormat, get_commands_meta, STORED_DEPRECATION_KEY
 from .util import export_commands_meta, dump_command_tree, add_to_command_tree
 from ..statistics import _create_invoker_and_load_cmds, _get_command_source, \
@@ -144,26 +145,7 @@ def cmp_command_meta(base_meta_file, diff_meta_file, only_break=False, output_ty
 def export_command_tree(modules, output_file=None):
     require_azure_cli()
 
-    # allow user to run only on CLI or extensions
-    cli_only = modules == ['CLI']
-    ext_only = modules == ['EXT']
-    if cli_only or ext_only:
-        modules = None
-
-    selected_modules = get_path_table(include_only=modules)
-
-    if cli_only:
-        selected_modules['ext'] = {}
-    if ext_only:
-        selected_modules['core'] = {}
-        selected_modules['mod'] = {}
-
-    if not any(selected_modules.values()):
-        logger.warning('No commands selected to check.')
-
-    selected_mod_names = list(selected_modules['mod'].keys())
-    selected_mod_names += list(selected_modules['ext'].keys())
-    selected_mod_names += list(selected_modules['core'].keys())
+    selected_mod_names = calc_selected_mod_names(modules)
 
     if selected_mod_names:
         display('Modules selected: {}\n'.format(', '.join(selected_mod_names)))

{azdev-0.1.81 → azdev-0.1.82}/azdev/operations/statistics/__init__.py

@@ -194,7 +194,7 @@ def _get_command_source(command_name, command):
     }
 
 
-def _create_invoker_and_load_cmds(cli_ctx):
+def _create_invoker_and_load_cmds(cli_ctx, load_arguments=False):
     from knack.events import (
         EVENT_INVOKER_PRE_CMD_TBL_CREATE, EVENT_INVOKER_POST_CMD_TBL_CREATE)
     from azure.cli.core.commands import register_cache_arguments
@@ -215,9 +215,11 @@ def _create_invoker_and_load_cmds(cli_ctx):
     invoker.commands_loader.load_command_table(None)
     invoker.commands_loader.command_name = ''
 
-    # cli_ctx.raise_event(EVENT_INVOKER_PRE_LOAD_ARGUMENTS, commands_loader=invoker.commands_loader)
-    # invoker.commands_loader.load_arguments()
-    # cli_ctx.raise_event(EVENT_INVOKER_POST_LOAD_ARGUMENTS, commands_loader=invoker.commands_loader)
+    if load_arguments:
+        from azure.cli.core.commands.events import EVENT_INVOKER_PRE_LOAD_ARGUMENTS, EVENT_INVOKER_POST_LOAD_ARGUMENTS
+        cli_ctx.raise_event(EVENT_INVOKER_PRE_LOAD_ARGUMENTS, commands_loader=invoker.commands_loader)
+        invoker.commands_loader.load_arguments()
+        cli_ctx.raise_event(EVENT_INVOKER_POST_LOAD_ARGUMENTS, commands_loader=invoker.commands_loader)
 
     cli_ctx.raise_event(EVENT_INVOKER_POST_CMD_TBL_CREATE, commands_loader=invoker.commands_loader)
     invoker.parser.cli_ctx = cli_ctx

{azdev-0.1.81 → azdev-0.1.82}/azdev/params.py

@@ -256,3 +256,17 @@ def load_arguments(self, _):
                                           'If the base directory does not exist, it will be created')
             c.argument('output_type', choices=['xml', 'html', 'text', 'man', 'latex'], default="xml",
                        help='Output type of the generated docs.')
+
+    with ArgumentsContext(self, 'generate-breaking-change-report') as c:
+        c.positional('modules', modules_type)
+        c.argument('target_version', default='NextWindow',
+                   help='Only the breaking changes scheduled prior to the specified version will be displayed. '
+                        'The value could be `NextWindow`, `None` or a specified version like `3.0.0`')
+        c.argument('source', choices=['deprecate_info', 'pre_announce'], default='pre_announce',
+                   help='The source of pre-announced breaking changes. `deprecate_info` represents all breaking changes '
+                        'marked through `deprecation_info`; `pre_announce` represents the breaking changes announced in '
+                        '`breaking_change.py` file.')
+        c.argument('group_by_version', action='store_true',
+                   help='If specified, breaking changes would be grouped by their target version as well.')
+        c.argument('output_format', choices=['structure', 'markdown'], default='structure',
+                   help='Output format of the collected breaking changes.')

{azdev-0.1.81 → azdev-0.1.82}/azdev/utilities/__init__.py

@@ -47,7 +47,8 @@ from .path import (
     get_cli_repo_path,
     get_ext_repo_paths,
     get_path_table,
-    get_name_index
+    get_name_index,
+    calc_selected_mod_names
 )
 from .testing import test_cmd
 from .tools import (
@@ -93,4 +94,5 @@ __all__ = [
     'require_virtual_env',
     'require_azure_cli',
     'diff_branches_detail',
+    'calc_selected_mod_names',
 ]

{azdev-0.1.81 → azdev-0.1.82}/azdev/utilities/path.py

@@ -3,7 +3,7 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -----------------------------------------------------------------------------
-
+import logging
 import os
 from glob import glob
 
@@ -11,6 +11,8 @@ from knack.util import CLIError
 
 from .const import COMMAND_MODULE_PREFIX, EXTENSION_PREFIX, ENV_VAR_VIRTUAL_ENV
 
+logger = logging.getLogger(__name__)
+
 
 def extract_module_name(path):
 
@@ -261,3 +263,27 @@ def get_path_table(include_only=None, include_whl_extensions=False):
         raise CLIError('unrecognized modules: [ {} ]'.format(', '.join(include_only)))
 
     return table
+
+
+def calc_selected_mod_names(modules=None):
+    # allow user to run only on CLI or extensions
+    cli_only = modules == ['CLI']
+    ext_only = modules == ['EXT']
+    if cli_only or ext_only:
+        modules = None
+
+    selected_modules = get_path_table(include_only=modules)
+
+    if cli_only:
+        selected_modules['ext'] = {}
+    if ext_only:
+        selected_modules['core'] = {}
+        selected_modules['mod'] = {}
+
+    if not any(selected_modules.values()):
+        logger.warning('No commands selected to check.')
+
+    selected_mod_names = list(selected_modules['mod'].keys())
+    selected_mod_names += list(selected_modules['ext'].keys())
+    selected_mod_names += list(selected_modules['core'].keys())
+    return selected_mod_names

{azdev-0.1.81 → azdev-0.1.82/azdev.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: azdev
-Version: 0.1.81
+Version: 0.1.82
 Summary: Microsoft Azure CLI Developer Tools
 Home-page: https://github.com/Azure/azure-cli-dev-tools
 Author: Microsoft Corporation
@@ -148,6 +148,10 @@ License
 
 Release History
 ===============
+0.1.82
+++++++
+* `azdev generate-breaking-change-report`: New command to collect upcoming breaking changes from codebase.
+
 0.1.81
 ++++++
 * `azdev scan/mask`: Add `--confidence-level` to support secret pattern levels