LineageOS/android_development
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Skip JavaDoc checks for Java tests classes

Browse Source 
Bug: 26862656
Change-Id: I708ee552154796ece6655db8f9f3157a2e9f3ba5
This commit is contained in:
Aurimas Liutikas
2016-01-29 13:07:22 -08:00
parent 4e89da7764
commit 99451e5b13
2 changed files with 42 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
tools/checkstyle/checkstyle.py
View File

@@ -34,6 +34,8 @@ CHECKSTYLE_JAR = os.path.join(MAIN_DIRECTORY, 'checkstyle.jar')
CHECKSTYLE_STYLE = os.path.join(MAIN_DIRECTORY, 'android-style.xml')
FORCED_RULES = ['com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck',
'com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck']
SKIPPED_RULES_FOR_TEST_FILES = ['com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck']
SUBPATH_FOR_TEST_FILES = ['/tests/java/', '/tests/src/']
ERROR_UNCOMMITTED = 'You need to commit all modified files before running Checkstyle\n'
ERROR_UNTRACKED = 'You have untracked java files that are not being checked:\n'
@@ -157,16 +159,20 @@ def _ParseAndFilterOutput(stdout,
file_name = file_element.attributes['name'].value
if tmp_file_map:
file_name = tmp_file_map[file_name]
modified_lines = None
if commit_modified_files:
modified_lines = git.modified_lines(file_name,
commit_modified_files[file_name],
sha)
test_class = any(substring in file_name for substring
in SUBPATH_FOR_TEST_FILES)
file_name = os.path.relpath(file_name)
errors = file_element.getElementsByTagName('error')
for error in errors:
line = int(error.attributes['line'].value)
rule = error.attributes['source'].value
if commit_modified_files and _ShouldSkip(modified_lines, line, rule):
if _ShouldSkip(commit_modified_files, modified_lines, line, rule,
test_class):
continue
column = ''
@@ -183,18 +189,24 @@ def _ParseAndFilterOutput(stdout,
return result_errors, result_warnings
def _ShouldSkip(modified_lines, line, rule):
def _ShouldSkip(commit_check, modified_lines, line, rule, test_class=False):
"""Returns whether an error on a given line should be skipped.
Args:
commit_check: Whether Checkstyle is being run on a specific commit.
modified_lines: A list of lines that has been modified.
line: The line that has a rule violation.
rule: The type of rule that a given line is violating.
test_class: Whether the file being checked is a test class.
Returns:
A boolean whether a given line should be skipped in the reporting.
"""
# None modified_lines means checked file is new and nothing should be skipped.
if test_class and rule in SKIPPED_RULES_FOR_TEST_FILES:
return True
if not commit_check:
return False
if modified_lines is None:
return False
return line not in modified_lines and rule not in FORCED_RULES

35
tools/checkstyle/tests.py
View File

@@ -77,14 +77,35 @@ class TestCheckstyle(unittest.TestCase):
checkstyle.git.last_commit = mock_last_commit
def test_ShouldSkip(self):
self.assertFalse(checkstyle._ShouldSkip(None, 1, TEST_RULE))
self.assertTrue(checkstyle._ShouldSkip([], 1, TEST_RULE))
self.assertFalse(checkstyle._ShouldSkip([1], 1, TEST_RULE))
self.assertFalse(checkstyle._ShouldSkip([1, 2, 3], 1, TEST_RULE))
self.assertTrue(checkstyle._ShouldSkip([1, 2, 3], 4, TEST_RULE))
# Skip checks for explicit git commit.
self.assertFalse(checkstyle._ShouldSkip(True, None, 1, TEST_RULE))
self.assertTrue(checkstyle._ShouldSkip(True, [], 1, TEST_RULE))
self.assertFalse(checkstyle._ShouldSkip(True, [1], 1, TEST_RULE))
self.assertFalse(checkstyle._ShouldSkip(True, [1, 2, 3], 1, TEST_RULE))
self.assertTrue(checkstyle._ShouldSkip(True, [1, 2, 3], 4, TEST_RULE))
for rule in checkstyle.FORCED_RULES:
self.assertFalse(checkstyle._ShouldSkip([1, 2, 3], 1, rule))
self.assertFalse(checkstyle._ShouldSkip([1, 2, 3], 4, rule))
self.assertFalse(checkstyle._ShouldSkip(True, [1, 2, 3], 1, rule))
self.assertFalse(checkstyle._ShouldSkip(True, [1, 2, 3], 4, rule))
# Skip checks for explicitly checked files.
self.assertFalse(checkstyle._ShouldSkip(False, None, 1, TEST_RULE))
self.assertFalse(checkstyle._ShouldSkip(False, [], 1, TEST_RULE))
self.assertFalse(checkstyle._ShouldSkip(False, [1], 1, TEST_RULE))
self.assertFalse(checkstyle._ShouldSkip(False, [1, 2, 3], 1, TEST_RULE))
self.assertFalse(checkstyle._ShouldSkip(False, [1, 2, 3], 4, TEST_RULE))
for rule in checkstyle.FORCED_RULES:
self.assertFalse(checkstyle._ShouldSkip(False, [1, 2, 3], 1, rule))
self.assertFalse(checkstyle._ShouldSkip(False, [1, 2, 3], 4, rule))
# Skip checks for test classes.
self.assertFalse(checkstyle._ShouldSkip(True, None, 1, TEST_RULE, True))
self.assertTrue(checkstyle._ShouldSkip(True, [], 1, TEST_RULE, True))
self.assertFalse(checkstyle._ShouldSkip(True, [1], 1, TEST_RULE, True))
self.assertFalse(checkstyle._ShouldSkip(True, [1, 2, 3], 1, TEST_RULE, True))
self.assertTrue(checkstyle._ShouldSkip(True, [1, 2, 3], 4, TEST_RULE, True))
for rule in checkstyle.SKIPPED_RULES_FOR_TEST_FILES:
self.assertTrue(checkstyle._ShouldSkip(True, [1, 2, 3], 1, rule, True))
self.assertTrue(checkstyle._ShouldSkip(True, [1, 2, 3], 4, rule, True))
def test_GetModifiedFiles(self):
checkstyle.git.modified_files = mock_modified_files_good