-
Notifications
You must be signed in to change notification settings - Fork 284
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for switch expressions (#520)
Fixes #289 Checker Framework 3.21.0 added support for switch expressions; we build on that to support the expressions in NullAway. We also add a `jdk17-unit-tests` module to test the support (which requires a JDK 12+ compiler).
- Loading branch information
Showing
6 changed files
with
249 additions
and
9 deletions.
There are no files selected for viewing
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
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,60 @@ | ||
| /* | ||
| * Copyright (C) 2021. Uber Technologies | ||
| * | ||
| * 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. | ||
| */ | ||
| plugins { | ||
| id 'java-library' | ||
| // For code coverage: | ||
| id 'jacoco' | ||
| } | ||
|
|
||
| // Use JDK 17 for this module, via a toolchain | ||
| java.toolchain.languageVersion.set JavaLanguageVersion.of(17) | ||
|
|
||
| dependencies { | ||
| testImplementation project(":nullaway") | ||
| testImplementation deps.test.junit4 | ||
| testImplementation(deps.build.errorProneTestHelpers) { | ||
| exclude group: "junit", module: "junit" | ||
| } | ||
| testImplementation deps.build.jsr305Annotations | ||
| } | ||
|
|
||
| test { | ||
| maxHeapSize = "1024m" | ||
| // to expose necessary JDK types on JDK 16+; see https://errorprone.info/docs/installation#java-9-and-newer | ||
| jvmArgs += [ | ||
| "--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED", | ||
| "--add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED", | ||
| "--add-exports=jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED", | ||
| "--add-exports=jdk.compiler/com.sun.tools.javac.model=ALL-UNNAMED", | ||
| "--add-exports=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED", | ||
| "--add-exports=jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED", | ||
| "--add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED", | ||
| "--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED", | ||
| "--add-opens=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED", | ||
| "--add-opens=jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED", | ||
| ] | ||
| } | ||
|
|
||
| jacoco { | ||
| toolVersion = "0.8.7" | ||
| } | ||
|
|
||
| jacocoTestReport { | ||
| reports { | ||
| xml.enabled = true // coveralls plugin depends on xml format report | ||
| html.enabled = true | ||
| } | ||
| } |
159 changes: 159 additions & 0 deletions
159
jdk17-unit-tests/src/test/java/com/uber/nullaway/jdk17/NullAwayJDK17Test.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,159 @@ | ||
| /* | ||
| * Copyright (c) 2021 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.jdk17; | ||
|
|
||
| import com.google.errorprone.CompilationTestHelper; | ||
| import com.uber.nullaway.NullAway; | ||
| import java.util.Arrays; | ||
| import org.junit.Before; | ||
| import org.junit.Rule; | ||
| import org.junit.Test; | ||
| import org.junit.rules.TemporaryFolder; | ||
|
|
||
| /** NullAway unit tests involving language features available on JDK 17 but not JDK 11. */ | ||
| public class NullAwayJDK17Test { | ||
|
|
||
| @Rule public final TemporaryFolder temporaryFolder = new TemporaryFolder(); | ||
|
|
||
| private CompilationTestHelper defaultCompilationHelper; | ||
|
|
||
| @Before | ||
| public void setup() { | ||
| defaultCompilationHelper = | ||
| CompilationTestHelper.newInstance(NullAway.class, getClass()) | ||
| .setArgs( | ||
| Arrays.asList( | ||
| "-d", | ||
| temporaryFolder.getRoot().getAbsolutePath(), | ||
| "-XepOpt:NullAway:AnnotatedPackages=com.uber")); | ||
| } | ||
|
|
||
| @Test | ||
| public void testSwitchExpressionAssign() { | ||
| defaultCompilationHelper | ||
| .addSourceLines( | ||
| "SwitchExpr.java", | ||
| "package com.uber;", | ||
| "class SwitchExpr {", | ||
| " public void testSwitchExpressionAssign(int i) {", | ||
| " Object o = switch (i) { case 3, 4, 5 -> new Object(); default -> null; };", | ||
| " // BUG: Diagnostic contains: dereferenced expression o is @Nullable", | ||
| " o.toString();", | ||
| " Object o2 = switch (i) { case 3, 4, 5 -> new Object(); default -> \"hello\"; };", | ||
| " // This dereference is safe", | ||
| " o2.toString();", | ||
| " }", | ||
| "}") | ||
| .doTest(); | ||
| } | ||
|
|
||
| @Test | ||
| public void testDirectlyDerefedSwitchExpr() { | ||
| defaultCompilationHelper | ||
| .addSourceLines( | ||
| "SwitchExpr.java", | ||
| "package com.uber;", | ||
| "class SwitchExpr {", | ||
| " public void testDirectlyDerefedSwitchExpr(int i) {", | ||
| " // BUG: Diagnostic contains: dereferenced expression (switch", | ||
| " (switch (i) { case 3, 4, 5 -> new Object(); default -> null; }).toString();", | ||
| " // This deference is safe", | ||
| " (switch (i) { case 3, 4, 5 -> new Object(); default -> \"hello\"; }).toString();", | ||
| " }", | ||
| "}") | ||
| .doTest(); | ||
| } | ||
|
|
||
| @Test | ||
| public void testPassingSwitchExprAsParam() { | ||
| defaultCompilationHelper | ||
| .addSourceLines( | ||
| "SwitchExpr.java", | ||
| "package com.uber;", | ||
| "class SwitchExpr {", | ||
| " private void takesNonNull(Object o) {}", | ||
| " public void testSwitchExpr3(int i) {", | ||
| " // BUG: Diagnostic contains: passing", | ||
| " takesNonNull(switch (i) { case 3, 4, 5 -> new Object(); default -> null; });", | ||
| " // This call is safe", | ||
| " takesNonNull(switch (i) { case 3, 4, 5 -> new Object(); default -> new Object(); });", | ||
| " }", | ||
| "}") | ||
| .doTest(); | ||
| } | ||
|
|
||
| @Test | ||
| public void testSwitchStmtArrowCase() { | ||
| defaultCompilationHelper | ||
| .addSourceLines( | ||
| "SwitchExpr.java", | ||
| "package com.uber;", | ||
| "class SwitchExpr {", | ||
| " public void testSwitchStmtArrowCase(int i) {", | ||
| " Object o = null;", | ||
| " switch (i) {", | ||
| " case 3, 4, 5 -> { o = new Object(); }", | ||
| " default -> { o = null; }", | ||
| " }", | ||
| " // BUG: Diagnostic contains: dereferenced expression o is @Nullable", | ||
| " o.toString();", | ||
| " Object o2 = null;", | ||
| " switch (i) {", | ||
| " case 3, 4, 5 -> { o2 = null; }", | ||
| " default -> { o2 = new Object(); }", | ||
| " }", | ||
| " // BUG: Diagnostic contains: dereferenced expression o2 is @Nullable", | ||
| " o2.toString();", | ||
| " Object o3 = null;", | ||
| " switch (i) {", | ||
| " case 3, 4, 5 -> { o3 = new Object(); }", | ||
| " default -> { o3 = new Object(); }", | ||
| " }", | ||
| " // This dereference is safe", | ||
| " o3.toString();", | ||
| " }", | ||
| "}") | ||
| .doTest(); | ||
| } | ||
|
|
||
| @Test | ||
| public void testSwitchExprUnbox() { | ||
| defaultCompilationHelper | ||
| .addSourceLines( | ||
| "SwitchExpr.java", | ||
| "package com.uber;", | ||
| "class SwitchExpr {", | ||
| " public void testSwitchExprUnbox() {", | ||
| " Integer i = null;", | ||
| " // NOTE: we should report a bug here due to the unboxing of i, but cannot do so until", | ||
| " // Error Prone supports matching switch expressions", | ||
| " Object o = switch (i) { case 3, 4, 5 -> new Object(); default -> null; };", | ||
| " int j1 = 0;", | ||
| " // BUG: Diagnostic contains: unboxing of a @Nullable value", | ||
| " int j2 = 3 + (switch (j1) { case 3, 4, 5 -> Integer.valueOf(4); default -> null; });", | ||
| " // This is safe", | ||
| " int j3 = 3 + (switch (j1) { case 3, 4, 5 -> Integer.valueOf(4); default -> Integer.valueOf(6); });", | ||
| " }", | ||
| "}") | ||
| .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
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
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