Remove scaffold workflow logs --container option (#721)

Co-authored-by: J3utter <j3utter@gmail.com>

Author: J3utter

stoobly_agent/app/cli/scaffold/docker/workflow/run_command.py

@@ -7,10 +7,10 @@
 from typing import List
 from types import FunctionType
 
-from stoobly_agent.app.cli.scaffold.constants import PROXY_MODE_REVERSE, WORKFLOW_CONTAINER_PROXY, WORKFLOW_CONTAINER_SERVICE, WORKFLOW_NAME
+from stoobly_agent.app.cli.scaffold.constants import PROXY_MODE_REVERSE, WORKFLOW_CONTAINER_INIT, WORKFLOW_CONTAINER_PROXY, WORKFLOW_CONTAINER_SERVICE, WORKFLOW_NAME
 from stoobly_agent.app.cli.scaffold.docker.constants import APP_EGRESS_NETWORK_TEMPLATE, APP_INGRESS_NETWORK_TEMPLATE, DOCKERFILE_CONTEXT
 from stoobly_agent.app.cli.scaffold.docker.service.gateway_base import GatewayBase
-from stoobly_agent.app.cli.scaffold.templates.constants import CORE_ENTRYPOINT_SERVICE_NAME, CORE_GATEWAY_SERVICE_NAME, CORE_SERVICES_DOCKER
+from stoobly_agent.app.cli.scaffold.templates.constants import CORE_BUILD_SERVICE_NAME, CORE_ENTRYPOINT_SERVICE_NAME, CORE_GATEWAY_SERVICE_NAME, CORE_MOCK_UI_SERVICE_NAME, CORE_SERVICES_DOCKER
 from stoobly_agent.app.cli.scaffold.workflow import Workflow
 from stoobly_agent.app.cli.scaffold.workflow_run_command import WorkflowRunCommand
 from stoobly_agent.app.cli.types.workflow_run_command import BuildOptions, DownOptions, UpOptions, WorkflowDownOptions, WorkflowUpOptions, WorkflowLogsOptions
@@ -205,18 +205,20 @@ def logs(self, **options: WorkflowLogsOptions):
       self.__find_and_verify_timestamp_file()
 
     print_service_header = options.get('print_service_header')
+
+    if self.app_config.proxy_mode == PROXY_MODE_REVERSE:
+      containers_to_log = [WORKFLOW_CONTAINER_INIT, WORKFLOW_CONTAINER_PROXY]
+    else:
+      containers_to_log = [WORKFLOW_CONTAINER_INIT, WORKFLOW_CONTAINER_SERVICE]
 
     # Filter services based on options
     filtered_services = []
 
     if self.app_config.proxy_mode == PROXY_MODE_REVERSE:
-      if len(options.get('container', [])) == 0:
-        options['container'] = [WORKFLOW_CONTAINER_PROXY]
-
       for service in self.services:
         if len(options.get('service', [])) == 0:
           # If no filter is specified, ignore CORE_SERVICES  
-          if service in CORE_SERVICES_DOCKER:
+          if service == CORE_BUILD_SERVICE_NAME or service == CORE_MOCK_UI_SERVICE_NAME or service == CORE_GATEWAY_SERVICE_NAME:
             continue
         else:
           # If a filter is specified, ignore all other services
@@ -225,13 +227,10 @@ def logs(self, **options: WorkflowLogsOptions):
 
         filtered_services.append(service)
     else:
-      if len(options.get('container', [])) == 0:
-        options['container'] = [WORKFLOW_CONTAINER_SERVICE]
-
       for service in self.services:
         if len(options.get('service', [])) == 0:
-          # If no filter is specified, ignore all other services except the gateway
-          if service != CORE_GATEWAY_SERVICE_NAME:
+          # If no filter is specified, ignore CORE_SERVICES other than the gateway
+          if service == CORE_BUILD_SERVICE_NAME or service == CORE_MOCK_UI_SERVICE_NAME:
             continue 
         else:
           # If a filter is specified, ignore all other services
@@ -249,15 +248,26 @@ def logs(self, **options: WorkflowLogsOptions):
       commands.append((service, command))
 
     # Sort commands by priority and execute
-    commands = sorted(commands, key=lambda x: x[1].service_config.priority)
+    if self.app_config.proxy_mode == PROXY_MODE_REVERSE:
+      commands = sorted(commands, key=lambda x: x[1].service_config.priority)
+    else:
+      # For forward proxy, gateway is second to last; entrypoint is last (follow target)
+      commands = sorted(
+        commands,
+        key=lambda x: (
+          2 if x[0] == CORE_ENTRYPOINT_SERVICE_NAME else 1 if x[0] == CORE_GATEWAY_SERVICE_NAME else 0,
+          x[1].service_config.priority,
+        ),
+      )
+
     for index, (service, command) in enumerate(commands):
       if print_service_header:
         print_service_header(service)
 
       follow = options.get('follow', False) and index == len(commands) - 1
       shell_commands = self._build_log_commands(
         command, 
-        containers=options.get('container', []), 
+        containers=containers_to_log, 
         follow=follow, 
         namespace=options.get('namespace')
       )
@@ -279,15 +289,13 @@ def _build_log_commands(self, command, containers=None, follow=False, namespace=
         ), containers or []
       )
     )
+    matched = [c for c in allowed_containers if c in available_containers]
 
-    for index, container in enumerate(available_containers):
-      if container not in allowed_containers:
-        continue
-
+    for index, container in enumerate(matched):
       container_name = self._container_name(container, namespace or command.workflow_name)
       log_commands.append(f"echo \"=== Logging {container_name}\"")
 
-      if follow and index == len(available_containers) - 1:
+      if follow and index == len(matched) - 1:
         docker_command = ['docker', 'logs', '--follow', container_name]
       else:
         docker_command = ['docker', 'logs', container_name]

stoobly_agent/app/cli/scaffold_cli.py

@@ -404,7 +404,7 @@ def show(**kwargs):
 )
 @click.option('--app-dir-path', default=context_dir_path, help='Path to application directory.')
 @click.option('--context-dir-path', default=data_dir.context_dir_path, help='Path to Stoobly data directory.')
-@click.option('--containerized', is_flag=True, help='Set if run from within a container.')
+@click.option('--containerized', is_flag=True, hidden=True, help='Set if run from within a container.')
 @click.option('--dry-run', default=False, is_flag=True)
 @click.option('--hostname-uninstall-confirm', default=None, type=click.Choice(['y', 'Y', 'n', 'N']), help='Confirm answer to hostname uninstall prompt.')
 @click.option('--log-level', default=INFO, type=click.Choice([DEBUG, INFO, WARNING, ERROR]), help='''
@@ -521,7 +521,7 @@ def down(**kwargs):
 
   finally:
     # Execute the workflow down
-    command_args = { 'print_service_header': lambda service_name: __print_header(f"SERVICE {service_name}") }
+    command_args = { 'print_service_header': lambda service_name: __print_header(f"service {service_name}") }
     workflow_command.down(
       **command_args,
       **kwargs
@@ -535,12 +535,9 @@ def down(**kwargs):
   help="Show or follow logs from workflow service(s)",
 )
 @click.option('--app-dir-path', default=context_dir_path, help='Path to application directory.')
-@click.option(
-  '--container', multiple=True, help=f"Select which containers to log."
-)
-@click.option('--containerized', is_flag=True, help='Set if run from within a container.')
+@click.option('--containerized', is_flag=True, hidden=True, help='Set if run from within a container.')
 @click.option('--dry-run', default=False, is_flag=True, help='If set, prints commands.')
-@click.option('--follow', is_flag=True, help='Follow last container log output.')
+@click.option('--follow', is_flag=True, help='Follow log output.')
 @click.option('--log-level', default=INFO, type=click.Choice([DEBUG, INFO, WARNING, ERROR]), help='''
     Log levels can be "debug", "info", "warning", or "error"
 ''')
@@ -583,7 +580,7 @@ def logs(**kwargs):
     )
 
   # Execute the workflow logs
-  command_args = { 'print_service_header': lambda service_name: __print_header(f"SERVICE {service_name}") }
+  command_args = { 'print_service_header': lambda service_name: __print_header(f"service {service_name}") }
   workflow_command.logs(
     **command_args,
     **kwargs
@@ -596,7 +593,7 @@ def logs(**kwargs):
 @click.option('--ca-certs-dir-path', default=None, help='Path to ca certs directory used to sign SSL certs. Defaults to the ca_certs dir of the context.')
 @click.option('--ca-certs-install-confirm', default=None, type=click.Choice(['y', 'Y', 'n', 'N']), help='Confirm answer to CA certificate installation prompt.')
 @click.option('--certs-dir-path', help='Path to certs directory. Defaults to the certs dir of the context.')
-@click.option('--containerized', is_flag=True, help='Set if run from within a container.')
+@click.option('--containerized', is_flag=True, hidden=True, help='Set if run from within a container.')
 @click.option('--context-dir-path', default=data_dir.context_dir_path, help='Path to Stoobly data directory.')
 @click.option('--detached', is_flag=True, help='If set, will run the highest priority service in the background.')
 @click.option('--dry-run', default=False, is_flag=True, help='If set, prints commands instead of running them.')
@@ -705,7 +702,7 @@ def up(**kwargs):
     Logger.instance(LOG_ID).info(f"To view logs, run `stoobly-agent scaffold workflow logs{options_str} {kwargs['workflow_name']}`")
 
   # Execute the workflow
-  command_args = { 'print_service_header': lambda service_name: __print_header(f"SERVICE {service_name}") }
+  command_args = { 'print_service_header': lambda service_name: __print_header(f"service {service_name}") }
   workflow_command.up(
     **command_args,
     **kwargs
@@ -717,7 +714,7 @@ def up(**kwargs):
 @click.option('--app-dir-path', default=context_dir_path, help='Path to application directory.')
 @click.option('--ca-certs-dir-path', default=None, help='Path to ca certs directory used to sign SSL certs. Defaults to the ca_certs dir of the context.')
 @click.option('--certs-dir-path', help='Path to certs directory. Defaults to the certs dir of the context.')
-@click.option('--containerized', is_flag=True, help='Set if run from within a container.')
+@click.option('--containerized', is_flag=True, hidden=True, help='Set if run from within a container.')
 @click.option('--context-dir-path', default=data_dir.context_dir_path, help='Path to Stoobly data directory.')
 @click.option('--service', multiple=True, help='Select specific services. Defaults to all.')
 @click.argument('workflow_name')
@@ -736,7 +733,7 @@ def mkcert(**kwargs):
   help="Sync normalize rewrite rules from service upstream hostname, port, and scheme"
 )
 @click.option('--app-dir-path', default=context_dir_path, help='Path to application directory.')
-@click.option('--containerized', is_flag=True, help='Set if run from within a container.')
+@click.option('--containerized', is_flag=True, hidden=True, help='Set if run from within a container.')
 @click.option('--context-dir-path', default=data_dir.context_dir_path, help='Path to Stoobly data directory.')
 @click.option('--service', multiple=True, help='Select specific services. Defaults to all.')
 @click.argument('workflow_name')
@@ -756,7 +753,7 @@ def rewrite(**kwargs):
   help="Configure include filter rules for workflow service(s)"
 )
 @click.option('--app-dir-path', default=context_dir_path, help='Path to application directory.')
-@click.option('--containerized', is_flag=True, help='Set if run from within a container.')
+@click.option('--containerized', is_flag=True, hidden=True, help='Set if run from within a container.')
 @click.option('--context-dir-path', default=data_dir.context_dir_path, help='Path to Stoobly data directory.')
 @click.option('--service', multiple=True, help='Select specific services. Defaults to all.')
 @click.argument('workflow_name')

stoobly_agent/app/cli/types/workflow_run_command.py

@@ -56,7 +56,6 @@ class WorkflowUpOptions(TypedDict, total=False):
 
 class WorkflowLogsOptions(TypedDict, total=False):
   print_service_header: Optional[Callable[[str], None]]
-  container: List[str]
   follow: bool
   namespace: Optional[str]
   # CLI-specific options that get passed through

stoobly_agent/test/app/cli/scaffold/docker/workflow_log_commands_test.py

@@ -0,0 +1,135 @@
+import pytest
+
+from unittest.mock import MagicMock
+
+from stoobly_agent.app.cli.scaffold.constants import (
+  WORKFLOW_CONTAINER_INIT,
+  WORKFLOW_CONTAINER_PROXY,
+  WORKFLOW_CONTAINER_SERVICE,
+)
+from stoobly_agent.app.cli.scaffold.templates.constants import CORE_ENTRYPOINT_SERVICE_NAME, CORE_GATEWAY_SERVICE_NAME
+from stoobly_agent.app.cli.scaffold.docker.workflow.run_command import DockerWorkflowRunCommand
+
+
+@pytest.fixture
+def run_command():
+  return DockerWorkflowRunCommand.__new__(DockerWorkflowRunCommand)
+
+
+def _stub_command(service_name, workflow_name, compose_services):
+  command = MagicMock()
+  command.service_name = service_name
+  command.workflow_name = workflow_name
+  command.containers = {name: {} for name in compose_services}
+  return command
+
+
+class TestBuildLogCommands:
+
+  def test_reverse_logs_init_then_proxy(self, run_command):
+    command = _stub_command('api', 'record', ['api.init', 'api.proxy'])
+    log_commands = run_command._build_log_commands(
+      command,
+      containers=[WORKFLOW_CONTAINER_INIT, WORKFLOW_CONTAINER_PROXY],
+      namespace='record',
+    )
+
+    assert log_commands == [
+      'echo "=== Logging record-api.init-1"',
+      'docker logs record-api.init-1',
+      'echo "=== Logging record-api.proxy-1"',
+      'docker logs record-api.proxy-1',
+    ]
+
+  def test_reverse_follow_only_on_proxy(self, run_command):
+    command = _stub_command('api', 'record', ['api.init', 'api.proxy'])
+    log_commands = run_command._build_log_commands(
+      command,
+      containers=[WORKFLOW_CONTAINER_INIT, WORKFLOW_CONTAINER_PROXY],
+      follow=True,
+      namespace='record',
+    )
+
+    assert log_commands[1] == 'docker logs record-api.init-1'
+    assert log_commands[3] == 'docker logs --follow record-api.proxy-1'
+
+  def test_forward_logs_service_when_init_absent(self, run_command):
+    command = _stub_command('gateway', 'record', ['gateway.service'])
+    log_commands = run_command._build_log_commands(
+      command,
+      containers=[WORKFLOW_CONTAINER_INIT, WORKFLOW_CONTAINER_SERVICE],
+      namespace='record',
+    )
+
+    assert log_commands == [
+      'echo "=== Logging record-gateway.service-1"',
+      'docker logs record-gateway.service-1',
+    ]
+
+  def test_forward_follow_only_on_service(self, run_command):
+    command = _stub_command('gateway', 'record', ['gateway.init', 'gateway.service'])
+    log_commands = run_command._build_log_commands(
+      command,
+      containers=[WORKFLOW_CONTAINER_INIT, WORKFLOW_CONTAINER_SERVICE],
+      follow=True,
+      namespace='record',
+    )
+
+    assert log_commands[1] == 'docker logs record-gateway.init-1'
+    assert log_commands[3] == 'docker logs --follow record-gateway.service-1'
+
+  def test_skips_missing_init_container(self, run_command):
+    command = _stub_command('api', 'record', ['api.proxy'])
+    log_commands = run_command._build_log_commands(
+      command,
+      containers=[WORKFLOW_CONTAINER_INIT, WORKFLOW_CONTAINER_PROXY],
+      namespace='record',
+    )
+
+    assert log_commands == [
+      'echo "=== Logging record-api.proxy-1"',
+      'docker logs record-api.proxy-1',
+    ]
+
+
+class TestForwardLogCommandSort:
+
+  def _sort(self, commands):
+    return sorted(
+      commands,
+      key=lambda x: (
+        2 if x[0] == CORE_ENTRYPOINT_SERVICE_NAME else 1 if x[0] == CORE_GATEWAY_SERVICE_NAME else 0,
+        x[1].service_config.priority,
+      ),
+    )
+
+  def test_gateway_sorted_second_to_last(self):
+    api_command = MagicMock()
+    api_command.service_config.priority = 10
+    gateway_command = MagicMock()
+    gateway_command.service_config.priority = 0
+    entrypoint_command = MagicMock()
+    entrypoint_command.service_config.priority = 5
+
+    commands = [
+      ('gateway', gateway_command),
+      ('entrypoint', entrypoint_command),
+      ('api', api_command),
+    ]
+    sorted_commands = self._sort(commands)
+
+    assert [service for service, _ in sorted_commands] == ['api', 'gateway', 'entrypoint']
+
+  def test_gateway_last_when_entrypoint_absent(self):
+    api_command = MagicMock()
+    api_command.service_config.priority = 10
+    gateway_command = MagicMock()
+    gateway_command.service_config.priority = 0
+
+    commands = [
+      ('gateway', gateway_command),
+      ('api', api_command),
+    ]
+    sorted_commands = self._sort(commands)
+
+    assert [service for service, _ in sorted_commands] == ['api', 'gateway']