MPT-17299: add status column to the list command

[svazquezco]

Add status column to the list command

Closes MPT-17299

• Add status column to the migrate list output (statuses: Running, Failed, Fake Apply, Applied, Not Applied)
• Add MigrationStatusEnum with from_state(...) to derive status from started_at/applied_at timestamps
• Introduce MigrationListItem dataclass to model list rows (migration_id, order_id, migration_type, started_at, applied_at, status)
• Refactor rendering to MigrationRender class using Rich and Console(width=CONSOLE_WIDTH)
• Update list use case to return list[MigrationListItem] sorted by order_id
• Add CONSOLE_WIDTH constant (200) for consistent console width
• Update run_migrations to track and persist status transitions (RUNNING, APPLIED, FAILED) and skip already-applied migrations
• Update CLI tests and documentation to include and explain the new status column

[coderabbitai]

📝 Walkthrough

Walkthrough

Adds a migration status enum and list-item dataclass, changes listing use-case to return typed items, replaces table renderer with a Rich-aware MigrationRender class, updates run logic to persist status transitions, adds CONSOLE_WIDTH, and updates docs/tests to show a new status column.

Changes

Cohort / File(s)	Summary
Documentation docs/PROJECT_DESCRIPTION.md	Inserted explanation of how migration status is derived from persisted timestamps and added mapping (RUNNING, FAILED, FAKE_APPLY, APPLIED, NOT_APPLIED) in two places.
Constants mpt_tool/constants.py	Added CONSOLE_WIDTH: int = 200.
Enums mpt_tool/enums.py	Added MigrationStatusEnum (RUNNING, FAILED, FAKE_APPLY, APPLIED, NOT_APPLIED) and from_state(...) to derive status from a Migration instance or None.
Data Models mpt_tool/models.py	Added frozen dataclass MigrationListItem with fields (migration_id, order_id, migration_type, started_at, applied_at, status) and from_sources(...) constructor using MigrationStatusEnum.from_state.
Rendering mpt_tool/renders.py	Replaced functional table builder with MigrationRender class that accepts migration_items: list[MigrationListItem] and implements __rich_console__ to produce a Rich Table including the new status column and formatted values.
Commands mpt_tool/commands/list.py	Renamed local variable state_data→migrations, changed emptiness check to if not migrations, instantiate Console(width=CONSOLE_WIDTH), and call MigrationRender(migration_items=migrations) for rendering.
Use Case — Listing mpt_tool/use_cases/list_migrations.py	execute() now returns list[MigrationListItem]; constructs items via MigrationListItem.from_sources(...), logs missing states, and returns items sorted by order_id.
Use Case — Running mpt_tool/use_cases/run_migrations.py	Introduced status-driven helpers: _get_migration_instance_by_type, _save_state and status transitions using MigrationStatusEnum (RUNNING/ APPLIED/ FAILED). Skips already-applied migrations and consistently wraps errors.
Tests tests/cli/test_cli_airtable_storage.py, tests/cli/test_cli_local_storage.py	Updated CLI table expectations to include a status column (e.g., Applied / NotApplied), adjusted timestamps/freeze_time and migration_id expectations to match new rendering and data model.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Possibly related PRs

• MPT-16657: refactor migration command handling #23: Overlaps changes to mpt_tool/commands/list.py and the listing/rendering integration (Console usage and MigrationRender).
• MPT-16846: implement fake option #21: Related alterations to migration state handling and fake-apply semantics that affect MigrationStatusEnum.from_state interpretations.
• MPT-16667: add Airtable storage #26: Touches the same use-case and runtime areas (use_cases/list_migrations.py, use_cases/run_migrations.py) and aligns with the typed item/rendering refactor.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Jira Issue Key In Title	✅ Passed	The PR title contains exactly one Jira issue key in the required format MPT-XXXX, properly formatted and separated from the description with a colon.
Test Coverage Required	✅ Passed	PR modifies 7 code files and includes test changes in 2 test files, satisfying the requirement.
Single Commit Required	✅ Passed	The PR contains exactly one commit (110289f feat: add status column to the list command), which meets the requirement for a clean and focused git history.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)

• MPT-17299: Cannot read properties of undefined (reading 'map')

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
88.3% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[coderabbitai]

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In `@mpt_tool/renders.py`:
- Line 15: Remove the unnecessary "# noqa: PLW3201" directive from the
__rich_console__ method signature (def __rich_console__(self, console: Console,
options: ConsoleOptions) -> RenderResult) since PLW3201 is not enforced by our
linters; simply delete the trailing noqa comment so the method signature is
clean.

In `@mpt_tool/use_cases/run_migrations.py`:
- Around line 52-55: Currently the code calls self._save_state(state,
status=MigrationStatusEnum.RUNNING) before executing migration_instance.run(),
which can leave migrations stuck as STARTED after a crash; remove or move that
pre-run persistence so you do not persist RUNNING before execution — instead
call self._save_state(...) with MigrationStatusEnum.RUNNING only after run() has
successfully started/finished as appropriate, or persist only immutable pre-run
metadata and persist RUNNING in the success path; update the block around
logger.info, self._save_state, and migration_instance.run() to ensure RUNNING is
not written prior to calling migration_instance.run().