chore: add code formatter (#422)

Author: olavloite

.github/workflows/units.yaml

@@ -16,3 +16,13 @@ jobs:
           java-version: ${{matrix.java}}
       - run: java -version
       - run: mvn -B test
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          distribution: zulu
+          java-version: 8
+      - run: java -version
+      - run: mvn com.coveo:fmt-maven-plugin:check -B -ntp

docs/contributing.md

@@ -22,6 +22,14 @@ use GitHub pull requests for this purpose. Consult
 [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
 information on using pull requests.
 
+## Code Formatting
+
+Run the following command to format the code:
+
+```shell
+mvn com.coveo:fmt-maven-plugin:format
+```
+
 ## Community Guidelines
 
 This project follows [Google's Open Source Community

pom.xml

@@ -255,6 +255,11 @@
           <artifactId>serviceloader-maven-plugin</artifactId>
           <version>1.4.0</version>
         </plugin>
+        <plugin>
+          <groupId>com.coveo</groupId>
+          <artifactId>fmt-maven-plugin</artifactId>
+          <version>2.9</version>
+        </plugin>
       </plugins>
     </pluginManagement>
     <plugins>
@@ -310,6 +315,17 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>com.coveo</groupId>
+        <artifactId>fmt-maven-plugin</artifactId>
+        <executions>
+          <execution>
+            <goals>
+              <goal>format</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
   <profiles>

src/main/java/liquibase/ext/spanner/CloudSpanner.java

@@ -13,23 +13,24 @@
  */
 package liquibase.ext.spanner;
 
+import static java.time.format.DateTimeFormatter.ISO_LOCAL_DATE;
+import static java.time.format.DateTimeFormatter.ISO_LOCAL_TIME;
+
 import com.google.cloud.spanner.Type;
 import com.google.cloud.spanner.jdbc.CloudSpannerJdbcConnection;
 import java.sql.DriverManager;
 import java.sql.SQLException;
+import java.text.ParseException;
+import java.time.Instant;
+import java.time.OffsetDateTime;
+import java.time.ZoneOffset;
+import java.util.Date;
 import liquibase.Scope;
 import liquibase.database.AbstractJdbcDatabase;
 import liquibase.database.DatabaseConnection;
 import liquibase.database.OfflineConnection;
 import liquibase.database.jvm.JdbcConnection;
 import liquibase.util.ISODateFormat;
-import java.text.ParseException;
-import java.time.Instant;
-import java.time.OffsetDateTime;
-import java.time.ZoneOffset;
-import static java.time.format.DateTimeFormatter.ISO_LOCAL_DATE;
-import static java.time.format.DateTimeFormatter.ISO_LOCAL_TIME;
-import java.util.Date;
 
 public class CloudSpanner extends AbstractJdbcDatabase implements ICloudSpanner {
 
@@ -47,7 +48,7 @@ public CloudSpanner() {
   public java.lang.Integer getDefaultPort() {
     return 9010;
   }
-  
+
   @Override
   public boolean dataTypeIsNotModifiable(final String typeName) {
     // All data types are returned including the length by the JDBC driver
@@ -137,17 +138,19 @@ public void setConnection(final DatabaseConnection conn) {
     // The latter should be safe, even if the caller uses the connection for other purposes, as
     // even if the connection was not replaced it would have been closed by Liquibase at the same
     // moment.
-    if (!(conn instanceof CloudSpannerConnection) && conn instanceof JdbcConnection
-        && ((JdbcConnection) conn)
-            .getUnderlyingConnection() instanceof CloudSpannerJdbcConnection) {
+    if (!(conn instanceof CloudSpannerConnection)
+        && conn instanceof JdbcConnection
+        && ((JdbcConnection) conn).getUnderlyingConnection()
+            instanceof CloudSpannerJdbcConnection) {
       // The underlying connection is a Spanner JDBC connection. Check whether it already included a
       // user-agent string.
       if (!conn.getURL().contains("userAgent=")) {
         // The underlying connection does not use a specific user-agent string. Create a replacement
         // connection that will be used by Liquibase with the correct user-agent.
         try {
-          connectionToUse = new CloudSpannerConnection(
-              DriverManager.getConnection(conn.getURL() + ";userAgent=sp-liq"), conn);
+          connectionToUse =
+              new CloudSpannerConnection(
+                  DriverManager.getConnection(conn.getURL() + ";userAgent=sp-liq"), conn);
         } catch (SQLException e) {
           // Ignore and use the original connection. This could for example happen if the user is
           // using an older version of the Spanner JDBC driver that does not support this user-agent

src/main/java/liquibase/ext/spanner/CloudSpannerConnection.java

@@ -1,18 +1,15 @@
 /**
  * Copyright 2021 Google LLC
  *
- * <p>
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
- * in compliance with the License. You may obtain a copy of the License at
+ * <p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of the License at
  *
- * <p>
- * https://www.apache.org/licenses/LICENSE-2.0
+ * <p>https://www.apache.org/licenses/LICENSE-2.0
  *
- * <p>
- * Unless required by applicable law or agreed to in writing, software distributed under the License
- * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
- * or implied. See the License for the specific language governing permissions and limitations under
- * the License.
+ * <p>Unless required by applicable law or agreed to in writing, software distributed under the
+ * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing permissions and
+ * limitations under the License.
  */
 package liquibase.ext.spanner;
 
@@ -75,5 +72,4 @@ public void open(String url, Driver driverObject, Properties driverProperties)
     }
     super.open(url, driverObject, driverProperties);
   }
-
 }

src/main/java/liquibase/ext/spanner/ICloudSpanner.java

@@ -2,5 +2,4 @@
 
 import liquibase.database.Database;
 
-public interface ICloudSpanner extends Database {
-}
+public interface ICloudSpanner extends Database {}

src/main/java/liquibase/ext/spanner/change/AddColumnChangeSpanner.java

@@ -21,7 +21,11 @@
 import liquibase.statement.SqlStatement;
 import liquibase.statement.core.UpdateStatement;
 
-@DatabaseChange(name="addColumn", description = "Adds a new column to an existing table", priority = ChangeMetaData.PRIORITY_DATABASE, appliesTo = "table")
+@DatabaseChange(
+    name = "addColumn",
+    description = "Adds a new column to an existing table",
+    priority = ChangeMetaData.PRIORITY_DATABASE,
+    appliesTo = "table")
 public class AddColumnChangeSpanner extends AddColumnChange {
 
   @Override

src/main/java/liquibase/ext/spanner/change/CreateTableChangeSpanner.java

@@ -20,18 +20,24 @@
 import liquibase.ext.spanner.ICloudSpanner;
 import liquibase.ext.spanner.sqlgenerator.CreateTableStatementSpanner;
 
-/** Custom implementation for Cloud Spanner that enables the creation of nullable primary key columns. */
-@DatabaseChange(name="createTable", description = "Create Table", priority = ChangeMetaData.PRIORITY_DATABASE)
+/**
+ * Custom implementation for Cloud Spanner that enables the creation of nullable primary key
+ * columns.
+ */
+@DatabaseChange(
+    name = "createTable",
+    description = "Create Table",
+    priority = ChangeMetaData.PRIORITY_DATABASE)
 public class CreateTableChangeSpanner extends CreateTableChange {
 
   @Override
   public boolean supports(Database database) {
     return (database instanceof ICloudSpanner);
   }
-  
+
   @Override
   protected CreateTableStatementSpanner generateCreateTableStatement() {
-    return new CreateTableStatementSpanner(getCatalogName(), getSchemaName(), getTableName(), getRemarks(), getTableType());
+    return new CreateTableStatementSpanner(
+        getCatalogName(), getSchemaName(), getTableName(), getRemarks(), getTableType());
   }
-
 }

src/main/java/liquibase/ext/spanner/change/DropAllForeignKeyConstraintsChangeSpanner.java

@@ -18,19 +18,25 @@
 import liquibase.ext.spanner.ICloudSpanner;
 import liquibase.statement.SqlStatement;
 
-@DatabaseChange(name="dropAllForeignKeyConstraints", description = "Drops all foreign key constraints for a table", priority = ChangeMetaData.PRIORITY_DATABASE, appliesTo = "table")
+@DatabaseChange(
+    name = "dropAllForeignKeyConstraints",
+    description = "Drops all foreign key constraints for a table",
+    priority = ChangeMetaData.PRIORITY_DATABASE,
+    appliesTo = "table")
 public class DropAllForeignKeyConstraintsChangeSpanner extends DropAllForeignKeyConstraintsChange {
 
   @Override
   public boolean supports(Database database) {
     return (database instanceof ICloudSpanner);
   }
-  
+
   public SqlStatement[] generateStatements(Database database) {
     List<SqlStatement> sqlStatements = new ArrayList<>();
-    
+
     JdbcConnection connection = (JdbcConnection) database.getConnection();
-    try (PreparedStatement ps = connection.prepareStatement("SELECT CONSTRAINT_NAME FROM INFORMATION_SCHEMA.TABLE_CONSTRAINTS WHERE TABLE_CATALOG=? AND TABLE_SCHEMA=? AND TABLE_NAME=? AND CONSTRAINT_TYPE='FOREIGN KEY'")) {
+    try (PreparedStatement ps =
+        connection.prepareStatement(
+            "SELECT CONSTRAINT_NAME FROM INFORMATION_SCHEMA.TABLE_CONSTRAINTS WHERE TABLE_CATALOG=? AND TABLE_SCHEMA=? AND TABLE_NAME=? AND CONSTRAINT_TYPE='FOREIGN KEY'")) {
       ps.setString(1, MoreObjects.firstNonNull(getBaseTableCatalogName(), ""));
       ps.setString(2, MoreObjects.firstNonNull(getBaseTableSchemaName(), ""));
       ps.setString(3, getBaseTableName());
@@ -45,10 +51,10 @@ public SqlStatement[] generateStatements(Database database) {
         }
       }
     } catch (SQLException | DatabaseException e) {
-      throw new UnexpectedLiquibaseException(String.format("Could not retrieve foreign keys for table %s", getBaseTableName()), e);
+      throw new UnexpectedLiquibaseException(
+          String.format("Could not retrieve foreign keys for table %s", getBaseTableName()), e);
     }
-    
+
     return sqlStatements.toArray(new SqlStatement[sqlStatements.size()]);
   }
-
 }

src/main/java/liquibase/ext/spanner/change/MergeColumnsChangeSpanner.java

@@ -31,11 +31,14 @@
  * Cloud Spanner-specific implementation of {@link MergeColumnChange}. Cloud Spanner requires all
  * UPDATE and DELETE statements to include a WHERE clause, even when all rows should be
  * updated/deleted. This feature is a safety precaution against accidental updates/deletes.
- * 
- * {@link SpannerMergeColumnsChange} will use a Partitioned DML statement to fill the data in the new column.
+ *
+ * <p>{@link SpannerMergeColumnsChange} will use a Partitioned DML statement to fill the data in the
+ * new column.
  */
-@DatabaseChange(name = "mergeColumns",
-    description = "Concatenates the values in two columns, joins them by with string, and stores the resulting value in a new column.",
+@DatabaseChange(
+    name = "mergeColumns",
+    description =
+        "Concatenates the values in two columns, joins them by with string, and stores the resulting value in a new column.",
     priority = ChangeMetaData.PRIORITY_DATABASE)
 public class MergeColumnsChangeSpanner extends MergeColumnChange {
 
@@ -55,12 +58,17 @@ public SqlStatement[] generateStatements(final Database database) {
 
     statements.add(new RawSqlStatement("SET AUTOCOMMIT=TRUE"));
     statements.add(new RawSqlStatement("SET AUTOCOMMIT_DML_MODE='PARTITIONED_NON_ATOMIC'"));
-    String updateStatement = "UPDATE "
-        + database.escapeTableName(getCatalogName(), getSchemaName(), getTableName()) + " SET "
-        + database.escapeObjectName(getFinalColumnName(), Column.class) + " = "
-        + database.getConcatSql(database.escapeObjectName(getColumn1Name(), Column.class),
-            "'" + getJoinString() + "'", database.escapeObjectName(getColumn2Name(), Column.class))
-        + " WHERE TRUE";
+    String updateStatement =
+        "UPDATE "
+            + database.escapeTableName(getCatalogName(), getSchemaName(), getTableName())
+            + " SET "
+            + database.escapeObjectName(getFinalColumnName(), Column.class)
+            + " = "
+            + database.getConcatSql(
+                database.escapeObjectName(getColumn1Name(), Column.class),
+                "'" + getJoinString() + "'",
+                database.escapeObjectName(getColumn2Name(), Column.class))
+            + " WHERE TRUE";
     statements.add(new RawSqlStatement(updateStatement));
     statements.add(new RawSqlStatement("SET AUTOCOMMIT_DML_MODE='TRANSACTIONAL'"));
 
@@ -80,5 +88,4 @@ public SqlStatement[] generateStatements(final Database database) {
 
     return statements.toArray(new SqlStatement[statements.size()]);
   }
-
 }