-
Notifications
You must be signed in to change notification settings - Fork 744
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New check to detect tranposing the arguments to nCopies
This is similar to StringBuilderInitWithChar and IndexOfChar. Calling nCopies('a', 10) returns a list with 97 copies of 10, not a list with 10 copies of 'a'. RELNOTES: New check to detect tranposing the arguments to nCopies ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=156437827
- Loading branch information
1 parent
80b2222
commit 487d0ef
Showing
4 changed files
with
127 additions
and
0 deletions.
There are no files selected for viewing
68 changes: 68 additions & 0 deletions
68
core/src/main/java/com/google/errorprone/bugpatterns/NCopiesOfChar.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
/* | ||
* Copyright 2017 Google Inc. All Rights Reserved. | ||
* | ||
* 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. | ||
*/ | ||
|
||
package com.google.errorprone.bugpatterns; | ||
|
||
import static com.google.errorprone.BugPattern.Category.JDK; | ||
import static com.google.errorprone.BugPattern.SeverityLevel.ERROR; | ||
import static com.google.errorprone.matchers.Description.NO_MATCH; | ||
import static com.google.errorprone.matchers.method.MethodMatchers.staticMethod; | ||
import static com.google.errorprone.util.ASTHelpers.getType; | ||
|
||
import com.google.errorprone.BugPattern; | ||
import com.google.errorprone.VisitorState; | ||
import com.google.errorprone.bugpatterns.BugChecker.MethodInvocationTreeMatcher; | ||
import com.google.errorprone.fixes.SuggestedFix; | ||
import com.google.errorprone.matchers.Description; | ||
import com.google.errorprone.matchers.Matcher; | ||
import com.sun.source.tree.ExpressionTree; | ||
import com.sun.source.tree.MethodInvocationTree; | ||
import com.sun.tools.javac.code.Symtab; | ||
import com.sun.tools.javac.code.Types; | ||
import java.util.List; | ||
|
||
/** @author [email protected] (Liam Miller-Cushon) */ | ||
@BugPattern( | ||
name = "NCopiesOfChar", | ||
category = JDK, | ||
summary = | ||
"The first argument to nCopies is the number of copies, and the second is the item to copy", | ||
severity = ERROR | ||
) | ||
public class NCopiesOfChar extends BugChecker implements MethodInvocationTreeMatcher { | ||
private static final Matcher<ExpressionTree> MATCHER = | ||
staticMethod().onClass("java.util.Collections").named("nCopies"); | ||
|
||
@Override | ||
public Description matchMethodInvocation(MethodInvocationTree tree, VisitorState state) { | ||
if (!MATCHER.matches(tree, state)) { | ||
return NO_MATCH; | ||
} | ||
List<? extends ExpressionTree> arguments = tree.getArguments(); | ||
Symtab syms = state.getSymtab(); | ||
Types types = state.getTypes(); | ||
if (types.isSameType(types.unboxedTypeOrType(getType(arguments.get(1))), syms.intType) | ||
&& types.isSameType(types.unboxedTypeOrType(getType(arguments.get(0))), syms.charType)) { | ||
return describeMatch( | ||
tree, | ||
SuggestedFix.builder() | ||
.replace(arguments.get(0), state.getSourceForNode(arguments.get(1))) | ||
.replace(arguments.get(1), state.getSourceForNode(arguments.get(0))) | ||
.build()); | ||
} | ||
return NO_MATCH; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
55 changes: 55 additions & 0 deletions
55
core/src/test/java/com/google/errorprone/bugpatterns/NCopiesOfCharTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
/* | ||
* Copyright 2017 Google Inc. All Rights Reserved. | ||
* | ||
* 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. | ||
*/ | ||
|
||
package com.google.errorprone.bugpatterns; | ||
|
||
import com.google.errorprone.CompilationTestHelper; | ||
import org.junit.Test; | ||
import org.junit.runner.RunWith; | ||
import org.junit.runners.JUnit4; | ||
|
||
/** {@link NCopiesOfChar}Test */ | ||
@RunWith(JUnit4.class) | ||
public class NCopiesOfCharTest { | ||
|
||
private final CompilationTestHelper compilationHelper = | ||
CompilationTestHelper.newInstance(NCopiesOfChar.class, getClass()); | ||
|
||
@Test | ||
public void positive() throws Exception { | ||
compilationHelper | ||
.addSourceLines( | ||
"Test.java", // | ||
"import java.util.Collections;", | ||
"class Test {{", | ||
" // BUG: Diagnostic contains: nCopies(10, ' ');", | ||
" Collections.nCopies(' ', 10);", | ||
"}}") | ||
.doTest(); | ||
} | ||
|
||
@Test | ||
public void negative() throws Exception { | ||
compilationHelper | ||
.addSourceLines( | ||
"Test.java", // | ||
"import java.util.Collections;", | ||
"class Test {{", | ||
" Collections.nCopies(10, ' ');", | ||
"}}") | ||
.doTest(); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
Calling `nCopies('a', 10)` returns a list with 97 copies of 10, not a list with | ||
10 copies of 'a'. |