Skip to content

WINDUPRULE-398 Web*ConfigurationSupport rule #380

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

Open
mrizzi wants to merge 1 commit into
base: master
Choose a base branch
from
Open

WINDUPRULE-398 Web*ConfigurationSupport rule #380

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
17 changes: 17 additions & 0 deletions rules-reviewed/spring5/spring5.1/tests/data/webapplications/AppConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;

@Configuration(proxyBeanMethods = false)
@ComponentScan
public class AppConfig extends WebMvcConfigurationSupport {
@Override
@Bean
public RequestMappingHandlerMapping requestMappingHandlerMapping() {
RequestMappingHandlerMapping m = super.requestMappingHandlerMapping();
m.setDefaultHandler(new MyDefaultHandler());
return m;
}
}
35 changes: 35 additions & 0 deletions rules-reviewed/spring5/spring5.1/tests/webapplications.windup.test.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<?xml version="1.0"?>
<ruletest id="webapplications-test"
xmlns="http://windup.jboss.org/schema/jboss-ruleset"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://windup.jboss.org/schema/jboss-ruleset http://windup.jboss.org/schema/jboss-ruleset/windup-jboss-ruleset.xsd">
<testDataPath>data/webapplications</testDataPath>
<rulePath>../webapplications.windup.xml</rulePath>
<ruleset>
<rules>
<!-- <rule id="webapplications-00001-test">
<when>
<not>
<iterable-filter size="8">
<hint-exists message="Spring Boot has to be updated to Spring Boot 2.0 before being able to be migrated"/>
</iterable-filter>
</not>
</when>
<perform>
<fail message="[springboot-00001] Spring Boot update to v2.0 pre-migration hint was not found!" />
</perform>
</rule>-->
<rule id="webapplications-00002-test">
<when>
<not>
<iterable-filter size="1">
<hint-exists message="When sub-classing `org.springframework.web*"/>
</iterable-filter>
</not>
</when>
<perform>
<fail message="[webapplications-00002] @EnableWebMvc and @EnableWebFlux Infrastructure hint was not found!" />
</perform>
</rule>
</rules>
</ruleset>
</ruletest>
54 changes: 54 additions & 0 deletions rules-reviewed/spring5/spring5.1/webapplications.windup.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<?xml version="1.0"?>
<ruleset id="webapplications" xmlns="http://windup.jboss.org/schema/jboss-ruleset"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://windup.jboss.org/schema/jboss-ruleset http://windup.jboss.org/schema/jboss-ruleset/windup-jboss-ruleset.xsd">
<metadata>
<description>
Rules set to provide suggestions on changes needed for Spring web applications upgrade
</description>
<dependencies>
<addon id="org.jboss.windup.rules,windup-rules-javaee,3.0.0.Final" />
<addon id="org.jboss.windup.rules,windup-rules-java,3.0.0.Final" />
<addon id="org.jboss.windup.rules,windup-rules-xml,3.0.0.Final" />
</dependencies>
<sourceTechnology id="spring" versionRange="[,4]"/>
<targetTechnology id="spring" versionRange="[5,6)" />
</metadata>
<rules>
<!--
<rule id="webapplications-00001">
&lt;!&ndash; rule condition, when it could be fired &ndash;&gt;
<when>
</when>
&lt;!&ndash; rule operation, what to do if it is fired &ndash;&gt;
<perform>
</perform>
</rule>
-->
<rule id="webapplications-00002">
<!-- rule condition, when it could be fired -->
<when>
<javaclass references="org.springframework.web.{classes}" as="sub-classing">
<location>INHERITANCE</location>
</javaclass>
<javaclass references="org.springframework.context.annotation.Configuration" as="annotation">
<location>ANNOTATION</location>
<annotation-literal name="proxyBeanMethods" pattern="false" />
</javaclass>
</when>
<!-- rule operation, what to do if it is fired -->
<perform>
<iteration over="sub-classing">
<hint title="@EnableWebMvc and @EnableWebFlux Infrastructure" effort="1" category-id="mandatory">
<message>When sub-classing `org.springframework.web.{classes}` and using `@Configuration(proxyBeanMethods=false)` be sure to also to declare dependent beans as method arguments rather than using method calls.</message>
<link href="https://github.com/spring-projects/spring-framework/wiki/Upgrading-to-Spring-Framework-5.x#enablewebmvc-and-enablewebflux-infrastructure"
title="Upgrading to Spring Framework 5.x - @EnableWebMvc and @EnableWebFlux Infrastructure" />
</hint>
</iteration>
</perform>
<where param="classes">
<matches pattern="(servlet.config.annotation.WebMvcConfigurationSupport|reactive.config.WebFluxConfigurationSupport)" />
</where>
</rule>
</rules>
</ruleset>