Move unit testing to test and build commands

.changes/unreleased/Features-20231116-144006.yaml

@@ -0,0 +1,6 @@
+kind: Features
+body: Move unit testing to test command
+time: 2023-11-16T14:40:06.121336-05:00
+custom:
+  Author: gshank
+  Issue: "8979"

core/dbt/cli/flags.py

@@ -396,7 +396,6 @@ def command_args(command: CliCommand) -> ArgsList:
         CliCommand.SOURCE_FRESHNESS: cli.freshness,
         CliCommand.TEST: cli.test,
         CliCommand.RETRY: cli.retry,
-        CliCommand.UNIT_TEST: cli.unit_test,
     }
     click_cmd: Optional[ClickCommand] = CMD_DICT.get(command, None)
     if click_cmd is None:

core/dbt/cli/main.py

@@ -40,7 +40,6 @@
 from dbt.task.show import ShowTask
 from dbt.task.snapshot import SnapshotTask
 from dbt.task.test import TestTask
-from dbt.task.unit_test import UnitTestTask
 
 
 @dataclass
@@ -870,6 +869,7 @@ def freshness(ctx, **kwargs):
 @p.project_dir
 @p.select
 @p.selector
+@p.show_output_format
 @p.state
 @p.defer_state
 @p.deprecated_state
@@ -897,50 +897,6 @@ def test(ctx, **kwargs):
     return results, success
 
 
-# dbt unit-test
-@cli.command("unit-test")
-@click.pass_context
-@p.defer
-@p.deprecated_defer
-@p.exclude
-@p.fail_fast
-@p.favor_state
-@p.deprecated_favor_state
-@p.indirect_selection
-@p.show_output_format
-@p.profile
-@p.profiles_dir
-@p.project_dir
-@p.select
-@p.selector
-@p.state
-@p.defer_state
-@p.deprecated_state
-@p.store_failures
-@p.target
-@p.target_path
-@p.threads
-@p.vars
-@p.version_check
-@requires.postflight
-@requires.preflight
-@requires.profile
-@requires.project
-@requires.runtime_config
-@requires.manifest
-def unit_test(ctx, **kwargs):
-    """Runs tests on data in deployed models. Run this after `dbt run`"""
-    task = UnitTestTask(
-        ctx.obj["flags"],
-        ctx.obj["runtime_config"],
-        ctx.obj["manifest"],
-    )
-
-    results = task.run()
-    success = task.interpret_results(results)
-    return results, success
-
-
 # Support running as a module
 if __name__ == "__main__":
     cli()

core/dbt/cli/types.py

@@ -24,7 +24,6 @@ class Command(Enum):
     SOURCE_FRESHNESS = "freshness"
     TEST = "test"
     RETRY = "retry"
-    UNIT_TEST = "unit-test"
 
     @classmethod
     def from_str(cls, s: str) -> "Command":

core/dbt/compilation.py

@@ -25,6 +25,7 @@
     InjectedCTE,
     SeedNode,
     UnitTestNode,
+    UnitTestDefinition,
 )
 from dbt.exceptions import (
     GraphDependencyNotFoundError,
@@ -539,6 +540,9 @@ def compile_node(
         the node's raw_code into compiled_code, and then calls the
         recursive method to "prepend" the ctes.
         """
+        if isinstance(node, UnitTestDefinition):
+            return node
+
         # Make sure Lexer for sqlparse 0.4.4 is initialized
         from sqlparse.lexer import Lexer  # type: ignore
 

core/dbt/constants.py

@@ -16,5 +16,4 @@
 MANIFEST_FILE_NAME = "manifest.json"
 SEMANTIC_MANIFEST_FILE_NAME = "semantic_manifest.json"
 PARTIAL_PARSE_FILE_NAME = "partial_parse.msgpack"
-UNIT_TEST_MANIFEST_FILE_NAME = "unit_test_manifest.json"
 PACKAGE_LOCK_HASH_KEY = "sha1_hash"

core/dbt/contracts/graph/nodes.py

@@ -1082,16 +1082,30 @@ class UnitTestNode(CompiledNode):
 
 
 @dataclass
-class UnitTestDefinition(GraphNode):
+class UnitTestDefinitionMandatory:
     model: str
     given: Sequence[UnitTestInputFixture]
     expect: UnitTestOutputFixture
+
+
+@dataclass
+class UnitTestDefinition(NodeInfoMixin, GraphNode, UnitTestDefinitionMandatory):
     description: str = ""
     overrides: Optional[UnitTestOverrides] = None
     depends_on: DependsOn = field(default_factory=DependsOn)
     config: UnitTestConfig = field(default_factory=UnitTestConfig)
     checksum: Optional[str] = None
 
+    @property
+    def build_path(self):
+        # TODO: is this actually necessary?
+        return self.original_file_path
+
+    @property
+    def compiled_path(self):
+        # TODO: is this actually necessary?
+        return self.original_file_path
+
     @property
     def depends_on_nodes(self):
         return self.depends_on.nodes

core/dbt/contracts/results.py

@@ -1,7 +1,12 @@
 import threading
 
 from dbt.contracts.graph.unparsed import FreshnessThreshold
-from dbt.contracts.graph.nodes import CompiledNode, SourceDefinition, ResultNode
+from dbt.contracts.graph.nodes import (
+    CompiledNode,
+    SourceDefinition,
+    ResultNode,
+    UnitTestDefinition,
+)
 from dbt.contracts.util import (
     BaseArtifactMetadata,
     ArtifactMixin,
@@ -153,7 +158,7 @@ def to_msg_dict(self):
 
 @dataclass
 class NodeResult(BaseResult):
-    node: ResultNode
+    node: Union[ResultNode, UnitTestDefinition]
 
 
 @dataclass

core/dbt/include/global_project/macros/unit_test_sql/get_fixture_sql.sql

@@ -11,7 +11,7 @@
 {%- endif -%}
 
 {%- if not column_name_to_data_types -%}
-    {{ exceptions.raise_compiler_error("columns not available for " ~ model.name) }}
+    {{ exceptions.raise_compiler_error("Not able to get columns for unit test '" ~ model.name ~ "' from relation " ~ this) }}
 {%- endif -%}
 
 {%- for column_name, column_type in column_name_to_data_types.items() -%}

core/dbt/parser/manifest.py

@@ -39,7 +39,6 @@
     MANIFEST_FILE_NAME,
     PARTIAL_PARSE_FILE_NAME,
     SEMANTIC_MANIFEST_FILE_NAME,
-    UNIT_TEST_MANIFEST_FILE_NAME,
 )
 from dbt.helper_types import PathSet
 from dbt.events.functions import fire_event, get_invocation_id, warn_or_error
@@ -1767,11 +1766,7 @@ def write_semantic_manifest(manifest: Manifest, target_path: str) -> None:
 
 
 def write_manifest(manifest: Manifest, target_path: str, which: Optional[str] = None):
-    if which and which == "unit-test":
-        file_name = UNIT_TEST_MANIFEST_FILE_NAME
-    else:
-        file_name = MANIFEST_FILE_NAME
-
+    file_name = MANIFEST_FILE_NAME
     path = os.path.join(target_path, file_name)
     manifest.write(path)
 

core/dbt/parser/unit_tests.py

@@ -44,9 +44,9 @@ def __init__(self, manifest, root_project, selected) -> None:
 
     def load(self) -> Manifest:
         for unique_id in self.selected:
-            unit_test_case = self.manifest.unit_tests[unique_id]
-            self.parse_unit_test_case(unit_test_case)
-
+            if unique_id in self.manifest.unit_tests:
+                unit_test_case = self.manifest.unit_tests[unique_id]
+                self.parse_unit_test_case(unit_test_case)
         return self.unit_test_manifest
 
     def parse_unit_test_case(self, test_case: UnitTestDefinition):
@@ -86,7 +86,6 @@ def parse_unit_test_case(self, test_case: UnitTestDefinition):
             overrides=test_case.overrides,
         )
 
-        # TODO: generalize this method
         ctx = generate_parse_exposure(
             unit_test_node,  # type: ignore
             self.root_project,

core/dbt/task/base.py

@@ -308,7 +308,7 @@ def compile_and_execute(self, manifest, ctx):
             with collect_timing_info("compile", ctx.timing.append):
                 # if we fail here, we still have a compiled node to return
                 # this has the benefit of showing a build path for the errant
-                # model
+                # model.  This calls the 'compile' method in CompileTask
                 ctx.node = self.compile(manifest)
 
             # for ephemeral nodes, we only want to compile, not run

core/dbt/task/retry.py

@@ -17,7 +17,6 @@
 from dbt.task.seed import SeedTask
 from dbt.task.snapshot import SnapshotTask
 from dbt.task.test import TestTask
-from dbt.task.unit_test import UnitTestTask
 
 RETRYABLE_STATUSES = {NodeStatus.Error, NodeStatus.Fail, NodeStatus.Skipped, NodeStatus.RuntimeErr}
 OVERRIDE_PARENT_FLAGS = {
@@ -41,7 +40,6 @@
     "test": TestTask,
     "run": RunTask,
     "run-operation": RunOperationTask,
-    "unit-test": UnitTestTask,
 }
 
 CMD_DICT = {
@@ -54,7 +52,6 @@
     "test": CliCommand.TEST,
     "run": CliCommand.RUN,
     "run-operation": CliCommand.RUN_OPERATION,
-    "unit-test": CliCommand.UNIT_TEST,
 }
 
 

core/dbt/task/runnable.py

@@ -141,20 +141,13 @@ def get_graph_queue(self) -> GraphQueue:
         spec = self.get_selection_spec()
         return selector.get_graph_queue(spec)
 
-    # A callback for unit testing
-    def reset_job_queue_and_manifest(self):
-        pass
-
     def _runtime_initialize(self):
         self.compile_manifest()
         if self.manifest is None or self.graph is None:
             raise DbtInternalError("_runtime_initialize never loaded the graph!")
 
         self.job_queue = self.get_graph_queue()
 
-        # for unit testing
-        self.reset_job_queue_and_manifest()
-
         # we use this a couple of times. order does not matter.
         self._flattened_nodes = []
         for uid in self.job_queue.get_selected_nodes():
@@ -164,9 +157,11 @@ def _runtime_initialize(self):
                 self._flattened_nodes.append(self.manifest.sources[uid])
             elif uid in self.manifest.saved_queries:
                 self._flattened_nodes.append(self.manifest.saved_queries[uid])
+            elif uid in self.manifest.unit_tests:
+                self._flattened_nodes.append(self.manifest.unit_tests[uid])
             else:
                 raise DbtInternalError(
-                    f"Node selection returned {uid}, expected a node or a source"
+                    f"Node selection returned {uid}, expected a node, a source, or a unit test"
                 )
 
         self.num_nodes = len([n for n in self._flattened_nodes if not n.is_ephemeral_model])
@@ -496,7 +491,7 @@ def run(self):
 
         if self.args.write_json:
             # args.which used to determine file name for unit test manifest
-            write_manifest(self.manifest, self.config.project_target_path, self.args.which)
+            write_manifest(self.manifest, self.config.project_target_path)
             if hasattr(result, "write"):
                 result.write(self.result_path())