test

README

Tests

This folder contains automated tests for this Module. All of the tests are written in Go. Most of these are "integration tests" that deploy real infrastructure using Terraform and verify that infrastructure works as expected using a helper library called Terratest.

WARNING WARNING WARNING

Note #1: Many of these tests create real resources in a GCP project and then try to clean those resources up at the end of a test run. That means these tests may cost you money to run! When adding tests, please be considerate of the resources you create and take extra care to clean everything up when you're done!

Note #2: Never forcefully shut the tests down (e.g. by hitting CTRL + C) or the cleanup tasks won't run!

Note #3: We set -timeout 60m on all tests not because they necessarily take that long, but because Go has a default test timeout of 10 minutes, after which it forcefully kills the tests with a SIGQUIT, preventing the cleanup tasks from running. Therefore, we set an overlying long timeout to make sure all tests have enough time to finish and clean up.

Running the tests

Prerequisites

• Install the latest version of Go.
• Install dep for Go dependency management.
• Install Terraform.
• Configure your Google credentials using one of the options supported by GCP.

One-time setup

Download Go dependencies using dep:

cd test
dep ensure

Run all the tests

cd test
go test -v -timeout 60m

Run a specific test

To run a specific test called TestFoo:

cd test
go test -v -timeout 60m -run TestFoo

Documentation

Index

• Constants

Constants

const DB_NAME = "testdb"

const DB_PASS = "testpassword"

const DB_USER = "testuser"

const KEY_FAILOVER_REPLICA_ZONE = "failoverReplicaZone"

const KEY_MASTER_ZONE = "masterZone"

const KEY_PROJECT = "project"

const KEY_READ_REPLICA_ZONE = "readReplicaZone"

const KEY_REGION = "region"

const MYSQL_CREATE_TEST_TABLE_WITH_AUTO_INCREMENT_STATEMENT = "CREATE TABLE IF NOT EXISTS test (id int NOT NULL AUTO_INCREMENT, name varchar(10) NOT NULL, PRIMARY KEY (ID))"

const MYSQL_INSERT_TEST_ROW = "INSERT INTO test(name) VALUES(?)"

const OUTPUT_CLIENT_CA_CERT = "client_ca_cert"

const OUTPUT_CLIENT_PRIVATE_KEY = "client_private_key"

const OUTPUT_DB_NAME = "db_name"

const OUTPUT_FAILOVER_INSTANCE_NAME = "failover_instance_name"

const OUTPUT_FAILOVER_PROXY_CONNECTION = "failover_proxy_connection"

const OUTPUT_MASTER_CA_CERT = "master_ca_cert"

const OUTPUT_MASTER_INSTANCE_NAME = "master_instance_name"

const OUTPUT_MASTER_IP_ADDRESSES = "master_ip_addresses"

const OUTPUT_MASTER_PRIVATE_IP = "master_private_ip"

const OUTPUT_MASTER_PROXY_CONNECTION = "master_proxy_connection"

const OUTPUT_MASTER_PUBLIC_IP = "master_public_ip"

const OUTPUT_READ_REPLICA_INSTANCE_NAMES = "read_replica_instance_names"

const OUTPUT_READ_REPLICA_PROXY_CONNECTIONS = "read_replica_proxy_connections"

const OUTPUT_READ_REPLICA_PUBLIC_IPS = "read_replica_public_ips"

const POSTGRES_CREATE_TEST_TABLE_WITH_SERIAL = "CREATE TABLE IF NOT EXISTS test (id SERIAL, name varchar(10) NOT NULL, PRIMARY KEY (ID))"

const POSTGRES_DROP_TEST_TABLE = "DROP TABLE IF EXISTS test"

const POSTGRES_INSERT_TEST_ROW = "INSERT INTO test(name) VALUES('Grunty') RETURNING id"

const SQL_EMPTY_TEST_TABLE_STATEMENT = "DELETE FROM test"

const SQL_QUERY_ROW_COUNT = "SELECT count(*) FROM test"