-
Notifications
You must be signed in to change notification settings - Fork 206
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Marker and quick fix for WebSecurityConfigurerAdapter
- Loading branch information
Showing
7 changed files
with
143 additions
and
146 deletions.
There are no files selected for viewing
142 changes: 0 additions & 142 deletions
142
...ngframework/ide/vscode/commons/rewrite/java/AddConfigurationAnnotationIfBeansPresent.java
This file was deleted.
Oops, something went wrong.
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
99 changes: 99 additions & 0 deletions
99
...mework/ide/vscode/boot/java/rewrite/reconcile/WebSecurityConfigurerAdapterCodeAction.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,99 @@ | ||
/******************************************************************************* | ||
* Copyright (c) 2023 VMware, Inc. | ||
* All rights reserved. This program and the accompanying materials | ||
* are made available under the terms of the Eclipse Public License v1.0 | ||
* which accompanies this distribution, and is available at | ||
* https://www.eclipse.org/legal/epl-v10.html | ||
* | ||
* Contributors: | ||
* VMware, Inc. - initial API and implementation | ||
*******************************************************************************/ | ||
package org.springframework.ide.vscode.boot.java.rewrite.reconcile; | ||
|
||
import java.util.List; | ||
|
||
import org.openrewrite.ExecutionContext; | ||
import org.openrewrite.SourceFile; | ||
import org.openrewrite.Tree; | ||
import org.openrewrite.java.JavaVisitor; | ||
import org.openrewrite.java.tree.J; | ||
import org.openrewrite.java.tree.J.ClassDeclaration; | ||
import org.openrewrite.java.tree.JavaType; | ||
import org.openrewrite.java.tree.TypeTree; | ||
import org.springframework.context.ApplicationContext; | ||
import org.springframework.ide.vscode.boot.java.Boot2JavaProblemType; | ||
import org.springframework.ide.vscode.commons.java.IJavaProject; | ||
import org.springframework.ide.vscode.commons.java.SpringProjectUtil; | ||
import org.springframework.ide.vscode.commons.java.Version; | ||
import org.springframework.ide.vscode.commons.languageserver.reconcile.ProblemType; | ||
import org.springframework.ide.vscode.commons.rewrite.config.RecipeCodeActionDescriptor; | ||
import org.springframework.ide.vscode.commons.rewrite.config.RecipeScope; | ||
import org.springframework.ide.vscode.commons.rewrite.java.FixAssistMarker; | ||
import org.springframework.ide.vscode.commons.rewrite.java.FixDescriptor; | ||
import org.springframework.ide.vscode.commons.rewrite.java.JavaMarkerVisitor; | ||
|
||
public class WebSecurityConfigurerAdapterCodeAction implements RecipeCodeActionDescriptor { | ||
|
||
private static final String ID = "org.openrewrite.java.spring.boot2.WebSecurityConfigurerAdapter"; | ||
|
||
private static final String FQN_WEB_SECURITY_CONFIGURER_ADAPTER = "org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter"; | ||
|
||
private static final String PROBLEM_LABEL = "Class extends 'WebSecurityConfigurerAdapter' which is removed in Spring-Security 6.x"; | ||
|
||
protected static final String FIX_LABEL = "Refactor class into a Configuration bean not extending 'WebSecurityConfigurerAdapter'"; | ||
|
||
@Override | ||
public String getId() { | ||
return ID; | ||
} | ||
|
||
@Override | ||
public ProblemType getProblemType() { | ||
return Boot2JavaProblemType.WEB_SECURITY_CONFIGURER_ADAPTER; | ||
} | ||
|
||
@Override | ||
public JavaVisitor<ExecutionContext> getMarkerVisitor(ApplicationContext applicationContext) { | ||
return new JavaMarkerVisitor<>() { | ||
|
||
@Override | ||
public ClassDeclaration visitClassDeclaration(ClassDeclaration classDecl, ExecutionContext p) { | ||
ClassDeclaration c = super.visitClassDeclaration(classDecl, p); | ||
if (isExtendingWebSecurityConfigurerAdapter(c)) { | ||
String uri = getCursor().firstEnclosing(SourceFile.class).getSourcePath().toUri().toASCIIString(); | ||
FixAssistMarker marker = new FixAssistMarker(Tree.randomId(), ID).withLabel(PROBLEM_LABEL) | ||
.withFixes( | ||
new FixDescriptor(ID, List.of(uri), | ||
RecipeCodeActionDescriptor.buildLabel(FIX_LABEL, RecipeScope.FILE)) | ||
.withRecipeScope(RecipeScope.FILE), | ||
new FixDescriptor(ID, List.of(uri), | ||
RecipeCodeActionDescriptor.buildLabel(FIX_LABEL, RecipeScope.PROJECT)) | ||
.withRecipeScope(RecipeScope.PROJECT)); | ||
c = c.withName(c.getName().withMarkers(c.getName().getMarkers().add(marker))); | ||
} | ||
return c; | ||
} | ||
|
||
private boolean isExtendingWebSecurityConfigurerAdapter(J.ClassDeclaration c) { | ||
TypeTree superClass = c.getExtends(); | ||
if (superClass != null) { | ||
if (superClass.getType() instanceof JavaType.FullyQualified) { | ||
return FQN_WEB_SECURITY_CONFIGURER_ADAPTER.equals( ((JavaType.FullyQualified)superClass.getType()).getFullyQualifiedName()); | ||
} else if (superClass.getType() instanceof JavaType.Unknown) { | ||
String strType = superClass.printTrimmed(getCursor()); | ||
return "WebSecurityConfigurerAdapter".equals(strType) || FQN_WEB_SECURITY_CONFIGURER_ADAPTER.equals(strType); | ||
} | ||
} | ||
return false; | ||
} | ||
|
||
}; | ||
} | ||
|
||
@Override | ||
public boolean isApplicable(IJavaProject project) { | ||
Version version = SpringProjectUtil.getDependencyVersion(project, "spring-security-config"); | ||
return version != null && version.compareTo(new Version(5, 7, 0, null)) >= 0 && version.compareTo(new Version(6, 0, 0, null)) < 0; | ||
} | ||
|
||
} |
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