checkxmlstyle/checkxmlstyle.py - chromium/src/tools/android - Git at Google

 # Copyright 2018 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.

 """Script that is used by PRESUBMIT.py to check Android XML files.

 This file checks for the following:
   - Colors are defined as RRGGBB or AARRGGBB
   - No (A)RGB values are referenced outside colors.xml
   - No duplicate (A)RGB values are referenced in colors.xml
   - XML namspace "app" is used for "http://schemas.android.com/apk/res-auto"
   - Android text attributes are only defined in text appearance styles
   - Warning on adding new text appearance styles
 """

 from collections import defaultdict
 import os
 import re
 import xml.etree.ElementTree as ET

 COLOR_PATTERN = re.compile(r'(>|")(#[0-9A-Fa-f]+)(<|")')
 VALID_COLOR_PATTERN = re.compile(
     r'^#([0-9A-F][0-9A-E]|[0-9A-E][0-9A-F])?[0-9A-F]{6}$')
 XML_APP_NAMESPACE_PATTERN = re.compile(
     r'xmlns:(\w+)="http://schemas.android.com/apk/res-auto"')
 TEXT_APPEARANCE_STYLE_PATTERN = re.compile(r'^TextAppearance\.')
 INCLUDED_PATHS = [
     r'^(chrome|ui|components|content)[\\/](.*[\\/])?java[\\/]res.+\.xml$'
 ]


 def CheckStyleOnUpload(input_api, output_api):
   """Returns result for all the presubmit upload checks for XML files."""
   result = _CommonChecks(input_api, output_api)
   result.extend(_CheckNewTextAppearance(input_api, output_api))
   return result


 def CheckStyleOnCommit(input_api, output_api):
   """Returns result for all the presubmit commit checks for XML files."""
   return _CommonChecks(input_api, output_api)


 def IncludedFiles(input_api):
   # Filter out XML files outside included paths and files that were deleted.
   files = lambda f: input_api.FilterSourceFile(f, white_list=INCLUDED_PATHS)
   return input_api.AffectedFiles(include_deletes=False, file_filter=files)


 def _CommonChecks(input_api, output_api):
   """Checks common to both upload and commit."""
   result = []
   result.extend(_CheckColorFormat(input_api, output_api))
   result.extend(_CheckColorReferences(input_api, output_api))
   result.extend(_CheckDuplicateColors(input_api, output_api))
   result.extend(_CheckXmlNamespacePrefixes(input_api, output_api))
   result.extend(_CheckTextAppearance(input_api, output_api))
   # Add more checks here
   return result


 def _CheckColorFormat(input_api, output_api):
   """Checks color (A)RGB values are of format either RRGGBB or AARRGGBB."""
   errors = []
   for f in IncludedFiles(input_api):
     # Ingnore vector drawable xmls
     contents = input_api.ReadFile(f)
     if '<vector' in contents:
       continue
     for line_number, line in f.ChangedContents():
       color = COLOR_PATTERN.search(line)
       if color and not VALID_COLOR_PATTERN.match(color.group(2)):
         errors.append(
             '  %s:%d\n    \t%s' % (f.LocalPath(), line_number, line.strip()))
   if errors:
     return [output_api.PresubmitError(
   '''
   Android Color Reference Check failed:
     Your new code added (A)RGB values for colors that are not well
     formatted, listed below.

     This is banned, please define colors in format of #RRGGBB for opaque
     colors or #AARRGGBB for translucent colors. Note that they should be
     defined in chrome/android/java/res/values/colors.xml.

     See https://crbug.com/775198 for more information.
   ''',
         errors)]
   return []


 def _CheckColorReferences(input_api, output_api):
   """Checks no (A)RGB values are defined outside colors.xml."""
   errors = []
   for f in IncludedFiles(input_api):
     if (f.LocalPath().endswith('/colors.xml') or
         f.LocalPath().endswith('/color_palette.xml')):
       continue
     # Ingnore vector drawable xmls
     contents = input_api.ReadFile(f)
     if '<vector' in contents:
       continue
     for line_number, line in f.ChangedContents():
       if COLOR_PATTERN.search(line):
         errors.append(
             '  %s:%d\n    \t%s' % (f.LocalPath(), line_number, line.strip()))
   if errors:
     return [output_api.PresubmitError(
   '''
   Android Color Reference Check failed:
     Your new code added new color references that are not color resources from
     chrome/android/java/res/values/colors.xml, listed below.

     This is banned, please use the existing color resources or create a new
     color resource in colors.xml, and reference the color by @color/....

     See https://crbug.com/775198 for more information.
   ''',
         errors)]
   return []


 def _CheckDuplicateColors(input_api, output_api):
   """Checks colors defined by (A)RGB values in colors.xml are unique."""
   errors = []
   for f in IncludedFiles(input_api):
     if not (f.LocalPath().endswith('/colors.xml')
             or f.LocalPath().endswith('/color_palette.xml')):
       continue
     colors = defaultdict(int)
     contents = input_api.ReadFile(f)
     # Get count for each color defined.
     for line in contents.splitlines(False):
       color = COLOR_PATTERN.search(line)
       if color:
         colors[color.group(2)] += 1

     # Check duplicates in changed contents.
     for line_number, line in f.ChangedContents():
       color = COLOR_PATTERN.search(line)
       if color and colors[color.group(2)] > 1:
         errors.append(
             '  %s:%d\n    \t%s' % (f.LocalPath(), line_number, line.strip()))
   if errors:
     return [output_api.PresubmitError(
   '''
   Android Duplicate Color Declaration Check failed:
     Your new code added new colors by (A)RGB values that are already defined in
     chrome/android/java/res/values/colors.xml, listed below.

     This is banned, please reference the existing color resource from colors.xml
     using @color/... and if needed, give the existing color resource a more
     general name (e.g. modern_grey_100).

     See https://crbug.com/775198 for more information.
   ''',
         errors)]
   return []


 def _CheckXmlNamespacePrefixes(input_api, output_api):
   """Checks consistency of prefixes used for XML namespace names."""
   errors = []
   for f in IncludedFiles(input_api):
     for line_number, line in f.ChangedContents():
       xml_app_namespace = XML_APP_NAMESPACE_PATTERN.search(line)
       if xml_app_namespace and not xml_app_namespace.group(1) == 'app':
         errors.append(
             '  %s:%d\n    \t%s' % (f.LocalPath(), line_number, line.strip()))
   if errors:
     return [output_api.PresubmitError(
   '''
   XML Namespace Prefixes Check failed:
     Your new code added new xml namespace declaration that is not consistent
     with other XML files. Namespace "http://schemas.android.com/apk/res-auto"
     should use 'app' prefix:

     xmlns:app="http://schemas.android.com/apk/res-auto"

     See https://crbug.com/850616 for more information.
   ''',
         errors)]
   return []


 def _CheckTextAppearance(input_api, output_api):
   """Checks text attributes are only used for text appearance styles in XMLs."""
   text_attributes = [
       'android:textColor', 'android:textSize', 'android:textStyle',
       'android:fontFamily', 'android:textAllCaps']
   namespace = {'android': 'http://schemas.android.com/apk/res/android'}
   errors = []
   for f in IncludedFiles(input_api):
     root = ET.fromstring(input_api.ReadFile(f))
     # Check if there are text attributes defined outside text appearances.
     for attribute in text_attributes:
       # Get style name that contains text attributes but is not text appearance.
       invalid_styles = []
       for style in root.findall('style') + root.findall('.//style'):
         name = style.get('name')
         is_text_appearance = TEXT_APPEARANCE_STYLE_PATTERN.search(name)
         item = style.find(".//item[@name='"+attribute+"']")
         if is_text_appearance is None and item is not None:
           invalid_styles.append(name)
       # Append error messages.
       contents = input_api.ReadFile(f)
       style_count = 0
       widget_count = len(root.findall('[@'+attribute+']', namespace)) + len(
           root.findall('.//*[@'+attribute+']', namespace))
       for line_number, line in enumerate(contents.splitlines(False)):
         # Error for text attributes in non-text-appearance style.
         if (style_count < len(invalid_styles) and
             invalid_styles[style_count] in line):
           errors.append('  %s:%d contains attribute %s\n    \t%s' % (
               f.LocalPath(), line_number+1, attribute, line.strip()))
           style_count += 1
         # Error for text attributes in layout.
         if widget_count > 0 and attribute in line:
           errors.append('  %s:%d contains attribute %s\n    \t%s' % (
               f.LocalPath(), line_number+1, attribute, line.strip()))
           widget_count -= 1
   # TODO(huayinz): Change the path on the error message to the corresponding
   # styles.xml when this check applies to all resource directories.
   if errors:
     return [output_api.PresubmitError(
   '''
   Android Text Appearance Check failed:
     Your modified files contain Android text attributes defined outside
     text appearance styles, listed below.

     It is recommended to use the pre-defined text appearance styles in
       src/ui/android/java/res/values-v17/styles.xml

     And to use
       android:textAppearance="@style/SomeTextAppearance"
     in the XML layout whenever possible.

     If your text appearance absolutely has to deviate from the existing
     pre-defined text appearance style, you will need UX approval for adding a
     new text appearance style.

     If your approved text appearance style is a common text appreance style,
     please define it in src/ui/android/java/res/values-v17/styles.xml.

     Otherwise, if your approved text appearance is feature-specific, in
     chrome/android/java/res/values*/styles.xml, please define
       <style name="TextAppearance.YourTextAppearanceName>
         <item name="android:textColor">...</item>
         <item name="android:textSize">...</item>
         ...
       </style>

     Please contact hannahs@chromium.org for UX approval, and
     src/chrome/android/java/res/OWNERS for questions.
     See https://crbug.com/775198 for more information.
   ''',
         errors)]
   return []


 def _CheckNewTextAppearance(input_api, output_api):
   """Checks whether a new text appearance style is defined."""
   errors = []
   for f in IncludedFiles(input_api):
     for line_number, line in f.ChangedContents():
       if '<style name="TextAppearance.' in line:
         errors.append(
             '  %s:%d\n    \t%s' % (f.LocalPath(), line_number, line.strip()))
   if errors:
     return [output_api.PresubmitPromptWarning(
   '''
   New Text Appearance in styles.xml Check failed:
     Your new code added, edited or removed a text appearance style.
     If you are removing or editing an existing text appearance style, or your
     new text appearance style is approved by UX, please bypass this check.

     Otherwise, please contact hannahs@chromium.org for UX approval, and
     src/chrome/android/java/res/OWNERS for questions.
     See https://crbug.com/775198 for more information.
   ''',
         errors)]
   return []
	# Copyright 2018 The Chromium Authors. All rights reserved.
	# Use of this source code is governed by a BSD-style license that can be
	# found in the LICENSE file.

	"""Script that is used by PRESUBMIT.py to check Android XML files.

	This file checks for the following:
	- Colors are defined as RRGGBB or AARRGGBB
	- No (A)RGB values are referenced outside colors.xml
	- No duplicate (A)RGB values are referenced in colors.xml
	- XML namspace "app" is used for "http://schemas.android.com/apk/res-auto"
	- Android text attributes are only defined in text appearance styles
	- Warning on adding new text appearance styles
	"""

	from collections import defaultdict
	import os
	import re
	import xml.etree.ElementTree as ET

	COLOR_PATTERN = re.compile(r'(>\|")(#[0-9A-Fa-f]+)(<\|")')
	VALID_COLOR_PATTERN = re.compile(
	r'^#([0-9A-F][0-9A-E]\|[0-9A-E][0-9A-F])?[0-9A-F]{6}$')
	XML_APP_NAMESPACE_PATTERN = re.compile(
	r'xmlns:(\w+)="http://schemas.android.com/apk/res-auto"')
	TEXT_APPEARANCE_STYLE_PATTERN = re.compile(r'^TextAppearance\.')
	INCLUDED_PATHS = [
	r'^(chrome\|ui\|components\|content)[\\/](.*[\\/])?java[\\/]res.+\.xml$'
	]


	def CheckStyleOnUpload(input_api, output_api):
	"""Returns result for all the presubmit upload checks for XML files."""
	result = _CommonChecks(input_api, output_api)
	result.extend(_CheckNewTextAppearance(input_api, output_api))
	return result


	def CheckStyleOnCommit(input_api, output_api):
	"""Returns result for all the presubmit commit checks for XML files."""
	return _CommonChecks(input_api, output_api)


	def IncludedFiles(input_api):
	# Filter out XML files outside included paths and files that were deleted.
	files = lambda f: input_api.FilterSourceFile(f, white_list=INCLUDED_PATHS)
	return input_api.AffectedFiles(include_deletes=False, file_filter=files)


	def _CommonChecks(input_api, output_api):
	"""Checks common to both upload and commit."""
	result = []
	result.extend(_CheckColorFormat(input_api, output_api))
	result.extend(_CheckColorReferences(input_api, output_api))
	result.extend(_CheckDuplicateColors(input_api, output_api))
	result.extend(_CheckXmlNamespacePrefixes(input_api, output_api))
	result.extend(_CheckTextAppearance(input_api, output_api))
	# Add more checks here
	return result


	def _CheckColorFormat(input_api, output_api):
	"""Checks color (A)RGB values are of format either RRGGBB or AARRGGBB."""
	errors = []
	for f in IncludedFiles(input_api):
	# Ingnore vector drawable xmls
	contents = input_api.ReadFile(f)
	if '<vector' in contents:
	continue
	for line_number, line in f.ChangedContents():
	color = COLOR_PATTERN.search(line)
	if color and not VALID_COLOR_PATTERN.match(color.group(2)):
	errors.append(
	' %s:%d\n \t%s' % (f.LocalPath(), line_number, line.strip()))
	if errors:
	return [output_api.PresubmitError(
	'''
	Android Color Reference Check failed:
	Your new code added (A)RGB values for colors that are not well
	formatted, listed below.

	This is banned, please define colors in format of #RRGGBB for opaque
	colors or #AARRGGBB for translucent colors. Note that they should be
	defined in chrome/android/java/res/values/colors.xml.

	See https://crbug.com/775198 for more information.
	''',
	errors)]
	return []


	def _CheckColorReferences(input_api, output_api):
	"""Checks no (A)RGB values are defined outside colors.xml."""
	errors = []
	for f in IncludedFiles(input_api):
	if (f.LocalPath().endswith('/colors.xml') or
	f.LocalPath().endswith('/color_palette.xml')):
	continue
	# Ingnore vector drawable xmls
	contents = input_api.ReadFile(f)
	if '<vector' in contents:
	continue
	for line_number, line in f.ChangedContents():
	if COLOR_PATTERN.search(line):
	errors.append(
	' %s:%d\n \t%s' % (f.LocalPath(), line_number, line.strip()))
	if errors:
	return [output_api.PresubmitError(
	'''
	Android Color Reference Check failed:
	Your new code added new color references that are not color resources from
	chrome/android/java/res/values/colors.xml, listed below.

	This is banned, please use the existing color resources or create a new
	color resource in colors.xml, and reference the color by @color/....

	See https://crbug.com/775198 for more information.
	''',
	errors)]
	return []


	def _CheckDuplicateColors(input_api, output_api):
	"""Checks colors defined by (A)RGB values in colors.xml are unique."""
	errors = []
	for f in IncludedFiles(input_api):
	if not (f.LocalPath().endswith('/colors.xml')
	or f.LocalPath().endswith('/color_palette.xml')):
	continue
	colors = defaultdict(int)
	contents = input_api.ReadFile(f)
	# Get count for each color defined.
	for line in contents.splitlines(False):
	color = COLOR_PATTERN.search(line)
	if color:
	colors[color.group(2)] += 1

	# Check duplicates in changed contents.
	for line_number, line in f.ChangedContents():
	color = COLOR_PATTERN.search(line)
	if color and colors[color.group(2)] > 1:
	errors.append(
	' %s:%d\n \t%s' % (f.LocalPath(), line_number, line.strip()))
	if errors:
	return [output_api.PresubmitError(
	'''
	Android Duplicate Color Declaration Check failed:
	Your new code added new colors by (A)RGB values that are already defined in
	chrome/android/java/res/values/colors.xml, listed below.

	This is banned, please reference the existing color resource from colors.xml
	using @color/... and if needed, give the existing color resource a more
	general name (e.g. modern_grey_100).

	See https://crbug.com/775198 for more information.
	''',
	errors)]
	return []


	def _CheckXmlNamespacePrefixes(input_api, output_api):
	"""Checks consistency of prefixes used for XML namespace names."""
	errors = []
	for f in IncludedFiles(input_api):
	for line_number, line in f.ChangedContents():
	xml_app_namespace = XML_APP_NAMESPACE_PATTERN.search(line)
	if xml_app_namespace and not xml_app_namespace.group(1) == 'app':
	errors.append(
	' %s:%d\n \t%s' % (f.LocalPath(), line_number, line.strip()))
	if errors:
	return [output_api.PresubmitError(
	'''
	XML Namespace Prefixes Check failed:
	Your new code added new xml namespace declaration that is not consistent
	with other XML files. Namespace "http://schemas.android.com/apk/res-auto"
	should use 'app' prefix:

	xmlns:app="http://schemas.android.com/apk/res-auto"

	See https://crbug.com/850616 for more information.
	''',
	errors)]
	return []


	def _CheckTextAppearance(input_api, output_api):
	"""Checks text attributes are only used for text appearance styles in XMLs."""
	text_attributes = [
	'android:textColor', 'android:textSize', 'android:textStyle',
	'android:fontFamily', 'android:textAllCaps']
	namespace = {'android': 'http://schemas.android.com/apk/res/android'}
	errors = []
	for f in IncludedFiles(input_api):
	root = ET.fromstring(input_api.ReadFile(f))
	# Check if there are text attributes defined outside text appearances.
	for attribute in text_attributes:
	# Get style name that contains text attributes but is not text appearance.
	invalid_styles = []
	for style in root.findall('style') + root.findall('.//style'):
	name = style.get('name')
	is_text_appearance = TEXT_APPEARANCE_STYLE_PATTERN.search(name)
	item = style.find(".//item[@name='"+attribute+"']")
	if is_text_appearance is None and item is not None:
	invalid_styles.append(name)
	# Append error messages.
	contents = input_api.ReadFile(f)
	style_count = 0
	widget_count = len(root.findall('[@'+attribute+']', namespace)) + len(
	root.findall('.//*[@'+attribute+']', namespace))
	for line_number, line in enumerate(contents.splitlines(False)):
	# Error for text attributes in non-text-appearance style.
	if (style_count < len(invalid_styles) and
	invalid_styles[style_count] in line):
	errors.append(' %s:%d contains attribute %s\n \t%s' % (
	f.LocalPath(), line_number+1, attribute, line.strip()))
	style_count += 1
	# Error for text attributes in layout.
	if widget_count > 0 and attribute in line:
	errors.append(' %s:%d contains attribute %s\n \t%s' % (
	f.LocalPath(), line_number+1, attribute, line.strip()))
	widget_count -= 1
	# TODO(huayinz): Change the path on the error message to the corresponding
	# styles.xml when this check applies to all resource directories.
	if errors:
	return [output_api.PresubmitError(
	'''
	Android Text Appearance Check failed:
	Your modified files contain Android text attributes defined outside
	text appearance styles, listed below.

	It is recommended to use the pre-defined text appearance styles in
	src/ui/android/java/res/values-v17/styles.xml

	And to use
	android:textAppearance="@style/SomeTextAppearance"
	in the XML layout whenever possible.

	If your text appearance absolutely has to deviate from the existing
	pre-defined text appearance style, you will need UX approval for adding a
	new text appearance style.

	If your approved text appearance style is a common text appreance style,
	please define it in src/ui/android/java/res/values-v17/styles.xml.

	Otherwise, if your approved text appearance is feature-specific, in
	chrome/android/java/res/values*/styles.xml, please define
	<style name="TextAppearance.YourTextAppearanceName>
	<item name="android:textColor">...</item>
	<item name="android:textSize">...</item>
	...
	</style>

	Please contact hannahs@chromium.org for UX approval, and
	src/chrome/android/java/res/OWNERS for questions.
	See https://crbug.com/775198 for more information.
	''',
	errors)]
	return []


	def _CheckNewTextAppearance(input_api, output_api):
	"""Checks whether a new text appearance style is defined."""
	errors = []
	for f in IncludedFiles(input_api):
	for line_number, line in f.ChangedContents():
	if '<style name="TextAppearance.' in line:
	errors.append(
	' %s:%d\n \t%s' % (f.LocalPath(), line_number, line.strip()))
	if errors:
	return [output_api.PresubmitPromptWarning(
	'''
	New Text Appearance in styles.xml Check failed:
	Your new code added, edited or removed a text appearance style.
	If you are removing or editing an existing text appearance style, or your
	new text appearance style is approved by UX, please bypass this check.

	Otherwise, please contact hannahs@chromium.org for UX approval, and
	src/chrome/android/java/res/OWNERS for questions.
	See https://crbug.com/775198 for more information.
	''',
	errors)]
	return []