docs: Update integration test documentation and default wrapperPlugins value (#396)

Update integration test documentation and default wrapperPlugins value

Author: crystall-bitquill

docs/Documentation.md

@@ -1,7 +1,7 @@
 # Documentation
 
 - [Getting Started](./GettingStarted.md)
-- [Using the AWS Advanced JDBC Wrapper](/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md)
+- [Using the AWS JDBC Driver](/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md)
   - [Data Sources](/docs/using-the-jdbc-driver/DataSource.md)
   - [Logging](/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#logging)
   - [JDBC Wrapper Parameters](/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#aws-advanced-jdbc-driver-parameters)
@@ -13,9 +13,10 @@
     - [AWS Secrets Manager Plugin](/docs/using-the-jdbc-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md)
     - [Aurora Connection Tracker Plugin](/docs/using-the-jdbc-driver/using-plugins/UsingTheAuroraConnectionTrackerPlugin.md)
     - [Driver Metadata Connection Plugin](/docs/using-the-jdbc-driver/using-plugins/UsingTheDriverMetadataConnectionPlugin.md)
+    - [Read Write Splitting Plugin](/docs/using-the-jdbc-driver/using-plugins/UsingTheReadWriteSplittingPlugin.md)
 - [Development Guide](./development-guide/DevelopmentGuide.md)
   - [Setup](./development-guide/DevelopmentGuide.md#setup)
-  - [Building the AWS Advanced JDBC Driver](./development-guide/DevelopmentGuide.md#building-the-aws-advanced-jdbc-driver)
+  - [Building the AWS JDBC Driver](./development-guide/DevelopmentGuide.md#building-the-aws-advanced-jdbc-driver)
   - [Running the Tests](./development-guide/DevelopmentGuide.md#running-the-tests)
   - [Architecture](./development-guide/Architecture.md)
     - [Plugin Manager](./development-guide/PluginManager.md)

docs/development-guide/DevelopmentGuide.md

@@ -150,13 +150,10 @@ Windows:
 ./gradlew test
 ```
 
-For more information about running driver-specific integration tests, visit: <br />
+#### Integration Tests
+For more information on how to run the integration tests, please visit [Integration Tests](/docs/development-guide/IntegrationTests.md).
 
-[PostgreSQL](/docs/driver-specific/postgresql/postgresql.md)
-
-[MySQL](/docs/driver-specific/mysql/mysql.md)
-
-###### Sample Code
+#### Sample Code
 [Connection Test Sample Code](/docs/driver-specific/postgresql/ConnectionSample.java)
 
 ## Architecture

docs/development-guide/IntegrationTests.md

@@ -5,6 +5,7 @@
 - Docker Desktop:
     - [Docker Desktop for Mac](https://docs.docker.com/desktop/install/mac-install/)
     - [Docker Desktop for Windows](https://docs.docker.com/desktop/install/windows-install/)
+- [Environment variables](#Environment-Variables)
 
 ##### Aurora Test Requirements
 - An AWS account with:
@@ -25,8 +26,46 @@ PostgreSQL and MySQL tests are currently supported.
 These integration tests are focused on testing connection strings against a local database inside a Docker container.
 PostgreSQL and MySQL tests are currently supported.
 
+### Environment Variables
+
+If the environment variable `REUSE_AURORA_CLUSTER` is set to true, the integration tests will use the existing cluster defined by your environment variables. Otherwise, the integration tests will create a new Aurora cluster and then delete it automatically when the tests are done. Note that you will need a valid Docker environment to run any of the integration tests because they are run using a Docker environment as a host. The appropriate Docker containers will be created automatically when you run the tests, so you will not need to execute any Docker commands manually.
+
+>**Note:** if you are running tests against an existing cluster, the tests will only run against the Aurora database engine of that cluster. For example, if you specify a MySQL cluster using the environment variables, only the MySQL tests will be run even if you pick test-all-aurora as the task. To run against Postgres instead, you will need to change your environment variables
+
+| Environment Variable Name | Required | Description                                                                                                                                                                                                      | Example Value                                |
+|---------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------|
+| `DB_USERNAME`             | Yes      | The username to access the database.                                                                                                                                                                             | `admin`                                      |
+| `DB_PASSWORD`             | Yes      | The database cluster password.                                                                                                                                                                                   | `password`                                   |
+| `DB_DATABASE_NAME`        | No       | Name of the database that will be used by the tests. The default database name is test.                                                                                                                          | `test_db_name`                               |
+| `AURORA_CLUSTER_NAME`     | Yes      | The database identifier for your Aurora cluster. Must be a unique value to avoid conflicting with existing clusters.                                                                                             | `db-identifier`                              |
+| `AURORA_CLUSTER_DOMAIN`   | No       | The existing database connection suffix. Use this variable to run against an existing database.                                                                                                                  | `XYZ.us-east-2.rds.amazonaws.com`            |
+| `IAM_USER`                | No       | User within the database that is identified with AWSAuthenticationPlugin. This is used for AWS IAM Authentication and is optional                                                                                | `example_user_name`                          |
+| `AWS_ACCESS_KEY_ID`       | Yes      | An AWS access key associated with an IAM user or role with RDS permissions.                                                                                                                                      | `ASIAIOSFODNN7EXAMPLE`                       |
+| `AWS_SECRET_ACCESS_KEY`   | Yes      | The secret key associated with the provided AWS_ACCESS_KEY_ID.                                                                                                                                                   | `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`   |
+| `AWS_SESSION_TOKEN`       | No       | AWS Session Token for CLI, SDK, & API access. This value is for MFA credentials only. See: [temporary AWS credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html). | `AQoDYXdzEJr...<remainder of session token>` |                                          |
+| `REUSE_AURORA_CLUSTER`    | Yes      | Set to true if you would like to use an existing cluster for your tests.                                                                                                                                         | `false`                                      |
+| `AURORA_DB_REGION`        | Yes      | The database region.                                                                                                                                                                                             | `us-east-2`                                  |
+
 ### Running the Integration Tests
-Please view [this](../driver-specific/postgresql/postgresql.md) page for further instructions on how to run the PostgreSQL integration tests.
 
-Please view [this](../driver-specific/mysql/mysql.md) page for further instructions on how to run the MySQL integration tests.
+To run the integration tests, you can select from a number of tasks:
+- `test-all-environments`: run all Aurora and standard database tests
+- `test-all-docker`: run all standard database tests
+- `test-all-aurora`: run all Aurora tests
+- `debug-all-environments`: debug all Aurora and standard database tests
+- `debug-all-docker`: debug all standard database tests
+- `debug-all-aurora`: debug all Aurora tests
+
+For example, to run all integration tests, you can use the following commands:
+
+macOS:
+```bash
+./gradlew --no-parallel --no-daemon test-all-environments
+```
+
+Windows:
+```bash
+cmd /c ./gradlew --no-parallel --no-daemon test-all-environments
+```
 
+Test results can be found at `wrapper/build/report/index.html`.