Enable `--resource-type` and `--exclude-resource-type` CLI flags and environment variables for `dbt test` #10706

dbeatty10 · 2024-09-12T21:10:58Z

Resolves #10656

Alternative to #10657

Problem

Currently, the resource type CLI flags and environment variables apply to the dbt build, dbt list and dbt clone subcommands ONLY -- they do not extend to dbt test.

We want to extend these to apply to the dbt test subcommand also.

Solution

Simplify by standardizing upon the ResourceTypeSelector which already provides the desired resource_types parameter.

This was accomplished by:

adding the resource_type and exclude_resource_type click args to the dbt test subcommand
adding a TEST_NODE_TYPES list of valid test types (data tests and unit tests)
👉 adding resource_types property to the TestTask (which uses TEST_NODE_TYPES) 👈 this was the crux!

Backstory

Branched from #10657 to try an alternative approach that resolves the issue via a refactor.

Did these PRs leading up to this one:

Code examples

dbt test now enables passing values like unit_tests, tests, etc. in the --resource-type / --exclude-resource-type CLI flags (or in the environment variables DBT_RESOURCE_TYPES / DBT_EXCLUDE_RESOURCE_TYPES).

Example 1 - CLI flags

dbt test --resource-type unit_test
dbt test --exclude-resource-type unit_test

Example 2 - environment variables

DBT_RESOURCE_TYPES=unit_test dbt test
DBT_EXCLUDE_RESOURCE_TYPES=unit_test dbt test

Documentation to update

At minimum (there may be other relevant pages):

https://docs.getdbt.com/reference/global-configs/resource-type

Checklist

I have read the contributing guide and understand what's expected of me.
I have run this code in development, and it appears to resolve the stated issue.
This PR includes tests, or tests are not required or relevant for this PR.
This PR has no interface changes (e.g., macros, CLI, logs, JSON artifacts, config files, adapter interface, etc.) or this PR has already received feedback and approval from Product or DX.
This PR includes type annotations for new and modified functions.

…uded_resource_types

… associated environment variables

codecov · 2024-09-12T21:14:05Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.96%. Comparing base (3308a43) to head (8186042).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #10706      +/-   ##
==========================================
- Coverage   88.97%   88.96%   -0.01%     
==========================================
  Files         181      181              
  Lines       22971    22979       +8     
==========================================
+ Hits        20438    20443       +5     
- Misses       2533     2536       +3

Flag	Coverage Δ
integration	`86.14% <100.00%> (-0.01%)`	⬇️
unit	`62.39% <72.72%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
Unit Tests	`62.39% <72.72%> (+<0.01%)`	⬆️
Integration Tests	`86.14% <100.00%> (-0.01%)`	⬇️

…ector"

.changes/unreleased/Features-20240903-132428.yaml

…est`

…elector` references later)

dbeatty10 · 2024-09-18T21:53:57Z

core/dbt/task/test.py

+    @property
+    def resource_types(self) -> List[NodeType]:
+        resource_types: Collection[NodeType] = resource_types_from_args(
+            self.args, set(TEST_NODE_TYPES), set(TEST_NODE_TYPES)
+        )
+
+        # filter out any non-test node types
+        resource_types = [rt for rt in resource_types if rt in TEST_NODE_TYPES]
+        return list(resource_types)
+


This is basically the same thing as here and here.

dbeatty10 · 2024-09-18T21:57:50Z

core/dbt/task/test.py

    def get_node_selector(self) -> ResourceTypeSelector:
        if self.manifest is None or self.graph is None:
            raise DbtInternalError("manifest and graph must be set to get perform node selection")
        return ResourceTypeSelector(
            graph=self.graph,
            manifest=self.manifest,
            previous_state=self.previous_state,
-            resource_types=[NodeType.Test, NodeType.Unit],
+            resource_types=self.resource_types,


Basically same thing as here and here.

…environment variables for `dbt test` (#10706) * Adding logic to TestSelector to remove unit tests if they are in excluded_resource_types * Adding change log * Respect `--resource-type` and `--exclude-resource-type` CLI flags and associated environment variables * Test CLI flag for excluding unit tests for the `dbt test` command * Satisy isort pre-commit hook * Fix mypy for positional argument "resource_types" in call to "TestSelector" * Replace `TestSelector` with `ResourceTypeSelector` * Add co-author * Update changelog description * Add functional tests for new feature * Compare the actual results, not just the count * Remove test case covered elsewhere * Test for `DBT_EXCLUDE_RESOURCE_TYPES` environment variable for `dbt test` * Update per pre-commit hook * Restore to original form (until we refactor extraneous `ResourceTypeSelector` references later) --------- Co-authored-by: Matthew Cooper <asimov.1st@gmail.com>

TowardOliver and others added 3 commits September 3, 2024 13:20

Adding logic to TestSelector to remove unit tests if they are in excl…

3e19e62

…uded_resource_types

Adding change log

4914cc9

Respect --resource-type and --exclude-resource-type CLI flags and…

9ab1c0d

… associated environment variables

cla-bot bot added the cla:yes label Sep 12, 2024

dbeatty10 added 4 commits September 12, 2024 15:17

Test CLI flag for excluding unit tests for the dbt test command

57fed01

Satisy isort pre-commit hook

7cf2e2e

Fix mypy for positional argument "resource_types" in call to "TestSel…

1d5d1dc

…ector"

Replace TestSelector with ResourceTypeSelector

bd74613

dbeatty10 marked this pull request as ready for review September 12, 2024 22:08

dbeatty10 requested a review from a team as a code owner September 12, 2024 22:08

TowardOliver mentioned this pull request Sep 13, 2024

Adding logic to TestSelector to remove unit tests if they are in excluded_resource_types #10657

Closed

5 tasks

dbeatty10 commented Sep 13, 2024

View reviewed changes

.changes/unreleased/Features-20240903-132428.yaml Outdated Show resolved Hide resolved

Add co-author

ed79666

dbeatty10 changed the title ~~Adding logic to TestSelector to remove unit tests if they are in excluded_resource_types~~ Enable --resource-type and --exclude-resource-type CLI flags and environment variables for dbt test Sep 13, 2024

dbeatty10 commented Sep 13, 2024

View reviewed changes

.changes/unreleased/Features-20240903-132428.yaml Outdated Show resolved Hide resolved

Update changelog description

f9f563b

dbeatty10 added the user docs [docs.getdbt.com] Needs better documentation label Sep 13, 2024

dbeatty10 mentioned this pull request Sep 16, 2024

Replace TestSelector with ResourceTypeSelector #10718

Merged

5 tasks

dbeatty10 marked this pull request as draft September 18, 2024 12:02

dbeatty10 added 7 commits September 18, 2024 14:29

Merge branch 'main' into dbeatty/fix-10656

c8e363e

Add functional tests for new feature

01ba1b6

Compare the actual results, not just the count

0c966e6

Remove test case covered elsewhere

3864740

Test for DBT_EXCLUDE_RESOURCE_TYPES environment variable for `dbt t…

0856e85

…est`

Update per pre-commit hook

4e7a3c3

Restore to original form (until we refactor extraneous `ResourceTypeS…

98249eb

…elector` references later)

dbeatty10 marked this pull request as ready for review September 18, 2024 21:48

dbeatty10 commented Sep 18, 2024

View reviewed changes

Merge branch 'main' into dbeatty/fix-10656

8186042

dbeatty10 requested a review from gshank September 19, 2024 20:00

gshank approved these changes Sep 19, 2024

View reviewed changes

dbeatty10 merged commit 9ca10fb into main Sep 19, 2024
61 of 62 checks passed

dbeatty10 deleted the dbeatty/fix-10656 branch September 19, 2024 22:53

dbeatty10 mentioned this pull request Sep 20, 2024

[Core] Enable --resource-type and --exclude-resource-type CLI flags and environment variables for dbt test dbt-labs/docs.getdbt.com#6101

Closed

dbeatty10 mentioned this pull request Sep 22, 2024

[Bug] Not able to select unit tests via the --resource-type flag #10267

Open

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable `--resource-type` and `--exclude-resource-type` CLI flags and environment variables for `dbt test` #10706

Enable `--resource-type` and `--exclude-resource-type` CLI flags and environment variables for `dbt test` #10706

dbeatty10 commented Sep 12, 2024 •

edited

Loading

codecov bot commented Sep 12, 2024 •

edited

Loading

dbeatty10 Sep 18, 2024

dbeatty10 Sep 18, 2024

Enable --resource-type and --exclude-resource-type CLI flags and environment variables for dbt test #10706

Enable --resource-type and --exclude-resource-type CLI flags and environment variables for dbt test #10706

Conversation

dbeatty10 commented Sep 12, 2024 • edited Loading

Problem

Solution

Backstory

Code examples

Example 1 - CLI flags

Example 2 - environment variables

Documentation to update

Checklist

codecov bot commented Sep 12, 2024 • edited Loading

Codecov Report

dbeatty10 Sep 18, 2024

Choose a reason for hiding this comment

dbeatty10 Sep 18, 2024

Choose a reason for hiding this comment

Enable `--resource-type` and `--exclude-resource-type` CLI flags and environment variables for `dbt test` #10706

Enable `--resource-type` and `--exclude-resource-type` CLI flags and environment variables for `dbt test` #10706

dbeatty10 commented Sep 12, 2024 •

edited

Loading

codecov bot commented Sep 12, 2024 •

edited

Loading