✨ restructure deps command with package-lock.yml

.changes/unreleased/Features-20230125-165933.yaml

@@ -0,0 +1,6 @@
+kind: Features
+body: add log file of installed packages via dbt deps
+time: 2023-01-25T16:59:33.786304-05:00
+custom:
+  Author: jusbaldw
+  Issue: "6643"

core/dbt/cli/main.py

@@ -8,7 +8,7 @@
 from dbt.contracts.graph.manifest import Manifest
 from dbt.task.clean import CleanTask
 from dbt.task.compile import CompileTask
-from dbt.task.deps import DepsTask
+from dbt.task.deps import AddTask, DepsTask, LockTask
 from dbt.task.debug import DebugTask
 from dbt.task.run import RunTask
 from dbt.task.serve import ServeTask
@@ -289,7 +289,13 @@ def debug(ctx, **kwargs):
 
 
 # dbt deps
-@cli.command("deps")
+@cli.group()
+@click.pass_context
+def deps(ctx, **kwargs):
+    """Pull the most recent version of the dependencies listed in packages.yml"""
+
+
+@deps.command("install")
 @click.pass_context
 @p.profile
 @p.profiles_dir
@@ -299,14 +305,56 @@ def debug(ctx, **kwargs):
 @requires.preflight
 @requires.unset_profile
 @requires.project
-def deps(ctx, **kwargs):
-    """Pull the most recent version of the dependencies listed in packages.yml"""
+def deps_install(ctx, **kwargs):
+    """Install the most recent version of the dependencies listed in packages.yml"""
     task = DepsTask(ctx.obj["flags"], ctx.obj["project"])
     results = task.run()
     success = task.interpret_results(results)
     return results, success
 
 
+# dbt deps lock
+@deps.command("lock")
+@click.pass_context
+@p.profile
+@p.profiles_dir
+@p.project_dir
+@p.target
+@p.vars
+@requires.preflight
+@requires.unset_profile
+@requires.project
+def deps_lock(ctx, **kwargs):
+    """Pull the most recent version of the dependencies listed in packages.yml into package-lock.yml file"""
+    task = LockTask(ctx.obj["flags"], ctx.obj["project"])
+    results = task.run()
+    success = task.interpret_results(results)
+    return results, success
+
+
+# dbt deps add
+@deps.command("add")
+@click.pass_context
+@p.profile
+@p.profiles_dir
+@p.project_dir
+@p.target
+@p.vars
+@p.package
+@p.package_version
+@p.source
+@p.dry_run
+@requires.preflight
+@requires.unset_profile
+@requires.project
+def deps_add(ctx, **kwargs):
+    """Add a new package to the packages.yml file"""
+    task = AddTask(ctx.obj["flags"], ctx.obj["project"])
+    results = task.run()
+    success = task.interpret_results(results)
+    return results, success
+
+
 # dbt init
 @cli.command("init")
 @click.pass_context

core/dbt/cli/params.py

@@ -72,6 +72,14 @@
     help="If set, defer to the state variable for resolving unselected nodes.",
 )
 
+dry_run = click.option(
+    "--dry-run",
+    envvar=None,
+    help="Option to run `dbt deps add` without updating package-lock.yml file.",
+    default=False,
+    type=click.BOOL,
+)
+
 enable_legacy_logger = click.option(
     "--enable-legacy-logger/--no-enable-legacy-logger",
     envvar="DBT_ENABLE_LEGACY_LOGGER",
@@ -160,6 +168,14 @@
     default=PurePath.joinpath(Path.cwd(), "target/sources.json"),
 )
 
+package = click.option(
+    "--package", envvar=None, help="Name of package to add to packages.yml.", type=click.STRING
+)
+
+package_version = click.option(
+    "--version", envvar=None, help="Version of the package to install.", type=click.STRING
+)
+
 parse_only = click.option(
     "--parse-only",
     envvar=None,
@@ -312,6 +328,14 @@
     "--skip-profile-setup", "-s", envvar=None, help="Skip interactive profile setup.", is_flag=True
 )
 
+source = click.option(
+    "--source",
+    envvar=None,
+    help="Source to download page from, must be one of hub, git, or local. Defaults to hub.",
+    type=click.Choice(["hub", "git", "local"], case_sensitive=True),
+    default="hub",
+)
+
 # TODO:  The env var and name (reflected in flags) are corrections!
 # The original name was `ARTIFACT_STATE_PATH` and used the env var `DBT_ARTIFACT_STATE_PATH`.
 # Both of which break existing naming conventions.

core/dbt/config/project.py

@@ -94,13 +94,14 @@ def _load_yaml(path):
     return load_yaml_text(contents)
 
 
-def package_data_from_root(project_root):
-    package_filepath = resolve_path_from_base("packages.yml", project_root)
+def package_data_from_root(project_root, package_file_name="packages.yml"):
+    package_filepath = resolve_path_from_base(package_file_name, project_root)
 
     if path_exists(package_filepath):
         packages_dict = _load_yaml(package_filepath)
     else:
         packages_dict = None
+
     return packages_dict
 
 
@@ -502,6 +503,7 @@ def from_project_root(
         project_root = os.path.normpath(project_root)
         project_dict = load_raw_project(project_root)
         config_version = project_dict.get("config-version", 1)
+
         if config_version != 2:
             raise DbtProjectError(
                 f"Invalid config version: {config_version}, expected 2",
@@ -510,6 +512,7 @@ def from_project_root(
 
         packages_dict = package_data_from_root(project_root)
         selectors_dict = selector_data_from_root(project_root)
+
         return cls.from_dicts(
             project_root=project_root,
             project_dict=project_dict,

core/dbt/deps/resolver.py

@@ -135,3 +135,15 @@ def resolve_packages(
     resolved = final.resolved()
     _check_for_duplicate_project_names(resolved, project, renderer)
     return resolved
+
+
+def resolve_lock_packages(packages: List[PackageContract]) -> List[PinnedPackage]:
+    lock_packages = PackageListing.from_contracts(packages)
+    final = PackageListing()
+
+    for package in lock_packages:
+        final.incorporate(package)
+
+    resolved = final.resolved()
+
+    return resolved

core/dbt/events/types.py

@@ -1392,6 +1392,51 @@ def message(self) -> str:
         return f"The selection criterion '{self.spec_raw}' does not match any nodes"
 
 
+@dataclass
+class DepsLockCreated(InfoLevel, pt.DepsLockCreated):
+    def code(self):
+        return "M031"
+
+    def message(self) -> str:
+        return f"Created lock file in file path: {self.lock_filepath}"
+
+
+@dataclass
+class DepsLockUpdating(InfoLevel, pt.DepsLockUpdating):
+    def code(self):
+        return "M032"
+
+    def message(self) -> str:
+        return f"Updating lock file in file path: {self.lock_filepath}"
+
+
+@dataclass
+class DepsAddPackage(InfoLevel, pt.DepsAddPackage):
+    def code(self):
+        return "M033"
+
+    def message(self) -> str:
+        return f"Added new package {self.package_name}@{self.version} to {self.packages_filepath}"
+
+
+@dataclass
+class DepsFoundDuplicatePackage(InfoLevel, pt.DepsFoundDuplicatePackage):
+    def code(self):
+        return "M034"
+
+    def message(self) -> str:
+        return f"Found duplicate package in packages.yml, removing: {self.removed_package}"
+
+
+@dataclass
+class DepsVersionMissing(InfoLevel, pt.DepsVersionMissing):
+    def code(self):
+        return "M035"
+
+    def message(self) -> str:
+        return f"Version is required to add a package when source is {self.source}"
+
+
 # =======================================================
 # Q - Node execution
 # =======================================================