Paw/record final (#10045)

* Enable record/replay via environment variables.

* Add support for recording dbt's interactions, enabled by env var.

* Add changelog entry.

.changes/unreleased/Under the Hood-20240425-170138.yaml

@@ -0,0 +1,6 @@
+kind: Under the Hood
+body: Enable use of record mode via environment variable
+time: 2024-04-25T17:01:38.093524-04:00
+custom:
+  Author: peterallenwebb
+  Issue: "10045"

core/dbt/cli/requires.py

@@ -1,9 +1,11 @@
 import os
 
-import dbt.tracking
-from dbt_common.context import set_invocation_context
+from dbt_common.context import get_invocation_context, set_invocation_context
+from dbt_common.record import Recorder, RecorderMode, get_record_mode_from_env
+from dbt_common.clients.system import get_env
 from dbt_common.invocation import reset_invocation_id
 
+import dbt.tracking
 from dbt.version import installed as installed_version
 from dbt.adapters.factory import adapter_management, register_adapter, get_adapter
 from dbt.context.providers import generate_runtime_macro_context
@@ -44,6 +46,7 @@
 import importlib.util
 import time
 import traceback
+from typing import Optional
 
 
 def preflight(func):
@@ -52,7 +55,14 @@ def wrapper(*args, **kwargs):
         assert isinstance(ctx, Context)
         ctx.obj = ctx.obj or {}
 
-        set_invocation_context(os.environ)
+        set_invocation_context({})
+
+        # Record/Replay
+        setup_record_replay()
+
+        # Must be set after record/replay is set up so that the env can be
+        # recorded or replayed if needed.
+        get_invocation_context()._env = get_env()
 
         # Flags
         flags = Flags(ctx)
@@ -93,6 +103,28 @@ def wrapper(*args, **kwargs):
     return update_wrapper(wrapper, func)
 
 
+def setup_record_replay():
+    rec_mode = get_record_mode_from_env()
+
+    recorder: Optional[Recorder] = None
+    if rec_mode == RecorderMode.REPLAY:
+        recording_path = os.environ["DBT_REPLAY"]
+        recorder = Recorder(RecorderMode.REPLAY, recording_path)
+    elif rec_mode == RecorderMode.RECORD:
+        recorder = Recorder(RecorderMode.RECORD)
+
+    get_invocation_context().recorder = recorder
+
+
+def tear_down_record_replay():
+    recorder = get_invocation_context().recorder
+    if recorder is not None:
+        if recorder.mode == RecorderMode.RECORD:
+            recorder.write("recording.json")
+        elif recorder.mode == RecorderMode.REPLAY:
+            recorder.write_diffs("replay_diffs.json")
+
+
 def postflight(func):
     """The decorator that handles all exception handling for the click commands.
     This decorator must be used before any other decorators that may throw an exception."""
@@ -146,6 +178,8 @@ def wrapper(*args, **kwargs):
                 )
             )
 
+            tear_down_record_replay()
+
         if not success:
             raise ResultExit(result)
 

tests/functional/record/record.py

@@ -0,0 +1,17 @@
+import os
+
+from dbt.tests.util import run_dbt
+
+
+class TestRecord:
+    def test_record_when_env_var_set(self, project):
+        temp = os.environ.get("DBT_RECORD", None)
+        try:
+            os.environ["DBT_RECORD"] = "True"
+            run_dbt(["run"])
+            assert os.path.isfile(os.path.join(os.getcwd(), "recording.json"))
+        finally:
+            if temp is None:
+                del os.environ["DBT_RECORD"]
+            else:
+                os.environ["DBT_RECORD"] = temp