IntegrationTests

Integration Tests

Prerequisites

• Docker Desktop:
  • Docker Desktop for Mac
  • Docker Desktop for Windows
• Environment variables

Aurora Test Requirements

• An AWS account with:

  • RDS permissions
  • EC2 permissions so integration tests can add the current IP address in the Aurora cluster's EC2 security group.
  • For more information, see: Setting Up for Amazon RDS User Guide.

• An available Aurora PostgreSQL or MySQL DB cluster is required if you're running the tests against an existing DB cluster.

Aurora Integration Tests

The Aurora integration tests are focused on testing connection strings and failover capabilities of any driver. The tests are run in Docker but make a connection to test against an Aurora cluster. PostgreSQL and MySQL tests are currently supported.

Standard Integration Tests

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.	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

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:

./gradlew --no-parallel --no-daemon test-all-environments

Windows:

cmd /c ./gradlew --no-parallel --no-daemon test-all-environments

Test results can be found at wrapper/build/report/index.html.