Skip to content

Issue #13328: resolve mutation for UnusedLocalVariableCheck #13546

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

Closed
rdiachenko wants to merge 1 commit into from
Closed

Issue #13328: resolve mutation for UnusedLocalVariableCheck #13546

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 0 additions & 12 deletions config/pitest-suppressions/pitest-coding-2-suppressions.xml
View file
Open in desktop

This file was deleted.

22 changes: 12 additions & 10 deletions src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/UnusedLocalVariableCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -500,15 +500,15 @@ private TypeDeclDesc getSuperClassOfAnonInnerClass(DetailAST literalNewAst) {
*
* @param obtainedClass super class of the anon inner class
* @param variablesStack stack of all the relevant variables in the scope
* @param literalNewAst ast node of type {@link TokenTypes#LITERAL_NEW}
* @param objBlockAst ast node of type {@link TokenTypes#OBJBLOCK}
*/
private void modifyVariablesStack(TypeDeclDesc obtainedClass,
Deque<VariableDesc> variablesStack,
DetailAST literalNewAst) {
DetailAST objBlockAst) {
if (obtainedClass != null) {
final Deque<VariableDesc> instAndClassVarDeque = typeDeclAstToTypeDeclDesc
.get(obtainedClass.getTypeDeclAst())
.getUpdatedCopyOfVarStack(literalNewAst);
.getUpdatedCopyOfVarStack(objBlockAst);
instAndClassVarDeque.forEach(variablesStack::push);
}
}
Expand Down Expand Up @@ -640,9 +640,12 @@ else if (type == TokenTypes.VARIABLE_DEF) {
else if (type == TokenTypes.IDENT) {
visitIdentToken(ast, variablesStack);
}
else if (isInsideLocalAnonInnerClass(ast)) {
final TypeDeclDesc obtainedClass = getSuperClassOfAnonInnerClass(ast);
modifyVariablesStack(obtainedClass, variablesStack, ast);
else {
final DetailAST lastChild = ast.getLastChild();
if (lastChild != null && lastChild.getType() == TokenTypes.OBJBLOCK) {
final TypeDeclDesc obtainedClass = getSuperClassOfAnonInnerClass(ast);
modifyVariablesStack(obtainedClass, variablesStack, lastChild);
}
Comment on lines +644 to +648
Copy link
Copy Markdown
Member

@Vyom-Yadav Vyom-Yadav Aug 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From a quick look, this can cause problems as isInsideLocalAnonInnerClass(#) returns false for type declarations and lastChild != null && lastChild.getType() == TokenTypes.OBJBLOCK is true for type declarations.

Tests cases might not be there, but it may cause problems in stack order, etc.

Copy link
Copy Markdown
Member Author

@rdiachenko rdiachenko Aug 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm curious about a real test case which can catch this. Could you help to come up with at least one such a case? Otherwise I don't think it's an issue.

Copy link
Copy Markdown
Member Author

@rdiachenko rdiachenko Sep 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Vyom-Yadav ping

}
}

Expand Down Expand Up @@ -958,15 +961,14 @@ public DetailAST getTypeDeclAst() {
/**
* Get the copy of variables in instanceAndClassVar stack with updated scope.
*
* @param literalNewAst ast node of type {@link TokenTypes#LITERAL_NEW}
* @param objBlockAst ast node of type {@link TokenTypes#OBJBLOCK}
* @return copy of variables in instanceAndClassVar stack with updated scope.
*/
public Deque<VariableDesc> getUpdatedCopyOfVarStack(DetailAST literalNewAst) {
final DetailAST updatedScope = literalNewAst.getLastChild();
public Deque<VariableDesc> getUpdatedCopyOfVarStack(DetailAST objBlockAst) {
final Deque<VariableDesc> instAndClassVarDeque = new ArrayDeque<>();
instanceAndClassVarStack.forEach(instVar -> {
final VariableDesc variableDesc = new VariableDesc(instVar.getName(),
updatedScope);
objBlockAst);
variableDesc.registerAsInstOrClassVar();
instAndClassVarDeque.push(variableDesc);
});
Expand Down