Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix hamcrest arrayContainingInAnyOrder conversion #859

Merged
merged 2 commits into from
Sep 19, 2019
Merged

Fix hamcrest arrayContainingInAnyOrder conversion #859

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
531cf01
Fix hamcrest arrayContainingInAnyOrder conversion
carterkozak Sep 19, 2019
75af50d
Add generated changelog entries
carterkozak Sep 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
48 changes: 45 additions & 3 deletions baseline-error-prone/src/main/java/com/palantir/baseline/errorprone/PreferAssertj.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@

import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Preconditions.checkState;

import com.google.auto.service.AutoService;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import com.google.errorprone.BugPattern;
import com.google.errorprone.VisitorState;
import com.google.errorprone.bugpatterns.BugChecker;
Expand All @@ -39,6 +41,7 @@
import com.sun.source.tree.MethodInvocationTree;
import com.sun.source.tree.Tree;
import com.sun.source.util.SimpleTreeVisitor;
import com.sun.tools.javac.code.Symbol;
import com.sun.tools.javac.code.Type;
import java.util.List;
import java.util.Optional;
Expand Down Expand Up @@ -548,7 +551,15 @@ public boolean apply(Type type, VisitorState state) {
// Note: cannot match array/vararg arguments
private static final Matcher<ExpressionTree> HAS_ITEMS = MethodMatchers.staticMethod()
.onClass(MATCHERS)
.namedAnyOf("hasItems", "arrayContainingInAnyOrder");
.named("hasItems");

private static final Matcher<ExpressionTree> CONTAINS_EXACTLY_ANY_ORDER = MethodMatchers.staticMethod()
.onClass(MATCHERS)
.namedAnyOf("arrayContainingInAnyOrder", "containsInAnyOrder");

private static final Matcher<ExpressionTree> CONTAINS_EXACTLY_ORDERED = MethodMatchers.staticMethod()
.onClass(MATCHERS)
.named("contains");

private static final Matcher<ExpressionTree> IS_EMPTY = Matchers.anyOf(
MethodMatchers.staticMethod()
Expand Down Expand Up @@ -634,8 +645,7 @@ public Optional<String> visitMethodInvocation(MethodInvocationTree node, Visitor

return Optional.of(".hasSize(" + argSource(node, state, 0) + ')');
}
if (HAS_ITEMS.matches(node, state)
&& checkNotNull(ASTHelpers.getSymbol(node), "symbol").isVarArgs()) {
if (HAS_ITEMS.matches(node, state) && isObjectVarArgs(node, state)) {
if (negated) {
// this negates to 'doesNotContainAll' which doesn't exist. AssertJ doesNotContain
// evaluates as 'does not contain any'.
Expand All @@ -645,7 +655,39 @@ && checkNotNull(ASTHelpers.getSymbol(node), "symbol").isVarArgs()) {
.map(state::getSourceForNode)
.collect(Collectors.joining(", ")) + ')');
}
if (CONTAINS_EXACTLY_ANY_ORDER.matches(node, state) && isObjectVarArgs(node, state)) {
if (negated) {
// this negates to 'doesNotContainExactlyInAnyOrder' which doesn't exist.
return Optional.empty();
}
return Optional.of(".containsExactlyInAnyOrder(" + node.getArguments().stream()
.map(state::getSourceForNode)
.collect(Collectors.joining(", ")) + ')');
}
if (CONTAINS_EXACTLY_ORDERED.matches(node, state) && isObjectVarArgs(node, state)) {
if (negated) {
// this negates to 'doesNotContainExactly' which doesn't exist.
return Optional.empty();
}
return Optional.of(".containsExactly(" + node.getArguments().stream()
.map(state::getSourceForNode)
.collect(Collectors.joining(", ")) + ')');
}
return Optional.empty();
}
}

private static boolean isObjectVarArgs(MethodInvocationTree tree, VisitorState state) {
Symbol.MethodSymbol methodSymbol = checkNotNull(ASTHelpers.getSymbol(tree), "symbol");
if (!methodSymbol.isVarArgs()) {
return false;
}
Symbol.VarSymbol varSymbol = Iterables.getLast(methodSymbol.getParameters());
checkState(varSymbol.type instanceof Type.ArrayType, "Expected an array as last argument of a vararg method");
Type.ArrayType arrayType = (Type.ArrayType) varSymbol.type;
return ASTHelpers.isSameType(
arrayType.getComponentType(),
state.getTypeFromString(Object.class.getName()),
state);
}
}
6 changes: 5 additions & 1 deletion baseline-error-prone/src/test/java/com/palantir/baseline/errorprone/PreferAssertjTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1040,6 +1040,8 @@ public void fix_assertThat_contains() {
" assertThat(arrayValue, hasItemInArray(\"str\"));",
" assertThat(value, hasItems(\"one\", \"two\"));",
" assertThat(arrayValue, arrayContainingInAnyOrder(\"one\", \"two\"));",
" assertThat(value, containsInAnyOrder(\"one\", \"two\"));",
" assertThat(value, contains(\"one\", \"two\"));",
" assertThat(value, not(hasItem(\"str\")));",
" assertThat(arrayValue, not(hasItemInArray(\"str\")));",
" assertThat(arrayValue[0], containsString(\"str\"));",
Expand All @@ -1054,7 +1056,9 @@ public void fix_assertThat_contains() {
" assertThat(value).contains(\"str\");",
" assertThat(arrayValue).contains(\"str\");",
" assertThat(value).contains(\"one\", \"two\");",
" assertThat(arrayValue).contains(\"one\", \"two\");",
" assertThat(arrayValue).containsExactlyInAnyOrder(\"one\", \"two\");",
" assertThat(value).containsExactlyInAnyOrder(\"one\", \"two\");",
" assertThat(value).containsExactly(\"one\", \"two\");",
" assertThat(value).doesNotContain(\"str\");",
" assertThat(arrayValue).doesNotContain(\"str\");",
" assertThat(arrayValue[0]).contains(\"str\");",
Expand Down
5 changes: 5 additions & 0 deletions changelog/@unreleased/pr-859.v2.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
type: fix
fix:
description: Fix hamcrest arrayContainingInAnyOrder conversion
links:
- https://github.com/palantir/gradle-baseline/pull/859