From c9b234eafc9f0e543e4cd260dbe7a26e0f5348f8 Mon Sep 17 00:00:00 2001
From: Andi-Bogdan Postelnicu <bpostelnicu@mozilla.com>
Date: Thu, 11 Apr 2019 09:58:59 +0000
Subject: [PATCH] Bug 1543492 - for clang based static-analysis and formating
 add a package version that represents a baseline if we continue the analysis
 or prompt for an update. r=sylvestre

Differential Revision: https://phabricator.services.mozilla.com/D27042

--HG--
extra : moz-landing-system : lando
---
 python/mozbuild/mozbuild/mach_commands.py | 48 ++++++++++++++++++++++-
 tools/clang-tidy/config.yaml              |  2 +-
 2 files changed, 47 insertions(+), 3 deletions(-)

diff --git a/python/mozbuild/mozbuild/mach_commands.py b/python/mozbuild/mozbuild/mach_commands.py
index 5ab6f1bc8b95..a150b40bace0 100644
--- a/python/mozbuild/mozbuild/mach_commands.py
+++ b/python/mozbuild/mozbuild/mach_commands.py
@@ -1677,6 +1677,8 @@ class StaticAnalysis(MachCommandBase):
     # File contaning all paths to exclude from formatting
     _format_ignore_file = '.clang-format-ignore'
 
+    _clang_tidy_config = None
+
     @Command('static-analysis', category='testing',
              description='Run C++ static analysis checks')
     def static_analysis(self):
@@ -1724,9 +1726,17 @@ class StaticAnalysis(MachCommandBase):
         self._set_log_level(verbose)
         self.log_manager.enable_all_structured_loggers()
 
+        rc = self._get_clang_tools(verbose=verbose)
+        if rc != 0:
+            return rc
+
+        if self._is_version_eligible() is False:
+            self.log(logging.ERROR, 'static-analysis', {}, "You're using an old version of clang-format binary."
+                            " Please update to a more recent one by running: './mach bootstrap'")
+            return 1
+
         rc = self._build_compile_db(verbose=verbose)
         rc = rc or self._build_export(jobs=jobs, verbose=verbose)
-        rc = rc or self._get_clang_tools(verbose=verbose)
         if rc != 0:
             return rc
 
@@ -1753,7 +1763,8 @@ class StaticAnalysis(MachCommandBase):
 
         cwd = self.topobjdir
         self._compilation_commands_path = self.topobjdir
-        self._clang_tidy_config = self._get_clang_tidy_config()
+        if self._clang_tidy_config is None:
+            self._clang_tidy_config = self._get_clang_tidy_config()
         args = self._get_clang_tidy_command(
             checks=checks, header_filter=header_filter, sources=source, jobs=jobs, fix=fix)
 
@@ -2203,6 +2214,34 @@ class StaticAnalysis(MachCommandBase):
             return None
         return config
 
+    def _is_version_eligible(self):
+        # make sure that we've cached self._clang_tidy_config
+        if self._clang_tidy_config is None:
+            self._clang_tidy_config = self._get_clang_tidy_config()
+
+        version = None
+        if 'package_version' in self._clang_tidy_config:
+            version = self._clang_tidy_config['package_version']
+        else:
+            self.log(logging.ERROR, 'static-analysis', {}, "Unable to find 'package_version' in the config.yml")
+            return False
+
+        # Because the fact that we ship together clang-tidy and clang-format
+        # we are sure that these two will always share the same version.
+        # Thus in order to determine that the version is compatible we only
+        # need to check one of them, going with clang-format
+        cmd = [self._clang_format_path, '--version']
+        try:
+            output = subprocess.check_output(cmd, stderr=subprocess.STDOUT).decode('utf-8')
+            version_string = 'clang-format version ' + version
+            if output.startswith(version_string):
+                return True
+        except subprocess.CalledProcessError as e:
+            self.log(logging.ERROR, 'static-analysis', {},
+                     "Error determining the version clang-tidy/format binary, please see the attached exception: \n{}".format(e.output))
+
+        return False
+
     def _get_clang_tidy_command(self, checks, header_filter, sources, jobs, fix):
 
         if checks == '-*':
@@ -2755,6 +2794,11 @@ class StaticAnalysis(MachCommandBase):
             if rc != 0:
                 return rc
 
+        if self._is_version_eligible() is False:
+            self.log(logging.ERROR, 'static-analysis', {}, "You're using an old version of clang-format binary."
+                            " Please update to a more recent one by running: './mach bootstrap'")
+            return 1
+
         if path is None:
             return self._run_clang_format_diff(self._clang_format_diff,
                                                self._clang_format_path, commit, output)
diff --git a/tools/clang-tidy/config.yaml b/tools/clang-tidy/config.yaml
index 869c0a84ac42..120a001639f4 100644
--- a/tools/clang-tidy/config.yaml
+++ b/tools/clang-tidy/config.yaml
@@ -18,7 +18,7 @@ platforms:
   - win64
 # Minimum clang-tidy version that is required for all the following checkers
 # to work properly.
-min_clang_tidy: "8.0.0"
+package_version: "8.0.0"
 clang_checkers:
   - name: -*
     publish: !!bool no