add google code formatter (#175)

Author: swaroopar

.github/workflows/ci.yml

@@ -23,5 +23,7 @@ jobs:
         with:
           java-version: 21
           distribution: 'temurin'
-      - name: Build
+      - name: Format check
+        run: mvn spotless:check &&  mvn checkstyle:check
+      - name: Build & Test
         run: mvn --batch-mode --update-snapshots --no-transfer-progress verify

README.md

@@ -1,15 +1,15 @@
 <p align='center'>
 <a href="https://github.com/eclipse-xpanse/terraform-boot/actions/workflows/ci.yml" target="_blank">
-    <img src="https://github.com/eclipse-xpanse/terraform-boot/actions/workflows/ci.yml/badge.svg" alt="build">
+	<img src="https://github.com/eclipse-xpanse/terraform-boot/actions/workflows/ci.yml/badge.svg" alt="build">
 </a>
 <a href="https://opensource.org/licenses/Apache-2.0" target="_blank">
-    <img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="coverage">
-  </a>
+	<img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="coverage">
+</a>
 </p>
 
 # terraform-boot
 
-A spring-boot-based project which aims to provide a RESTful API for Terraform CLI. It provides three different modes of 
+A spring-boot-based project which aims to provide a RESTful API for Terraform CLI. It provides three different modes of
 execution
 
 1. Scripts in a directory
@@ -42,8 +42,8 @@ the files and return terraform execution result.
 
 ### Scripts in GIT Repo
 
-If the scripts are present in a GIT repo, then we can directly pass the details of the GIT repo. Terraform-boot will 
-clone the repo and execute the scripts and then return the result. 
+If the scripts are present in a GIT repo, then we can directly pass the details of the GIT repo. Terraform-boot will
+clone the repo and execute the scripts and then return the result.
 
 > [!NOTE]
 > Currently supports only repos that can be cloned without authentication and also with HTTP(S) only.
@@ -124,15 +124,15 @@ $ java -jar target/terraform-boot-*.jar
 
 1.Start with oauth
 
-    1.Set values for the authorization related variables in the application-oauth-properties configuration file, 
-      and specify the configuration file for loading oauth in the application-properties configuration file, 
-      start the main application.
-    2.Or the oauth related variables configuration can be added to IDE and the main application can be executed directly
-      to launch the application.
+	1.Set values for the authorization related variables in the application-oauth-properties configuration file,
+	and specify the configuration file for loading oauth in the application-properties configuration file,
+	start the main application.
+	2.Or the oauth related variables configuration can be added to IDE and the main application can be executed directly
+	to launch the application.
 
 2.Start without oauth
 
-    Simply start the main application.
+	Simply start the main application.
 
 API can be accessed using the following URLs
 
@@ -167,4 +167,20 @@ value of `otel.exporter.otlp.endpoint` configuration property.
 
 ## Dependencies File
 
-All third-party related content is listed in the [DEPENDENCIES](DEPENDENCIES) file.
+All third-party related content is listed in the [DEPENDENCIES](DEPENDENCIES) file.
+
+## Code Formatter
+
+The project follows [google-code-format](https://github.com/google/google-java-format).
+We use the [spotless plugin](https://github.com/diffplug/spotless/tree/main/plugin-maven#google-java-format) to format code and to validate code format.
+We can automatically format the code using the command below.
+
+```shell
+mvn spotless:apply
+```
+
+To validate errors we can run the command below.
+
+```shell
+mvn spotless:check &&  mvn checkstyle:check
+```

checkstyle.xml

@@ -2,6 +2,7 @@
 <!--
   ~ SPDX-License-Identifier: Apache-2.0
   ~ SPDX-FileCopyrightText: Huawei Inc.
+  ~
   -->
 
 <!DOCTYPE module PUBLIC
@@ -30,12 +31,6 @@
         <property name="eachLine" value="true"/>
     </module>
 
-    <module name="LineLength">
-        <property name="fileExtensions" value="java"/>
-        <property name="max" value="100"/>
-        <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
-    </module>
-
     <module name="SuppressWithPlainTextCommentFilter">
         <property name="offCommentFormat" value="CHECKSTYLE OFF\: ([\w\|]+)"/>
         <property name="onCommentFormat" value="CHECKSTYLE ON\: ([\w\|]+)"/>
@@ -99,27 +94,6 @@
                                      or preceding-sibling::*[last()][self::LCURLY]]"/>
         </module>
         <module name="WhitespaceAfter"/>
-        <module name="WhitespaceAround">
-            <property name="allowEmptyConstructors" value="true"/>
-            <property name="allowEmptyLambdas" value="true"/>
-            <property name="allowEmptyMethods" value="true"/>
-            <property name="allowEmptyTypes" value="true"/>
-            <property name="allowEmptyLoops" value="true"/>
-            <property name="ignoreEnhancedForColon" value="false"/>
-            <property name="tokens"
-                      value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR,
-                    BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, DO_WHILE, EQUAL, GE, GT, LAMBDA, LAND,
-                    LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY,
-                    LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SWITCH, LITERAL_SYNCHRONIZED,
-                    LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN,
-                    NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR,
-                    SR_ASSIGN, STAR, STAR_ASSIGN, LITERAL_ASSERT, TYPE_EXTENSION_AND"/>
-            <message key="ws.notFollowed"
-                     value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks
-               may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
-            <message key="ws.notPreceded"
-                     value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
-        </module>
         <module name="OneStatementPerLine"/>
         <module name="MultipleVariableDeclarations"/>
         <module name="ArrayTypeStyle"/>
@@ -223,7 +197,7 @@
                      value="Method type name ''{0}'' must match pattern ''{1}''."/>
         </module>
         <module name="InterfaceTypeParameterName">
-            <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
+            <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[a-zA-Z]$)"/>
             <message key="name.invalidPattern"
                      value="Interface type name ''{0}'' must match pattern ''{1}''."/>
         </module>
@@ -257,12 +231,6 @@
         <module name="NoWhitespaceBeforeCaseDefaultColon"/>
         <module name="OverloadMethodsDeclarationOrder"/>
         <module name="VariableDeclarationUsageDistance"/>
-        <module name="CustomImportOrder">
-            <property name="sortImportsInGroupAlphabetically" value="true"/>
-            <property name="separateLineBetweenGroups" value="true"/>
-            <property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
-            <property name="tokens" value="IMPORT, STATIC_IMPORT, PACKAGE_DEF"/>
-        </module>
         <module name="MethodParamPad">
             <property name="tokens"
                       value="CTOR_DEF, LITERAL_NEW, METHOD_CALL, METHOD_DEF,
@@ -282,13 +250,6 @@
                     METHOD_DEF, QUESTION, RESOURCE_SPECIFICATION, SUPER_CTOR_CALL, LAMBDA,
                     RECORD_DEF"/>
         </module>
-        <module name="OperatorWrap">
-            <property name="option" value="NL"/>
-            <property name="tokens"
-                      value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR,
-                    LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF,
-                    TYPE_EXTENSION_AND "/>
-        </module>
         <module name="AnnotationLocation">
             <property name="id" value="AnnotationLocationMostCases"/>
             <property name="tokens"
@@ -397,7 +358,6 @@
         <module name="MethodParamPad"/>
         <module name="NoWhitespaceBefore"/>
         <module name="NoWhitespaceAfter"/>
-        <module name="OperatorWrap"/>
         <module name="ParenPad"/>
         <module name="TypecastParenPad"/>
         <module name="WhitespaceAfter">

pom.xml

@@ -34,6 +34,7 @@
 		<maven.complier.plugin.version>3.13.0</maven.complier.plugin.version>
 		<maven.surefire.plugin.version>3.5.2</maven.surefire.plugin.version>
 		<maven.enforcer.plugin.version>3.5.0</maven.enforcer.plugin.version>
+		<spotless.version>2.43.0</spotless.version>
 	</properties>
 	<dependencyManagement>
 		<dependencies>
@@ -181,6 +182,51 @@
 					</execution>
 				</executions>
 			</plugin>
+			<plugin>
+				<groupId>com.diffplug.spotless</groupId>
+				<artifactId>spotless-maven-plugin</artifactId>
+				<version>${spotless.version}</version>
+				<configuration>
+					<formats>
+						<format>
+							<includes>
+								<include>*.md</include>
+								<include>.gitignore</include>
+							</includes>
+							<trimTrailingWhitespace/>
+							<endWithNewline/>
+							<indent>
+								<tabs>true</tabs>
+								<spacesPerTab>4</spacesPerTab>
+							</indent>
+						</format>
+					</formats>
+					<java>
+						<importOrder />
+						<removeUnusedImports />
+						<googleJavaFormat>
+							<style>AOSP</style>
+							<reflowLongStrings>true</reflowLongStrings>
+						</googleJavaFormat>
+					</java>
+				</configuration>
+				<executions>
+					<execution>
+						<id>apply-spotless</id>
+						<goals>
+							<goal>apply</goal>
+						</goals>
+						<phase>validate</phase>
+					</execution>
+					<execution>
+						<id>check-spotless</id>
+						<goals>
+							<goal>check</goal>
+						</goals>
+						<phase>verify</phase>
+					</execution>
+				</executions>
+			</plugin>
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-enforcer-plugin</artifactId>

src/main/java/org/eclipse/xpanse/terraform/boot/TerraformBootApplication.java

@@ -13,9 +13,7 @@
 import org.springframework.scheduling.annotation.EnableAsync;
 import org.springframework.scheduling.annotation.EnableScheduling;
 
-/**
- * Main entry class to terraform-boot. This class can be directly executed to start the server.
- */
+/** Main entry class to terraform-boot. This class can be directly executed to start the server. */
 @EnableRetry
 @EnableAsync
 @EnableCaching
@@ -26,5 +24,4 @@ public class TerraformBootApplication {
     public static void main(String[] args) {
         SpringApplication.run(TerraformBootApplication.class, args);
     }
-
 }

src/main/java/org/eclipse/xpanse/terraform/boot/api/config/SpringDocOpenApiConfig.java

@@ -11,23 +11,21 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
-
-/**
- * Configuration springdoc openAPI.
- */
+/** Configuration springdoc openAPI. */
 @Configuration
 public class SpringDocOpenApiConfig {
 
     @Value("${app.version:1.0.0}")
     private String version;
 
-    /**
-     * Configuration openAPI.
-     */
+    /** Configuration openAPI. */
     @Bean
     public OpenAPI configOpenApi() {
-        return new OpenAPI().info(new Info().title("Terraform-Boot API")
-                .description("RESTful Services to interact with terraform CLI")
-                .version(version));
+        return new OpenAPI()
+                .info(
+                        new Info()
+                                .title("Terraform-Boot API")
+                                .description("RESTful Services to interact with terraform CLI")
+                                .version(version));
     }
 }

src/main/java/org/eclipse/xpanse/terraform/boot/api/controllers/TerraformBootAdminApi.java

@@ -20,9 +20,7 @@
 import org.springframework.web.bind.annotation.ResponseStatus;
 import org.springframework.web.bind.annotation.RestController;
 
-/**
- * REST controller for admin services of terraform-boot.
- */
+/** REST controller for admin services of terraform-boot. */
 @Slf4j
 @CrossOrigin
 @RestController
@@ -34,7 +32,7 @@ public class TerraformBootAdminApi {
     @Autowired
     public TerraformBootAdminApi(
             @Qualifier("terraformDirectoryService")
-            TerraformDirectoryService terraformDirectoryService) {
+                    TerraformDirectoryService terraformDirectoryService) {
         this.terraformDirectoryService = terraformDirectoryService;
     }
 
@@ -43,13 +41,11 @@ public TerraformBootAdminApi(
      *
      * @return Returns the current state of the system.
      */
-    @Tag(name = "Admin", description =
-            "Admin services for managing the application.")
+    @Tag(name = "Admin", description = "Admin services for managing the application.")
     @Operation(description = "Check health of Terraform Boot API service")
     @GetMapping(value = "/health", produces = MediaType.APPLICATION_JSON_VALUE)
     @ResponseStatus(HttpStatus.OK)
     public TerraformBootSystemStatus healthCheck() {
         return terraformDirectoryService.tfHealthCheck();
     }
-
 }