Change show-schedule command to table, add schedule name and derive source

Author: Mark90

orchestrator/cli/scheduler.py

@@ -67,8 +67,30 @@ def show_schedule() -> None:
 
     in cli underscore is replaced by a dash `show-schedule`
     """
-    for task in get_all_scheduler_tasks():
-        typer.echo(f"[{task.id}] Next run: {task.next_run_time} | Trigger: {task.trigger}")
+    from rich.console import Console
+    from rich.table import Table
+
+    from orchestrator.schedules.service import get_linker_entries_by_schedule_ids
+
+    console = Console()
+
+    table = Table(title="Scheduled Tasks")
+    table.add_column("id", no_wrap=True)
+    table.add_column("name")
+    table.add_column("source")
+    table.add_column("next run time")
+    table.add_column("trigger")
+
+    scheduled_tasks = get_all_scheduler_tasks()
+    _schedule_ids = [task.id for task in scheduled_tasks]
+    api_managed = {str(i.schedule_id) for i in get_linker_entries_by_schedule_ids(_schedule_ids)}
+
+    for task in scheduled_tasks:
+        source = "API" if task.id in api_managed else "decorator"
+        run_time = str(task.next_run_time.replace(microsecond=0))
+        table.add_row(task.id, task.name, source, str(run_time), str(task.trigger))
+
+    console.print(table)
 
 
 @app.command()

test/unit_tests/schedules/test_scheduling.py

@@ -1,8 +1,11 @@
+import re
+from datetime import datetime
 from unittest import mock
 
 from typer.testing import CliRunner
 
 from orchestrator.cli.scheduler import app
+from orchestrator.db.models import WorkflowApschedulerJob
 
 runner = CliRunner()
 
@@ -15,22 +18,50 @@ def test_run_scheduler(mock_scheduler):
     assert result.exit_code == 130
 
 
-@mock.patch("orchestrator.schedules.scheduler.get_scheduler_store")
-def test_show_schedule_command(mock_get_scheduler_store):
+def make_mock_job(id_, name, next_run_time_str, trigger):
     mock_job = mock.MagicMock()
-    mock_job.id = "job1"
-    mock_job.next_run_time = "2025-08-05 12:00:00"
-    mock_job.trigger = "trigger_info"
+    mock_job.id = id_
+    mock_job.name = name
+    mock_job.next_run_time = datetime.fromisoformat(next_run_time_str)
+    mock_job.trigger = trigger
+    return mock_job
+
+
+def to_ascii_line(line: str):
+    # Remove unicode from a rich.table outputted line
+    return line.encode("ascii", "ignore").decode("ascii").strip()
+
+
+def to_regex(mock_job, *, source):
+    # Create regex to match mock job in show-schedule output
+    return re.compile(rf"{mock_job.id}\s+{mock_job.name}\s+{source}\s+.*", flags=re.MULTILINE)
+
+
+@mock.patch("orchestrator.schedules.service.get_linker_entries_by_schedule_ids")
+@mock.patch("orchestrator.schedules.scheduler.get_scheduler_store")
+def test_show_schedule_command(mock_get_scheduler_store, mock_get_linker_entries):
+    # given
+    mock_job1 = make_mock_job("job1", "My Job 1", "2025-08-05T12:00:00", "trigger_info")
+    mock_job2 = make_mock_job("6faf2c63-44de-48bc-853d-bb3f57225055", "My Job 2", "2025-08-05T14:00:00", "trigger_info")
 
     mock_scheduler = mock.MagicMock()
-    mock_scheduler.get_all_jobs.return_value = [mock_job]
+    mock_scheduler.get_all_jobs.return_value = [mock_job1, mock_job2]
     mock_get_scheduler_store.return_value.__enter__.return_value = mock_scheduler
 
-    result = runner.invoke(app, ["show-schedule"])
-    assert result.exit_code == 0
-    assert "[job1]" in result.output
-    assert "Next run: 2025-08-05 12:00:00" in result.output
-    assert "trigger_info" in result.output
+    mock_linker_entry_job2 = mock.MagicMock(spec=WorkflowApschedulerJob)
+    mock_linker_entry_job2.schedule_id = mock_job2.id
+    mock_get_linker_entries.return_value = [mock_linker_entry_job2]  # only job 2 is defined in API
+
+    regex1 = to_regex(mock_job1, source="decorator")
+    regex2 = to_regex(mock_job2, source="API")
+
+    # when
+    result = runner.invoke(app, ["show-schedule"], env={"COLUMNS": "300", "LINES": "200"})
+    output_stripped = "\n".join([to_ascii_line(line) for line in result.output.splitlines()])
+
+    # then
+    assert regex1.findall(output_stripped) != [], f"Regex {regex1} did not match output {output_stripped}"
+    assert regex2.findall(output_stripped) != [], f"Regex {regex2} did not match output {output_stripped}"
 
 
 @mock.patch("orchestrator.schedules.scheduler.get_scheduler_store")