chore: add Prettier and Spotless checks, format files

Author: ThirdEyeSqueegee

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,10 +1,9 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
+title: ""
 labels: bug
-assignees: ''
-
+assignees: ""
 ---
 
 **Describe the bug**

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,10 +1,7 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
+title: ""
 labels: enhancement
-assignees: ''
-
+assignees: ""
 ---
-
-

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,5 @@
-*Issue #, if available:*
-
-*Description of changes:*
+_Issue #, if available:_
 
+_Description of changes:_
 
 By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

.github/workflows/CI.yml

@@ -22,8 +22,18 @@ jobs:
           java-version: 11
           distribution: adopt
 
+      - name: Prettier
+        uses: rutajdash/prettier-cli-action@v1.0.2
+        with:
+          file_pattern: "**/*.{md,yml}"
+
+      - name: Check formatting
+        run: mvn spotless:check
+
       - name: Build with Maven
         run: mvn --batch-mode --update-snapshots package
 
       - name: Codecov
         uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

CHANGELOG.md

@@ -1,4 +1,5 @@
 ## Code of Conduct
-This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). 
-For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact 
+
+This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
+For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
 opensource-codeofconduct@amazon.com with any additional questions or comments.

CODE_OF_CONDUCT.md

@@ -1,58 +1,63 @@
 # Contributing Guidelines
 
-Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional 
+Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
 documentation, we greatly value feedback and contributions from our community.
 
-Please read through this document before submitting any issues or pull requests to ensure we have all the necessary 
+Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
 information to effectively respond to your bug report or contribution.
 
-
 ## Reporting Bugs/Feature Requests
 
 We welcome you to use the GitHub issue tracker to report bugs or suggest features.
 
-When filing an issue, please check [existing open](https://github.com/aws/aws-secretsmanager-jdbc/issues), or [recently closed](https://github.com/aws/aws-secretsmanager-jdbc/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already 
+When filing an issue, please check [existing open](https://github.com/aws/aws-secretsmanager-jdbc/issues), or [recently closed](https://github.com/aws/aws-secretsmanager-jdbc/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
 reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
 
-* A reproducible test case or series of steps
-* The version of our code being used
-* Any modifications you've made relevant to the bug
-* Anything unusual about your environment or deployment
-
+- A reproducible test case or series of steps
+- The version of our code being used
+- Any modifications you've made relevant to the bug
+- Anything unusual about your environment or deployment
 
 ## Contributing via Pull Requests
+
 Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
 
-1. You are working against the latest source on the *master* branch.
+1. You are working against the latest source on the _master_ branch.
 2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
 3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
 
 To send us a pull request, please:
 
 1. Fork the repository.
 2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
-3. Ensure local tests pass.
-4. Commit to your fork using clear commit messages.
-5. Send us a pull request, answering any default questions in the pull request interface.
-6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
+3. Use rustfmt to ensure consistent formatting for `.java` files, and Prettier for `.md` and `.yml` files (see [Formatting instructions](#formatting-instructions)).
+4. Ensure local tests pass.
+5. Commit to your fork using clear commit messages.
+6. Send us a pull request, answering any default questions in the pull request interface.
+7. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
 
-GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and 
+GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
 [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
 
+# Formatting instructions
+
+- Install [Prettier](https://prettier.io/docs/install).
+  - If using VS Code, install the VS Code extension for the above.
+- Run `mvn spotless:apply` and `prettier --write **/*.{md,yml}`.
 
 ## Finding contributions to work on
-Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/aws/aws-secretsmanager-jdbc/labels/help%20wanted) issues is a great place to start. 
 
+Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/aws/aws-secretsmanager-jdbc/labels/help%20wanted) issues is a great place to start.
 
 ## Code of Conduct
-This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). 
-For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact 
-opensource-codeofconduct@amazon.com with any additional questions or comments.
 
+This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
+For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
+opensource-codeofconduct@amazon.com with any additional questions or comments.
 
 ## Security issue notifications
-If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
 
+If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
 
 ## Licensing
 

CONTRIBUTING.md

@@ -11,21 +11,23 @@ This library is licensed under the Apache 2.0 License.
 
 ## Features
 
-* Provides wrappers to common JDBC drivers enabling simple database connectivity
-* Provides database connection pooling support through c3p0
+- Provides wrappers to common JDBC drivers enabling simple database connectivity
+- Provides database connection pooling support through c3p0
 
 ## Building from Source
 
-After you've downloaded the code from GitHub, you can build it using Maven. 
-* To disable GPG signing in the build, use this command: `mvn clean install -Dgpg.skip=true`
-* To build the default (non-shaded) JAR, use this command: `mvn clean install`
-* To build the shaded (uber) JAR with all dependencies included, use this command: `mvn clean install -Pshade`
-The shaded JAR will be generated in the `target/` directory with the `-shaded` classifier, e.g.: `target/aws-secretsmanager-jdbc-2.0.2-shaded.jar`
+After you've downloaded the code from GitHub, you can build it using Maven.
+
+- To disable GPG signing in the build, use this command: `mvn clean install -Dgpg.skip=true`
+- To build the default (non-shaded) JAR, use this command: `mvn clean install`
+- To build the shaded (uber) JAR with all dependencies included, use this command: `mvn clean install -Pshade`
+  The shaded JAR will be generated in the `target/` directory with the `-shaded` classifier, e.g.: `target/aws-secretsmanager-jdbc-2.0.2-shaded.jar`
 
 ## Usage
-The recommended way to use the SQL Connection Library is to consume it from Maven.  The latest released version can be found at: https://mvnrepository.com/artifact/com.amazonaws.secretsmanager/aws-secretsmanager-jdbc
 
-``` xml
+The recommended way to use the SQL Connection Library is to consume it from Maven. The latest released version can be found at: https://mvnrepository.com/artifact/com.amazonaws.secretsmanager/aws-secretsmanager-jdbc
+
+```xml
 <dependency>
     <groupId>com.amazonaws.secretsmanager</groupId>
     <artifactId>aws-secretsmanager-jdbc</artifactId>
@@ -35,7 +37,7 @@ The recommended way to use the SQL Connection Library is to consume it from Mave
 
 To use the latest build (pre-release), don't forget to enable the download of snapshot jars from Maven.
 
-``` xml
+```xml
 <profiles>
   <profile>
     <id>allow-snapshots</id>
@@ -53,13 +55,12 @@ To use the latest build (pre-release), don't forget to enable the download of sn
 ```
 
 ### Usage Example
+
 We provide database drivers that intercept calls to real database drivers and replace secret IDs with actual login credentials.
 This prevents hard-coding database credentials into your application code.
 
-
 The following is an example which uses the secret to resolve both the endpoint and the login credentials.
 
-
 ```
 // Load the JDBC driver
 Class.forName( "com.amazonaws.secretsmanager.sql.AWSSecretsManagerPostgreSQLDriver" ).newInstance();
@@ -88,30 +89,32 @@ String URL = "jdbc-secretsmanager:postgresql://example.com:5432/database";
 ```
 
 The secret should be in the correct JSON format. For more information, see the [AWS Secrets Manager documentation](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure). For example:
+
 ```json
 {
   "host": "<host name>",
   "username": "<username>",
   "password": "<password>",
   "dbname": "<database name>",
-  "port": "<port number>",
+  "port": "<port number>"
 }
 ```
 
 We support a variety of drivers. For more information, see the [AWS Secrets Manager JDBC documentation](https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets_jdbc).
 
-
 ## Credentials
 
 This library uses the [Default Credential Provider Chain](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials.html). The following options exist to override some of the defaults:
 
-1) Set a PrivateLink DNS endpoint URL and a region in the secretsmanager.properties file:
+1. Set a PrivateLink DNS endpoint URL and a region in the secretsmanager.properties file:
+
 ```text
 drivers.vpcEndpointUrl= #The endpoint URL
 drivers.vpcEndpointRegion= #The endpoint region
 ```
 
-2) Override the primary region by setting the 'AWS_SECRET_JDBC_REGION' environment variable to the preferred region, or via the secretsmanager.properties file:
+2. Override the primary region by setting the 'AWS_SECRET_JDBC_REGION' environment variable to the preferred region, or via the secretsmanager.properties file:
+
 ```text
 drivers.region= #The region to use.
 ```

README.md

@@ -225,6 +225,20 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>com.diffplug.spotless</groupId>
+        <artifactId>spotless-maven-plugin</artifactId>
+        <version>2.44.4</version>
+        <configuration>
+          <!-- define a language-specific format -->
+          <java>
+            <palantirJavaFormat>
+              <version>2.39.0</version>
+              <style>PALANTIR</style>
+            </palantirJavaFormat>
+          </java>
+        </configuration>
+      </plugin>
     </plugins>
   </build>
 

pom.xml

@@ -12,6 +12,13 @@
  */
 package com.amazonaws.secretsmanager.sql;
 
+import com.amazonaws.secretsmanager.caching.SecretCache;
+import com.amazonaws.secretsmanager.caching.SecretCacheConfiguration;
+import com.amazonaws.secretsmanager.util.Config;
+import com.amazonaws.secretsmanager.util.JDBCSecretCacheBuilderProvider;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import java.io.IOException;
 import java.sql.Connection;
 import java.sql.Driver;
@@ -22,16 +29,6 @@
 import java.util.Enumeration;
 import java.util.Properties;
 import java.util.logging.Logger;
-
-import com.amazonaws.secretsmanager.caching.SecretCache;
-import com.amazonaws.secretsmanager.caching.SecretCacheConfiguration;
-import com.amazonaws.secretsmanager.util.Config;
-import com.amazonaws.secretsmanager.util.JDBCSecretCacheBuilderProvider;
-import com.fasterxml.jackson.databind.JsonNode;
-import com.fasterxml.jackson.databind.ObjectMapper;
-
-import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
-
 import software.amazon.awssdk.services.secretsmanager.SecretsManagerClient;
 import software.amazon.awssdk.services.secretsmanager.SecretsManagerClientBuilder;
 import software.amazon.awssdk.utils.StringUtils;
@@ -105,7 +102,7 @@ public abstract class AWSSecretsManagerDriver implements Driver {
 
     /**
      * Message to return on the RuntimeException when secret string is invalid json
-     */ 
+     */
     public static final String INVALID_SECRET_STRING_JSON = "Could not parse SecretString JSON";
 
     private SecretCache secretCache;
@@ -116,8 +113,6 @@ public abstract class AWSSecretsManagerDriver implements Driver {
 
     private ObjectMapper mapper = new ObjectMapper();
 
-
-
     /**
      * Constructs the driver setting the properties from the properties file using system properties as defaults.
      * Instantiates the secret cache with default options.
@@ -126,7 +121,6 @@ protected AWSSecretsManagerDriver() {
         this(new JDBCSecretCacheBuilderProvider().build());
     }
 
-
     /**
      * Constructs the driver setting the properties from the properties file using system properties as defaults.
      * Sets the secret cache to the cache that was passed in.
@@ -196,7 +190,8 @@ private void loadRealDriver() {
         try {
             Class.forName(this.realDriverClass);
         } catch (ClassNotFoundException e) {
-            throw new IllegalStateException("Could not load real driver with name, \"" + this.realDriverClass + "\".", e);
+            throw new IllegalStateException(
+                    "Could not load real driver with name, \"" + this.realDriverClass + "\".", e);
         }
     }
 
@@ -268,8 +263,8 @@ public Driver getWrappedDriver() {
             }
         }
         throw new IllegalStateException("No Driver has been registered with name, " + this.realDriverClass
-                                        + ". Please check your system properties or " + Config.CONFIG_FILE_NAME
-                                        + " for typos. Also ensure that the Driver registers itself.");
+                + ". Please check your system properties or " + Config.CONFIG_FILE_NAME
+                + " for typos. Also ensure that the Driver registers itself.");
     }
 
     @Override
@@ -284,7 +279,7 @@ public boolean acceptsURL(String url) throws SQLException {
         } else if (url.startsWith("jdbc:")) {
             // For any other JDBC URL, return false
             return false;
-        } else  {
+        } else {
             // We accept a secret ID as the URL so if the config is set, and it's not a JDBC URL, return true
             return true;
         }
@@ -306,7 +301,7 @@ public boolean acceptsURL(String url) throws SQLException {
 
     /**
      * Construct a database URL from the endpoint, port and database name. This method is called when the
-     * <code>connect</code> method is called with a secret ID instead of a URL. 
+     * <code>connect</code> method is called with a secret ID instead of a URL.
      *
      * @param endpoint                                          The endpoint retrieved from the secret cache
      * @param port                                              The port retrieved from the secret cache
@@ -364,11 +359,10 @@ private Connection connectWithSecret(String unwrappedUrl, Properties info, Strin
                 if (isExceptionDueToAuthenticationError(e)) {
                     boolean refreshSuccess = this.secretCache.refreshNow(credentialsSecretId);
                     if (!refreshSuccess) {
-                        throw(e);
+                        throw (e);
                     }
-                }
-                else {
-                    throw(e);
+                } else {
+                    throw (e);
                 }
             }
         }
@@ -391,8 +385,8 @@ public Connection connect(String url, Properties info) throws SQLException {
             try {
                 String secretString = secretCache.getSecretString(url);
                 if (StringUtils.isBlank(secretString)) {
-                    throw new IllegalArgumentException("URL " + url + " is not a valid URL starting with scheme " +
-                            SCHEME + " or a valid retrievable secret ID ");
+                    throw new IllegalArgumentException("URL " + url + " is not a valid URL starting with scheme "
+                            + SCHEME + " or a valid retrievable secret ID ");
                 }
                 JsonNode jsonObject = mapper.readTree(secretString);
                 String endpoint = jsonObject.get("host").asText();