Presubmit: Check the commit description for AX-Relnotes field

In addition to checking the commit footer, we should also check the
commit description for the AX-Relnotes field.

Bug: N/A

Change-Id: Ie9839bbf02b84d97ace0c60e8b972d048bbe7eb6
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2198931
Commit-Queue: Akihiro Ota <akihiroota@chromium.org>
Reviewed-by: Dirk Pranke <dpranke@chromium.org>
Reviewed-by: Chris Hall <chrishall@chromium.org>
Cr-Commit-Position: refs/heads/master@{#770600}

PRESUBMIT.py

@@ -4310,8 +4310,16 @@ def _CheckAccessibilityRelnotesField(input_api, output_api):
   if not any(input_api.AffectedFiles(file_filter=FileFilter)):
     return []
 
-  relnotes = input_api.change.GitFootersFromDescription().get('AX-Relnotes', [])
-  if relnotes:
+  # AX-Relnotes can appear in either the description or the footer.
+  # When searching the description, require 'AX-Relnotes:' to appear at the
+  # beginning of a line.
+  ax_regex = input_api.re.compile('ax-relnotes[:=]')
+  description_has_relnotes = any(ax_regex.match(line)
+    for line in input_api.change.DescriptionText().lower().splitlines())
+
+  footer_relnotes = input_api.change.GitFootersFromDescription().get(
+    'AX-Relnotes', [])
+  if description_has_relnotes or footer_relnotes:
     return []
 
   # TODO(chrishall): link to Relnotes documentation in message.

PRESUBMIT_test.py

@@ -1028,6 +1028,7 @@ class AccessibilityRelnotesFieldTest(unittest.TestCase):
     mock_output_api = MockOutputApi()
 
     mock_input_api.files = [MockAffectedFile('ui/accessibility/foo.bar', [''])]
+    mock_input_api.change.DescriptionText = lambda : 'Commit description'
     mock_input_api.change.footers['AX-Relnotes'] = [
         'Important user facing change']
 
@@ -1046,6 +1047,7 @@ class AccessibilityRelnotesFieldTest(unittest.TestCase):
         MockAffectedFile('ui/accessibility/foo.bar', ['']),
         MockAffectedFile('some/other/file', [''])
     ]
+    mock_input_api.change.DescriptionText = lambda : 'Commit description'
 
     msgs = PRESUBMIT._CheckAccessibilityRelnotesField(
         mock_input_api, mock_output_api)
@@ -1065,6 +1067,7 @@ class AccessibilityRelnotesFieldTest(unittest.TestCase):
         MockAffectedFile('some/file', ['']),
         MockAffectedFile('some/other/file', [''])
     ]
+    mock_input_api.change.DescriptionText = lambda : 'Commit description'
 
     msgs = PRESUBMIT._CheckAccessibilityRelnotesField(
         mock_input_api, mock_output_api)
@@ -1097,6 +1100,7 @@ class AccessibilityRelnotesFieldTest(unittest.TestCase):
       mock_input_api.files = [
           MockAffectedFile(testFile, [''])
       ]
+      mock_input_api.change.DescriptionText = lambda : 'Commit description'
 
       msgs = PRESUBMIT._CheckAccessibilityRelnotesField(
           mock_input_api, mock_output_api)
@@ -1107,6 +1111,58 @@ class AccessibilityRelnotesFieldTest(unittest.TestCase):
                       ('Missing AX-Relnotes field message not found in errors '
                        ' for file %s' % (testFile)))
 
+  # Test that AX-Relnotes field can appear in the commit description (as long
+  # as it appears at the beginning of a line).
+  def testRelnotesInCommitDescription(self):
+    mock_input_api = MockInputApi()
+    mock_output_api = MockOutputApi()
+
+    mock_input_api.files = [
+        MockAffectedFile('ui/accessibility/foo.bar', ['']),
+    ]
+    mock_input_api.change.DescriptionText = lambda : ('Description:\n' +
+        'AX-Relnotes: solves all accessibility issues forever')
+
+    msgs = PRESUBMIT._CheckAccessibilityRelnotesField(
+        mock_input_api, mock_output_api)
+    self.assertEqual(0, len(msgs),
+                     'Expected %d messages, found %d: %s'
+                     % (0, len(msgs), msgs))
+
+  # Test that we don't match AX-Relnotes if it appears in the middle of a line.
+  def testRelnotesMustAppearAtBeginningOfLine(self):
+    mock_input_api = MockInputApi()
+    mock_output_api = MockOutputApi()
+
+    mock_input_api.files = [
+        MockAffectedFile('ui/accessibility/foo.bar', ['']),
+    ]
+    mock_input_api.change.DescriptionText = lambda : ('Description:\n' +
+        'This change has no AX-Relnotes: we should print a warning')
+
+    msgs = PRESUBMIT._CheckAccessibilityRelnotesField(
+        mock_input_api, mock_output_api)
+    self.assertTrue("Missing 'AX-Relnotes:' field" in msgs[0].message,
+                    'Missing AX-Relnotes field message not found in errors')
+
+  # Tests that the AX-Relnotes field can be lowercase and use a '=' in place
+  # of a ':'.
+  def testRelnotesLowercaseWithEqualSign(self):
+    mock_input_api = MockInputApi()
+    mock_output_api = MockOutputApi()
+
+    mock_input_api.files = [
+        MockAffectedFile('ui/accessibility/foo.bar', ['']),
+    ]
+    mock_input_api.change.DescriptionText = lambda : ('Description:\n' +
+        'ax-relnotes= this is a valid format for accessibiliy relnotes')
+
+    msgs = PRESUBMIT._CheckAccessibilityRelnotesField(
+        mock_input_api, mock_output_api)
+    self.assertEqual(0, len(msgs),
+                     'Expected %d messages, found %d: %s'
+                     % (0, len(msgs), msgs))
+
 class AndroidDeprecatedTestAnnotationTest(unittest.TestCase):
   def testCheckAndroidTestAnnotationUsage(self):
     mock_input_api = MockInputApi()