Updates to run on ADO (#112)

* Copy exclusions from Azure CLI.

* Fix document map check.

* Fix `azdev verify document-map`.

* Port linter change from azure-cli.

* Add wrong-import-order to pylint exceptions.

* Azdev style fix for CI.

* Update version and history.

* Fix CI.

Author: tjprescott

HISTORY.rst

@@ -3,6 +3,12 @@
 Release History
 ===============
 
+0.1.4
+++++++
+* `azdev linter`: Fix issue with help example rule.
+* `azdev style`: Omit namespace packages from core modules.
+* `azdev verify document-map`: Updates to work correctly on Linux.
+
 0.1.3
 ++++++
 * `azdev linter`: Fix issue where certain installations would fail on `ci_exclusions.yml` not found.

azdev/__init__.py

@@ -4,4 +4,4 @@
 # license information.
 # -----------------------------------------------------------------------------
 
-__VERSION__ = '0.1.3'
+__VERSION__ = '0.1.4'

azdev/config/cli_pylintrc

@@ -11,7 +11,20 @@ reports=no
 # chained-comparison: Does not provide guidance on what would be better and arguably these are fine.
 # useless-import-alias: Removing the alias often breaks the import, so it isn't really useless after all.
 # useless-suppression: Depends on the Python version and the pylint version...
-disable=missing-docstring,locally-disabled,fixme,cyclic-import,too-many-arguments,invalid-name,duplicate-code,useless-object-inheritance,chained-comparison,useless-import-alias,useless-suppression
+# wrong-import-order: Pylint keeps changing its mind...
+disable=
+    missing-docstring,
+    locally-disabled,
+    fixme,
+    cyclic-import,
+    too-many-arguments,
+    invalid-name,
+    duplicate-code,
+    useless-object-inheritance,
+    chained-comparison,
+    useless-import-alias,
+    useless-suppression,
+    wrong-import-order
 
 [FORMAT]
 max-line-length=120

azdev/config/ext_pylintrc

@@ -11,11 +11,20 @@ reports=no
 # chained-comparison: Does not provide guidance on what would be better and arguably these are fine.
 # useless-import-alias: Removing the alias often breaks the import, so it isn't really useless after all.
 # useless-suppression: Depends on the Python version and the pylint version...
-disable=missing-docstring,locally-disabled,fixme,cyclic-import,too-many-arguments,invalid-name,duplicate-code,useless-object-inheritance,chained-comparison,useless-import-alias,useless-suppression
-
-[TYPECHECK]
-# For Azure CLI extensions, we ignore some import errors as they'll be available in the environment of the CLI
-ignored-modules=azure,azure.cli,azure.cli.core,azure.cli.core.commands,knack,msrestazure,argcomplete 
+# wrong-import-order: Pylint keeps changing its mind...
+disable=
+    missing-docstring,
+    locally-disabled,
+    fixme,
+    cyclic-import,
+    too-many-arguments,
+    invalid-name,
+    duplicate-code,
+    useless-object-inheritance,
+    chained-comparison,
+    useless-import-alias,
+    useless-suppression,
+    wrong-import-order
 
 [FORMAT]
 max-line-length=120
@@ -50,3 +59,7 @@ function-name-hint=lower_case_with_underscores
 argument-name-hint=lower_case_with_underscores
 variable-name-hint=lower_case_with_underscores
 inlinevar-name-hint=lower_case_with_underscores (short is OK)
+
+[TYPECHECK]
+# For Azure CLI extensions, we ignore some import errors as they'll be available in the environment of the CLI
+ignored-modules=azure,azure.cli,azure.cli.core,azure.cli.core.commands,knack,msrestazure,argcomplete 

azdev/operations/help.py

@@ -65,8 +65,8 @@ def _help_files_not_in_map(cli_repo, help_files_in_map):
     not_in_map = []
     for _, path in get_path_table()['mod'].items():
         help_path = os.path.join(path, HELP_FILE_NAME)
-        help_path = help_path.replace(cli_repo.lower() + '\\', '')
-        if help_path in help_files_in_map:
+        help_path = help_path.replace(cli_repo.lower() + os.sep, '')
+        if help_path in help_files_in_map or not os.path.isfile(help_path):
             continue
         not_in_map.append(help_path)
     return not_in_map

azdev/operations/linter/rules/ci_exclusions.yml

@@ -3,25 +3,11 @@
 # note that this is a TEMPORARY stop-gap and the rule violations should be addressed
 
 no_ids_for_list_commands:
-- advisor
 - dla
 - dls
-- eventgrid
 - iot
 - rdbms
 - sql
-missing_parameter_help:
-- acs
-- cdn
-- dla
-- dls
-- eventgrid
-- eventhubs
-- keyvault
-- rdbms
-- resource
-- role
-- servicebus
-- servicefabric
-- sql
+faulty_help_example_parameters_rule:
+- find
 ...

azdev/operations/linter/rules/help_rules.py

@@ -142,8 +142,28 @@ def get_value_side_effect(action, arg_string):  # pylint: disable=unused-argumen
 def _extract_commands_from_example(example_text):
 
     # fold commands spanning multiple lines into one line. Split commands that use pipes
-    example_text = example_text.replace("\\\n", " ")  # wrap escaped newline into one line.
-    example_text = example_text.replace("\\ ", " ")  # remove left over escape after wrapping
+    # handle single and double quotes properly
+    lines = example_text.splitlines()
+    example_text = ""
+    quote = None
+    for line in lines:
+        for ch in line:
+            if quote is None:
+                if ch in ('"', "'"):
+                    quote = ch
+            elif ch == quote:
+                quote = None
+        if quote is None and line.endswith("\\"):
+            # attach this line with removed '\' and no '\n' (space at the end to keep consistent with initial algorithm)
+            example_text += line[0:-1] + " "
+        elif quote is not None:
+            # attach this line without '\n'
+            example_text += line
+        else:
+            # attach this line with '\n' as no quote and no continuation
+            example_text += line + "\n"
+    # this is also for consistency with original algorithm
+    example_text = example_text.replace("\\ ", " ")
 
     commands = example_text.splitlines()
     processed_commands = []

azdev/operations/style.py

@@ -25,6 +25,11 @@ def check_style(modules=None, pylint=False, pep8=False):
     heading('Style Check')
 
     selected_modules = get_path_table(include_only=modules)
+
+    # remove these two non-modules
+    selected_modules['core'].pop('azure-cli-nspkg', None)
+    selected_modules['core'].pop('azure-cli-command_modules-nspkg', None)
+
     pep8_result = None
     pylint_result = None
 

scripts/ci/install.sh

@@ -5,8 +5,8 @@ set -ev
 echo "Install azdev into virtual environment"
 python -m venv env
 . env/bin/activate
-pip install -U pip setuptools wheel
-pip install $(find ${BUILD_ARTIFACTSTAGINGDIRECTORY}/pypi -name *.tar.gz)
+pip install -U pip setuptools wheel -q
+pip install $(find ${BUILD_ARTIFACTSTAGINGDIRECTORY}/pypi -name *.tar.gz) -q
 git clone https://github.com/Azure/azure-cli.git
 git clone https://github.com/Azure/azure-cli-extensions.git
 azdev setup -c -r azure-cli-extensions