Add PRESUBMIT check if modified UMA histogram name can be found (2)
This CL is an iteration of http://crrev.com/766713004, that got reverted
after http://crbug.com/445265 because it could not cope correctly
with structures of the type:
<histogram_suffixes name="SafeBrowsingStores.SBWhiteLists" separator=".">
<suffix name="CSD" label="CSD"/>
<suffix name="DownloadWhitelist" label="DownloadWhitelist"/>
<affected-histogram name="SB2.DatabaseKilobytes"/>
</histogram_suffixes>
(in particular: affected-histogram-suffixes).
Limitation that should be solved now.
Original description ---------------------------------------------------
Add PRESUBMIT check if modified UMA histogram name can be found
This Presubmit checks if some diffs affect any UMA_HISTOGRAM_*
macro and, if so, checks if the histogram name is to be found
in either tools/metrics/histograms/histograms.xml or in the
CL diffs.
Addresses the problem of someone modifying code and
inadvertently forgetting a corresponding histograms.xml
adaptation, that has happened in the past.
BUG=434420, 445265
Review URL: https://codereview.chromium.org/885783007
Cr-Commit-Position: refs/heads/master@{#314557}
diff --git a/PRESUBMIT.py b/PRESUBMIT.py
index 3326d8c..8e4880b2 100644
--- a/PRESUBMIT.py
+++ b/PRESUBMIT.py
@@ -359,6 +359,69 @@
'\n'.join(problems))]
+def _FindHistogramNameInLine(histogram_name, line):
+ """Tries to find a histogram name or prefix in a line."""
+ if not "affected-histogram" in line:
+ return histogram_name in line
+ # A histogram_suffixes tag type has an affected-histogram name as a prefix of
+ # the histogram_name.
+ if not '"' in line:
+ return False
+ histogram_prefix = line.split('\"')[1]
+ return histogram_prefix in histogram_name
+
+
+def _CheckUmaHistogramChanges(input_api, output_api):
+ """Check that UMA histogram names in touched lines can still be found in other
+ lines of the patch or in histograms.xml. Note that this check would not catch
+ the reverse: changes in histograms.xml not matched in the code itself."""
+ touched_histograms = []
+ histograms_xml_modifications = []
+ pattern = input_api.re.compile('UMA_HISTOGRAM.*\("(.*)"')
+ for f in input_api.AffectedFiles():
+ # If histograms.xml itself is modified, keep the modified lines for later.
+ if f.LocalPath().endswith(('histograms.xml')):
+ histograms_xml_modifications = f.ChangedContents()
+ continue
+ if not f.LocalPath().endswith(('cc', 'mm', 'cpp')):
+ continue
+ for line_num, line in f.ChangedContents():
+ found = pattern.search(line)
+ if found:
+ touched_histograms.append([found.group(1), f, line_num])
+
+ # Search for the touched histogram names in the local modifications to
+ # histograms.xml, and, if not found, on the base histograms.xml file.
+ unmatched_histograms = []
+ for histogram_info in touched_histograms:
+ histogram_name_found = False
+ for line_num, line in histograms_xml_modifications:
+ histogram_name_found = _FindHistogramNameInLine(histogram_info[0], line)
+ if histogram_name_found:
+ break
+ if not histogram_name_found:
+ unmatched_histograms.append(histogram_info)
+
+ problems = []
+ if unmatched_histograms:
+ with open('tools/metrics/histograms/histograms.xml') as histograms_xml:
+ for histogram_name, f, line_num in unmatched_histograms:
+ histogram_name_found = False
+ for line in histograms_xml:
+ histogram_name_found = _FindHistogramNameInLine(histogram_name, line)
+ if histogram_name_found:
+ break
+ if not histogram_name_found:
+ problems.append(' [%s:%d] %s' %
+ (f.LocalPath(), line_num, histogram_name))
+
+ if not problems:
+ return []
+ return [output_api.PresubmitPromptWarning('Some UMA_HISTOGRAM lines have '
+ 'been modified and the associated histogram name has no match in either '
+ 'metrics/histograms.xml or the modifications of it:', problems)]
+
+
def _CheckNoNewWStrings(input_api, output_api):
"""Checks to make sure we don't introduce use of wstrings."""
problems = []
@@ -1585,6 +1648,7 @@
results.extend(_CheckJavaStyle(input_api, output_api))
results.extend(
input_api.canned_checks.CheckGNFormatted(input_api, output_api))
+ results.extend(_CheckUmaHistogramChanges(input_api, output_api))
return results
diff --git a/PRESUBMIT_test.py b/PRESUBMIT_test.py
index 58ca402..00997b43 100755
--- a/PRESUBMIT_test.py
+++ b/PRESUBMIT_test.py
@@ -270,6 +270,73 @@
self.assertTrue('3' in errors[1])
self.assertTrue('5' in errors[2])
+class UmaHistogramChangeMatchedOrNotTest(unittest.TestCase):
+ def testTypicalCorrectlyMatchedChange(self):
+ diff_cc = ['UMA_HISTOGRAM_BOOL("Bla.Foo.Dummy", true)']
+ diff_xml = ['<histogram name="Bla.Foo.Dummy"> </histogram>']
+ mock_input_api = MockInputApi()
+ mock_input_api.files = [
+ MockFile('some/path/foo.cc', diff_cc),
+ MockFile('tools/metrics/histograms/histograms.xml', diff_xml),
+ ]
+ warnings = PRESUBMIT._CheckUmaHistogramChanges(mock_input_api,
+ MockOutputApi())
+ self.assertEqual(0, len(warnings))
+
+ def testTypicalNotMatchedChange(self):
+ diff_cc = ['UMA_HISTOGRAM_BOOL("Bla.Foo.Dummy", true)']
+ mock_input_api = MockInputApi()
+ mock_input_api.files = [MockFile('some/path/foo.cc', diff_cc)]
+ warnings = PRESUBMIT._CheckUmaHistogramChanges(mock_input_api,
+ MockOutputApi())
+ self.assertEqual(1, len(warnings))
+ self.assertEqual('warning', warnings[0].type)
+
+ def testTypicalNotMatchedChangeViaSuffixes(self):
+ diff_cc = ['UMA_HISTOGRAM_BOOL("Bla.Foo.Dummy", true)']
+ diff_xml = ['<histogram_suffixes name="SuperHistogram">',
+ ' <suffix name="Dummy"/>',
+ ' <affected-histogram name="Snafu.Dummy"/>',
+ '</histogram>']
+ mock_input_api = MockInputApi()
+ mock_input_api.files = [
+ MockFile('some/path/foo.cc', diff_cc),
+ MockFile('tools/metrics/histograms/histograms.xml', diff_xml),
+ ]
+ warnings = PRESUBMIT._CheckUmaHistogramChanges(mock_input_api,
+ MockOutputApi())
+ self.assertEqual(1, len(warnings))
+ self.assertEqual('warning', warnings[0].type)
+
+ def testTypicalCorrectlyMatchedChangeViaSuffixes(self):
+ diff_cc = ['UMA_HISTOGRAM_BOOL("Bla.Foo.Dummy", true)']
+ diff_xml = ['<histogram_suffixes name="SuperHistogram">',
+ ' <suffix name="Dummy"/>',
+ ' <affected-histogram name="Bla.Foo"/>',
+ '</histogram>']
+ mock_input_api = MockInputApi()
+ mock_input_api.files = [
+ MockFile('some/path/foo.cc', diff_cc),
+ MockFile('tools/metrics/histograms/histograms.xml', diff_xml),
+ ]
+ warnings = PRESUBMIT._CheckUmaHistogramChanges(mock_input_api,
+ MockOutputApi())
+ self.assertEqual(0, len(warnings))
+
+ def testTypicalCorrectlyMatchedChangeViaSuffixesWithSeparator(self):
+ diff_cc = ['UMA_HISTOGRAM_BOOL("Snafu_Dummy", true)']
+ diff_xml = ['<histogram_suffixes name="SuperHistogram" separator="_">',
+ ' <suffix name="Dummy"/>',
+ ' <affected-histogram name="Snafu"/>',
+ '</histogram>']
+ mock_input_api = MockInputApi()
+ mock_input_api.files = [
+ MockFile('some/path/foo.cc', diff_cc),
+ MockFile('tools/metrics/histograms/histograms.xml', diff_xml),
+ ]
+ warnings = PRESUBMIT._CheckUmaHistogramChanges(mock_input_api,
+ MockOutputApi())
+ self.assertEqual(0, len(warnings))
class BadExtensionsTest(unittest.TestCase):
def testBadRejFile(self):
