Skip to main content

The set of reusable tests and test fixtures used to test common functionality

Project description

dbt logo

dbt-tests-adapter

For context and guidance on using this package, please read: "Testing a new adapter"

What is it?

This package includes reusable test cases that reinforce behaviors common to all or many adapter plugins. There are two categories of tests:

  1. Basic tests that every adapter plugin is expected to pass. These are defined in tests.adapter.basic. Given differences across data platforms, these may require slight modification or reimplementation. Significantly overriding or disabling these tests should be with good reason, since each represents basic functionality expected by dbt users. For example, if your adapter does not support incremental models, you should disable the test, by marking it with skip or xfail, as well as noting that limitation in any documentation, READMEs, and usage guides that accompany your adapter.

  2. Optional tests, for second-order functionality that is common across plugins, but not required for basic use. Your plugin can opt into these test cases by inheriting existing ones, or reimplementing them with adjustments. For now, this category includes all tests located outside the basic subdirectory. More tests will be added as we convert older tests defined on dbt-core and mature plugins to use the standard framework.

How to use it?

Each test case in this repo is packaged as a class, prefixed Base. To enable a test case to run with your adapter plugin, you should inherit the base class into a new class, prefixed Test. That test class will be discovered and run by pytest. It can also makes modifications if needed.

class TestSimpleMaterializations(BaseSimpleMaterializations):
    pass

Distribution

To install:

pip install dbt-tests-adapter

This package is versioned in lockstep with dbt-core, and the same versioning guidelines apply:

  • New "basic" test cases MAY be added in minor versions ONLY. They may not be included in patch releases.
  • Breaking changes to existing test cases MAY be included and communicated as part of minor version upgrades ONLY. They MAY NOT be included in patch releases. We will aim to avoid these whenever possible.
  • New "optional" test cases, and non-breaking fixes to existing test cases, MAY be added in minor or patch versions.

Assuming you adapter plugin is pinned to a specific minor version of dbt-core (e.g. ~=1.1.0), you can use the same pin for dbt-tests-adapter.

Note: This is packaged as a plugin using a python namespace package. It cannot have an __init__.py file in the part of the hierarchy to which it needs to be attached.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dbt_tests_adapter-1.16.0.tar.gz (164.7 kB view details)

Uploaded Source

Built Distribution

dbt_tests_adapter-1.16.0-py3-none-any.whl (235.8 kB view details)

Uploaded Python 3

File details

Details for the file dbt_tests_adapter-1.16.0.tar.gz.

File metadata

  • Download URL: dbt_tests_adapter-1.16.0.tar.gz
  • Upload date:
  • Size: 164.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for dbt_tests_adapter-1.16.0.tar.gz
Algorithm Hash digest
SHA256 6f1192464fd2609ef3f43f5c8c3b96a010a2c83f2779b65d61f70749a75dc4c4
MD5 46bf36edf55175d9704296cf940d52b1
BLAKE2b-256 3d0b517deba3b82d9ea3568945d77edb759f9b6de3da2967fa7aa082000d222f

See more details on using hashes here.

Provenance

The following attestation bundles were made for dbt_tests_adapter-1.16.0.tar.gz:

Publisher: publish-oss.yml on dbt-labs/dbt-adapters

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dbt_tests_adapter-1.16.0-py3-none-any.whl.

File metadata

File hashes

Hashes for dbt_tests_adapter-1.16.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d6322547069c811f3c843fbcfce01a50a116578fcd5e1187bd8da81a00524e98
MD5 1ec5737f27fd9b23375cbc65122335e2
BLAKE2b-256 8d007d9e420f2210ef1a32662ced228db43d0f2bf16be655a643d33a3c01108d

See more details on using hashes here.

Provenance

The following attestation bundles were made for dbt_tests_adapter-1.16.0-py3-none-any.whl:

Publisher: publish-oss.yml on dbt-labs/dbt-adapters

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page