Fix checkstyle issues

marcusdacoregio · marcusdacoregio · commit 1cac1305c485 · 2023-10-19T11:03:30.000-03:00
Issue gh-2528
diff --git a/buildSrc/src/main/groovy/io/spring/gradle/convention/CheckstylePlugin.groovy b/buildSrc/src/main/groovy/io/spring/gradle/convention/CheckstylePlugin.groovy
@@ -36,7 +36,8 @@ class CheckstylePlugin implements Plugin<Project> {
 				.named("libs")
 		project.plugins.withType(JavaPlugin) {
 			def checkstyleDir = project.rootProject.file(CHECKSTYLE_DIR)
-			if (checkstyleDir.exists() && checkstyleDir.directory) {
+			boolean isSampleProject = project.name.contains('sample')
+			if (checkstyleDir.exists() && checkstyleDir.directory && !isSampleProject) {
 				project.getPluginManager().apply('checkstyle')
 				project.dependencies.add('checkstyle', versionCatalog.findLibrary('io-spring-javaformat-spring-javaformat-checkstyle').get())
 				project.dependencies.add('checkstyle', versionCatalog.findLibrary('io-spring-nohttp-nohttp-checkstyle').get())
diff --git a/etc/checkstyle/checkstyle.xml b/etc/checkstyle/checkstyle.xml
@@ -6,7 +6,9 @@
 		<property name="file" value="${config_loc}/suppressions.xml"/>
 	</module>
 	<module name="io.spring.nohttp.checkstyle.check.NoHttpCheck"/>
-	<module name="io.spring.javaformat.checkstyle.SpringChecks"/>
+	<module name="io.spring.javaformat.checkstyle.SpringChecks">
+		<property name="excludes" value="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocPackageCheck" />
+	</module>
 	<module name="com.puppycrawl.tools.checkstyle.TreeWalker">
 		<module name="io.spring.javaformat.checkstyle.check.SpringJUnit5Check"/>
 		<module name="com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck">
diff --git a/spring-session-core/src/main/java/org/springframework/session/config/annotation/web/http/SpringHttpSessionConfiguration.java b/spring-session-core/src/main/java/org/springframework/session/config/annotation/web/http/SpringHttpSessionConfiguration.java
@@ -22,7 +22,6 @@
 import jakarta.servlet.ServletContext;
 import jakarta.servlet.SessionCookieConfig;
 import jakarta.servlet.http.HttpSessionListener;
-
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
diff --git a/spring-session-core/src/main/java/org/springframework/session/security/web/authentication/SpringSessionRememberMeServices.java b/spring-session-core/src/main/java/org/springframework/session/security/web/authentication/SpringSessionRememberMeServices.java
@@ -19,7 +19,6 @@
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
 import jakarta.servlet.http.HttpSession;
-
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
diff --git a/spring-session-core/src/main/java/org/springframework/session/web/http/DefaultCookieSerializer.java b/spring-session-core/src/main/java/org/springframework/session/web/http/DefaultCookieSerializer.java
@@ -31,7 +31,6 @@
 import jakarta.servlet.http.Cookie;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
-
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
diff --git a/spring-session-core/src/main/java/org/springframework/session/web/http/HttpSessionAdapter.java b/spring-session-core/src/main/java/org/springframework/session/web/http/HttpSessionAdapter.java
@@ -24,7 +24,6 @@
 import jakarta.servlet.http.HttpSession;
 import jakarta.servlet.http.HttpSessionBindingEvent;
 import jakarta.servlet.http.HttpSessionBindingListener;
-
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
diff --git a/spring-session-core/src/main/java/org/springframework/session/web/http/SessionRepositoryFilter.java b/spring-session-core/src/main/java/org/springframework/session/web/http/SessionRepositoryFilter.java
@@ -30,7 +30,6 @@
 import jakarta.servlet.http.HttpServletRequestWrapper;
 import jakarta.servlet.http.HttpServletResponse;
 import jakarta.servlet.http.HttpSession;
-
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
diff --git a/spring-session-core/src/test/java/org/springframework/session/config/annotation/web/http/EnableSpringHttpSessionCustomCookieSerializerTests.java b/spring-session-core/src/test/java/org/springframework/session/config/annotation/web/http/EnableSpringHttpSessionCustomCookieSerializerTests.java
@@ -23,7 +23,6 @@
 import jakarta.servlet.ServletRequest;
 import jakarta.servlet.ServletResponse;
 import jakarta.servlet.http.HttpServletRequest;
-
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
diff --git a/spring-session-core/src/test/java/org/springframework/session/config/annotation/web/http/SpringHttpSessionConfigurationTests.java b/spring-session-core/src/test/java/org/springframework/session/config/annotation/web/http/SpringHttpSessionConfigurationTests.java
@@ -19,7 +19,6 @@
 import java.util.concurrent.ConcurrentHashMap;
 
 import jakarta.servlet.ServletContext;
-
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
 
diff --git a/spring-session-core/src/test/java/org/springframework/session/security/SpringSessionBackedSessionRegistryTests.java b/spring-session-core/src/test/java/org/springframework/session/security/SpringSessionBackedSessionRegistryTests.java
@@ -50,7 +50,7 @@
  * Tests for {@link SpringSessionBackedSessionRegistry}.
  */
 @ExtendWith(MockitoExtension.class)
-class SpringSessionBackedSessionRegistryTest {
+class SpringSessionBackedSessionRegistryTests {
 
 	private static final String SESSION_ID = "sessionId";
 
diff --git a/spring-session-core/src/test/java/org/springframework/session/security/web/authentication/SpringSessionRememberMeServicesTests.java b/spring-session-core/src/test/java/org/springframework/session/security/web/authentication/SpringSessionRememberMeServicesTests.java
@@ -19,7 +19,6 @@
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
 import jakarta.servlet.http.HttpSession;
-
 import org.junit.jupiter.api.Test;
 
 import org.springframework.security.core.Authentication;
diff --git a/spring-session-core/src/test/java/org/springframework/session/web/http/CookieHttpSessionIdResolverTests.java b/spring-session-core/src/test/java/org/springframework/session/web/http/CookieHttpSessionIdResolverTests.java
@@ -20,7 +20,6 @@
 import java.util.Collections;
 
 import jakarta.servlet.http.Cookie;
-
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
diff --git a/spring-session-core/src/test/java/org/springframework/session/web/http/DefaultCookieSerializerTests.java b/spring-session-core/src/test/java/org/springframework/session/web/http/DefaultCookieSerializerTests.java
@@ -24,7 +24,6 @@
 import java.util.Base64;
 
 import jakarta.servlet.http.Cookie;
-
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
diff --git a/spring-session-core/src/test/java/org/springframework/session/web/http/OnCommittedResponseWrapperTests.java b/spring-session-core/src/test/java/org/springframework/session/web/http/OnCommittedResponseWrapperTests.java
@@ -23,7 +23,6 @@
 
 import jakarta.servlet.ServletOutputStream;
 import jakarta.servlet.http.HttpServletResponse;
-
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
diff --git a/spring-session-core/src/test/java/org/springframework/session/web/http/OncePerRequestFilterTests.java b/spring-session-core/src/test/java/org/springframework/session/web/http/OncePerRequestFilterTests.java
@@ -26,7 +26,6 @@
 import jakarta.servlet.http.HttpServlet;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
-
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
diff --git a/spring-session-core/src/test/java/org/springframework/session/web/http/SessionEventHttpSessionListenerAdapterTests.java b/spring-session-core/src/test/java/org/springframework/session/web/http/SessionEventHttpSessionListenerAdapterTests.java
@@ -22,7 +22,6 @@
 import jakarta.servlet.ServletContext;
 import jakarta.servlet.http.HttpSessionEvent;
 import jakarta.servlet.http.HttpSessionListener;
-
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
diff --git a/spring-session-core/src/test/java/org/springframework/session/web/http/SessionRepositoryFilterTests.java b/spring-session-core/src/test/java/org/springframework/session/web/http/SessionRepositoryFilterTests.java
@@ -39,7 +39,6 @@
 import jakarta.servlet.http.HttpSession;
 import jakarta.servlet.http.HttpSessionBindingEvent;
 import jakarta.servlet.http.HttpSessionBindingListener;
-
 import org.assertj.core.data.Offset;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
diff --git a/spring-session-core/src/test/java/org/springframework/session/web/socket/server/SessionRepositoryMessageInterceptorTests.java b/spring-session-core/src/test/java/org/springframework/session/web/socket/server/SessionRepositoryMessageInterceptorTests.java
@@ -24,7 +24,6 @@
 import java.util.concurrent.TimeUnit;
 
 import jakarta.servlet.http.HttpSession;
-
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
diff --git a/spring-session-data-mongodb/src/test/java/org/springframework/session/data/mongo/AbstractMongoSessionConverterTests.java b/spring-session-data-mongodb/src/test/java/org/springframework/session/data/mongo/AbstractMongoSessionConverterTests.java
@@ -33,7 +33,7 @@
 /**
  * @author Greg Turnquist
  */
-public abstract class AbstractMongoSessionConverterTest {
+public abstract class AbstractMongoSessionConverterTests {
 
 	abstract AbstractMongoSessionConverter getMongoSessionConverter();
 
diff --git a/spring-session-data-mongodb/src/test/java/org/springframework/session/data/mongo/JacksonMongoSessionConverterTests.java b/spring-session-data-mongodb/src/test/java/org/springframework/session/data/mongo/JacksonMongoSessionConverterTests.java
@@ -35,7 +35,7 @@
  * @author Jakub Kubrynski
  * @author Greg Turnquist
  */
-public class JacksonMongoSessionConverterTest extends AbstractMongoSessionConverterTest {
+public class JacksonMongoSessionConverterTests extends AbstractMongoSessionConverterTests {
 
 	JacksonMongoSessionConverter mongoSessionConverter = new JacksonMongoSessionConverter();
 
diff --git a/spring-session-data-mongodb/src/test/java/org/springframework/session/data/mongo/JdkMongoSessionConverterTests.java b/spring-session-data-mongodb/src/test/java/org/springframework/session/data/mongo/JdkMongoSessionConverterTests.java
@@ -30,7 +30,7 @@
  * @author Rob Winch
  * @author Greg Turnquist
  */
-public class JdkMongoSessionConverterTest extends AbstractMongoSessionConverterTest {
+public class JdkMongoSessionConverterTests extends AbstractMongoSessionConverterTests {
 
 	Duration inactiveInterval = Duration.ofMinutes(30);
 
diff --git a/spring-session-data-mongodb/src/test/java/org/springframework/session/data/mongo/MongoIndexedSessionRepositoryTests.java b/spring-session-data-mongodb/src/test/java/org/springframework/session/data/mongo/MongoIndexedSessionRepositoryTests.java
@@ -51,7 +51,7 @@
  * @author Greg Turnquist
  */
 @ExtendWith(MockitoExtension.class)
-public class MongoIndexedSessionRepositoryTest {
+public class MongoIndexedSessionRepositoryTests {
 
 	@Mock
 	private AbstractMongoSessionConverter converter;
diff --git a/spring-session-data-mongodb/src/test/java/org/springframework/session/data/mongo/MongoSessionTests.java b/spring-session-data-mongodb/src/test/java/org/springframework/session/data/mongo/MongoSessionTests.java
@@ -27,7 +27,7 @@
  * @author Rob Winch
  * @author Greg Turnquist
  */
-public class MongoSessionTest {
+public class MongoSessionTests {
 
 	@Test
 	void isExpiredWhenIntervalNegativeThenFalse() {
diff --git a/spring-session-data-mongodb/src/test/java/org/springframework/session/data/mongo/ReactiveMongoSessionRepositoryTests.java b/spring-session-data-mongodb/src/test/java/org/springframework/session/data/mongo/ReactiveMongoSessionRepositoryTests.java
@@ -55,7 +55,7 @@
  * @author Greg Turnquist
  */
 @ExtendWith(MockitoExtension.class)
-public class ReactiveMongoSessionRepositoryTest {
+public class ReactiveMongoSessionRepositoryTests {
 
 	@Mock
 	private AbstractMongoSessionConverter converter;
diff --git a/spring-session-data-mongodb/src/test/java/org/springframework/session/data/mongo/config/annotation/web/http/MongoHttpSessionConfigurationTests.java b/spring-session-data-mongodb/src/test/java/org/springframework/session/data/mongo/config/annotation/web/http/MongoHttpSessionConfigurationTests.java
@@ -52,7 +52,7 @@
  * @author Eddú Meléndez
  * @author Vedran Pavic
  */
-public class MongoHttpSessionConfigurationTest {
+public class MongoHttpSessionConfigurationTests {
 
 	private static final String COLLECTION_NAME = "testSessions";
 
diff --git a/spring-session-data-mongodb/src/test/java/org/springframework/session/data/mongo/config/annotation/web/reactive/ReactiveMongoWebSessionConfigurationTests.java b/spring-session-data-mongodb/src/test/java/org/springframework/session/data/mongo/config/annotation/web/reactive/ReactiveMongoWebSessionConfigurationTests.java
@@ -59,7 +59,7 @@
  * @author Greg Turnquist
  * @author Vedran Pavic
  */
-public class ReactiveMongoWebSessionConfigurationTest {
+public class ReactiveMongoWebSessionConfigurationTests {
 
 	private AnnotationConfigApplicationContext context;
 
diff --git a/spring-session-docs/modules/ROOT/examples/java/docs/security/RememberMeSecurityConfigurationTests.java b/spring-session-docs/modules/ROOT/examples/java/docs/security/RememberMeSecurityConfigurationTests.java
@@ -20,7 +20,6 @@
 import java.util.Base64;
 
 import jakarta.servlet.http.Cookie;
-
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
diff --git a/spring-session-docs/modules/ROOT/examples/java/docs/security/RememberMeSecurityConfigurationXmlTests.java b/spring-session-docs/modules/ROOT/examples/java/docs/security/RememberMeSecurityConfigurationXmlTests.java
@@ -20,7 +20,6 @@
 import java.util.Base64;
 
 import jakarta.servlet.http.Cookie;
-
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
diff --git a/spring-session-hazelcast/src/test/java/org/springframework/session/hazelcast/SessionUpdateEntryProcessorTests.java b/spring-session-hazelcast/src/test/java/org/springframework/session/hazelcast/SessionUpdateEntryProcessorTests.java
@@ -32,7 +32,7 @@
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.verify;
 
-class SessionUpdateEntryProcessorTest {
+class SessionUpdateEntryProcessorTests {
 
 	private SessionUpdateEntryProcessor processor;
 
