Skip to content

Commit

Permalink
New check to detect tranposing the arguments to nCopies
Browse files Browse the repository at this point in the history
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
cushon authored and ronshapiro committed May 24, 2017
1 parent 80b2222 commit 487d0ef
Show file tree
Hide file tree
Showing 4 changed files with 127 additions and 0 deletions.
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;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@
import com.google.errorprone.bugpatterns.MultipleTopLevelClasses;
import com.google.errorprone.bugpatterns.MustBeClosedChecker;
import com.google.errorprone.bugpatterns.MutableConstantField;
import com.google.errorprone.bugpatterns.NCopiesOfChar;
import com.google.errorprone.bugpatterns.NarrowingCompoundAssignment;
import com.google.errorprone.bugpatterns.NoAllocationChecker;
import com.google.errorprone.bugpatterns.NonAtomicVolatileUpdate;
Expand Down Expand Up @@ -340,6 +341,7 @@ public static ScannerSupplier errorChecks() {
MoreThanOneInjectableConstructor.class,
MoreThanOneScopeAnnotationOnClass.class,
MustBeClosedChecker.class,
NCopiesOfChar.class,
NonCanonicalStaticImport.class,
NonFinalCompileTimeConstant.class,
NonRuntimeAnnotation.class,
Expand Down
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();
}
}
2 changes: 2 additions & 0 deletions docs/bugpattern/NCopiesOfChar.md
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'.

0 comments on commit 487d0ef

Please sign in to comment.