diff --git a/dbt-athena/.changes/unreleased/Fixes-20251115-223739.yaml b/dbt-athena/.changes/unreleased/Fixes-20251115-223739.yaml new file mode 100644 index 000000000..0f86eace9 --- /dev/null +++ b/dbt-athena/.changes/unreleased/Fixes-20251115-223739.yaml @@ -0,0 +1,6 @@ +kind: Fixes +body: Add integration test documentation to CONTRIBUTING.md +time: 2025-11-15T22:37:39.7261048+08:00 +custom: + Author: godhahn + Issue: "843" diff --git a/dbt-athena/CONTRIBUTING.md b/dbt-athena/CONTRIBUTING.md index 28c9ad10b..e044f0f3a 100644 --- a/dbt-athena/CONTRIBUTING.md +++ b/dbt-athena/CONTRIBUTING.md @@ -1,4 +1,36 @@ -# Contributing to `dbt-adapters` +# Contributing to `dbt-athena` This document covers the incremental content beyond what is contained in the repository's [CONTRIBUTING.md](/CONTRIBUTING.md). You are strongly encouraged to start there first if you are reading this for the first time. + +# Testing + +## 1. Configure Environment + +From the `dbt-athena` directory, run `hatch run setup` to create a `test.env` file. Populate this file with your Athena connection details. + +* `DBT_TEST_ATHENA_S3_STAGING_DIR` +* `DBT_TEST_ATHENA_S3_TMP_TABLE_DIR` +* `DBT_TEST_ATHENA_REGION_NAME` +* `DBT_TEST_ATHENA_DATABASE` +* `DBT_TEST_ATHENA_SCHEMA` +* `DBT_TEST_ATHENA_WORK_GROUP` +* `DBT_TEST_ATHENA_THREADS` +* `DBT_TEST_ATHENA_POLL_INTERVAL` +* `DBT_TEST_ATHENA_NUM_RETRIES` +* `DBT_TEST_ATHENA_AWS_PROFILE_NAME` + +## 2. Run Tests + +Once `test.env` is configured, you can run tests using `hatch`: + +```shell +# run all integration tests +$ hatch run integration-tests + +# run tests for a specific module +$ hatch run integration-tests tests/functional/adapter/test_basic_hive.py + +# run a specific test class +$ hatch run integration-tests tests/functional/adapter/test_basic_hive.py::TestSimpleMaterializationsHive +``` diff --git a/dbt-bigquery/.changes/unreleased/Fixes-20251115-223927.yaml b/dbt-bigquery/.changes/unreleased/Fixes-20251115-223927.yaml new file mode 100644 index 000000000..d455752e4 --- /dev/null +++ b/dbt-bigquery/.changes/unreleased/Fixes-20251115-223927.yaml @@ -0,0 +1,6 @@ +kind: Fixes +body: Add integration test documentation to CONTRIBUTING.md +time: 2025-11-15T22:39:27.7160737+08:00 +custom: + Author: godhahn + Issue: "843" diff --git a/dbt-bigquery/CONTRIBUTING.md b/dbt-bigquery/CONTRIBUTING.md index 82d93fe36..4d987d798 100644 --- a/dbt-bigquery/CONTRIBUTING.md +++ b/dbt-bigquery/CONTRIBUTING.md @@ -2,3 +2,34 @@ This document covers the incremental content beyond what is contained in the repository's [CONTRIBUTING.md](/CONTRIBUTING.md). You are strongly encouraged to start there first if you are reading this for the first time. + +# Testing + +## 1. Configure Environment + +From the `dbt-bigquery` directory, run `hatch run setup` to create a `test.env` file. Populate this file with your BigQuery connection details. + +* `BIGQUERY_TEST_NO_ACCESS_DATABASE` +* `BIGQUERY_TEST_SERVICE_ACCOUNT_JSON` +* `BIGQUERY_TEST_ICEBERG_BUCKET` +* `DBT_TEST_USER_1` +* `DBT_TEST_USER_2` +* `DBT_TEST_USER_3` +* `COMPUTE_REGION` +* `DATAPROC_CLUSTER_NAME` +* `GCS_BUCKET` + +## 2. Run Tests + +Once `test.env` is configured, you can run tests using `hatch`: + +```shell +# run all integration tests +$ hatch run integration-tests + +# run tests for a specific module +$ hatch run integration-tests tests/functional/adapter/test_basic.py + +# run a specific test class +$ hatch run integration-tests tests/functional/adapter/test_basic.py::TestSimpleMaterializationsBigQuery +``` diff --git a/dbt-postgres/.changes/unreleased/Fixes-20251115-223906.yaml b/dbt-postgres/.changes/unreleased/Fixes-20251115-223906.yaml new file mode 100644 index 000000000..fbb538be2 --- /dev/null +++ b/dbt-postgres/.changes/unreleased/Fixes-20251115-223906.yaml @@ -0,0 +1,6 @@ +kind: Fixes +body: Add integration test documentation to CONTRIBUTING.md +time: 2025-11-15T22:39:06.7814256+08:00 +custom: + Author: godhahn + Issue: "843" diff --git a/dbt-postgres/CONTRIBUTING.md b/dbt-postgres/CONTRIBUTING.md index f58437c4d..ac50d2c1b 100644 --- a/dbt-postgres/CONTRIBUTING.md +++ b/dbt-postgres/CONTRIBUTING.md @@ -2,3 +2,34 @@ This document covers the incremental content beyond what is contained in the repository's [CONTRIBUTING.md](/CONTRIBUTING.md). You are strongly encouraged to start there first if you are reading this for the first time. + +# Testing + +## 1. Configure Environment + +From the `dbt-postgres` directory, run `hatch run setup` to create a `test.env` file. Populate this file with your Postgres connection details. + +* `POSTGRES_TEST_HOST` +* `POSTGRES_TEST_PORT` +* `POSTGRES_TEST_USER` +* `POSTGRES_TEST_PASS` +* `POSTGRES_TEST_DATABASE` +* `POSTGRES_TEST_THREADS` +* `DBT_TEST_USER_1` +* `DBT_TEST_USER_2` +* `DBT_TEST_USER_3` + +## 2. Run Tests + +Once `test.env` is configured, you can run tests using `hatch`: + +```shell +# run all integration tests +$ hatch run integration-tests + +# run tests for a specific module +$ hatch run integration-tests tests/functional/adapter/test_basic.py + +# run a specific test class +$ hatch run integration-tests tests/functional/adapter/test_basic.py::TestSimpleMaterializations +``` diff --git a/dbt-redshift/.changes/unreleased/Fixes-20251115-223819.yaml b/dbt-redshift/.changes/unreleased/Fixes-20251115-223819.yaml new file mode 100644 index 000000000..dc09299f9 --- /dev/null +++ b/dbt-redshift/.changes/unreleased/Fixes-20251115-223819.yaml @@ -0,0 +1,6 @@ +kind: Fixes +body: Add integration test documentation to CONTRIBUTING.md +time: 2025-11-15T22:38:19.2782804+08:00 +custom: + Author: godhahn + Issue: "843" diff --git a/dbt-redshift/CONTRIBUTING.md b/dbt-redshift/CONTRIBUTING.md index 2b797807c..18bf72dc9 100644 --- a/dbt-redshift/CONTRIBUTING.md +++ b/dbt-redshift/CONTRIBUTING.md @@ -2,3 +2,39 @@ This document covers the incremental content beyond what is contained in the repository's [CONTRIBUTING.md](/CONTRIBUTING.md). You are strongly encouraged to start there first if you are reading this for the first time. + +# Testing + +## 1. Configure Environment + +From the `dbt-redshift` directory, run `hatch run setup` to create a `test.env` file. Populate this file with your Redshift connection details. + +* `REDSHIFT_TEST_HOST` +* `REDSHIFT_TEST_PORT` +* `REDSHIFT_TEST_DBNAME` +* `REDSHIFT_TEST_USER` +* `REDSHIFT_TEST_PASS` +* `REDSHIFT_TEST_REGION` +* `REDSHIFT_TEST_CLUSTER_ID` +* `REDSHIFT_TEST_IAM_USER_PROFILE` +* `REDSHIFT_TEST_IAM_USER_ACCESS_KEY_ID` +* `REDSHIFT_TEST_IAM_USER_SECRET_ACCESS_KEY` +* `REDSHIFT_TEST_IAM_ROLE_PROFILE` +* `DBT_TEST_USER_1` +* `DBT_TEST_USER_2` +* `DBT_TEST_USER_3` + +## 2. Run Tests + +Once `test.env` is configured, you can run tests using `hatch`: + +```shell +# run all integration tests +$ hatch run integration-tests + +# run tests for a specific module +$ hatch run integration-tests tests/functional/adapter/test_basic.py + +# run a specific test class +$ hatch run integration-tests tests/functional/adapter/test_basic.py::TestSimpleMaterializationsRedshift +``` diff --git a/dbt-snowflake/.changes/unreleased/Fixes-20251115-223846.yaml b/dbt-snowflake/.changes/unreleased/Fixes-20251115-223846.yaml new file mode 100644 index 000000000..f0c41ce6a --- /dev/null +++ b/dbt-snowflake/.changes/unreleased/Fixes-20251115-223846.yaml @@ -0,0 +1,6 @@ +kind: Fixes +body: Add integration test documentation to CONTRIBUTING.md +time: 2025-11-15T22:38:46.9746906+08:00 +custom: + Author: godhahn + Issue: "843" diff --git a/dbt-snowflake/CONTRIBUTING.md b/dbt-snowflake/CONTRIBUTING.md index 70e412257..a390ef919 100644 --- a/dbt-snowflake/CONTRIBUTING.md +++ b/dbt-snowflake/CONTRIBUTING.md @@ -2,3 +2,40 @@ This document covers the incremental content beyond what is contained in the repository's [CONTRIBUTING.md](/CONTRIBUTING.md). You are strongly encouraged to start there first if you are reading this for the first time. + +# Testing + +## 1. Configure Environment + +From the `dbt-snowflake` directory, run `hatch run setup` to create a `test.env` file. Populate this file with your Snowflake connection details. + +* `SNOWFLAKE_TEST_ACCOUNT` +* `SNOWFLAKE_TEST_ALT_DATABASE` +* `SNOWFLAKE_TEST_ALT_WAREHOUSE` +* `SNOWFLAKE_TEST_DATABASE` +* `SNOWFLAKE_TEST_OAUTH_CLIENT_ID` +* `SNOWFLAKE_TEST_OAUTH_CLIENT_SECRET` +* `SNOWFLAKE_TEST_OAUTH_REFRESH_TOKEN` +* `SNOWFLAKE_TEST_PASSWORD` +* `SNOWFLAKE_TEST_QUOTED_DATABASE` +* `SNOWFLAKE_TEST_USER` +* `SNOWFLAKE_TEST_WAREHOUSE` +* `SNOWFLAKE_TEST_CATALOG_LINKED_DATABASE` +* `DBT_TEST_USER_1` +* `DBT_TEST_USER_2` +* `DBT_TEST_USER_3` + +## 2. Run Tests + +Once `test.env` is configured, you can run tests using `hatch`: + +```shell +# run all integration tests +$ hatch run integration-tests + +# run tests for a specific module +$ hatch run integration-tests tests/functional/adapter/test_basic.py + +# run a specific test class +$ hatch run integration-tests tests/functional/adapter/test_basic.py::TestSimpleMaterializationsSnowflake +```