From 68bdb650685df061967bcfcc706a55e885ccb4d0 Mon Sep 17 00:00:00 2001
From: Miguel Casas <mcasas@chromium.org>
Date: Tue, 19 Dec 2017 16:29:09 +0000
Subject: [PATCH] PRESUBMIT: Skip TODO(crbug.com/ pattern for upload warning

This CL admits the TODO(crbug.com/...) format for bug
references in the code base and avoids the presubmit
warning in those cases. This pattern is pervasive and
even necessary in some folders (e.g. ios/) so, although
it isn't linkified by cs.chromium.org, it's accepted.

Change-Id: Ifb6eda7967271acf76ddfb5fa555ed60f9bce415
Reviewed-on: https://chromium-review.googlesource.com/833203
Reviewed-by: Jochen Eisinger <jochen@chromium.org>
Reviewed-by: Sylvain Defresne <sdefresne@chromium.org>
Commit-Queue: Miguel Casas <mcasas@chromium.org>
Cr-Commit-Position: refs/heads/master@{#525052}
---
 PRESUBMIT.py      | 7 +++++--
 PRESUBMIT_test.py | 4 +++-
 2 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/PRESUBMIT.py b/PRESUBMIT.py
index b3f9a99f18ce1c..3dec54d61613a8 100644
--- a/PRESUBMIT.py
+++ b/PRESUBMIT.py
@@ -2762,17 +2762,20 @@ def _CheckSyslogUseWarning(input_api, output_api, source_file_filter=None,
 
 
 def _CheckCrbugLinksHaveHttps(input_api, output_api):
-  """Checks that crbug(.com) links are correctly prefixed by https://"""
+  """Checks that crbug(.com) links are correctly prefixed by https://,
+   unless they come in the accepted form TODO(crbug.com/...)
+  """
   white_list = r'.+%s' % _IMPLEMENTATION_EXTENSIONS
   black_list = (_EXCLUDED_PATHS + _TEST_CODE_EXCLUDED_PATHS)
   sources = lambda f: input_api.FilterSourceFile(
       f, white_list=white_list, black_list=black_list)
 
   pattern = input_api.re.compile(r'//.*(?<!:\/\/)crbug[.com]*')
+  accepted_pattern = input_api.re.compile(r'//.*TODO\(crbug[.com]*');
   problems = []
   for f in input_api.AffectedSourceFiles(sources):
     for line_num, line in f.ChangedContents():
-      if pattern.search(line):
+      if pattern.search(line) and not accepted_pattern.search(line):
         problems.append('    %s:%d %s' % (f.LocalPath(), line_num, line))
 
   if problems:
diff --git a/PRESUBMIT_test.py b/PRESUBMIT_test.py
index bb22f8c51af282..4b195d8f1f3285 100755
--- a/PRESUBMIT_test.py
+++ b/PRESUBMIT_test.py
@@ -1298,11 +1298,13 @@ def testCheckCrbugLinksHaveHttps(self):
                 '// TODO(developer): (crbug.com) should be linkified',
                 '// TODO(developer): crbug/123 should be well formed',
                 '// TODO(developer): http://crbug.com it\'s OK',
-                '// TODO(developer): https://crbug.com is just great']),
+                '// TODO(developer): https://crbug.com is just great',
+                '// TODO(crbug.com/123456): this pattern it\'s also OK']),
     ]
 
     warnings = PRESUBMIT._CheckCrbugLinksHaveHttps(input_api, MockOutputApi())
     self.assertEqual(1, len(warnings))
+    self.assertEqual(3, warnings[0].message.count('\n'));
 
 
 if __name__ == '__main__':