Skip to content

Rename python testing suite names - #314

Merged
oxesoft merged 3 commits into
v2.16-developfrom
feature/978_rename_python_script_suites
May 26, 2026
Merged

Rename python testing suite names#314
oxesoft merged 3 commits into
v2.16-developfrom
feature/978_rename_python_script_suites

Conversation

@rquidute

@rquidute rquidute commented May 18, 2026

Copy link
Copy Markdown
Contributor

Summary

Renames the Python Testing Suite categories to use clearer, more descriptive names that better reflect what each suite actually does. Adds a database migration to update
existing test run execution records so that historical data remains intact after the rename.

Changes

  • sdk_python_tests.py — Updated the two suite name strings in _init_test_suites():
    • "Python Testing Suite" → "Python Testing Suite - Auto commissioning"
    • "Python Testing Suite - No commissioning" → "Python Testing Suite - No auto commissioning"

Both the plain and -custom suffixed variants are covered.

  • test_sdk_python_collection.py — Updated test assertions to reference the new suite names.

  • alembic/versions/b1f9e3d7c2a5_rename_python_suite_commissioning_.py — New Alembic migration that updates testsuiteexecution.public_id and testsuitemetadata.public_id / title /
    description for all affected rows, including -custom variants. A downgrade() path is included to revert the rename if needed.

Motivation

The original names were ambiguous — "Python Testing Suite" gave no indication that commissioning was involved, and "No commissioning" was easy to misread as "nothing was commissioned yet" rather than "commissioning is handled externally." The new names ("Auto commissioning" / "No auto commissioning") make the distinction explicit and consistent with the language used elsewhere in the tool.

Without the migration, the left panel in the UI would appear empty for any existing test run execution, because the frontend and backend use the suite public_id as a key to reconstruct execution state, and the DB would still hold the old names.

Impact

  • Breaking for existing DB records if the migration is not run — the left panel will be blank for historical executions until alembic upgrade head is applied.
  • No API contract changes; the rename is internal to suite metadata.
  • Custom test suites (side-loaded with -custom suffix) are also migrated, so they are not affected.

Related Issue

project-chip/certification-tool#978

Testing

  • Unit tests were updated and they are all passing

  • UI displays the renamed Python suites

Screenshot 2026-05-18 at 18 48 54 Screenshot 2026-05-18 at 18 49 00
  • Old execution displays the renamed suite name

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request renames the "Python Testing Suite" and its variants to "Python Testing Suite - Auto commissioning" and "Python Testing Suite - No auto commissioning" across database migrations, suite declarations, and unit tests. Feedback on the new Alembic migration script suggests refactoring the upgrade and downgrade logic into loops for better maintainability and ensuring that the metadata table is updated before the execution table to prevent potential foreign key constraint issues.

Comment thread alembic/versions/b1f9e3d7c2a5_rename_python_suite_commissioning_.py Outdated
Comment thread alembic/versions/b1f9e3d7c2a5_rename_python_suite_commissioning_.py Outdated
@rquidute
rquidute changed the base branch from v2.15-develop to v2.16-develop May 25, 2026 22:19
@oxesoft
oxesoft merged commit 9c21334 into v2.16-develop May 26, 2026
7 of 9 checks passed
@oxesoft
oxesoft deleted the feature/978_rename_python_script_suites branch May 26, 2026 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants