tft-cli 0.0.23__py3-none-any.whl → 0.0.24__py3-none-any.whl

tft/cli/commands.py

@@ -278,6 +278,14 @@ def _option_reservation_duration(panel: str) -> int:
     )
 
 
+def _option_debug_reservation(panel: Optional[str] = None) -> bool:
+    return typer.Option(
+        False,
+        help="Enable debug messages in the reservation code. Useful for testing changes to reservation code.",
+        rich_help_panel=panel,
+    )
+
+
 def _generate_tmt_extra_args(step: str) -> Optional[List[str]]:
     return typer.Option(
         None,
@@ -395,7 +403,13 @@ def _localhost_ingress_rule(session: requests.Session) -> str:
         exit_error(f"Got {get_ip.status_code} while checking {settings.PUBLIC_IP_CHECKER_URL}")
 
 
-def _add_reservation(ssh_public_keys: List[str], rules: Dict[str, Any], duration: int, environment: Dict[str, Any]):
+def _add_reservation(
+    ssh_public_keys: List[str],
+    rules: Dict[str, Any],
+    duration: int,
+    environment: Dict[str, Any],
+    debug_reservation: bool,
+):
     """
     Add discovery of the reservation test to the given environment.
     """
@@ -423,6 +437,9 @@ def _add_reservation(ssh_public_keys: List[str], rules: Dict[str, Any], duration
 
     environment["variables"].update({"TF_RESERVATION_DURATION": str(duration)})
 
+    if debug_reservation:
+        environment["variables"].update({"TF_RESERVATION_DEBUG": "1"})
+
     if "tmt" not in environment or environment["tmt"] is None:
         environment["tmt"] = {"extra_args": {}}
 
@@ -770,6 +787,10 @@ def watch(
             _print_summary_table(request_summary, format)
             raise typer.Exit(code=2)
 
+        elif state in ["canceled", "cancel-requested"]:
+            _console_print("⚠️ pipeline cancelled", style="yellow")
+            raise typer.Exit(code=3)
+
         if no_wait:
             _print_summary_table(request_summary, format, show_details=False)
             raise typer.Exit()
@@ -877,6 +898,7 @@ def request(
     ssh_public_keys: List[str] = _option_ssh_public_keys(REQUEST_PANEL_RESERVE),
     autoconnect: bool = _option_autoconnect(REQUEST_PANEL_RESERVE),
     reservation_duration: int = _option_reservation_duration(REQUEST_PANEL_RESERVE),
+    debug_reservation: bool = _option_debug_reservation(REQUEST_PANEL_RESERVE),
 ):
     """
     Request testing from Testing Farm.
@@ -1066,7 +1088,11 @@ def request(
 
         for environment in environments:
             _add_reservation(
-                ssh_public_keys=ssh_public_keys, rules=rules, duration=reservation_duration, environment=environment
+                ssh_public_keys=ssh_public_keys,
+                rules=rules,
+                duration=reservation_duration,
+                environment=environment,
+                debug_reservation=debug_reservation,
             )
 
         machine_pre = "Machine" if len(environments) == 1 else str(len(environments)) + " machines"
@@ -1116,7 +1142,7 @@ def request(
     request["environments"] = environments
     request["settings"] = {}
 
-    if reserve or pipeline_type or parallel_limit:
+    if reserve or pipeline_type or parallel_limit or timeout != DEFAULT_PIPELINE_TIMEOUT:
         request["settings"]["pipeline"] = {}
 
     # in case the reservation duration is more than the pipeline timeout, adjust also the pipeline timeout
@@ -1128,6 +1154,11 @@ def request(
             request["settings"]["pipeline"] = {"timeout": timeout}
             console.print(f"⏳ Maximum reservation time is {timeout} minutes")
 
+    # forced pipeline timeout
+    elif timeout != DEFAULT_PIPELINE_TIMEOUT:
+        console.print(f"⏳ Pipeline timeout forced to {timeout} minutes")
+        request["settings"]["pipeline"] = {"timeout": timeout}
+
     if pipeline_type:
         request["settings"]["pipeline"]["type"] = pipeline_type.value
 
@@ -1217,6 +1248,7 @@ def restart(
     ssh_public_keys: List[str] = _option_ssh_public_keys(REQUEST_PANEL_RESERVE),
     autoconnect: bool = _option_autoconnect(REQUEST_PANEL_RESERVE),
     reservation_duration: int = _option_reservation_duration(REQUEST_PANEL_RESERVE),
+    debug_reservation: bool = _option_debug_reservation(REQUEST_PANEL_RESERVE),
 ):
     """
     Restart a Testing Farm request.
@@ -1401,7 +1433,11 @@ def restart(
 
         for environment in request["environments"]:
             _add_reservation(
-                ssh_public_keys=ssh_public_keys, rules=rules, duration=reservation_duration, environment=environment
+                ssh_public_keys=ssh_public_keys,
+                rules=rules,
+                duration=reservation_duration,
+                environment=environment,
+                debug_reservation=debug_reservation,
             )
 
         machine_pre = (
@@ -1560,6 +1596,10 @@ def run(
             if state in ["complete", "error"]:
                 break
 
+            if state in ["canceled", "cancel-requested"]:
+                progress.stop()
+                exit_error("Request canceled.")
+
             time.sleep(1)
 
         # workaround TFT-1690
@@ -1636,6 +1676,7 @@ def reserve(
     git_ref: Optional[str] = typer.Option(
         None, help="Force GIT ref or branch. Useful for testing changes to reservation plan."
     ),
+    debug_reservation: bool = _option_debug_reservation(),
 ):
     """
     Reserve a system in Testing Farm.
@@ -1726,7 +1767,14 @@ def reserve(
         environment["settings"]["provisioning"].update(rules)
 
     console.print(f"🕗 Reserved for [blue]{str(reservation_duration)}[/blue] minutes")
-    environment["variables"] = {"TF_RESERVATION_DURATION": str(reservation_duration)}
+
+    if "variables" not in environment or environment["variables"] is None:
+        environment["variables"] = {}
+
+    environment["variables"]["TF_RESERVATION_DURATION"] = str(reservation_duration)
+
+    if debug_reservation:
+        environment["variables"]["TF_RESERVATION_DEBUG"] = "1"
 
     authorized_keys = read_glob_paths(ssh_public_keys).encode("utf-8")
     if not authorized_keys:
@@ -1826,7 +1874,11 @@ def reserve(
             current_state = state
 
             if state in ["complete", "error"]:
-                exit_error("Reservation failed, check API request or contact Testing Farm")
+                exit_error("Reservation failed, check the API request or contact Testing Farm.")
+
+            if state in ["canceled", "cancel-requested"]:
+                progress.stop()
+                exit_error("Reservation canceled.")
 
             if not print_only_request_id and task_id is not None:
                 progress.update(task_id, description=f"Reservation job is [yellow]{current_state}[/yellow]")
@@ -1881,6 +1933,10 @@ def reserve(
                     )
                 )
 
+            if '[testing-farm-request] Cancelling pipeline' in pipeline_log:
+                progress.stop()
+                exit_error('Pipeline was canceled.')
+
             if '[pre-artifact-installation]' in pipeline_log:
                 current_state = "preparing environment"