hashicorp-copywrite[bot]andJohan Brandhorst-Satzkorn
29da0bcb92
* Adding explicit MPL license for sub-package. This directory and its subdirectories (packages) contain files licensed with the MPLv2 `LICENSE` file in this directory and are intentionally licensed separately from the BSL `LICENSE` file at the root of this repository. * Adding explicit MPL license for sub-package This directory and its subdirectories (packages) contain files licensed with the MPLv2 `LICENSE` file in this directory and are intentionally licensed separately from the BSL `LICENSE` file at the root of this repository. * Updating the license from MPL to Business Source License Going forward, this project will be licensed under the Business Source License v1.1. Please see our blog post for more details at https://hashi.co/bsl-blog, FAQ at www.hashicorp.com/licensing-faq, and details of the license at www.hashicorp.com/bsl. * Update copyright file headers to BUS-1.1 * Rerun make gen This will pick up the last of the license changes * Revert "Rerun make gen" This reverts commit dbe0968bffd92745d8663c6940debae098395a6b. * Remove copywrite from generation script The current version of copywrite is not sophisticated enough to only apply the copywrite changes to certain subdirectories, so to avoid accidentally relicensing our api and sdk modules, we will stop running the copywrite script until such time that it can do the right thing. * License protobuf API as MPL The protobuf API files are used to generate the SDK, since we want the SDK to be MPL, the protobuf files must also be MPL. This extends to all protobuf files whose sources end up in the SDK directory, including: - internal/proto/controller/api - internal/proto/controller/custom_options - internal/proto/plugin It also includes the generated service directory in internal/gen/controller/api/services, since they are generated from the protobuf sources used for the SDK. * Change website license file name This makes the naming scheme consistent with the rest of the repository. * Add note on licensing to README * Set copywrite license to BUSL * Revert "Add note on licensing to README" This reverts commit 4d865a91a7a4f11605f0dc4609355d7e3c3cfffe. --------- Co-authored-by: hashicorp-copywrite[bot] <110428419+hashicorp-copywrite[bot]@users.noreply.github.com> Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
SQL Tests
This test suite is used to test behavior of the database logic. In particular the data warehouse implementation is completely in sql via plpgsql, functions, and triggers. This test suite is also implemented directly in sql.
Organization
initdb.d: contains init scripts/sql that is run on the test database when it starts. It ensures the sql migrations are run and creates test helper functions.tests: contains the tests. Each file can contain only a single test that runs in a transaction so it can rollback.
The tests leverage the pgTap postgres extension to make assertions and provide more readable test output.
Usage
To run the test run make or make test. This will:
- Start a docker
postgrescontainer and initialize it. - Start a docker
pgtapcontainer to execute the tests.
When writing new tests it can be faster to keep the database up and just re-run the tests. This can be done by running:
# starts database docker image in the background
make database-up
# runs the tests, call this multiple times while implementing new tests.
make run-tests
# to clean up
make clean
You can also run individual tests:
# run a single test file
make TESTS=tests/setup/wtt_load.sql
# run a single test file with the database already created.
make run-tests TESTS=tests/setup/wtt_load.sql
# run a directory of tests
make TESTS=tests/setup/*.sql
You can pass through options to pg_prove.
See the docs
for available options, i.e:
# run tests in parallel with verbose output
make PROVE_OPTS='-j9 -v'
By default the database docker container does not use a host port. This can be changed using an environment variable:
$ export SQL_TEST_DB_PORT=5433
$ make database-up
$ make run-tests
Different versions of postgres can easily be tested:
make PG_DOCKER_TAG=latest
make PG_DOCKER_TAG=14-alpine
make PG_DOCKER_TAG=13-alpine
make PG_DOCKER_TAG=12-alpine