Merge pull request #561 from groldan/build/switch_formatter_to_spotless

Switch to spotless maven plugin with palantir formatting
geoserver · Nov 29, 2024 · be724be · be724be
2 parents 2e7016f + fdc2dcc
commit be724be
Show file tree

Hide file tree

Showing 585 changed files with 4,686 additions and 8,111 deletions.
diff --git a/.github/workflows/pull-request.yaml b/.github/workflows/pull-request.yaml
@@ -38,9 +38,11 @@ jobs:
         java-version: '21'
         cache: 'maven'
 
+    - name: Validate pom formatting
+      run: make lint-pom
+
     - name: Validate source code formatting
-      run: |
-        make lint
+      run: make lint-java
 
     - name: Test
       run: |

diff --git a/.gitignore b/.gitignore
@@ -43,3 +43,5 @@ docker-compose_datadir*
 .env.yjp
 
 hs_err_pid*.log
+
+.spotless-index
diff --git a/Makefile b/Makefile
@@ -13,12 +13,26 @@ clean:
 	./mvnw clean
 
 .PHONY: lint
-lint:
-	./mvnw fmt:check sortpom:verify -Dsort.verifyFailOn=strict -Dsort.verifyFail=stop -ntp -T1C
+lint: lint-pom lint-java
+
+.PHONY: lint-pom
+lint-pom:
+	./mvnw sortpom:verify -Dsort.verifyFailOn=strict -Dsort.verifyFail=stop -ntp -T1C
+
+.PHONY: lint-java
+lint-java:
+	./mvnw spotless:check -ntp -T1C
 
 .PHONY: format
-format:
-	./mvnw sortpom:sort fmt:format -ntp -T1C
+format: format-pom format-java
+
+.PHONY: format-pom
+format-pom:
+	./mvnw sortpom:sort -ntp -T1C
+
+.PHONY: format-java
+format-java:
+	./mvnw spotless:apply -ntp -T1C
 
 .PHONY: install
 install:

diff --git a/pom.xml b/pom.xml
@@ -12,8 +12,11 @@
   </modules>
   <properties>
     <revision>1.9-SNAPSHOT</revision>
-    <fmt.action>format</fmt.action>
     <fmt.skip>false</fmt.skip>
+    <spotless.action>apply</spotless.action>
+    <spotless.apply.skip>${fmt.skip}</spotless.apply.skip>
+    <pom.fmt.action>sort</pom.fmt.action>
+    <pom.fmt.skip>${fmt.skip}</pom.fmt.skip>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <sonar.host.url>https://sonarcloud.io</sonar.host.url>
   </properties>
@@ -215,9 +218,9 @@
     <pluginManagement>
       <plugins>
         <plugin>
-          <groupId>com.spotify.fmt</groupId>
-          <artifactId>fmt-maven-plugin</artifactId>
-          <version>2.21.1</version>
+          <groupId>com.diffplug.spotless</groupId>
+          <artifactId>spotless-maven-plugin</artifactId>
+          <version>2.43.0</version>
         </plugin>
         <plugin>
           <groupId>com.github.ekryd.sortpom</groupId>
@@ -242,37 +245,43 @@
         <artifactId>sortpom-maven-plugin</artifactId>
         <configuration>
           <encoding>UTF-8</encoding>
+          <keepBlankLines>true</keepBlankLines>
+          <spaceBeforeCloseEmptyElement>false</spaceBeforeCloseEmptyElement>
           <createBackupFile>false</createBackupFile>
           <lineSeparator>\n</lineSeparator>
-          <nrOfIndentSpace>2</nrOfIndentSpace>
           <verifyFail>stop</verifyFail>
           <verifyFailOn>strict</verifyFailOn>
-          <skip>${fmt.skip}</skip>
+          <skip>${pom.fmt.skip}</skip>
         </configuration>
         <executions>
           <execution>
-            <id>sort</id>
             <goals>
-              <goal>sort</goal>
+              <goal>${pom.fmt.action}</goal>
             </goals>
-            <phase>validate</phase>
+            <phase>verify</phase>
           </execution>
         </executions>
       </plugin>
       <plugin>
-        <groupId>com.spotify.fmt</groupId>
-        <artifactId>fmt-maven-plugin</artifactId>
+        <groupId>com.diffplug.spotless</groupId>
+        <artifactId>spotless-maven-plugin</artifactId>
         <configuration>
-          <verbose>false</verbose>
-          <filesNamePattern>.*\.java</filesNamePattern>
-          <skip>${fmt.skip}</skip>
-          <style>aosp</style>
+          <java>
+            <palantirJavaFormat>
+              <version>2.50.0</version>
+            </palantirJavaFormat>
+          </java>
+          <upToDateChecking>
+            <enabled>true</enabled>
+            <indexFile>${project.basedir}/.spotless-index</indexFile>
+          </upToDateChecking>
         </configuration>
         <executions>
           <execution>
             <goals>
-              <goal>${fmt.action}</goal>
+              <goal>${spotless.action}</goal>
             </goals>
+            <phase>validate</phase>
           </execution>
         </executions>
       </plugin>

diff --git a/src/apps/geoserver/gwc/src/main/java/org/geoserver/cloud/gwc/app/GeoWebCacheApplication.java b/src/apps/geoserver/gwc/src/main/java/org/geoserver/cloud/gwc/app/GeoWebCacheApplication.java
@@ -18,8 +18,7 @@ public static void main(String[] args) {
             SpringApplication.run(GeoWebCacheApplication.class, args);
         } catch (RuntimeException e) {
             try {
-                LoggerFactory.getLogger(GeoWebCacheApplication.class)
-                        .error("Application run failed", e);
+                LoggerFactory.getLogger(GeoWebCacheApplication.class).error("Application run failed", e);
             } finally {
                 System.exit(-1);
             }

diff --git a/...er/gwc/src/main/java/org/geoserver/cloud/gwc/app/GeoWebCacheApplicationConfiguration.java b/...er/gwc/src/main/java/org/geoserver/cloud/gwc/app/GeoWebCacheApplicationConfiguration.java
@@ -4,6 +4,14 @@
  */
 package org.geoserver.cloud.gwc.app;
 
+import java.io.IOException;
+import javax.servlet.Filter;
+import javax.servlet.FilterChain;
+import javax.servlet.ServletException;
+import javax.servlet.ServletRequest;
+import javax.servlet.ServletResponse;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletRequestWrapper;
 import org.geoserver.catalog.Catalog;
 import org.geoserver.cloud.gwc.config.core.WebMapServiceMinimalConfiguration;
 import org.geoserver.gwc.layer.GeoServerTileLayer;
@@ -22,16 +30,6 @@
 import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;
 import org.springframework.web.servlet.resource.ResourceUrlProvider;
 
-import java.io.IOException;
-
-import javax.servlet.Filter;
-import javax.servlet.FilterChain;
-import javax.servlet.ServletException;
-import javax.servlet.ServletRequest;
-import javax.servlet.ServletResponse;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletRequestWrapper;
-
 @Configuration
 public class GeoWebCacheApplicationConfiguration extends RestConfiguration {
 
@@ -44,8 +42,7 @@ public class GeoWebCacheApplicationConfiguration extends RestConfiguration {
      */
     @Bean
     @ConditionalOnMissingBean
-    LegendSample legendSample(
-            @Qualifier("rawCatalog") Catalog catalog, GeoServerResourceLoader loader) {
+    LegendSample legendSample(@Qualifier("rawCatalog") Catalog catalog, GeoServerResourceLoader loader) {
         return new LegendSampleImpl(catalog, loader);
     }
 
@@ -64,14 +61,12 @@ public void configureContentNegotiation(ContentNegotiationConfigurer configurer)
     @Bean
     @Override
     public RequestMappingHandlerMapping requestMappingHandlerMapping(
-            @Qualifier("mvcContentNegotiationManager")
-                    ContentNegotiationManager contentNegotiationManager,
+            @Qualifier("mvcContentNegotiationManager") ContentNegotiationManager contentNegotiationManager,
             @Qualifier("mvcConversionService") FormattingConversionService conversionService,
             @Qualifier("mvcResourceUrlProvider") ResourceUrlProvider resourceUrlProvider) {
 
         RequestMappingHandlerMapping handlerMapping =
-                super.requestMappingHandlerMapping(
-                        contentNegotiationManager, conversionService, resourceUrlProvider);
+                super.requestMappingHandlerMapping(contentNegotiationManager, conversionService, resourceUrlProvider);
 
         handlerMapping.setUseSuffixPatternMatch(true);
         handlerMapping.setUseRegisteredSuffixPatternMatch(true);

diff --git a/...s/geoserver/gwc/src/test/java/org/geoserver/cloud/gwc/app/GeoWebCacheApplicationTest.java b/...s/geoserver/gwc/src/test/java/org/geoserver/cloud/gwc/app/GeoWebCacheApplicationTest.java
@@ -10,7 +10,6 @@
 
 import com.google.gson.JsonElement;
 import com.google.gson.JsonParser;
-
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -26,7 +25,8 @@
 @ActiveProfiles("test")
 class GeoWebCacheApplicationTest {
 
-    @Autowired private TestRestTemplate restTemplate;
+    @Autowired
+    private TestRestTemplate restTemplate;
 
     @BeforeEach
     void before() {
@@ -37,16 +37,14 @@ void before() {
 
     @Test
     void testRESTDefaultContentType() {
-        ResponseEntity<String> response =
-                testGetRequestContentType("/gwc/rest/layers", APPLICATION_JSON);
+        ResponseEntity<String> response = testGetRequestContentType("/gwc/rest/layers", APPLICATION_JSON);
         JsonElement parsed = JsonParser.parseString(response.getBody());
         assertThat(parsed.isJsonArray()).isTrue();
     }
 
     @Test
     void testRESTPathExtensionContentNegotiation() {
-        ResponseEntity<String> response =
-                testGetRequestContentType("/gwc/rest/layers.json", APPLICATION_JSON);
+        ResponseEntity<String> response = testGetRequestContentType("/gwc/rest/layers.json", APPLICATION_JSON);
         JsonElement parsed = JsonParser.parseString(response.getBody());
         assertThat(parsed.isJsonArray()).isTrue();
 

diff --git a/...server/restconfig/src/main/java/org/geoserver/cloud/restconfig/RestConfigApplication.java b/...server/restconfig/src/main/java/org/geoserver/cloud/restconfig/RestConfigApplication.java
@@ -18,8 +18,7 @@ public static void main(String[] args) {
             SpringApplication.run(RestConfigApplication.class, args);
         } catch (RuntimeException e) {
             try {
-                LoggerFactory.getLogger(RestConfigApplication.class)
-                        .error("Application run failed", e);
+                LoggerFactory.getLogger(RestConfigApplication.class).error("Application run failed", e);
             } finally {
                 System.exit(-1);
             }

diff --git a/...nfig/src/main/java/org/geoserver/cloud/restconfig/RestConfigApplicationConfiguration.java b/...nfig/src/main/java/org/geoserver/cloud/restconfig/RestConfigApplicationConfiguration.java
@@ -4,6 +4,14 @@
  */
 package org.geoserver.cloud.restconfig;
 
+import java.io.IOException;
+import javax.servlet.Filter;
+import javax.servlet.FilterChain;
+import javax.servlet.ServletException;
+import javax.servlet.ServletRequest;
+import javax.servlet.ServletResponse;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletRequestWrapper;
 import org.geoserver.rest.RequestInfo;
 import org.geoserver.rest.RestConfiguration;
 import org.geoserver.rest.catalog.AdminRequestCallback;
@@ -19,16 +27,6 @@
 import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;
 import org.springframework.web.servlet.resource.ResourceUrlProvider;
 
-import java.io.IOException;
-
-import javax.servlet.Filter;
-import javax.servlet.FilterChain;
-import javax.servlet.ServletException;
-import javax.servlet.ServletRequest;
-import javax.servlet.ServletResponse;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletRequestWrapper;
-
 @Configuration
 @ComponentScan(basePackageClasses = org.geoserver.rest.AbstractGeoServerController.class)
 @SuppressWarnings("deprecation")
@@ -53,14 +51,12 @@ AdminRequestCallback adminRequestCallback() {
     @Bean
     @Override
     public RequestMappingHandlerMapping requestMappingHandlerMapping(
-            @Qualifier("mvcContentNegotiationManager")
-                    ContentNegotiationManager contentNegotiationManager,
+            @Qualifier("mvcContentNegotiationManager") ContentNegotiationManager contentNegotiationManager,
             @Qualifier("mvcConversionService") FormattingConversionService conversionService,
             @Qualifier("mvcResourceUrlProvider") ResourceUrlProvider resourceUrlProvider) {
 
         RequestMappingHandlerMapping handlerMapping =
-                super.requestMappingHandlerMapping(
-                        contentNegotiationManager, conversionService, resourceUrlProvider);
+                super.requestMappingHandlerMapping(contentNegotiationManager, conversionService, resourceUrlProvider);
 
         handlerMapping.setUseSuffixPatternMatch(true);
         handlerMapping.setUseRegisteredSuffixPatternMatch(true);

diff --git a/...er/restconfig/src/test/java/org/geoserver/cloud/restconfig/RestConfigApplicationTest.java b/...er/restconfig/src/test/java/org/geoserver/cloud/restconfig/RestConfigApplicationTest.java
@@ -25,7 +25,8 @@
 @ActiveProfiles("test")
 class RestConfigApplicationTest {
 
-    @Autowired private TestRestTemplate restTemplate;
+    @Autowired
+    private TestRestTemplate restTemplate;
 
     @BeforeEach
     void before() {
@@ -45,8 +46,7 @@ void testPathExtensionContentNegotiation() {
         testPathExtensionContentType("/rest/styles/line.json", APPLICATION_JSON);
         testPathExtensionContentType("/rest/styles/line.xml", APPLICATION_XML);
         testPathExtensionContentType("/rest/styles/line.html", TEXT_HTML);
-        testPathExtensionContentType(
-                "/rest/styles/line.sld", MediaType.valueOf(SLDHandler.MIMETYPE_10));
+        testPathExtensionContentType("/rest/styles/line.sld", MediaType.valueOf(SLDHandler.MIMETYPE_10));
 
         testPathExtensionContentType("/rest/workspaces.html", TEXT_HTML);
         testPathExtensionContentType("/rest/workspaces.xml", APPLICATION_XML);

diff --git a/src/apps/geoserver/wcs/src/main/java/org/geoserver/cloud/wcs/WCSController.java b/src/apps/geoserver/wcs/src/main/java/org/geoserver/cloud/wcs/WCSController.java
@@ -4,9 +4,10 @@
  */
 package org.geoserver.cloud.wcs;
 
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
 import lombok.NonNull;
 import lombok.RequiredArgsConstructor;
-
 import org.geoserver.cloud.virtualservice.VirtualServiceVerifier;
 import org.geoserver.ows.Dispatcher;
 import org.springframework.stereotype.Controller;
@@ -15,9 +16,6 @@
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.servlet.view.RedirectView;
 
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
-
 @RequiredArgsConstructor
 public @Controller class WCSController {
 
@@ -34,20 +32,17 @@ public RedirectView redirectRootToGetCapabilities() {
 
     /** Serve only WCS schemas from classpath (e.g. {@code /schemas/wcs/1.1.1/wcsAll.xsd}) */
     @GetMapping(path = "/schemas/wcs/**")
-    public void getSchema(HttpServletRequest request, HttpServletResponse response)
-            throws Exception {
+    public void getSchema(HttpServletRequest request, HttpServletResponse response) throws Exception {
         classPathPublisher.handleRequest(request, response);
     }
 
     @GetMapping(path = {"/wcs", "/ows"})
-    public void handleGet(HttpServletRequest request, HttpServletResponse response)
-            throws Exception {
+    public void handleGet(HttpServletRequest request, HttpServletResponse response) throws Exception {
         dispatch(request, response);
     }
 
     @PostMapping(path = {"/wcs", "/ows"})
-    public void handlePost(HttpServletRequest request, HttpServletResponse response)
-            throws Exception {
+    public void handlePost(HttpServletRequest request, HttpServletResponse response) throws Exception {
         dispatch(request, response);
     }
 
@@ -97,8 +92,7 @@ public void handleVirtualServiceLayerPost(
         dispatch(request, response);
     }
 
-    private void dispatch(HttpServletRequest request, HttpServletResponse response)
-            throws Exception {
+    private void dispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
         geoserverDispatcher.handleRequest(request, response);
     }
 }
Original file line number	Diff line number	Diff line change
Expand Up		@@ -43,3 +43,5 @@ docker-compose_datadir*
		.env.yjp

		hs_err_pid*.log

		.spotless-index