fix: attach container stdin on tutor dev start <service>

changelog.d/20241205_211837_danyal.faheem_add_dev_attach_command.md

@@ -0,0 +1 @@
+- [Bugfix] Fix breakpoint debugging by attaching container stdin when running tutor dev start <service> for a single <service>. (by @Danyal-Faheem)

docs/tutorials/edx-platform.rst

@@ -139,6 +139,8 @@ To debug a local edx-platform repository, first, start development in detached m
   # Or, debugging CMS:
   tutor dev start cms
 
+To detach from the service without shutting it down, use ``Ctrl+p`` followed with ``Ctrl+q``.
+
 Running edx-platform unit tests
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

tutor/commands/compose.py

@@ -245,14 +245,22 @@ def start(
     services: list[str],
 ) -> None:
     command = ["up", "--remove-orphans"]
+    attach = len(services) == 1
     if build:
         command.append("--build")
-    if detach:
+    # We have to run the container in detached mode first to attach to it
+    if detach or attach:
         command.append("-d")
 
     # Start services
     config = tutor_config.load(context.root)
     context.job_runner(config).docker_compose(*command, *services)
+    if attach and not detach:
+        fmt.echo_info(
+            f"""Attaching to service {services[0]}
+ℹ️  To detach without stopping the service, use ctrl+p followed by ctrl+q"""
+        )
+        context.job_runner(config).docker_compose("attach", *services)
 
 
 @click.command(help="Stop a running platform")