TouchInstinct
/
checkstyle
307
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Issue #2616: Add CatchParameterName check for catch blocks parameters

This commit is contained in:
Michal Kordas 2015-11-17 23:38:59 +01:00 committed by Roman Ivanov
parent e9e8d2f0a7
commit d67d10e9f2
10 changed files with 459 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
config/checkstyle_checks.xml
View File

@ -338,6 +338,9 @@
<property name="format" value="^[a-z][a-zA-Z0-9]+$"/>
<property name="ignoreOverridden" value="true"/>
</module>
<module name="CatchParameterName">
<property name="format" value="^(ex|[a-z][a-z][a-zA-Z]+)$"/>
</module>
<module name="StaticVariableName">
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
</module>

55
src/it/java/com/google/checkstyle/test/chapter5naming/rule51identifiernames/CatchParameterNameTest.java Normal file
View File

@ -0,0 +1,55 @@
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2015 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package com.google.checkstyle.test.chapter5naming.rule51identifiernames;
import java.io.File;
import java.io.IOException;
import org.junit.Test;
import com.google.checkstyle.test.base.BaseCheckTestSupport;
import com.puppycrawl.tools.checkstyle.api.Configuration;
public class CatchParameterNameTest extends BaseCheckTestSupport {
@Override
protected String getPath(String fileName) throws IOException {
return super.getPath("chapter5naming" + File.separator + "rule51identifiernames"
+ File.separator + fileName);
}
@Test
public void catchParameterNameTest() throws Exception {
final Configuration checkConfig = getCheckConfig("CatchParameterName");
final String msgKey = "name.invalidPattern";
final String format = "^[a-z][a-z0-9][a-zA-Z0-9]*$";
final String[] expected = {
"6:28: " + getCheckMessage(checkConfig.getMessages(), msgKey, "e", format),
"24:28: " + getCheckMessage(checkConfig.getMessages(), msgKey, "t", format),
"47:28: " + getCheckMessage(checkConfig.getMessages(), msgKey, "iException", format),
"50:28: " + getCheckMessage(checkConfig.getMessages(), msgKey, "x", format),
};
final String filePath = getPath("InputCatchParameterName.java");
final Integer[] warnList = getLinesWithWarn(filePath);
verify(checkConfig, filePath, expected, warnList);
}
}

53
src/it/resources/com/google/checkstyle/test/chapter5naming/rule51identifiernames/InputCatchParameterName.java Normal file
View File

@ -0,0 +1,53 @@
package com.google.checkstyle.test.chapter5naming.rule51identifiernames;
public class InputCatchParameterName {
{
try {
} catch (Exception e) { // warn
}
try {
} catch (Exception ex) { // ok
}
try {
} catch (Error | Exception err) { // ok
}
try {
} catch (Exception exception) { // ok
}
try {
} catch (Exception exception1) { // ok
}
try {
} catch (Exception noWorries) { // ok
}
try {
} catch (Throwable t) { // warn
}
try {
throw new InterruptedException("interruptedException");
} catch (InterruptedException ie) { // ok
}
try {
} catch (Exception ok) { // ok
// appropriate to take no action here
}
try {
} catch (Exception e1) { // ok
try {
} catch (Exception e2) { // ok
}
}
try {
} catch (Throwable t1) { // ok
try {
} catch (Throwable t2) { // ok
}
}
try {
} catch (Exception iException) { // warn
}
try {
} catch (Exception x) { // warn
}
}
}

91
src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/CatchParameterNameCheck.java Normal file
View File

@ -0,0 +1,91 @@
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2015 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.checks.naming;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* <p>
* Checks that {@code catch} parameter names conform to a format specified by the format property.
* The format is a {@link java.util.regex.Pattern regular expression} and defaults to
* <strong>^(e|t|ex|[a-z][a-z][a-zA-Z]+)$</strong>.
* </p>
* <p>
* Default pattern has the following characteristic:
* </p>
* <ul>
* <li>allows names beginning with two lowercase letters followed by at least one uppercase or
* lowercase letter</li>
* <li>allows {@code e} abbreviation (suitable for exceptions end errors)</li>
* <li>allows {@code ex} abbreviation (suitable for exceptions)</li>
* <li>allows {@code t} abbreviation (suitable for throwables)</li>
* <li>prohibits numbered abbreviations like {@code e1} or {@code t2}</li>
* <li>prohibits one letter prefixes like {@code pException}</li>
* <li>prohibits two letter abbreviations like {@code ie} or {@code ee}</li>
* <li>prohibits any other characters than letters</li>
* </ul>
* <p>
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;module name="CatchParameterName"/&gt;
* </pre>
* <p>
* An example of how to configure the check for names that begin with a lower case letter,
* followed by any letters or digits is:
* </p>
* <pre>
* &lt;module name="CatchParameterName"&gt;
* &lt;property name="format" value="^[a-z][a-zA-Z0-9]+$"/&gt;
* &lt;/module&gt;
* </pre>
*
* @author Michal Kordas
*/
public class CatchParameterNameCheck extends AbstractNameCheck {
/**
* Creates a new {@code CatchParameterNameCheck} instance.
*/
public CatchParameterNameCheck() {
super("^(e|t|ex|[a-z][a-z][a-zA-Z]+)$");
}
@Override
public int[] getDefaultTokens() {
return getAcceptableTokens();
}
@Override
public int[] getAcceptableTokens() {
return new int[]{TokenTypes.PARAMETER_DEF};
}
@Override
public int[] getRequiredTokens() {
return getAcceptableTokens();
}
@Override
protected boolean mustCheckName(DetailAST ast) {
return ast.getParent().getType() == TokenTypes.LITERAL_CATCH;
}
}

5
src/main/resources/google_checks.xml
View File

@ -112,6 +112,11 @@
<message key="name.invalidPattern"
value="Parameter name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="CatchParameterName">
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
<message key="name.invalidPattern"
value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="LocalVariableName">
<property name="tokens" value="VARIABLE_DEF"/>
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>

102
src/test/java/com/puppycrawl/tools/checkstyle/checks/naming/CatchParameterNameCheckTest.java Normal file
View File

@ -0,0 +1,102 @@
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2015 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.checks.naming;
import static com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck.MSG_INVALID_PATTERN;
import static org.junit.Assert.assertArrayEquals;
import java.io.File;
import java.io.IOException;
import org.apache.commons.lang3.ArrayUtils;
import org.junit.Test;
import com.puppycrawl.tools.checkstyle.BaseCheckTestSupport;
import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
import com.puppycrawl.tools.checkstyle.api.Configuration;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
public class CatchParameterNameCheckTest extends BaseCheckTestSupport {
@Override
protected String getPath(String filename) throws IOException {
return super.getPath("checks" + File.separator + "naming" + File.separator + filename);
}
@Test
public void testTokens() {
final CatchParameterNameCheck catchParameterNameCheck = new CatchParameterNameCheck();
final int[] expected = {TokenTypes.PARAMETER_DEF};
assertArrayEquals(expected, catchParameterNameCheck.getRequiredTokens());
assertArrayEquals(expected, catchParameterNameCheck.getAcceptableTokens());
}
@Test
public void testDefaultConfigurationOnCorrectFile() throws Exception {
final Configuration checkConfig = createCheckConfig(CatchParameterNameCheck.class);
final String[] expected = ArrayUtils.EMPTY_STRING_ARRAY;
verify(checkConfig, getPath("InputSimple.java"), expected);
}
@Test
public void testDefaultConfigurationOnFileWithViolations() throws Exception {
final Configuration checkConfig = createCheckConfig(CatchParameterNameCheck.class);
final String defaultFormat = "^(e|t|ex|[a-z][a-z][a-zA-Z]+)$";
final String[] expected = {
"18:28: " + getCheckMessage(MSG_INVALID_PATTERN, "exception1", defaultFormat),
"28:39: " + getCheckMessage(MSG_INVALID_PATTERN, "ie", defaultFormat),
"31:28: " + getCheckMessage(MSG_INVALID_PATTERN, "iException", defaultFormat),
"34:28: " + getCheckMessage(MSG_INVALID_PATTERN, "ok", defaultFormat),
"38:28: " + getCheckMessage(MSG_INVALID_PATTERN, "e1", defaultFormat),
"40:32: " + getCheckMessage(MSG_INVALID_PATTERN, "e2", defaultFormat),
"44:28: " + getCheckMessage(MSG_INVALID_PATTERN, "t1", defaultFormat),
"46:32: " + getCheckMessage(MSG_INVALID_PATTERN, "t2", defaultFormat),
};
verify(checkConfig, getPath("InputCatchParameterName.java"), expected);
}
@Test
public void testCustomFormatFromJavadoc() throws Exception {
final DefaultConfiguration checkConfig = createCheckConfig(CatchParameterNameCheck.class);
final String format = "^[a-z][a-zA-Z0-9]+$";
checkConfig.addAttribute("format", format);
final String[] expected = {
"6:28: " + getCheckMessage(MSG_INVALID_PATTERN, "e", format),
"24:28: " + getCheckMessage(MSG_INVALID_PATTERN, "t", format),
};
verify(checkConfig, getPath("InputCatchParameterName.java"), expected);
}
@Test
public void testCustomFormatWithNoAnchors() throws Exception {
final DefaultConfiguration checkConfig = createCheckConfig(CatchParameterNameCheck.class);
final String format = "[a-z]";
checkConfig.addAttribute("format", format);
final String[] expected = ArrayUtils.EMPTY_STRING_ARRAY;
verify(checkConfig, getPath("InputCatchParameterName.java"), expected);
}
}

50
src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/InputCatchParameterName.java Normal file
View File

@ -0,0 +1,50 @@
package com.puppycrawl.tools.checkstyle.checks.naming;
public class InputCatchParameterName {
{
try {
} catch (Exception e) {
}
try {
} catch (Exception ex) {
}
try {
} catch (Error | Exception err) {
}
try {
} catch (Exception exception) {
}
try {
} catch (Exception exception1) {
}
try {
} catch (Exception noWorries) {
}
try {
} catch (Throwable t) {
}
try {
throw new InterruptedException("interruptedException");
} catch (InterruptedException ie) { // violation with default config
}
try {
} catch (Exception iException) { // violation with default config
}
try {
} catch (Exception ok) {
// appropriate to take no action here
}
try {
} catch (Exception e1) {
try {
} catch (Exception e2) {
}
}
try {
} catch (Throwable t1) {
try {
} catch (Throwable t2) {
}
}
}
}

4
src/xdocs/checks.xml
View File

@ -94,6 +94,10 @@
and ^) to a specified depth (default = 3).
</td>
</tr>
<tr>
<td><a href="config_naming.html#CatchParameterName">CatchParameterName</a></td>
<td>Checks that catch parameter names conform to a format specified by the format property.</td>
</tr>
<tr>
<td><a href="config_metrics.html#ClassDataAbstractionCoupling">ClassDataAbstractionCoupling</a></td>
<td>This metric measures the number of instantiations of other classes within the given class.</td>

84
src/xdocs/config_naming.xml
View File

@ -230,6 +230,90 @@
</subsection>
</section>
<section name="CatchParameterName">
<subsection name="Description">
<p>
Checks that catch parameter names conform to a format specified by the format property.
Default pattern has the following characteristic:
</p>
<ul>
<li>allows names beginning with two lowercase letters followed by at least one uppercase
or lowercase letter</li>
<li>allows <code>e</code> abbreviation (suitable for exceptions end errors)</li>
<li>allows <code>ex</code> abbreviation (suitable for exceptions)</li>
<li>allows <code>t</code> abbreviation (suitable for throwables)</li>
<li>prohibits numbered abbreviations like <code>e1</code> or <code>t2</code></li>
<li>prohibits one letter prefixes like <code>pException</code></li>
<li>prohibits two letter abbreviations like <code>ie</code> or <code>ee</code></li>
<li>prohibits any other characters than letters</li>
</ul>
</subsection>
<subsection name="Properties">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
</tr>
<tr>
<td>format</td>
<td>Specifies valid identifiers.</td>
<td>
<a href="property_types.html#regexp">regular expression</a>
</td>
<td>
<code>^(e|t|ex|[a-z][a-z][a-zA-Z]+)$</code>
</td>
</tr>
</table>
</subsection>
<subsection name="Examples">
<p>
To configure the check:
</p>
<source>
&lt;module name=&quot;CatchParameterName&quot;/&gt;
</source>
<p>
An example of how to configure the check for names that begin with
a lower case letter, followed by letters and digits is:
</p>
<source>
&lt;module name="ParameterName"&gt;
&lt;property name="format" value="^[a-z][a-zA-Z0-9]+$"/&gt;
&lt;/module&gt;
</source>
</subsection>
<subsection name="Example of Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources+filename%3Agoogle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+CatchParameterName">
Google Style
</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+CatchParameterName">
Checkstyle Style
</a>
</li>
</ul>
</subsection>
<subsection name="Package">
<p>com.puppycrawl.tools.checkstyle.checks.naming</p>
</subsection>
<subsection name="Parent Module">
<p>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
<section name="ClassTypeParameterName">
<subsection name="Description">
<p>Validates identifiers for class type parameters.</p>

12
src/xdocs/google_style.xml
View File

@ -1144,6 +1144,10 @@
src="images/ok_green.png"
alt="" />
<a href="config_naming.html#ParameterName">ParameterName</a>
<br/>
<br/>
<img src="images/ok_green.png" alt=""/>
<a href="config_naming.html#CatchParameterName">CatchParameterName</a>
</td>
<td>
<a
@ -1151,6 +1155,14 @@
<br />
<a
href="https://github.com/checkstyle/checkstyle/blob/master/src/it/java/com/google/checkstyle/test/chapter5naming/rule526parameternames/ParameterNameTest.java">test</a>
<br/>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources+filename%3Agoogle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+CatchParameterName">
config
</a>
<br/>
<a href="https://github.com/checkstyle/checkstyle/blob/master/src/it/java/com/google/checkstyle/test/chapter5naming/rule51identifiernames/CatchParameterNameTest.java">
test
</a>
</td>
</tr>
<tr>