Issue #11220: False positive in MissingSwitchDefault with pattern in switch label #11221

nrmancuso · 2022-01-20T00:27:51Z

Report label: all projects

Diff Regression config: https://gist.githubusercontent.com/nmancus1/3db3e23a5063857160d7d92cbdfa1bfe/raw/b8fc9b284c6604bf0862f237f030794bfb0a7800/config.xml

Diff Regression projects: https://raw.githubusercontent.com/checkstyle/contribution/e34312d61da0b073f31339cfbf385f289b721fed/checkstyle-tester/projects-to-test-on-for-github-action.properties

Final report: https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/f5590ec_2022232703/reports/diff/index.html

Only diffs are in openjdk17, in noncompilable files. I am not sure if we should add files filters for these files, though, since they are how I confirmed logic of check update. I think that they might be valuable in the future for similar reasons.

Blocked until #11100

Only last commit is under review.

Example of compile error on new enum value:

$ cat Test.java 
public class Test {
enum Color { RED, GREEN, BLUE, MY_COLOR }

/**
 * In the case of switch expressions, the compiler requires
 * that they are exhaustive, so this check does not enforce
 * a default label. This code would still compile with a
 * default label, but it is unnecessary so this check does
 * not enforce it.
 */
static int showSwitchExpressionExhaustiveness(Color color) {
    switch (color) {
        case RED: System.out.println("RED"); break;
        case BLUE: System.out.println("BLUE"); break;
        case GREEN: System.out.println("GREEN"); break;
        // Check will require default label below, compiler
        // does not enforce a switch statement with constants
        // to be complete.
        //default: System.out.println("Something else");
    }

    // Check will not require default label in switch
    // expression below, because code will not compile
    // if all possible values are not handled. If the
    // 'Color' enum is extended, code will fail to compile.
    return switch (color) {
        case RED:
            yield 1;
        case GREEN:
            yield 2;
        case BLUE:
            yield 3;
    };
}

  }

$ javac --enable-preview --release 17 Test.java 
Test.java:26: error: the switch expression does not cover all possible input values
    return switch (color) {
           ^
1 error

nrmancuso

Comments:

nrmancuso · 2022-01-20T19:12:08Z

src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/MissingSwitchDefaultCheck.java

@@ -127,22 +139,71 @@ public void visitToken(DetailAST ast) {
     * @param caseGroupAst first case group to check.
     * @return true if 'default' switch found.
     */
-    private static boolean containsDefaultSwitch(DetailAST caseGroupAst) {


Changed the name of this method to be consistent with language from the JLS: https://docs.oracle.com/javase/specs/jls/se17/preview/specs/patterns-switch-jls.html

This language is also used throughout the check for consistency.

src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/MissingSwitchDefaultCheck.java

nrmancuso · 2022-01-20T19:17:14Z

...heckstyle/checks/coding/missingswitchdefault/InputMissingSwitchDefaultCaseLabelElements.java

+    void m2(String s) {
+        switch (s) { // ok
+            case "a": throw new AssertionError("Wrong branch.");
+            case default: break;


default case label

nrmancuso · 2022-01-20T19:19:12Z

Github, generate report

...uppycrawl/tools/checkstyle/checks/coding/missingswitchdefault/InputMissingSwitchDefault.java

github-actions · 2022-01-23T17:08:37Z

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/b89b1d1_2022170715/index.html

nrmancuso · 2022-01-23T18:00:22Z

GitHub, rebase

romani

Item:

src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/MissingSwitchDefaultCheck.java

romani · 2022-01-24T02:02:41Z

Github, generate site

github-actions · 2022-01-24T02:09:16Z

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/314603a_2022020754/index.html

nrmancuso · 2022-01-24T03:48:08Z

Github, generate site

github-actions · 2022-01-24T03:56:56Z

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/8d658f0_2022035457/index.html

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/8d658f0_2022035457/config_coding.html#MissingSwitchDefault

romani

item:

src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/MissingSwitchDefaultCheck.java

romani · 2022-01-26T04:00:41Z

GitHub, generate web site

github-actions · 2022-01-26T04:07:20Z

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/d50c431_2022040530/index.html

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/d50c431_2022040530/config_coding.html#MissingSwitchDefault

nrmancuso · 2022-01-26T04:19:31Z

Github, rebase

romani

Ok to merge

src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/MissingSwitchDefaultCheck.java

rnveach · 2022-01-26T22:41:04Z

...n/resources/com/puppycrawl/tools/checkstyle/meta/checks/coding/MissingSwitchDefaultCheck.xml

@@ -17,7 +17,9 @@
 introduction of new types in an enumeration type. Note that
 the compiler requires switch expressions to be exhaustive,
 so this check does not enforce default branches on
- such expressions.
+ such expressions. Also, switch statements that use pattern or null


@romani Am I missing something that this file looks manually changed and isn't using the description in the javadoc and xdoc?

@nmancus1 Are you manually modifying this file?

Are you manually modifying this file?

No.

Such files are updated by test that generate meta data

…attern in switch label

romani · 2022-01-27T22:09:02Z

GitHub, generate web site

github-actions · 2022-01-27T22:14:09Z

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/2e8759e_2022221210/index.html

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/2e8759e_2022221210/config_coding.html#MissingSwitchDefault

nrmancuso self-assigned this Jan 20, 2022

nrmancuso force-pushed the issue-11220 branch 2 times, most recently from 7bbd54b to e4b6731 Compare January 20, 2022 01:21

nrmancuso marked this pull request as draft January 20, 2022 01:24

nrmancuso force-pushed the issue-11220 branch from e4b6731 to 369e5b5 Compare January 20, 2022 05:19

nrmancuso removed their assignment Jan 20, 2022

nrmancuso marked this pull request as ready for review January 20, 2022 05:30

nrmancuso mentioned this pull request Jan 20, 2022

config: add openjdk17 project to projects-to-test-on-for-github-action checkstyle/contribution#594

Merged

nrmancuso force-pushed the issue-11220 branch 3 times, most recently from 8e3e43b to 6702d33 Compare January 20, 2022 17:10

nrmancuso self-assigned this Jan 20, 2022

nrmancuso force-pushed the issue-11220 branch 4 times, most recently from 06f1f01 to 21925fb Compare January 20, 2022 19:11

nrmancuso commented Jan 20, 2022

View reviewed changes

nrmancuso force-pushed the issue-11220 branch from 21925fb to d7e667e Compare January 20, 2022 19:30

nrmancuso commented Jan 20, 2022

View reviewed changes

...uppycrawl/tools/checkstyle/checks/coding/missingswitchdefault/InputMissingSwitchDefault.java Show resolved Hide resolved

checkstyle deleted a comment from github-actions bot Jan 20, 2022

github-actions bot force-pushed the issue-11220 branch from b89b1d1 to f91ef50 Compare January 23, 2022 18:01

romani requested changes Jan 23, 2022

View reviewed changes

src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/MissingSwitchDefaultCheck.java Outdated Show resolved Hide resolved

nrmancuso force-pushed the issue-11220 branch 2 times, most recently from 81fdc35 to 314603a Compare January 23, 2022 20:47

nrmancuso removed the blocked label Jan 23, 2022

nrmancuso force-pushed the issue-11220 branch from 314603a to 8d658f0 Compare January 24, 2022 03:47

romani requested changes Jan 24, 2022

View reviewed changes

src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/MissingSwitchDefaultCheck.java Outdated Show resolved Hide resolved

nrmancuso force-pushed the issue-11220 branch 2 times, most recently from 39983b1 to d50c431 Compare January 26, 2022 03:59

romani approved these changes Jan 26, 2022

View reviewed changes

romani assigned rnveach and unassigned romani Jan 26, 2022

nrmancuso force-pushed the issue-11220 branch from d50c431 to 260d82b Compare January 26, 2022 04:39

rnveach reviewed Jan 26, 2022

View reviewed changes

Issue checkstyle#11220: False positive in MissingSwitchDefault with p…

2e8759e

…attern in switch label

nrmancuso force-pushed the issue-11220 branch from 260d82b to 2e8759e Compare January 27, 2022 02:25

nrmancuso requested a review from rnveach January 28, 2022 03:54

rnveach approved these changes Jan 28, 2022

View reviewed changes

rnveach merged commit 7cd807c into checkstyle:master Jan 28, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue #11220: False positive in MissingSwitchDefault with pattern in switch label #11221

Issue #11220: False positive in MissingSwitchDefault with pattern in switch label #11221

nrmancuso commented Jan 20, 2022 •

edited by romani

nrmancuso left a comment

nrmancuso Jan 20, 2022

nrmancuso Jan 20, 2022

nrmancuso commented Jan 20, 2022

github-actions bot commented Jan 23, 2022

nrmancuso commented Jan 23, 2022

romani left a comment

romani commented Jan 24, 2022

github-actions bot commented Jan 24, 2022

nrmancuso commented Jan 24, 2022

github-actions bot commented Jan 24, 2022 •

edited by romani

romani left a comment

romani commented Jan 26, 2022

github-actions bot commented Jan 26, 2022 •

edited by romani

nrmancuso commented Jan 26, 2022

romani left a comment

rnveach Jan 26, 2022

rnveach Jan 27, 2022

nrmancuso Jan 27, 2022

romani Jan 27, 2022

romani commented Jan 27, 2022

github-actions bot commented Jan 27, 2022 •

edited by romani

Issue #11220: False positive in MissingSwitchDefault with pattern in switch label #11221

Issue #11220: False positive in MissingSwitchDefault with pattern in switch label #11221

Conversation

nrmancuso commented Jan 20, 2022 • edited by romani

nrmancuso left a comment

Choose a reason for hiding this comment

nrmancuso Jan 20, 2022

Choose a reason for hiding this comment

nrmancuso Jan 20, 2022

Choose a reason for hiding this comment

nrmancuso commented Jan 20, 2022

github-actions bot commented Jan 23, 2022

nrmancuso commented Jan 23, 2022

romani left a comment

Choose a reason for hiding this comment

romani commented Jan 24, 2022

github-actions bot commented Jan 24, 2022

nrmancuso commented Jan 24, 2022

github-actions bot commented Jan 24, 2022 • edited by romani

romani left a comment

Choose a reason for hiding this comment

romani commented Jan 26, 2022

github-actions bot commented Jan 26, 2022 • edited by romani

nrmancuso commented Jan 26, 2022

romani left a comment

Choose a reason for hiding this comment

rnveach Jan 26, 2022

Choose a reason for hiding this comment

rnveach Jan 27, 2022

Choose a reason for hiding this comment

nrmancuso Jan 27, 2022

Choose a reason for hiding this comment

romani Jan 27, 2022

Choose a reason for hiding this comment

romani commented Jan 27, 2022

github-actions bot commented Jan 27, 2022 • edited by romani

nrmancuso commented Jan 20, 2022 •

edited by romani

github-actions bot commented Jan 24, 2022 •

edited by romani

github-actions bot commented Jan 26, 2022 •

edited by romani

github-actions bot commented Jan 27, 2022 •

edited by romani