Use profile specified in --profile with dbt init

.changes/unreleased/Fixes-20230424-161642.yaml

@@ -0,0 +1,7 @@
+kind: Fixes
+body: If --profile specified with dbt-init, create the project with the specified
+ profile
+time: 2023-04-24T16:16:42.994547-04:00
+custom:
+ Author: ezraerb
+ Issue: "6154"

core/dbt/task/init.py

@@ -3,13 +3,15 @@
 from pathlib import Path
 import re
 import shutil
+import sys
 from typing import Optional
 
 import yaml
 import click
 
 import dbt.config
 import dbt.clients.system
+from dbt.config.profile import read_profile
 from dbt.flags import get_flags
 from dbt.version import _get_adapter_plugin_names
 from dbt.adapters.factory import load_plugin, get_include_paths
@@ -247,11 +249,11 @@ def get_valid_project_name(self) -> str:
 
  return name
 
- def create_new_project(self, project_name: str):
+ def create_new_project(self, project_name: str, profile_name: str):
  self.copy_starter_repo(project_name)
  os.chdir(project_name)
  with open("dbt_project.yml", "r") as f:
- content = f"{f.read()}".format(project_name=project_name, profile_name=project_name)
+ content = f"{f.read()}".format(project_name=project_name, profile_name=profile_name)
  with open("dbt_project.yml", "w") as f:
  f.write(content)
  fire_event(
@@ -274,9 +276,18 @@ def run(self):
  in_project = False
 
  if in_project:
+ # If --profile was specified, it means use an existing profile, which is not
+ # applicable to this case
+ if getattr(get_flags(), "PROFILE", None):
+ print(
+ "Can not init existing project with specified profile, edit dbt_project.yml instead"
+ )
+ sys.exit(1)
+
  # When dbt init is run inside an existing project,
  # just setup the user's profile.
  profile_name = self.get_profile_name_from_current_project()
+ profile_specified = False
  else:
  # When dbt init is run outside of an existing project,
  # create a new project and set up the user's profile.
@@ -285,11 +296,25 @@ def run(self):
  if project_path.exists():
  fire_event(ProjectNameAlreadyExists(name=project_name))
  return
- self.create_new_project(project_name)
- profile_name = project_name
 
- # Ask for adapter only if skip_profile_setup flag is not provided.
- if not self.args.skip_profile_setup:
+ # If the user specified an existing profile to use, use it instead of generating a new one
+ user_profile_name = getattr(get_flags(), "PROFILE", None)
+ if user_profile_name:
+ # Verify it exists. Can't use the regular profile validation routine because it assumes
+ # the project file exists
+ raw_profiles = read_profile(profiles_dir)
+ if user_profile_name not in raw_profiles:
+ print("Could not find profile named '{}'".format(user_profile_name))
+ sys.exit(1)
+ profile_name = user_profile_name
+ profile_specified = True
+ else:
+ profile_name = project_name
+ profile_specified = False
+ self.create_new_project(project_name, profile_name)
+
+ # Ask for adapter only if skip_profile_setup flag is not provided and no profile to use was specified.
+ if not self.args.skip_profile_setup and not profile_specified:
  fire_event(SettingUpProfile())
  if not self.check_if_can_write_profile(profile_name=profile_name):
  return

tests/functional/init/test_init.py

@@ -1,5 +1,6 @@
 import click
 import os
+import yaml
 import pytest
 from pathlib import Path
 from unittest import mock
@@ -84,6 +85,12 @@ def test_init_task_in_project_with_existing_profiles_yml(
 """
  )
 
+ def test_init_task_in_project_specifying_profile_errors(self):
+ # This triggers a call to sys.exit(), requring the following to test it
+ with pytest.raises(SystemExit) as error:
+ run_dbt(["init", "--profile", "test"])
+ assert error.value.code == 1
+
 
 class TestInitProjectWithoutExistingProfilesYml:
  @mock.patch("dbt.task.init._get_adapter_plugin_names")
@@ -159,6 +166,21 @@ def exists_side_effect(path):
 """
  )
 
+ @mock.patch.object(Path, "exists", autospec=True)
+ def test_init_task_in_project_without_profile_yml_specifying_profile_errors(self, exists):
+ def exists_side_effect(path):
+ # Override responses on specific files, default to 'real world' if not overriden
+ return {"profiles.yml": False}.get(path.name, os.path.exists(path))
+
+ exists.side_effect = exists_side_effect
+
+ # Even through no profiles.yml file exists, the init will not modify project.yml,
+ # so this errors
+ # This triggers a call to sys.exit(), requring the following to test it
+ with pytest.raises(SystemExit) as error:
+ run_dbt(["init", "--profile", "test"])
+ assert error.value.code == 1
+
 
 class TestInitProjectWithoutExistingProfilesYmlOrTemplate:
  @mock.patch("dbt.task.init._get_adapter_plugin_names")
@@ -708,3 +730,130 @@ def test_init_inside_project_and_skip_profile_setup(
  # skip interactive profile setup
  run_dbt(["init", "--skip-profile-setup"])
  assert len(manager.mock_calls) == 0
+
+
+class TestInitOutsideOfProjectWithSpecifiedProfile(TestInitOutsideOfProjectBase):
+ @mock.patch("dbt.task.init._get_adapter_plugin_names")
+ @mock.patch("click.prompt")
+ def test_init_task_outside_of_project_with_specified_profile(
+ self, mock_prompt, mock_get_adapter, project, project_name, unique_schema, dbt_profile_data
+ ):
+ manager = Mock()
+ manager.attach_mock(mock_prompt, "prompt")
+ manager.prompt.side_effect = [
+ project_name,
+ ]
+ mock_get_adapter.return_value = [project.adapter.type()]
+ run_dbt(["init", "--profile", "test"])
+
+ manager.assert_has_calls(
+ [
+ call.prompt("Enter a name for your project (letters, digits, underscore)"),
+ ]
+ )
+
+ # profiles.yml is NOT overwritten, so assert that the text matches that of the
+ # original fixture
+ with open(os.path.join(project.profiles_dir, "profiles.yml"), "r") as f:
+ assert f.read() == yaml.safe_dump(dbt_profile_data)
+
+ with open(os.path.join(project.project_root, project_name, "dbt_project.yml"), "r") as f:
+ assert (
+ f.read()
+ == f"""
+# Name your project! Project names should contain only lowercase characters
+# and underscores. A good package name should reflect your organization's
+# name or the intended use of these models
+name: '{project_name}'
+version: '1.0.0'
+config-version: 2
+
+# This setting configures which "profile" dbt uses for this project.
+profile: 'test'
+
+# These configurations specify where dbt should look for different types of files.
+# The `model-paths` config, for example, states that models in this project can be
+# found in the "models/" directory. You probably won't need to change these!
+model-paths: ["models"]
+analysis-paths: ["analyses"]
+test-paths: ["tests"]
+seed-paths: ["seeds"]
+macro-paths: ["macros"]
+snapshot-paths: ["snapshots"]
+
+clean-targets: # directories to be removed by `dbt clean`
+ - "target"
+ - "dbt_packages"
+
+
+# Configuring models
+# Full documentation: https://docs.getdbt.com/docs/configuring-models
+
+# In this example config, we tell dbt to build all models in the example/
+# directory as views. These settings can be overridden in the individual model
+# files using the `{{{{ config(...) }}}}` macro.
+models:
+ {project_name}:
+ # Config indicated by + and applies to all files under models/example/
+ example:
+ +materialized: view
+"""
+ )
+
+
+class TestInitOutsideOfProjectSpecifyingInvalidProfile(TestInitOutsideOfProjectBase):
+ @mock.patch("dbt.task.init._get_adapter_plugin_names")
+ @mock.patch("click.prompt")
+ def test_init_task_outside_project_specifying_invalid_profile_errors(
+ self, mock_prompt, mock_get_adapter, project, project_name
+ ):
+ manager = Mock()
+ manager.attach_mock(mock_prompt, "prompt")
+ manager.prompt.side_effect = [
+ project_name,
+ ]
+ mock_get_adapter.return_value = [project.adapter.type()]
+
+ # This triggers a call to sys.exit(), requring the following to test it
+ with pytest.raises(SystemExit) as error:
+ run_dbt(["init", "--profile", "invalid"])
+ assert error.value.code == 1
+
+ manager.assert_has_calls(
+ [
+ call.prompt("Enter a name for your project (letters, digits, underscore)"),
+ ]
+ )
+
+
+class TestInitOutsideOfProjectSpecifyingProfileNoProfilesYml(TestInitOutsideOfProjectBase):
+ @mock.patch("dbt.task.init._get_adapter_plugin_names")
+ @mock.patch("click.prompt")
+ def test_init_task_outside_project_specifying_profile_no_profiles_yml_errors(
+ self, mock_prompt, mock_get_adapter, project, project_name
+ ):
+ manager = Mock()
+ manager.attach_mock(mock_prompt, "prompt")
+ manager.prompt.side_effect = [
+ project_name,
+ ]
+ mock_get_adapter.return_value = [project.adapter.type()]
+
+ # Override responses on specific files, default to 'real world' if not overriden
+ original_isfile = os.path.isfile
+ with mock.patch(
+ "os.path.isfile",
+ new=lambda path: {"profiles.yml": False}.get(
+ os.path.basename(path), original_isfile(path)
+ ),
+ ):
+ # This triggers a call to sys.exit(), requring the following to test it
+ with pytest.raises(SystemExit) as error:
+ run_dbt(["init", "--profile", "test"])
+ assert error.value.code == 1
+
+ manager.assert_has_calls(
+ [
+ call.prompt("Enter a name for your project (letters, digits, underscore)"),
+ ]
+ )