feat(load-task)!: add a -i/--interactive flag

BREAKING CHANGE: taskgraph load-task non-interactive by default.

This changes interactive to `False` by default. The reasoning is that
only some tasks (aka run-task based one), support this feature. Rather
than having a complex soup of behaviours.. e.g it is True by default
sometimes, but False for certain tasks.. I think it makes much better UX
to just make it something opt-in for all cases.

Author: ahal

src/taskgraph/docker.py

@@ -379,7 +379,7 @@ def load_task(
     remove: bool = True,
     user: Optional[str] = None,
     custom_image: Optional[str] = None,
-    interactive: Optional[bool] = True,
+    interactive: Optional[bool] = False,
 ) -> int:
     """Load and run a task interactively in a Docker container.
 
@@ -396,7 +396,7 @@ def load_task(
         custom_image: A custom image to use instead of the task's image.
         interactive: If True, execution of the task will be paused and user
           will be dropped into a shell. They can run `exec-task` to resume
-          it (default: True).
+          it (default: False).
 
     Returns:
         int: The exit code from the Docker container.

src/taskgraph/main.py

@@ -679,6 +679,16 @@ def image_digest(args):
     help="The task id or definition to load into a docker container. Can use "
     "'-' to read from stdin.",
 )
+@argument(
+    "-i",
+    "--interactive",
+    action="store_true",
+    default=False,
+    help="Setup the task but pause execution before executing its command. "
+    "Repositories will be cloned, environment variables will be set and an"
+    "executable script named `exec-task` will be provided to resume task "
+    "execution. Only supported for `run-task` based tasks.",
+)
 @argument(
     "--keep",
     dest="remove",
@@ -719,6 +729,7 @@ def load_task(args):
     return load_task(
         graph_config,
         args["task"],
+        interactive=args["interactive"],
         remove=args["remove"],
         user=args["user"],
         custom_image=args["image"],

test/test_main.py

@@ -444,7 +444,7 @@ def inner(args, stdin_data=None):
 
 
 def test_load_task_command(run_load_task):
-    # Test normal task ID
+    # Test normal task ID (default non-interactive)
     result, mocks = run_load_task(["load-task", "task-id-123"])
 
     assert result == 0
@@ -453,6 +453,20 @@ def test_load_task_command(run_load_task):
     mocks["docker_load_task"].assert_called_once_with(
         mocks["graph_config"],
         "task-id-123",
+        interactive=False,
+        remove=True,
+        user=None,
+        custom_image=None,
+    )
+
+    # Test with interactive flag
+    result, mocks = run_load_task(["load-task", "-i", "task-id-456"])
+
+    assert result == 0
+    mocks["docker_load_task"].assert_called_once_with(
+        mocks["graph_config"],
+        "task-id-456",
+        interactive=True,
         remove=True,
         user=None,
         custom_image=None,
@@ -476,6 +490,7 @@ def test_load_task_command_with_stdin(run_load_task):
     mocks["docker_load_task"].assert_called_once_with(
         mocks["graph_config"],
         task_def,
+        interactive=False,
         remove=True,
         user=None,
         custom_image=None,
@@ -492,6 +507,7 @@ def test_load_task_command_with_task_id(run_load_task):
     mocks["docker_load_task"].assert_called_once_with(
         mocks["graph_config"],
         "task-id-from-stdin",
+        interactive=False,
         remove=True,
         user=None,
         custom_image=None,