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.
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
Handle assertThat(...).isNotNull() statements #304
Changes from all commits
af56ff8
46b5d98
998bddb
ffe2698
c93b469
7e1fd8b
feb87b4
7eb7a91
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,116 @@ | ||
/* | ||
* Copyright (c) 2017 Uber Technologies, Inc. | ||
* | ||
* Permission is hereby granted, free of charge, to any person obtaining a copy | ||
* of this software and associated documentation files (the "Software"), to deal | ||
* in the Software without restriction, including without limitation the rights | ||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
* copies of the Software, and to permit persons to whom the Software is | ||
* furnished to do so, subject to the following conditions: | ||
* | ||
* The above copyright notice and this permission notice shall be included in | ||
* all copies or substantial portions of the Software. | ||
* | ||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
* THE SOFTWARE. | ||
*/ | ||
|
||
package com.uber.nullaway.handlers; | ||
|
||
import static com.uber.nullaway.Nullness.NONNULL; | ||
|
||
import com.google.errorprone.util.ASTHelpers; | ||
import com.sun.tools.javac.code.Symbol; | ||
import com.sun.tools.javac.code.Types; | ||
import com.sun.tools.javac.util.Context; | ||
import com.sun.tools.javac.util.Name; | ||
import com.uber.nullaway.dataflow.AccessPath; | ||
import com.uber.nullaway.dataflow.AccessPathNullnessPropagation; | ||
import org.checkerframework.dataflow.cfg.node.MethodInvocationNode; | ||
import org.checkerframework.dataflow.cfg.node.Node; | ||
|
||
/** This Handler deals with assertions which ensure that their arguments cannot be null. */ | ||
public class AssertionHandler extends BaseNoOpHandler { | ||
|
||
// Strings corresponding to the names of the methods (and their owners) used to identify | ||
// assertions in this handler. | ||
private static final String IS_NOT_NULL_METHOD = "isNotNull"; | ||
private static final String IS_NOT_NULL_OWNER = "com.google.common.truth.Subject"; | ||
private static final String ASSERT_THAT_METHOD = "assertThat"; | ||
private static final String ASSERT_THAT_OWNER = "com.google.common.truth.Truth"; | ||
|
||
// Names of the methods (and their owners) used to identify assertions in this handler. Name used | ||
// here refers to com.sun.tools.javac.util.Name. Comparing methods using Names is faster than | ||
// comparing using strings. | ||
private Name isNotNull; | ||
private Name isNotNullOwner; | ||
private Name assertThat; | ||
private Name assertThatOwner; | ||
|
||
@Override | ||
public NullnessHint onDataflowVisitMethodInvocation( | ||
MethodInvocationNode node, | ||
Types types, | ||
Context context, | ||
AccessPathNullnessPropagation.SubNodeValues inputs, | ||
AccessPathNullnessPropagation.Updates thenUpdates, | ||
AccessPathNullnessPropagation.Updates elseUpdates, | ||
AccessPathNullnessPropagation.Updates bothUpdates) { | ||
Symbol.MethodSymbol callee = ASTHelpers.getSymbol(node.getTree()); | ||
if (callee == null) { | ||
return NullnessHint.UNKNOWN; | ||
} | ||
|
||
if (!areMethodNamesInitialized()) { | ||
initializeMethodNames(callee.name.table); | ||
} | ||
|
||
// Look for statements of the form: assertThat(A).isNotNull() | ||
// A will not be NULL after this statement. | ||
if (isMethodIsNotNull(callee)) { | ||
Node receiver = node.getTarget().getReceiver(); | ||
if (receiver instanceof MethodInvocationNode) { | ||
MethodInvocationNode receiver_method = (MethodInvocationNode) receiver; | ||
Symbol.MethodSymbol receiver_symbol = ASTHelpers.getSymbol(receiver_method.getTree()); | ||
if (isMethodAssertThat(receiver_symbol)) { | ||
Node arg = receiver_method.getArgument(0); | ||
AccessPath ap = AccessPath.getAccessPathForNodeNoMapGet(arg); | ||
if (ap != null) { | ||
bothUpdates.set(ap, NONNULL); | ||
} | ||
} | ||
} | ||
} | ||
return NullnessHint.UNKNOWN; | ||
} | ||
|
||
private boolean isMethodIsNotNull(Symbol.MethodSymbol methodSymbol) { | ||
return matchesMethod(methodSymbol, isNotNull, isNotNullOwner); | ||
} | ||
|
||
private boolean isMethodAssertThat(Symbol.MethodSymbol methodSymbol) { | ||
return matchesMethod(methodSymbol, assertThat, assertThatOwner); | ||
} | ||
|
||
private boolean matchesMethod( | ||
Symbol.MethodSymbol methodSymbol, Name toMatchMethodName, Name toMatchOwnerName) { | ||
return methodSymbol.name.equals(toMatchMethodName) | ||
&& methodSymbol.owner.getQualifiedName().equals(toMatchOwnerName); | ||
} | ||
|
||
private boolean areMethodNamesInitialized() { | ||
return isNotNull != null; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Actually, upon reflection, this whole thing is not thread safe, since this could execute concurrent with My thoughts:
What do you think? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Concurrency is only an issue with static fields, which we should avoid unless they are immutable values. There should be a single BugChecker instance per javac instance and it should not be getting called from multiple threads. Since the only static fields here are final Strings we should be fine. But the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks for the clarification. Removed |
||
} | ||
|
||
private void initializeMethodNames(Name.Table table) { | ||
isNotNull = table.fromString(IS_NOT_NULL_METHOD); | ||
isNotNullOwner = table.fromString(IS_NOT_NULL_OWNER); | ||
assertThat = table.fromString(ASSERT_THAT_METHOD); | ||
assertThatOwner = table.fromString(ASSERT_THAT_OWNER); | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -967,6 +967,78 @@ public void supportObjectsIsNull() { | |
.doTest(); | ||
} | ||
|
||
@Test | ||
public void supportAssertThatIsNotNull_Object() { | ||
compilationHelper | ||
.setArgs( | ||
Arrays.asList( | ||
"-d", | ||
temporaryFolder.getRoot().getAbsolutePath(), | ||
"-XepOpt:NullAway:AnnotatedPackages=com.uber", | ||
"-XepOpt:NullAway:HandleTestAssertionLibraries=true")) | ||
.addSourceLines( | ||
"Test.java", | ||
"package com.uber;", | ||
"import java.lang.Object;", | ||
"import java.util.Objects;", | ||
"import javax.annotation.Nullable;", | ||
"class Test {", | ||
" private void foo(@Nullable Object o) {", | ||
" com.google.common.truth.Truth.assertThat(o).isNotNull();", | ||
" o.toString();", | ||
" }", | ||
"}") | ||
.doTest(); | ||
} | ||
|
||
@Test | ||
public void supportAssertThatIsNotNull_String() { | ||
compilationHelper | ||
.setArgs( | ||
Arrays.asList( | ||
"-d", | ||
temporaryFolder.getRoot().getAbsolutePath(), | ||
"-XepOpt:NullAway:AnnotatedPackages=com.uber", | ||
"-XepOpt:NullAway:HandleTestAssertionLibraries=true")) | ||
.addSourceLines( | ||
"Test.java", | ||
"package com.uber;", | ||
"import java.util.Objects;", | ||
"import javax.annotation.Nullable;", | ||
"class Test {", | ||
" private void foo(@Nullable String s) {", | ||
" com.google.common.truth.Truth.assertThat(s).isNotNull();", | ||
" s.toString();", | ||
" }", | ||
"}") | ||
.doTest(); | ||
} | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. After adding the flag, do add a positive test that returns an error on the same code with the flag turned off. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Added a test with flag turned off. |
||
@Test | ||
public void doNotSupportAssertThatWhenDisabled() { | ||
compilationHelper | ||
.setArgs( | ||
Arrays.asList( | ||
"-d", | ||
temporaryFolder.getRoot().getAbsolutePath(), | ||
"-XepOpt:NullAway:AnnotatedPackages=com.uber", | ||
"-XepOpt:NullAway:HandleTestAssertionLibraries=false")) | ||
.addSourceLines( | ||
"Test.java", | ||
"package com.uber;", | ||
"import java.lang.Object;", | ||
"import java.util.Objects;", | ||
"import javax.annotation.Nullable;", | ||
"class Test {", | ||
" private void foo(@Nullable Object o) {", | ||
" com.google.common.truth.Truth.assertThat(o).isNotNull();", | ||
" // BUG: Diagnostic contains: dereferenced expression", | ||
" o.toString();", | ||
" }", | ||
"}") | ||
.doTest(); | ||
} | ||
|
||
@Test | ||
public void supportSwitchExpression() { | ||
compilationHelper | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍