-
Notifications
You must be signed in to change notification settings - Fork 1.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Set Flags from UserConfig #6266
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
9e9bb11
prototype: prefer user_config to default in Flags
MichelleArk 302b81a
test flags with user config
MichelleArk e50cf4f
test env var preferred to user config
MichelleArk 9354016
changelog entry
MichelleArk 8e245ba
test_cli_group_flags_from_params
MichelleArk 81af2ee
flags.WHICH from invoked_subcommand if available
MichelleArk File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
kind: Features | ||
body: Click CLI Flags work with UserConfig | ||
time: 2022-11-29T18:32:39.068035-05:00 | ||
custom: | ||
Author: michelleark | ||
Issue: "6327" | ||
PR: "6266" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
import pytest | ||
|
||
import click | ||
from multiprocessing import get_context | ||
from typing import List | ||
|
||
from dbt.cli.main import cli | ||
from dbt.contracts.project import UserConfig | ||
from dbt.cli.flags import Flags | ||
|
||
|
||
class TestFlags: | ||
def make_dbt_context(self, context_name: str, args: List[str]) -> click.Context: | ||
ctx = cli.make_context(context_name, args) | ||
return ctx | ||
|
||
@pytest.fixture(scope="class") | ||
def run_context(self) -> click.Context: | ||
return self.make_dbt_context("run", ["run"]) | ||
|
||
def test_which(self, run_context): | ||
flags = Flags(run_context) | ||
assert flags.WHICH == "run" | ||
|
||
def test_mp_context(self, run_context): | ||
flags = Flags(run_context) | ||
assert flags.MP_CONTEXT == get_context("spawn") | ||
|
||
@pytest.mark.parametrize('param', cli.params) | ||
def test_cli_group_flags_from_params(self, run_context, param): | ||
flags = Flags(run_context) | ||
assert hasattr(flags, param.name.upper()) | ||
assert getattr(flags, param.name.upper()) == run_context.params[param.name.lower()] | ||
|
||
@pytest.mark.parametrize('do_not_track,expected_anonymous_usage_stats', [ | ||
("1", False), | ||
("t", False), | ||
("true", False), | ||
("y", False), | ||
("yes", False), | ||
("false", True), | ||
("anything", True), | ||
("2", True), | ||
]) | ||
def test_anonymous_usage_state(self, monkeypatch, run_context, do_not_track, expected_anonymous_usage_stats): | ||
monkeypatch.setenv("DO_NOT_TRACK", do_not_track) | ||
|
||
flags = Flags(run_context) | ||
assert flags.ANONYMOUS_USAGE_STATS == expected_anonymous_usage_stats | ||
|
||
def test_empty_user_config_uses_default(self, run_context): | ||
user_config = UserConfig() | ||
|
||
flags = Flags(run_context, user_config) | ||
assert flags.USE_COLORS == run_context.params['use_colors'] | ||
|
||
def test_none_user_config_uses_default(self, run_context): | ||
flags = Flags(run_context, None) | ||
assert flags.USE_COLORS == run_context.params['use_colors'] | ||
|
||
def test_prefer_user_config_to_default(self, run_context): | ||
user_config = UserConfig(use_colors=False) | ||
# ensure default value is not the same as user config | ||
assert run_context.params['use_colors'] is not user_config.use_colors | ||
|
||
flags = Flags(run_context, user_config) | ||
assert flags.USE_COLORS == user_config.use_colors | ||
|
||
def test_prefer_param_value_to_user_config(self): | ||
user_config = UserConfig(use_colors=False) | ||
context = self.make_dbt_context("run", ["--use-colors", "True", "run"]) | ||
|
||
flags = Flags(context, user_config) | ||
assert flags.USE_COLORS | ||
|
||
def test_prefer_env_to_user_config(self, monkeypatch): | ||
user_config = UserConfig(use_colors=False) | ||
monkeypatch.setenv("DBT_USE_COLORS", "True") | ||
context = self.make_dbt_context("run", ["run"]) | ||
|
||
flags = Flags(context, user_config) | ||
assert flags.USE_COLORS |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch! env vars != ints. Ever.