Issue #13086: fix InnerAssignmentCheck In SwitchRuleAndExpression

[mahfouz72]

Resolves #13086 :

Diff Regression config: https://gist.githubusercontent.com/mahfouz72/70e0fb4b76668949fd9e0fd3744deddd/raw/0b035184445fee1009e49543af7b1daa6b52f79f/innerass.xml

Diff Regression projects: https://gist.githubusercontent.com/mahfouz72/297d7353d2d0bcec178e1b098109cd9e/raw/546dcdbdff363110fa265ea80d70e36f079c6ee8/projects-to-test-on.properties

[mahfouz72]

Github, generate report

[mahfouz72]

Github, generate report

[github-actions]

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

[mahfouz72]

report is good

[romani]

Question

[romani]

Why we need TokenTypes.SLIST ? And TokenTypes.LITERAL_SWITCH

[mahfouz72]

To make sure that we are in normal Switch context not Switch Expression. if it is {TokenTypes.EXPR, TokenTypes.SWITCH_RULE} only then we will have no violation if the assignment is in switch expression (one line syntax without braces)
ex

    public void test2(int mode) {
        int x = 0;
        x = switch (mode) {
            case 2 -> {
                yield x = 2; 
            }
            case 1 -> x = 1;  // this will be ok but should be violation 
            default -> throw new UnsupportedOperationException();
        };
    }

Switch Expression AST:

        |--EXPR -> EXPR [8:10]
        |       |   `--ASSIGN -> = [8:10]   <<---
        |       |       |--IDENT -> x [8:8]
        |       |       `--LITERAL_SWITCH -> switch [8:12]   <<---
        |       |           |--LPAREN -> ( [8:19]
        |       |           |--EXPR -> EXPR [8:20]
        |       |           |   `--IDENT -> mode [8:20]
        |       |           |--RPAREN -> ) [8:24]
        |       |           |--LCURLY -> { [8:26]
        |       |           |--SWITCH_RULE -> SWITCH_RULE [9:12]   <<---
        |       |           |   |--LITERAL_CASE -> case [9:12]
        |       |           |   |   `--EXPR -> EXPR [9:17]
        |       |           |   |       `--NUM_INT -> 1 [9:17]
        |       |           |   |--LAMBDA -> -> [9:19]
        |       |           |   |--EXPR -> EXPR [9:24]         <<---
        |       |           |   |   `--ASSIGN -> = [9:24]
        |       |           |   |       |--IDENT -> x [9:22]
        |       |           |   |       `--NUM_INT -> 1 [9:26]
        |       |           |   `--SEMI -> ; [9:27]
        |       |           `--RCURLY -> } [10:8]

switch rule AST

        `--SLIST -> { [6:33]          <<---
        |       |--LITERAL_SWITCH -> switch [7:8]   <<---
        |       |   |--LPAREN -> ( [7:15]
        |       |   |--EXPR -> EXPR [7:16]
        |       |   |   `--IDENT -> mode [7:16]
        |       |   |--RPAREN -> ) [7:20]
        |       |   |--LCURLY -> { [7:22]
        |       |   |--SWITCH_RULE -> SWITCH_RULE [8:12]          <<---
        |       |   |   |--LITERAL_CASE -> case [8:12]
        |       |   |   |   `--EXPR -> EXPR [8:17]
        |       |   |   |       `--NUM_INT -> 1 [8:17]
        |       |   |   |--LAMBDA -> -> [8:19]
        |       |   |   |--EXPR -> EXPR [8:24]       <<---
        |       |   |   |   `--ASSIGN -> = [8:24]
        |       |   |   |       |--IDENT -> x [8:22]
        |       |   |   |       `--NUM_INT -> 1 [8:26]
        |       |   |   `--SEMI -> ; [8:27]
        |       |   `--RCURLY -> } [9:8]

[mahfouz72]

@romani ping

[nrmancuso]

Please review documentation to see if we need to update there as well.

Item:

[mahfouz72]

Github, generate site

[github-actions]

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

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/32b2013_2024154039/checks/coding/innerassignment.html#Example1-code

[nrmancuso]

@mahfouz72 please generate a regression report against openjdk21

[mahfouz72]

Github, generate report

[github-actions]

Report generation failed on phase "make_report",
step "Generate report".
Link: https://github.com/checkstyle/checkstyle/actions/runs/8756731451

[mahfouz72]

Github, generate report

[github-actions]

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