snowflake-cli 3.13.0__tar.gz → 3.13.1__tar.gz

{snowflake_cli-3.13.0 → snowflake_cli-3.13.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: snowflake-cli
-Version: 3.13.0
+Version: 3.13.1
 Summary: Snowflake CLI
 Project-URL: Source code, https://github.com/snowflakedb/snowflake-cli
 Project-URL: Bug Tracker, https://github.com/snowflakedb/snowflake-cli/issues

{snowflake_cli-3.13.0 → snowflake_cli-3.13.1}/RELEASE-NOTES.md

@@ -23,6 +23,17 @@
 ## Fixes and improvements
 
 
+# v3.13.1
+## Backward incompatibility
+
+## Deprecations
+
+## New additions
+
+## Fixes and improvements
+* Fixed parsing of --vars provided to `snow dbt execute` subcommands. This allows to pass variables in the same way as to dbt cli, i.e. --vars '{"key": "value"}'
+
+
 # v3.13.0
 
 ## Deprecations

{snowflake_cli-3.13.0 → snowflake_cli-3.13.1}/src/snowflake/cli/__about__.py

@@ -16,7 +16,7 @@ from __future__ import annotations
 
 from enum import Enum, unique
 
-VERSION = "3.13.0"
+VERSION = "3.13.1"
 
 
 @unique

{snowflake_cli-3.13.0 → snowflake_cli-3.13.1}/src/snowflake/cli/_plugins/dbt/manager.py

@@ -382,6 +382,30 @@ class DBTManager(SqlExecutionMixin):
         self, dbt_command: str, name: FQN, run_async: bool, *dbt_cli_args
     ) -> SnowflakeCursor:
         if dbt_cli_args:
-            dbt_command = " ".join([dbt_command, *dbt_cli_args]).strip()
-        query = f"EXECUTE DBT PROJECT {name} args='{dbt_command}'"
+            processed_args = self._process_dbt_args(dbt_cli_args)
+            dbt_command = f"{dbt_command} {processed_args}".strip()
+        dbt_command_escaped = dbt_command.replace("'", "\\'")
+        query = f"EXECUTE DBT PROJECT {name} args='{dbt_command_escaped}'"
         return self.execute_query(query, _exec_async=run_async)
+
+    @staticmethod
+    def _process_dbt_args(dbt_cli_args: tuple) -> str:
+        """
+        Process dbt CLI arguments, handling special cases like --vars flag.
+        """
+        if not dbt_cli_args:
+            return ""
+
+        processed_args = []
+        i = 0
+        while i < len(dbt_cli_args):
+            arg = dbt_cli_args[i]
+            if arg == "--vars" and i + 1 < len(dbt_cli_args):
+                vars_value = dbt_cli_args[i + 1]
+                processed_args.append("--vars")
+                processed_args.append(f"'{vars_value}'")
+                i += 2
+            else:
+                processed_args.append(arg)
+                i += 1
+        return " ".join(processed_args)

{snowflake_cli-3.13.0 → snowflake_cli-3.13.1}/tests/dbt/test_dbt_commands.py

@@ -356,7 +356,7 @@ class TestDBTExecute:
             ),
             pytest.param(
                 ["dbt", "execute", "pipeline_name", "compile", "--vars '{foo:bar}'"],
-                "EXECUTE DBT PROJECT pipeline_name args='compile --vars '{foo:bar}''",
+                "EXECUTE DBT PROJECT pipeline_name args='compile --vars \\'{foo:bar}\\''",
                 id="with-dbt-vars",
             ),
             pytest.param(
@@ -396,6 +396,80 @@ class TestDBTExecute:
                 "EXECUTE DBT PROJECT database.schema.pipeline_name args='run'",
                 id="with-fqn",
             ),
+            pytest.param(
+                [
+                    "dbt",
+                    "execute",
+                    "pipeline_name",
+                    "run",
+                    "--vars",
+                    '{"key": "value"}',
+                ],
+                "EXECUTE DBT PROJECT pipeline_name args='run --vars \\'{\"key\": \"value\"}\\''",
+                id="vars-json-format",
+            ),
+            pytest.param(
+                [
+                    "dbt",
+                    "execute",
+                    "pipeline_name",
+                    "run",
+                    "--vars",
+                    '{"key": "value", "date": 20180101}',
+                ],
+                'EXECUTE DBT PROJECT pipeline_name args=\'run --vars \\\'{"key": "value", "date": 20180101}\\\'\'',
+                id="vars-json-multiple-keys",
+            ),
+            pytest.param(
+                [
+                    "dbt",
+                    "execute",
+                    "pipeline_name",
+                    "run",
+                    "--vars",
+                    "{key: value, date: 20180101}",
+                ],
+                "EXECUTE DBT PROJECT pipeline_name args='run --vars \\'{key: value, date: 20180101}\\''",
+                id="vars-yaml-format",
+            ),
+            pytest.param(
+                [
+                    "dbt",
+                    "execute",
+                    "pipeline_name",
+                    "run",
+                    "--vars",
+                    "key: value",
+                ],
+                "EXECUTE DBT PROJECT pipeline_name args='run --vars \\'key: value\\''",
+                id="vars-single-key-value",
+            ),
+            pytest.param(
+                [
+                    "dbt",
+                    "execute",
+                    "pipeline_name",
+                    "run",
+                    "--vars",
+                    "{foo: foobar}",
+                ],
+                "EXECUTE DBT PROJECT pipeline_name args='run --vars \\'{foo: foobar}\\''",
+                id="vars-yaml-with-braces",
+            ),
+            pytest.param(
+                [
+                    "dbt",
+                    "execute",
+                    "pipeline_name",
+                    "run",
+                    "--vars",
+                    "start_date: 2016-06-01",
+                    "--select",
+                    "my_model",
+                ],
+                "EXECUTE DBT PROJECT pipeline_name args='run --vars \\'start_date: 2016-06-01\\' --select my_model'",
+                id="vars-with-other-flags",
+            ),
         ],
     )
     def test_dbt_execute(self, mock_connect, mock_cursor, runner, args, expected_query):

snowflake_cli-3.13.1/tests_integration/test_data/projects/dbt_project_with_variables/dbt_project.yml

@@ -0,0 +1,24 @@
+name: 'dbt_integration_project'
+version: '1.0.0'
+
+profile: 'dbt_integration_project'
+
+model-paths: ["models"]
+analysis-paths: ["analyses"]
+test-paths: ["tests"]
+seed-paths: ["seeds"]
+macro-paths: ["macros"]
+snapshot-paths: ["snapshots"]
+
+vars:
+  env: "default"
+  user: "default"
+
+clean-targets:
+  - "target"
+  - "dbt_packages"
+
+models:
+  dbt_integration_project:
+    example:
+      +materialized: view

snowflake_cli-3.13.1/tests_integration/test_data/projects/dbt_project_with_variables/models/example/my_first_dbt_model.sql

@@ -0,0 +1,11 @@
+{{ config(materialized='table') }}
+
+with source_data as (
+    select 1 as id
+    union all
+    select null as id
+)
+
+select *
+from source_data
+where id is not null

snowflake_cli-3.13.1/tests_integration/test_data/projects/dbt_project_with_variables/models/example/my_second_dbt_model.sql

@@ -0,0 +1,3 @@
+select *, '{{ var("env") }}' as env_tmpl, '{{ var("user") }}' as user_tmpl
+from {{ ref('my_first_dbt_model') }}
+where id = 1

snowflake_cli-3.13.1/tests_integration/test_data/projects/dbt_project_with_variables/models/example/schema.yml

@@ -0,0 +1,21 @@
+
+version: 2
+
+models:
+  - name: my_first_dbt_model
+    description: "A starter dbt model"
+    columns:
+      - name: id
+        description: "The primary key for this table"
+        data_tests:
+          - unique
+          - not_null
+
+  - name: my_second_dbt_model
+    description: "A starter dbt model"
+    columns:
+      - name: id
+        description: "The primary key for this table"
+        data_tests:
+          - unique
+          - not_null

snowflake_cli-3.13.1/tests_integration/test_data/projects/dbt_project_with_variables/profiles.yml

@@ -0,0 +1,5 @@
+dbt_integration_project:
+  target: dev
+  outputs: 
+    dev:
+      threads: 2

{snowflake_cli-3.13.0 → snowflake_cli-3.13.1}/tests_integration/test_dbt.py

@@ -300,7 +300,6 @@ def test_dbt_deploy_options(
 
 
 @pytest.mark.integration
-@pytest.mark.qa_only
 def test_deploy_with_default_target(
     runner,
     snowflake_session,
@@ -342,7 +341,6 @@ def test_deploy_with_default_target(
 
 
 @pytest.mark.integration
-@pytest.mark.qa_only
 def test_execute_with_target(
     runner,
     snowflake_session,
@@ -496,7 +494,6 @@ def test_dbt_deploy_with_external_access_integrations(
 
 
 @pytest.mark.integration
-@pytest.mark.qa_only
 def test_deploy_project_with_local_deps(
     runner,
     snowflake_session,
@@ -542,3 +539,81 @@ def test_deploy_project_with_local_deps(
         assert all(
             map(lambda x: x["UPPERCASE_NAME"].isupper(), result.json)
         ), result.json
+
+
+@pytest.mark.integration
+def test_execute_with_variables(
+    runner,
+    snowflake_session,
+    test_database,
+    project_directory,
+):
+    with project_directory("dbt_project_with_variables") as root_dir:
+        # Given a local dbt project
+        ts = int(datetime.datetime.now().timestamp())
+        name = f"dbt_project_{ts}"
+
+        # deploy for the first time
+        _setup_dbt_profile(root_dir, snowflake_session)
+        result = runner.invoke_with_connection_json(["dbt", "deploy", name])
+        assert result.exit_code == 0, result.output
+
+        # 1. run and provide one variable with simplified syntax.
+        # The other variable should default to the value from dbt_project.yml
+        result = runner.invoke_passthrough_with_connection(
+            args=[
+                "dbt",
+                "execute",
+            ],
+            passthrough_args=[name, "run", "--vars", "env: local"],
+        )
+
+        assert result.exit_code == 0, result.output
+
+        result = runner.invoke_with_connection_json(
+            ["sql", "-q", "select env_tmpl, user_tmpl from my_second_dbt_model;"]
+        )
+        assert len(result.json) == 1, result.json
+        assert result.json[0]["ENV_TMPL"] == "local", result.json[0]
+        assert result.json[0]["USER_TMPL"] == "default", result.json[0]
+
+        # 2. run and provide both variables without double quotes
+        result = runner.invoke_passthrough_with_connection(
+            args=[
+                "dbt",
+                "execute",
+            ],
+            passthrough_args=[name, "run", "--vars", "{env: stage, user: stage_user}"],
+        )
+
+        assert result.exit_code == 0, result.output
+
+        result = runner.invoke_with_connection_json(
+            ["sql", "-q", "select env_tmpl, user_tmpl from my_second_dbt_model;"]
+        )
+        assert len(result.json) == 1, result.json
+        assert result.json[0]["ENV_TMPL"] == "stage", result.json[0]
+        assert result.json[0]["USER_TMPL"] == "stage_user", result.json[0]
+
+        # 3. run and provide both variables wrapped with double quotes
+        result = runner.invoke_passthrough_with_connection(
+            args=[
+                "dbt",
+                "execute",
+            ],
+            passthrough_args=[
+                name,
+                "run",
+                "--vars",
+                '{"env": "prod", "user": "prod_user"}',
+            ],
+        )
+
+        assert result.exit_code == 0, result.output
+
+        result = runner.invoke_with_connection_json(
+            ["sql", "-q", "select env_tmpl, user_tmpl from my_second_dbt_model;"]
+        )
+        assert len(result.json) == 1, result.json
+        assert result.json[0]["ENV_TMPL"] == "prod", result.json[0]
+        assert result.json[0]["USER_TMPL"] == "prod_user", result.json[0]