1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
#!/usr/bin/python
#
# Copyright 2015, The Android Open Source Project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
"""Tests the Checkstyle script used to run style checks on Java files."""
from StringIO import StringIO
import unittest
import checkstyle
TEST_RULE = u'com.puppycrawl.tools.checkstyle.checks.BANANAS'
TEST_SHA = u'0000deadbeef000000deadbeef00deadbeef0000'
TEST_ROOT = u'/usr/local/android/master/framework/support'
TEST_FILE1 = TEST_ROOT + u'/Blarg.java'
TEST_FILE2 = TEST_ROOT + u'/Blarg2.java'
TEST_FILE_NON_JAVA = TEST_ROOT + u'/blarg.cc'
FILE_ADDED = u'A '
FILE_MODIFIED = u'M '
FILE_UNTRACKED = u'??'
def mock_repository_root():
return TEST_ROOT
def mock_last_commit():
return TEST_SHA
def mock_modified_files_good(root, tracked_only=False, commit=None):
if commit:
return {TEST_FILE1: FILE_MODIFIED, TEST_FILE2: FILE_ADDED}
return {}
def mock_modified_files_uncommitted(root, tracked_only=False, commit=None):
if tracked_only and not commit:
return {TEST_FILE1: FILE_MODIFIED}
if commit:
return {TEST_FILE1: FILE_MODIFIED, TEST_FILE2: FILE_ADDED}
return {}
def mock_modified_files_untracked(root, tracked_only=False, commit=None):
if not tracked_only:
return {TEST_FILE1: FILE_UNTRACKED}
if commit:
return {TEST_FILE2: FILE_ADDED}
return {}
def mock_modified_files_non_java(root, tracked_only=False, commit=None):
if commit:
return {TEST_FILE1: FILE_MODIFIED, TEST_FILE_NON_JAVA: FILE_ADDED}
return {}
class TestCheckstyle(unittest.TestCase):
def setUp(self):
checkstyle.git.repository_root = mock_repository_root
checkstyle.git.last_commit = mock_last_commit
def test_ShouldSkip(self):
# 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(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
out = StringIO()
files = checkstyle._GetModifiedFiles(mock_last_commit(), out=out)
output = out.getvalue()
self.assertEqual(output, '')
self.assertEqual(files, {TEST_FILE1: FILE_MODIFIED, TEST_FILE2: FILE_ADDED})
def test_GetModifiedFilesUncommitted(self):
checkstyle.git.modified_files = mock_modified_files_uncommitted
with self.assertRaises(SystemExit):
out = StringIO()
checkstyle._GetModifiedFiles(mock_last_commit(), out=out)
self.assertEqual(out.getvalue(), checkstyle.ERROR_UNCOMMITTED)
def test_GetModifiedFilesNonJava(self):
checkstyle.git.modified_files = mock_modified_files_non_java
out = StringIO()
files = checkstyle._GetModifiedFiles(mock_last_commit(), out=out)
output = out.getvalue()
self.assertEqual(output, '')
self.assertEqual(files, {TEST_FILE1: FILE_MODIFIED})
def test_WarnIfUntrackedFiles(self):
checkstyle.git.modified_files = mock_modified_files_untracked
out = StringIO()
checkstyle._WarnIfUntrackedFiles(out=out)
output = out.getvalue()
self.assertEqual(output, checkstyle.ERROR_UNTRACKED + TEST_FILE1 + '\n\n')
def test_WarnIfUntrackedFilesNoUntracked(self):
checkstyle.git.modified_files = mock_modified_files_good
out = StringIO()
checkstyle._WarnIfUntrackedFiles(out=out)
output = out.getvalue()
self.assertEqual(output, '')
if __name__ == '__main__':
unittest.main()
|
