Fixing Backend's API for the CLI Test Run Execution (#283)

* Fixing Backend's API for the CLI Test Run Execution

* Gemini suggestions: Updating logic for efficiency

Also avoiding modifying external variable.

* Solve flake8 error in singleton.py file

Author: antonio-amjr

app/api/api_v1/endpoints/test_run_executions.py

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2023 Project CHIP Authors
+# Copyright (c) 2025 Project CHIP Authors
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -32,6 +32,7 @@
 from app.crud.crud_test_run_execution import ImportError
 from app.db.session import get_db
 from app.default_environment_config import default_environment_config
+from app.models.project import Project
 from app.models.test_run_execution import TestRunExecution
 from app.schemas.test_run_execution import TestRunExecutionUpdate
 from app.test_engine import TEST_ENGINE_ABORTING_TESTING_MESSAGE
@@ -123,6 +124,49 @@ def __convert_pics_dict_to_object(pics: dict) -> Optional[schemas.PICS]:
         return None
 
 
+def __cli_project(
+    db: Session,
+    project_id: Optional[int],
+    config: Optional[dict],
+    pics_obj: schemas.PICS,
+) -> Project:
+    """Retrieve or create the default CLI project."""
+
+    # If project_id not is provided, try to retrieve the Default CLI project
+    if project_id is None:
+        # If the default CLI project does not exist, create it
+        if not (
+            cli_project := crud.project.get_by_name(
+                db=db, name=DEFAULT_CLI_PROJECT_NAME
+            )
+        ):
+            new_config = (
+                default_environment_config.__dict__ if config is None else config
+            )
+            project_create = schemas.ProjectCreate(
+                name=DEFAULT_CLI_PROJECT_NAME, config=new_config, pics=pics_obj
+            )
+            return crud.project.create(db=db, obj_in=project_create)
+    else:
+        cli_project = crud.project.get(db=db, id=project_id)
+        if not cli_project:
+            raise HTTPException(
+                status_code=HTTPStatus.NOT_FOUND,
+                detail=f"Project with ID {project_id} not found.",
+            )
+
+    if config is not None:
+        logger.info(f"CLI Config Arguments: {config}")
+        project_update = schemas.ProjectUpdate(
+            name=cli_project.name, config=config, pics=pics_obj
+        )
+        cli_project = crud.project.update(
+            db=db, db_obj=cli_project, obj_in=project_update
+        )
+
+    return cli_project
+
+
 @router.post("/cli", response_model=schemas.TestRunExecutionWithChildren)
 def create_cli_test_run_execution(
     *,
@@ -140,55 +184,19 @@ def create_cli_test_run_execution(
         config: Configuration parameters (optional)
         pics: PICS configuration (optional)
     """
-    if config is None:
-        config = default_environment_config.__dict__
-
-    logger.info(f"CLI Config Arguments: {config}")
-    logger.info(f"CLI PICS Arguments: {pics}")
 
     # Convert pics dict to PICS object if provided
+    logger.info(f"CLI PICS Arguments: {pics}")
     pics_obj = __convert_pics_dict_to_object(pics)
     if pics_obj is None:
         raise HTTPException(
             status_code=HTTPStatus.UNPROCESSABLE_ENTITY,
             detail="Invalid PICS data provided. Please check the format.",
         )
 
-    # Use provided project_id or default CLI project
-    if test_run_execution_in.project_id is not None:
-        project = crud.project.get(db=db, id=test_run_execution_in.project_id)
-        # Use the specified project_id
-        if not project:
-            raise HTTPException(
-                status_code=HTTPStatus.NOT_FOUND,
-                detail=f"Project with id {test_run_execution_in.project_id} not found.",
-            )
-        project_update = schemas.ProjectUpdate(config=config)
-
-        if pics_obj:
-            project_update.pics = pics_obj
-
-        project = crud.project.update(db=db, db_obj=project, obj_in=project_update)
-    else:
-        # Retrieve the default CLI project
-        cli_project = crud.project.get_by_name(db=db, name=DEFAULT_CLI_PROJECT_NAME)
-
-        # If the default CLI project does not exist, create it
-        if not cli_project:
-            project_create = schemas.ProjectCreate(name=DEFAULT_CLI_PROJECT_NAME)
-            project_create.config = config
-            if pics_obj:
-                project_create.pics = pics_obj
-            project = crud.project.create(db=db, obj_in=project_create)
-        else:
-            # Update the default CLI project with the cli config argument and pics
-            project_update = schemas.ProjectUpdate(config=config)
-            if pics_obj:
-                project_update.pics = pics_obj
-            project = crud.project.update(
-                db=db, db_obj=cli_project, obj_in=project_update
-            )
-        test_run_execution_in.project_id = project.id
+    # Retrieve or create the CLI project
+    cli_project = __cli_project(db, test_run_execution_in.project_id, config, pics_obj)
+    test_run_execution_in.project_id = cli_project.id
 
     test_run_execution_in.certification_mode = False
 
@@ -386,13 +394,14 @@ def repeat_test_run_execution(
     date_now = formated_datetime_now_str()
     title += date_now
 
-    test_run_execution_in = schemas.TestRunExecutionCreate(title=title)
-    test_run_execution_in.description = execution_to_repeat.description
-    test_run_execution_in.project_id = execution_to_repeat.project_id
-    test_run_execution_in.operator_id = execution_to_repeat.operator_id
-    test_run_execution_in.certification_mode = execution_to_repeat.certification_mode
-    # TODO: Remove test_run_config completely from the project
-    test_run_execution_in.test_run_config_id = None
+    test_run_execution_in = schemas.TestRunExecutionCreate(
+        title=title,
+        description=execution_to_repeat.description,
+        project_id=execution_to_repeat.project_id,
+        operator_id=execution_to_repeat.operator_id,
+        certification_mode=execution_to_repeat.certification_mode,
+        test_run_config_id=None,
+    )
 
     selected_tests = selected_tests_from_execution(execution_to_repeat)
 

app/singleton.py

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2023 Project CHIP Authors
+# Copyright (c) 2025 Project CHIP Authors
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,11 +13,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-from typing import Any, Dict, Type
+from typing import Any, Dict, Type, TypeVar, cast
+
+T = TypeVar("T")
 
 
 class Singleton(type):
-    """This is a metaclass for declaring classes a singletons
+    """This is a metaclass for declaring classes as singletons
 
     usage:
     ```
@@ -27,7 +29,9 @@ class NewSingletonClass(baseClass, metaclass=Singleton):
 
     _instances: Dict[Type, object] = {}
 
-    def __call__(cls, *args: Any, **kwargs: Any) -> object:
-        if cls not in cls._instances:
-            cls._instances[cls] = super(Singleton, cls).__call__(*args, **kwargs)
-        return cls._instances[cls]
+    def __call__(cls: Type[T], *args: Any, **kwargs: Any) -> T:
+        if cls not in Singleton._instances:
+            Singleton._instances[cls] = super().__call__(  # type: ignore[misc]
+                *args, **kwargs
+            )
+        return cast(T, Singleton._instances[cls])

app/tests/api/api_v1/test_test_run_executions.py

@@ -1528,7 +1528,7 @@ def test_create_cli_test_run_execution_with_invalid_project_id_in_execution(
 
     assert response.status_code == HTTPStatus.NOT_FOUND
     data = response.json()
-    assert "Project with id 999 not found" in data["detail"]
+    assert "Project with ID 999 not found" in data["detail"]
 
 
 def test_create_cli_test_run_execution_without_project_id_in_execution_uses_default(
@@ -1612,6 +1612,8 @@ def test_create_cli_test_run_execution_creates_default_project_when_missing(
         description=test_run_execution_create.description,
         project_id=1,
         operator_id=1,
+        certification_mode=False,
+        state=TestStateEnum.PENDING,
     )
 
     with patch(
@@ -1623,7 +1625,10 @@ def test_create_cli_test_run_execution_creates_default_project_when_missing(
         "app.api.api_v1.endpoints.test_run_executions.crud.project.create",
         return_value=mock_new_project,
     ), patch(
-        "app.api.api_v1.endpoints.test_run_executions.create_test_run_execution",
+        "app.api.api_v1.endpoints.test_run_executions.crud.project.update",
+        return_value=mock_new_project,
+    ), patch(
+        "app.api.api_v1.endpoints.test_run_executions.crud.test_run_execution.create",
         return_value=mock_test_run,
     ):
         response = client.post(