Skip to content

Commit 4ac7ab2

Browse files
peterjwestpeterjwest
authored
Merge pull request Diffblue-benchmarks#12 from DiffBlue-benchmarks/naming-and-linting-improvements
Naming and linting improvements
2 parents 6f52938 + cfb3918 commit 4ac7ab2

23 files changed

Lines changed: 539 additions & 271 deletions

File tree

‎README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
11
# java-test
2+
3+
This project contains sample Java code for the Diffblue Test Generation service.
4+
5+
The project is linted with the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html) and [checkstyle](http://checkstyle.sourceforge.net/).
6+
Run `checkstyle -c google_checks.xml .` to check the linting.

‎google_checks.xml‎

Lines changed: 219 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,219 @@
1+
<?xml version="1.0"?>
2+
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
3+
4+
<!--
5+
Checkstyle configuration that checks the Google coding conventions from Google Java Style
6+
that can be found at https://google.github.io/styleguide/javaguide.html.
7+
8+
Checkstyle is very configurable. Be sure to read the documentation at
9+
http://checkstyle.sf.net (or in your downloaded distribution).
10+
11+
To completely disable a check, just comment it out or delete it from the file.
12+
13+
Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
14+
-->
15+
16+
<module name="Checker">
17+
<property name="charset" value="UTF-8"/>
18+
19+
<property name="severity" value="warning"/>
20+
21+
<property name="fileExtensions" value="java, properties, xml"/>
22+
<!-- Checks for whitespace -->
23+
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
24+
<module name="FileTabCharacter">
25+
<property name="eachLine" value="true"/>
26+
</module>
27+
28+
<module name="SuppressWarningsFilter" />
29+
30+
<module name="TreeWalker">
31+
<module name="SuppressWarningsHolder" />
32+
<module name="OuterTypeFilename"/>
33+
<module name="IllegalTokenText">
34+
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
35+
<property name="format" value="\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
36+
<property name="message" value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
37+
</module>
38+
<module name="AvoidEscapedUnicodeCharacters">
39+
<property name="allowEscapesForControlCharacters" value="true"/>
40+
<property name="allowByTailComment" value="true"/>
41+
<property name="allowNonPrintableEscapes" value="true"/>
42+
</module>
43+
<module name="LineLength">
44+
<property name="max" value="100"/>
45+
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
46+
</module>
47+
<module name="AvoidStarImport"/>
48+
<module name="OneTopLevelClass"/>
49+
<module name="NoLineWrap"/>
50+
<module name="EmptyBlock">
51+
<property name="option" value="TEXT"/>
52+
<property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
53+
</module>
54+
<module name="NeedBraces"/>
55+
<module name="LeftCurly">
56+
<property name="maxLineLength" value="100"/>
57+
</module>
58+
<module name="RightCurly">
59+
<property name="id" value="RightCurlySame"/>
60+
<property name="tokens" value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_DO"/>
61+
</module>
62+
<module name="RightCurly">
63+
<property name="id" value="RightCurlyAlone"/>
64+
<property name="option" value="alone"/>
65+
<property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT, INSTANCE_INIT"/>
66+
</module>
67+
<module name="WhitespaceAround">
68+
<property name="allowEmptyConstructors" value="true"/>
69+
<property name="allowEmptyMethods" value="true"/>
70+
<property name="allowEmptyTypes" value="true"/>
71+
<property name="allowEmptyLoops" value="true"/>
72+
<message key="ws.notFollowed"
73+
value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
74+
<message key="ws.notPreceded"
75+
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
76+
</module>
77+
<module name="OneStatementPerLine"/>
78+
<module name="MultipleVariableDeclarations"/>
79+
<module name="ArrayTypeStyle"/>
80+
<module name="MissingSwitchDefault"/>
81+
<module name="FallThrough"/>
82+
<module name="UpperEll"/>
83+
<module name="ModifierOrder"/>
84+
<module name="EmptyLineSeparator">
85+
<property name="allowNoEmptyLineBetweenFields" value="true"/>
86+
</module>
87+
<module name="SeparatorWrap">
88+
<property name="id" value="SeparatorWrapDot"/>
89+
<property name="tokens" value="DOT"/>
90+
<property name="option" value="nl"/>
91+
</module>
92+
<module name="SeparatorWrap">
93+
<property name="id" value="SeparatorWrapComma"/>
94+
<property name="tokens" value="COMMA"/>
95+
<property name="option" value="EOL"/>
96+
</module>
97+
<module name="PackageName">
98+
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
99+
<message key="name.invalidPattern"
100+
value="Package name ''{0}'' must match pattern ''{1}''."/>
101+
</module>
102+
<module name="TypeName">
103+
<message key="name.invalidPattern"
104+
value="Type name ''{0}'' must match pattern ''{1}''."/>
105+
</module>
106+
<module name="MemberName">
107+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
108+
<message key="name.invalidPattern"
109+
value="Member name ''{0}'' must match pattern ''{1}''."/>
110+
</module>
111+
<module name="ParameterName">
112+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
113+
<message key="name.invalidPattern"
114+
value="Parameter name ''{0}'' must match pattern ''{1}''."/>
115+
</module>
116+
<module name="CatchParameterName">
117+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
118+
<message key="name.invalidPattern"
119+
value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
120+
</module>
121+
<module name="LocalVariableName">
122+
<property name="tokens" value="VARIABLE_DEF"/>
123+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
124+
<message key="name.invalidPattern"
125+
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
126+
</module>
127+
<module name="ClassTypeParameterName">
128+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
129+
<message key="name.invalidPattern"
130+
value="Class type name ''{0}'' must match pattern ''{1}''."/>
131+
</module>
132+
<module name="MethodTypeParameterName">
133+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
134+
<message key="name.invalidPattern"
135+
value="Method type name ''{0}'' must match pattern ''{1}''."/>
136+
</module>
137+
<module name="InterfaceTypeParameterName">
138+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
139+
<message key="name.invalidPattern"
140+
value="Interface type name ''{0}'' must match pattern ''{1}''."/>
141+
</module>
142+
<module name="NoFinalizer"/>
143+
<module name="GenericWhitespace">
144+
<message key="ws.followed"
145+
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
146+
<message key="ws.preceded"
147+
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
148+
<message key="ws.illegalFollow"
149+
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
150+
<message key="ws.notPreceded"
151+
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
152+
</module>
153+
<module name="Indentation">
154+
<property name="basicOffset" value="2"/>
155+
<property name="braceAdjustment" value="0"/>
156+
<property name="caseIndent" value="2"/>
157+
<property name="throwsIndent" value="4"/>
158+
<property name="lineWrappingIndentation" value="4"/>
159+
<property name="arrayInitIndent" value="2"/>
160+
</module>
161+
<module name="AbbreviationAsWordInName">
162+
<property name="ignoreFinal" value="false"/>
163+
<property name="allowedAbbreviationLength" value="1"/>
164+
</module>
165+
<module name="OverloadMethodsDeclarationOrder"/>
166+
<module name="VariableDeclarationUsageDistance"/>
167+
<module name="CustomImportOrder">
168+
<property name="sortImportsInGroupAlphabetically" value="true"/>
169+
<property name="separateLineBetweenGroups" value="true"/>
170+
<property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
171+
</module>
172+
<module name="MethodParamPad"/>
173+
<module name="ParenPad"/>
174+
<module name="OperatorWrap">
175+
<property name="option" value="NL"/>
176+
<property name="tokens" value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF "/>
177+
</module>
178+
<module name="AnnotationLocation">
179+
<property name="id" value="AnnotationLocationMostCases"/>
180+
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
181+
</module>
182+
<module name="AnnotationLocation">
183+
<property name="id" value="AnnotationLocationVariables"/>
184+
<property name="tokens" value="VARIABLE_DEF"/>
185+
<property name="allowSamelineMultipleAnnotations" value="true"/>
186+
</module>
187+
<module name="NonEmptyAtclauseDescription"/>
188+
<module name="JavadocTagContinuationIndentation"/>
189+
<module name="SummaryJavadoc">
190+
<property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
191+
</module>
192+
<module name="JavadocParagraph"/>
193+
<module name="AtclauseOrder">
194+
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
195+
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
196+
</module>
197+
<module name="JavadocMethod">
198+
<property name="scope" value="public"/>
199+
<property name="allowMissingParamTags" value="true"/>
200+
<property name="allowMissingThrowsTags" value="true"/>
201+
<property name="allowMissingReturnTag" value="true"/>
202+
<property name="minLineCount" value="2"/>
203+
<property name="allowedAnnotations" value="Override, Test"/>
204+
<property name="allowThrowsTagsForSubclasses" value="true"/>
205+
</module>
206+
<module name="MethodName">
207+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
208+
<message key="name.invalidPattern"
209+
value="Method name ''{0}'' must match pattern ''{1}''."/>
210+
</module>
211+
<module name="SingleLineJavadoc">
212+
<property name="ignoreInlineTags" value="false"/>
213+
</module>
214+
<module name="EmptyCatchBlock">
215+
<property name="exceptionVariableName" value="expected"/>
216+
</module>
217+
<module name="CommentsIndentation"/>
218+
</module>
219+
</module>

‎main-module/pom.xml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
22
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
33
<modelVersion>4.0.0</modelVersion>
4-
5-
<groupId>com.diffblue.java_test</groupId>
4+
5+
<groupId>com.diffblue.javatest</groupId>
66
<artifactId>main-module</artifactId>
77
<version>1.0-SNAPSHOT</version>
88
<packaging>jar</packaging>
9-
9+
1010
<name>Java Test Project</name>
1111
<url>http://maven.apache.org</url>
12-
12+
1313
<dependencies>
1414
<dependency>
1515
<groupId>junit</groupId>

‎main-module/src/main/java/com/diffblue/java_test/Additions.java‎

Lines changed: 0 additions & 138 deletions
This file was deleted.

‎main-module/src/main/java/com/diffblue/java_test/Calc.java‎

Lines changed: 0 additions & 9 deletions
This file was deleted.

0 commit comments

Comments
 (0)