[Linter] Show command should use g.show_command or g.custom_show_command (#241)

Author: mmyyrroonn

azdev/operations/linter/__init__.py

@@ -16,12 +16,14 @@
 from azdev.utilities import (
     heading, subheading, display, get_path_table, require_azure_cli, filter_by_git_diff)
 from azdev.utilities.path import get_cli_repo_path, get_ext_repo_paths
+from azdev.operations.style import run_pylint
 
 from .linter import LinterManager, LinterScope, RuleError, LinterSeverity
 from .util import filter_modules, merge_exclusion
 
 
 logger = get_logger(__name__)
+CHECKERS_PATH = 'azdev.operations.linter.pylint_checkers'
 
 
 # pylint:disable=too-many-locals, too-many-statements, too-many-branches
@@ -158,8 +160,29 @@ def run_linter(modules=None, rule_types=None, rules=None, ci_exclusions=None,
         run_commands=not rule_types or 'commands' in rule_types,
         run_command_groups=not rule_types or 'command_groups' in rule_types,
         run_help_files_entries=not rule_types or 'help_entries' in rule_types)
+    logger.info(os.linesep)
+    logger.info('Run custom pylint rules.')
+    exit_code += pylint_rules(selected_modules)
     sys.exit(exit_code)
 
 
+def pylint_rules(selected_modules):
+    # TODO: support severity for pylint rules
+    from importlib import import_module
+    my_env = os.environ.copy()
+    checker_path = import_module('{}'.format(CHECKERS_PATH)).__path__[0]
+    my_env['PYTHONPATH'] = checker_path
+    checkers = [os.path.splitext(f)[0] for f in os.listdir(checker_path) if
+                os.path.isfile(os.path.join(checker_path, f)) and f != '__init__.py']
+    enable = [s.replace('_', '-') for s in checkers]
+    pylint_result = run_pylint(selected_modules, env=my_env, checkers=checkers, disable_all=True, enable=enable)
+    if pylint_result and not pylint_result.error:
+        display(os.linesep + 'No violations found for custom pylint rules.')
+    if pylint_result and pylint_result.error:
+        logger.info(pylint_result.error.output.decode('utf-8'))
+        logger.info('Linter: FAILED\n')
+    return pylint_result.exit_code
+
+
 def linter_severity_choices():
     return [str(severity.name).lower() for severity in LinterSeverity]

azdev/operations/linter/linter.py

@@ -257,7 +257,7 @@ def run(self, run_params=None, run_commands=None, run_command_groups=None, run_h
             self._run_rules('params')
 
         if not self.exit_code:
-            print(os.linesep + 'No violations found.')
+            print(os.linesep + 'No violations found for linter rules.')
 
         if self._update_global_exclusion is not None:
             if self._update_global_exclusion == 'CLI':

azdev/operations/linter/pylint_checkers/__init__.py

@@ -0,0 +1,5 @@
+# -----------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# -----------------------------------------------------------------------------

azdev/operations/linter/pylint_checkers/show_command.py

@@ -0,0 +1,38 @@
+# -----------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# -----------------------------------------------------------------------------
+import astroid
+
+from pylint.checkers import BaseChecker
+from pylint.interfaces import IAstroidChecker
+
+
+class ShowCommandChecker(BaseChecker):
+    __implements__ = IAstroidChecker
+
+    name = 'show-command'
+    priority = -1
+    msgs = {
+        'E5001': (
+            'Show command must use show_command or custom_show_command.',
+            'show-command',
+            'Please use show_command or custom_show_command.'
+        ),
+    }
+
+    def visit_call(self, node):
+        try:
+            if not (isinstance(node.args[0], astroid.node_classes.Const) and node.args[0].value == 'show'):
+                return
+            if node.func.attrname == 'command' or node.func.attrname == 'custom_command':
+                self.add_message(
+                    'show-command', node=node,
+                )
+        except IndexError:
+            return
+
+
+def register(linter):
+    linter.register_checker(ShowCommandChecker(linter))

azdev/operations/style.py

@@ -79,7 +79,7 @@ def check_style(modules=None, pylint=False, pep8=False, git_source=None, git_tar
         exit_code_sum += pep8_result.exit_code
 
     if pylint:
-        pylint_result = _run_pylint(selected_modules)
+        pylint_result = run_pylint(selected_modules)
         exit_code_sum += pylint_result.exit_code
 
     display('')
@@ -131,7 +131,7 @@ def apply_result(item):
     return final_result
 
 
-def _run_pylint(modules):
+def run_pylint(modules, checkers=None, env=None, disable_all=False, enable=None):
     def get_core_module_paths(modules):
         core_paths = []
         for p in modules["core"].values():
@@ -148,20 +148,29 @@ def get_core_module_paths(modules):
         glob_pattern = os.path.normcase(os.path.join("{}*".format(EXTENSION_PREFIX)))
         ext_paths.append(glob(os.path.join(path, glob_pattern))[0])
 
-    def run(paths, rcfile, desc):
+    def run(paths, rcfile, desc, checkers=None, env=None, disable_all=False, enable=None):
         if not paths:
             return None
         logger.debug("Using rcfile file: %s", rcfile)
         logger.debug("Running on %s: %s", desc, "\n".join(paths))
         command = "pylint {} --ignore vendored_sdks,privates --rcfile={} -j {}".format(
             " ".join(paths), rcfile, multiprocessing.cpu_count()
         )
-        return py_cmd(command, message="Running pylint on {}...".format(desc))
+        if checkers is not None:
+            command += ' --load-plugins {}'.format(",".join(checkers))
+        if disable_all:
+            command += ' --disable=all'
+        if enable is not None:
+            command += ' --enable {}'.format(",".join(enable))
+
+        return py_cmd(command, message="Running pylint on {}...".format(desc), env=env)
 
     cli_pylintrc, ext_pylintrc = _config_file_path("pylint")
 
-    cli_result = run(cli_paths, cli_pylintrc, "modules")
-    ext_result = run(ext_paths, ext_pylintrc, "extensions")
+    cli_result = run(cli_paths, cli_pylintrc, "modules",
+                     checkers=checkers, env=env, disable_all=disable_all, enable=enable)
+    ext_result = run(ext_paths, ext_pylintrc, "extensions",
+                     checkers=checkers, env=env, disable_all=disable_all, enable=enable)
     return _combine_command_result(cli_result, ext_result)
 
 

azure-pipelines.yml

@@ -240,7 +240,7 @@ jobs:
       set -ev
       . scripts/ci/install.sh
       # verify azdev linter works
-      azdev linter CLI
+      azdev linter acr
     displayName: 'Test azdev linter'
 
 - job: TestAzdevStyle

setup.py

@@ -55,6 +55,7 @@
         'azdev.operations.help.refdoc',
         'azdev.operations.linter',
         'azdev.operations.linter.rules',
+        'azdev.operations.linter.pylint_checkers',
         'azdev.operations.testtool',
         'azdev.operations.extensions',
         'azdev.utilities',