Skip to content
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

Support quoted parameter list for MultiOption cli options #8665

Merged
merged 16 commits into from
Sep 22, 2023
6 changes: 6 additions & 0 deletions .changes/unreleased/Features-20230918-150855.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
kind: Features
body: Support quoted parameter list for MultiOption CLI options.
time: 2023-09-18T15:08:55.625412-05:00
custom:
Author: emmyoop
Issue: "8598"
6 changes: 5 additions & 1 deletion core/dbt/cli/flags.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ def args_to_context(args: List[str]) -> Context:
from dbt.cli.main import cli

cli_ctx = cli.make_context(cli.name, args)
# Split args if they're a comma seperated string.
# Split args if they're a comma separated string.
if len(args) == 1 and "," in args[0]:
args = args[0].split(",")
sub_command_name, sub_command, args = cli.resolve_command(cli_ctx, args)
Expand Down Expand Up @@ -340,6 +340,10 @@ def add_fn(x):

spinal_cased = k.replace("_", "-")

# MultiOption flags come back as lists, but we want to pass them as space separated strings
if isinstance(v, list):
v = " ".join(v)

if k == "macro" and command == CliCommand.RUN_OPERATION:
add_fn(v)
# None is a Singleton, False is a Flyweight, only one instance of each.
Expand Down
2 changes: 1 addition & 1 deletion core/dbt/cli/options.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ def add_to_parser(self, parser, ctx):
def parser_process(value, state):
emmyoop marked this conversation as resolved.
Show resolved Hide resolved
# method to hook to the parser.process
done = False
value = [value]
value = str.split(value, " ")
if self.save_other_options:
# grab everything up to the next option
while state.rargs and not done:
Expand Down
105 changes: 105 additions & 0 deletions tests/functional/cli/test_multioption.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
import pytest
from dbt.tests.util import run_dbt


model_one_sql = """
select 1 as fun
"""

source_sql = """
sources:
- name: my_source
description: "My source"
schema: test_schema
tables:
- name: my_table
"""


class TestResourceType:
@pytest.fixture(scope="class")
def models(self):
return {"schema.yml": source_sql, "model_one.sql": model_one_sql}

def test_resource_type_single(self, project):
result = run_dbt(["-q", "ls", "--resource-types", "model"])
assert len(result) == 1
assert result == ["test.model_one"]

def test_resource_type_quoted(self, project):
result = run_dbt(["-q", "ls", "--resource-types", "model source"])
assert len(result) == 2
assert result == ["test.model_one", "source:test.my_source.my_table"]
emmyoop marked this conversation as resolved.
Show resolved Hide resolved

def test_resource_type_args(self, project):
result = run_dbt(["-q", "ls", "--resource-type", "model", "--resource-type", "source"])
assert len(result) == 2
assert result == ["test.model_one", "source:test.my_source.my_table"]


class TestOutputKeys:
@pytest.fixture(scope="class")
def models(self):
return {"model_one.sql": model_one_sql}

def test_output_key_single(self, project):
result = run_dbt(["-q", "ls", "--output", "json", "--output-keys", "name"])
assert len(result) == 1
assert result == ['{"name": "model_one"}']

def test_output_key_quoted(self, project):
result = run_dbt(["-q", "ls", "--output", "json", "--output-keys", "name resource_type"])

assert len(result) == 1
assert result == ['{"name": "model_one", "resource_type": "model"}']

def test_output_key_args(self, project):
result = run_dbt(
[
"-q",
"ls",
"--output",
"json",
"--output-keys",
"name",
"--output-keys",
"resource_type",
]
)

assert len(result) == 1
assert result == ['{"name": "model_one", "resource_type": "model"}']


class TestSelectExclude:
@pytest.fixture(scope="class")
def models(self):
return {
"model_one.sql": model_one_sql,
"model_two.sql": model_one_sql,
"model_three.sql": model_one_sql,
}

def test_select_exclude_single(self, project):
result = run_dbt(["-q", "ls", "--select", "model_one"])
assert len(result) == 1
assert result == ["test.model_one"]
result = run_dbt(["-q", "ls", "--exclude", "model_one"])
assert len(result) == 2
assert "test.model_one" not in result

def test_select_exclude_quoted(self, project):
result = run_dbt(["-q", "ls", "--select", "model_one model_two"])
assert len(result) == 2
assert "test.model_three" not in result
result = run_dbt(["-q", "ls", "--exclude", "model_one model_two"])
assert len(result) == 1
assert result == ["test.model_three"]

def test_select_exclude_args(self, project):
result = run_dbt(["-q", "ls", "--select", "model_one", "--select", "model_two"])
assert len(result) == 2
assert "test.model_three" not in result
result = run_dbt(["-q", "ls", "--exclude", "model_one", "--exclude", "model_two"])
assert len(result) == 1
assert result == ["test.model_three"]
13 changes: 13 additions & 0 deletions tests/functional/retry/fixtures.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,16 @@
{% do log("Timezone set to: " + timezone, info=True) %}
{% endmacro %}
"""

simple_model = """
select null as id
"""

simple_schema = """
models:
- name: some_model
columns:
- name: id
tests:
- not_null
"""
46 changes: 46 additions & 0 deletions tests/functional/retry/test_retry.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
schema_yml,
models__second_model,
macros__alter_timezone_sql,
simple_model,
simple_schema,
)


Expand Down Expand Up @@ -225,3 +227,47 @@ def test_fail_fast(self, project):

results = run_dbt(["retry"])
assert {r.node.unique_id: r.status for r in results.results} == {}


class TestRetryResourceType:
@pytest.fixture(scope="class")
def models(self):
return {
"null_model.sql": simple_model,
"schema.yml": simple_schema,
}

def test_resource_type(self, project):
# test multiple options in single string
results = run_dbt(["build", "--select", "null_model", "--resource-type", "test model"])
assert len(results) == 1

# nothing to do
results = run_dbt(["retry"])
assert len(results) == 0

# test multiple options in multiple args
results = run_dbt(
[
"build",
"--select",
"null_model",
"--resource-type",
"test",
"--resource-type",
"model",
]
)
assert len(results) == 1

# nothing to do
results = run_dbt(["retry"])
assert len(results) == 0

# test single all option
results = run_dbt(["build", "--select", "null_model", "--resource-type", "all"])
assert len(results) == 1

# nothing to do
results = run_dbt(["retry"])
assert len(results) == 0
2 changes: 1 addition & 1 deletion tests/unit/test_cli_flags.py
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ def test_from_dict__run(self):
}
result = self._create_flags_from_dict(Command.RUN, args_dict)
assert "model_one" in result.select[0]
assert "model_two" in result.select[0]
assert "model_two" in result.select[1]

def test_from_dict__build(self):
args_dict = {
Expand Down