Skip to content

Commit 2ccfa65

Browse files
gregrluckgregrluck
committed
Added step by step tests
1 parent 3aeb913 commit 2ccfa65

12 files changed

+957
-118
lines changed

‎checkstyle/ClassHeader.txt

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
/**
2+
* Copyright 2011-2013 Terracotta, Inc.
3+
* Copyright 2011-2013 Oracle America Incorporated
4+
*
5+
* Licensed under the Apache License, Version 2.0 (the "License");
6+
* you may not use this file except in compliance with the License.
7+
* You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/

‎checkstyle/checkstyle.xml

Lines changed: 275 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,275 @@
1+
<?xml version="1.0"?>
2+
<!DOCTYPE module PUBLIC
3+
"-//Puppy Crawl//DTD Check Configuration 1.2//EN"
4+
"http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
5+
6+
<module name="Checker">
7+
<property name="severity" value="error"/>
8+
9+
<module name="Translation">
10+
<property name="severity" value="error"/>
11+
</module>
12+
13+
<module name="JavadocPackage">
14+
<property name="allowLegacy" value="true"/>
15+
</module>
16+
17+
<!-- Header -->
18+
<module name="Header">
19+
<property name="headerFile" value="${checkstyle.header.file}"/>
20+
</module>
21+
22+
<module name="FileLength">
23+
<property name="max" value="1400"/>
24+
</module>
25+
26+
<!-- Duplicate Code -->
27+
<module name="StrictDuplicateCode">
28+
<property name="min" value="30"/>
29+
</module>
30+
31+
<module name="NewlineAtEndOfFile">
32+
<property name="lineSeparator" value="lf"/>
33+
<property name="severity" value="warning"/>
34+
</module>
35+
36+
<module name="FileTabCharacter"/>
37+
38+
<!-- Miscellaneous -->
39+
<module name="RegexpSingleline">
40+
<!-- . matches any character, so we need to escape it and use \. to match dots. -->
41+
<property name="format" value="System\.out\.println"/>
42+
</module>
43+
<!-- Make sure commons logging is not used -->
44+
<module name="RegexpSingleline">
45+
<property name="format"
46+
value="import org\.apache\.commons\.logging\.Log;"/>
47+
</module>
48+
<!-- Make sure we are using safe element.get methods everywhere -->
49+
<module name="RegexpSingleline">
50+
<!-- . matches any character, so we need to escape it and use \. to match dots. -->
51+
<property name="format" value="[^entry]\\.getKey\\(\\)"/>
52+
</module>
53+
<module name="RegexpSingleline">
54+
<!-- . matches any character, so we need to escape it and use \. to match dots. -->
55+
<property name="format" value="[^entry]\\.getValue\\(\\)"/>
56+
</module>
57+
58+
<module name="TreeWalker">
59+
<!--<property name="cacheFile" value="checkstyle.cache}"/>-->
60+
61+
<!--Java 5 checks-->
62+
<module name="MissingDeprecated">
63+
<property name="severity" value="warning"/>
64+
</module>
65+
66+
<!-- javadoc -->
67+
<module name="JavadocType"/>
68+
<module name="JavadocMethod">
69+
<property name="scope" value="package"/>
70+
<property name="allowMissingParamTags" value="true"/>
71+
<property name="allowMissingThrowsTags" value="true"/>
72+
<property name="allowMissingReturnTag" value="true"/>
73+
<property name="allowUndeclaredRTE" value="true"/>
74+
</module>
75+
<module name="JavadocVariable">
76+
<property name="scope" value="package"/>
77+
</module>
78+
<module name="JavadocStyle">
79+
<property name="scope" value="public"/>
80+
<property name="checkFirstSentence" value="false"/>
81+
</module>
82+
83+
<!-- Naming Conventions -->
84+
<module name="ConstantName"/>
85+
<module name="MethodName"/>
86+
<module name="StaticVariableName"/>
87+
<module name="LocalFinalVariableName"/>
88+
<module name="LocalVariableName"/>
89+
<module name="MemberName"/>
90+
<module name="PackageName">
91+
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
92+
</module>
93+
<module name="ParameterName"/>
94+
<module name="TypeName"/>
95+
96+
97+
<!-- Imports -->
98+
<module name="AvoidStarImport"/>
99+
<module name="IllegalImport"/>
100+
<module name="RedundantImport"/>
101+
<module name="UnusedImports">
102+
<property name="processJavadoc" value="true"/>
103+
</module>
104+
105+
<!-- Size Violations -->
106+
<module name="LineLength">
107+
<property name="max" value="150"/>
108+
<property name="ignorePattern" value="^ *\* *"/>
109+
</module>
110+
<module name="MethodLength">
111+
<property name="max" value="200"/>
112+
<property name="tokens" value="METHOD_DEF"/>
113+
</module>
114+
<module name="MethodLength">
115+
<property name="max" value="60"/>
116+
<property name="tokens" value="CTOR_DEF"/>
117+
</module>
118+
<module name="ParameterNumber">
119+
<property name="max" value="8"/>
120+
<property name="tokens" value="METHOD_DEF"/>
121+
</module>
122+
<module name="ParameterNumber">
123+
<property name="max" value="12"/>
124+
<property name="tokens" value="CTOR_DEF"/>
125+
</module>
126+
<module name="AnonInnerLength">
127+
<property name="max" value="25"/>
128+
</module>
129+
<module name="ExecutableStatementCount">
130+
<property name="max" value="20"/>
131+
<property name="tokens" value="CTOR_DEF, INSTANCE_INIT, STATIC_INIT"/>
132+
</module>
133+
134+
<!-- Whitespace -->
135+
<module name="EmptyForInitializerPad"/>
136+
<module name="EmptyForIteratorPad"/>
137+
<module name="MethodParamPad"/>
138+
<module name="NoWhitespaceAfter">
139+
<property name="allowLineBreaks" value="false"/>
140+
</module>
141+
<module name="NoWhitespaceBefore">
142+
<property name="allowLineBreaks" value="false"/>
143+
</module>
144+
<module name="ParenPad"/>
145+
<module name="GenericWhitespace"/>
146+
<module name="WhitespaceAfter">
147+
<property name="tokens" value="COMMA, SEMI"/>
148+
</module>
149+
<module name="WhitespaceAround">
150+
<property name="tokens"
151+
value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, EQUAL, GE, GT, LAND, LCURLY, LE, LITERAL_ASSERT, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN"/>
152+
<property name="allowEmptyConstructors" value="true"/>
153+
<property name="allowEmptyMethods" value="true"/>
154+
</module>
155+
<module name="OperatorWrap">
156+
<property name="tokens"
157+
value="ASSIGN, DIV_ASSIGN, PLUS_ASSIGN, MINUS_ASSIGN, STAR_ASSIGN, MOD_ASSIGN, SR_ASSIGN, BSR_ASSIGN, SL_ASSIGN, BXOR_ASSIGN, BOR_ASSIGN, BAND_ASSIGN"/>
158+
<property name="option" value="eol"/>
159+
</module>
160+
161+
<!-- Modifiers -->
162+
<module name="ModifierOrder">
163+
<property name="severity" value="warning"/>
164+
</module>
165+
<module name="RedundantModifier">
166+
<property name="severity" value="warning"/>
167+
</module>
168+
169+
<!-- Blocks -->
170+
<module name="EmptyBlock">
171+
<property name="option" value="text"/>
172+
<property name="tokens" value="LITERAL_CATCH"/>
173+
</module>
174+
<module name="EmptyBlock">
175+
<property name="tokens"
176+
value="LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_IF, LITERAL_FOR, LITERAL_TRY, LITERAL_WHILE, STATIC_INIT"/>
177+
</module>
178+
<module name="RightCurly">
179+
<property name="option" value="same"/>
180+
</module>
181+
<module name="LeftCurly"/>
182+
<module name="AvoidNestedBlocks">
183+
<property name="allowInSwitchCase" value="true"/>
184+
</module>
185+
186+
<!-- Coding Problems -->
187+
<module name="ArrayTrailingComma"/>
188+
<module name="CovariantEquals"/>
189+
<module name="DeclarationOrder"/>
190+
<module name="ParameterAssignment"/>
191+
<module name="ExplicitInitialization"/>
192+
<module name="DefaultComesLast"/>
193+
<module name="FallThrough"/>
194+
<module name="MultipleVariableDeclarations"/>
195+
<module name="EmptyStatement"/>
196+
<module name="HiddenField">
197+
<property name="tokens" value="VARIABLE_DEF"/>
198+
</module>
199+
<module name="IllegalInstantiation">
200+
<property name="classes" value="java.lang.Boolean"/>
201+
</module>
202+
<module name="IllegalTokenText">
203+
<property name="tokens" value="NUM_INT,NUM_LONG"/>
204+
<property name="format" value="^0[^lx]"/>
205+
<property name="ignoreCase" value="true"/>
206+
</module>
207+
<module name="IllegalType">
208+
<property name="ignoredMethodNames" value="getInstance"/>
209+
<property name="tokens" value="PARAMETER_DEF, METHOD_DEF"/>
210+
</module>
211+
<module name="InnerAssignment"/>
212+
<module name="JUnitTestCase"/>
213+
<module name="ReturnCount">
214+
<property name="max" value="5"/>
215+
</module>
216+
<module name="NestedIfDepth">
217+
<property name="max" value="2"/>
218+
</module>
219+
<module name="NestedTryDepth">
220+
<property name="max" value="2"/>
221+
</module>
222+
<module name="PackageDeclaration"/>
223+
<module name="RedundantThrows">
224+
<property name="severity" value="warning"/>
225+
<property name="allowUnchecked" value="true"/>
226+
</module>
227+
<module name="SimplifyBooleanExpression"/>
228+
<module name="SimplifyBooleanReturn"/>
229+
<module name="StringLiteralEquality"/>
230+
<module name="SuperClone"/>
231+
<module name="SuperFinalize"/>
232+
<!--<module name="MagicNumber"/>-->
233+
<module name="EqualsHashCode"/>
234+
<module name="IllegalInstantiation"/>
235+
<module name="InnerAssignment"/>
236+
<module name="MissingSwitchDefault"/>
237+
238+
<!-- Class Design -->
239+
<module name="FinalClass"/>
240+
<module name="HideUtilityClassConstructor">
241+
<property name="severity" value="warning"/>
242+
</module>
243+
<module name="InterfaceIsType"/>
244+
<module name="MutableException"/>
245+
<module name="ThrowsCount">
246+
<property name="max" value="3"/>
247+
</module>
248+
<module name="VisibilityModifier">
249+
<property name="protectedAllowed" value="true"/>
250+
</module>
251+
252+
<!-- Metrics -->
253+
<module name="BooleanExpressionComplexity">
254+
<property name="max" value="4"/>
255+
</module>
256+
<module name="ClassDataAbstractionCoupling">
257+
<property name="max" value="15"/>
258+
</module>
259+
<module name="ClassFanOutComplexity">
260+
<property name="max" value="40"/>
261+
</module>
262+
<module name="CyclomaticComplexity">
263+
<property name="severity" value="error"/>
264+
<property name="max" value="12"/>
265+
</module>
266+
<module name="NPathComplexity">
267+
<property name="max" value="50"/>
268+
</module>
269+
270+
<module name="ArrayTypeStyle"/>
271+
<!--<module name="TodoComment"/>-->
272+
<module name="TrailingComment"/>
273+
<module name="UpperEll"/>
274+
</module>
275+
</module>

‎checkstyle/suppressions.xml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<?xml version="1.0"?>
2+
3+
<!DOCTYPE suppressions PUBLIC
4+
"-//Puppy Crawl//DTD Suppressions 1.1//EN"
5+
"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
6+
7+
<suppressions>
8+
9+
<!-- Suppress duplicate checking of copyright notice -->
10+
<suppress checks="StrictDuplicateCode" files=".java" lines="1-53"/>
11+
12+
<suppress checks="AnonInnerLength" files="RICache.java"/>
13+
<suppress checks="ClassDataAbstractionCoupling" files="RICache.java"/>
14+
<suppress checks="CyclomaticComplexity" files="RICache.java"/>
15+
<suppress checks="ExecutableStatementCount" files="RICache.java"/>
16+
<suppress checks="FanOutComplexity" files="RICache.java"/>
17+
<suppress checks="FileLength" files="RICache.java"/>
18+
<suppress checks="NPathComplexity" files="RICache.java"/>
19+
20+
<suppress checks="CyclomaticComplexity" files="RIConfiguration.java"/>
21+
<suppress checks="NPathComplexity" files="RIConfiguration.java"/>
22+
23+
<suppress checks="CyclomaticComplexity" files="AbstractCacheLookupUtil.java"/>
24+
<suppress checks="NPathComplexity" files="AbstractCacheLookupUtil.java"/>
25+
26+
<suppress checks="CyclomaticComplexity" files="RICacheManager.java"/>
27+
<suppress checks="NPathComplexity" files="RICacheManager.java"/>
28+
29+
<suppress checks="CyclomaticComplexity" files="RICacheEventDispatcher.java"/>
30+
<suppress checks="NPathComplexity" files="RICacheEventDispatcher.java"/>
31+
32+
<suppress checks="NPathComplexity"
33+
files="RICacheEntryListenerFactoryDefinition.java"/>
34+
35+
<suppress checks="NPathComplexity" files="RICacheEntryListenerRegistration.java"/>
36+
37+
<suppress checks="NPathComplexity" files="RICachingProvider.java"/>
38+
39+
<suppress checks="NestedIfDepth" files="RICache.java"/>
40+
41+
42+
<!--Exclude Clover instrumented sources-->
43+
<suppress checks="" files="[\\/]src-instrumented[\\/]"/>
44+
45+
</suppressions>

0 commit comments

Comments
 (0)