tft-cli 0.0.25__py3-none-any.whl → 0.0.28__py3-none-any.whl

tft/cli/commands.py

@@ -3,6 +3,7 @@
 
 import base64
 import codecs
+import importlib.metadata
 import ipaddress
 import json
 import os
@@ -17,22 +18,24 @@ import xml.etree.ElementTree as ET
 from enum import Enum
 from typing import Any, Dict, List, Optional
 
-import pkg_resources
 import requests
 import typer
-from click.core import ParameterSource  # pyre-ignore[21]
+from click.core import ParameterSource
 from rich import print, print_json
 from rich.progress import Progress, SpinnerColumn, TextColumn
-from rich.table import Table
+from rich.table import Table  # type: ignore
 
 from tft.cli.config import settings
 from tft.cli.utils import (
     artifacts,
+    authorization_headers,
     check_unexpected_arguments,
     cmd_output_or_exit,
     console,
     console_stderr,
+    edit_with_editor,
     exit_error,
+    extract_uuid,
     hw_constraints,
     install_http_retries,
     normalize_multistring_option,
@@ -41,7 +44,7 @@ from tft.cli.utils import (
     uuid_valid,
 )
 
-cli_version: str = pkg_resources.get_distribution("tft-cli").version
+cli_version: str = importlib.metadata.version("tft-cli")
 
 TestingFarmRequestV1: Dict[str, Any] = {'test': {}, 'environments': None}
 Environment: Dict[str, Any] = {'arch': None, 'os': None, 'pool': None, 'artifacts': None, 'variables': {}}
@@ -66,6 +69,7 @@ RESERVE_REF = os.getenv("TESTING_FARM_RESERVE_REF", "main")
 RESERVE_TMT_DISCOVER_EXTRA_ARGS = f"--insert --how fmf --url {RESERVE_URL} --ref {RESERVE_REF} --test {RESERVE_TEST}"
 
 DEFAULT_PIPELINE_TIMEOUT = 60 * 12
+DEFAULT_AGE = "7d"
 
 # SSH command options for reservation connections
 SSH_RESERVATION_OPTIONS = (
@@ -85,6 +89,20 @@ class PipelineType(str, Enum):
     tmt_multihost = "tmt-multihost"
 
 
+class PipelineState(str, Enum):
+    new = "new"
+    queued = "queued"
+    running = "running"
+    complete = "complete"
+    error = "error"
+    canceled = "canceled"
+
+
+class Ranch(str, Enum):
+    public = "public"
+    redhat = "redhat"
+
+
 # Arguments and options that are shared among multiple commands
 ARGUMENT_API_URL: str = typer.Argument(
     settings.API_URL, envvar="TESTING_FARM_API_URL", metavar='', rich_help_panel='Environment variables'
@@ -99,6 +117,12 @@ ARGUMENT_API_TOKEN: str = typer.Argument(
     metavar='',
     rich_help_panel='Environment variables',
 )
+ARGUMENT_INTERNAL_API_URL: str = typer.Argument(
+    settings.INTERNAL_API_URL,
+    envvar="TESTING_FARM_INTERNAL_API_URL",
+    metavar='',
+    rich_help_panel='Environment variables',
+)
 OPTION_API_TOKEN: str = typer.Option(
     settings.API_TOKEN,
     envvar="TESTING_FARM_API_TOKEN",
@@ -106,6 +130,33 @@ OPTION_API_TOKEN: str = typer.Option(
     metavar='',
     rich_help_panel='Environment variables',
 )
+
+# Restart command specific arguments for source operations
+ARGUMENT_SOURCE_API_URL: str = typer.Argument(
+    None, envvar="TESTING_FARM_SOURCE_API_URL", metavar='', rich_help_panel='Environment variables'
+)
+ARGUMENT_INTERNAL_SOURCE_API_URL: str = typer.Argument(
+    None, envvar="TESTING_FARM_INTERNAL_SOURCE_API_URL", metavar='', rich_help_panel='Environment variables'
+)
+ARGUMENT_SOURCE_API_TOKEN: str = typer.Argument(
+    None,
+    envvar="TESTING_FARM_SOURCE_API_TOKEN",
+    show_default=False,
+    metavar='',
+    rich_help_panel='Environment variables',
+)
+
+# Restart command specific arguments for target operations
+ARGUMENT_TARGET_API_URL: str = typer.Argument(
+    None, envvar="TESTING_FARM_TARGET_API_URL", metavar='', rich_help_panel='Environment variables'
+)
+ARGUMENT_TARGET_API_TOKEN: str = typer.Argument(
+    None,
+    envvar="TESTING_FARM_TARGET_API_TOKEN",
+    show_default=False,
+    metavar='',
+    rich_help_panel='Environment variables',
+)
 OPTION_TMT_PLAN_NAME: Optional[str] = typer.Option(
     None,
     "--plan",
@@ -271,6 +322,13 @@ OPTION_RESERVE: bool = typer.Option(
     help="Reserve machine after testing, similarly to the `reserve` command.",
     rich_help_panel=REQUEST_PANEL_RESERVE,
 )
+OPTION_TMT_CONTEXT: Optional[List[str]] = typer.Option(
+    None,
+    "-c",
+    "--context",
+    metavar="key=value|@file",
+    help="Context variables to pass to `tmt`. The @ prefix marks a yaml file to load.",
+)
 
 
 def _option_autoconnect(panel: str) -> bool:
@@ -527,14 +585,6 @@ def _parse_security_group_rules(ingress_rules: List[str], egress_rules: List[str
     return security_group_rules
 
 
-def _get_headers(api_key: str) -> Dict[str, str]:
-    """
-    Return a dict with headers for a request to Testing Farm API.
-    Used for authentication.
-    """
-    return {'Authorization': f'Bearer {api_key}'}
-
-
 def _parse_xunit(xunit: str):
     """
     A helper that parses xunit file into sets of passed_plans/failed_plans/errored_plans per arch.
@@ -761,7 +811,7 @@ def watch(
                 _handle_reservation(session, api_url, request["id"], autoconnect)
                 return
 
-            time.sleep(1)
+            time.sleep(settings.WATCH_TICK)
             continue
 
         current_state = state
@@ -861,13 +911,7 @@ def request(
     hardware: List[str] = OPTION_HARDWARE,
     kickstart: Optional[List[str]] = OPTION_KICKSTART,
     pool: Optional[str] = OPTION_POOL,
-    cli_tmt_context: Optional[List[str]] = typer.Option(
-        None,
-        "-c",
-        "--context",
-        metavar="key=value|@file",
-        help="Context variables to pass to `tmt`. The @ prefix marks a yaml file to load.",
-    ),
+    cli_tmt_context: Optional[List[str]] = OPTION_TMT_CONTEXT,
     variables: Optional[List[str]] = OPTION_VARIABLES,
     secrets: Optional[List[str]] = OPTION_SECRETS,
     tmt_environment: Optional[List[str]] = typer.Option(
@@ -1065,7 +1109,7 @@ def request(
 
         if kickstart:
             # Typer escapes newlines in options, we need to unescape them
-            kickstart = [codecs.decode(value, 'unicode_escape') for value in kickstart]  # pyre-ignore[6]
+            kickstart = [codecs.decode(value, 'unicode_escape') for value in kickstart]
             environment["kickstart"] = options_to_dict("environment kickstart", kickstart)
 
         if redhat_brew_build:
@@ -1112,7 +1156,10 @@ def request(
         if len(environments) > 1:
             exit_error("Reservations are currently supported for a single plan, cannot continue")
 
-        rules = _parse_security_group_rules([_localhost_ingress_rule(session)], [])
+        # support cases where the user has multiple localhost addresses
+        rules = _parse_security_group_rules(
+            list({_localhost_ingress_rule(requests.Session()) for _ in range(0, settings.PUBLIC_IP_RESOLVE_TRIES)}), []
+        )
 
         for environment in environments:
             _add_reservation(
@@ -1215,7 +1262,7 @@ def request(
         raise typer.Exit()
 
     # handle errors
-    response = session.post(post_url, json=request, headers=_get_headers(api_token))
+    response = session.post(post_url, json=request, headers=authorization_headers(api_token))
     if response.status_code == 401:
         exit_error(f"API token is invalid. See {settings.ONBOARDING_DOCS} for more information.")
 
@@ -1239,13 +1286,13 @@ def restart(
     context: typer.Context,
     request_id: str = typer.Argument(..., help="Testing Farm request ID or a string containing it."),
     api_url: str = ARGUMENT_API_URL,
-    internal_api_url: str = typer.Argument(
-        settings.INTERNAL_API_URL,
-        envvar="TESTING_FARM_INTERNAL_API_URL",
-        metavar='',
-        rich_help_panel='Environment variables',
-    ),
+    internal_api_url: str = ARGUMENT_INTERNAL_API_URL,
     api_token: str = ARGUMENT_API_TOKEN,
+    source_api_url: Optional[str] = ARGUMENT_SOURCE_API_URL,
+    internal_source_api_url: Optional[str] = ARGUMENT_INTERNAL_SOURCE_API_URL,
+    source_api_token: Optional[str] = ARGUMENT_SOURCE_API_TOKEN,
+    target_api_url: Optional[str] = ARGUMENT_TARGET_API_URL,
+    target_api_token: Optional[str] = ARGUMENT_TARGET_API_TOKEN,
     compose: Optional[str] = typer.Option(
         None,
         help="Force compose used to provision test environment.",  # noqa
@@ -1254,6 +1301,8 @@ def restart(
         None,
         help="Force pool to provision.",
     ),
+    cli_tmt_context: Optional[List[str]] = OPTION_TMT_CONTEXT,
+    variables: Optional[List[str]] = OPTION_VARIABLES,
     git_url: Optional[str] = typer.Option(None, help="Force URL of the GIT repository to test."),
     git_ref: Optional[str] = typer.Option(None, help="Force GIT ref or branch to test."),
     git_merge_sha: Optional[str] = typer.Option(None, help="Force GIT ref or branch into which --ref will be merged."),
@@ -1277,6 +1326,13 @@ def restart(
     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),
+    edit: bool = typer.Option(
+        False,
+        help=(
+            "Edit the request JSON in editor before submitting. "
+            "Use the EDITOR environment variable to adjust the editor if needed."
+        ),
+    ),
 ):
     """
     Restart a Testing Farm request.
@@ -1285,30 +1341,39 @@ def restart(
     """
 
     # Accept these arguments only via environment variables
-    check_unexpected_arguments(context, "api_url", "api_token", "internal_api_url")
-
-    # UUID pattern
-    uuid_pattern = re.compile('[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}')
+    check_unexpected_arguments(
+        context,
+        "api_url",
+        "api_token",
+        "internal_api_url",
+        "source_api_url",
+        "internal_source_api_url",
+        "source_api_token",
+        "target_api_url",
+        "target_api_token",
+    )
 
-    # Find the UUID in the string
-    uuid_match = uuid_pattern.search(request_id)
+    # Determine source configuration (fallback to general settings)
+    effective_source_api_url = source_api_url or api_url
+    effective_internal_source_api_url = internal_source_api_url or internal_api_url
+    effective_source_api_token = source_api_token or api_token
 
-    if not uuid_match:
-        exit_error(f"Could not find a valid Testing Farm request id in '{request_id}'.")
-        return
+    # Determine target configuration (fallback to general settings)
+    effective_target_api_url = target_api_url or api_url
+    effective_target_api_token = target_api_token or api_token
 
-    # Extract the UUID from the match object
-    _request_id = uuid_match.group()
+    # Extract the UUID from the request_id string
+    _request_id = extract_uuid(request_id)
 
     # Construct URL to the internal API
-    get_url = urllib.parse.urljoin(str(internal_api_url), f"v0.1/requests/{_request_id}")
+    get_url = urllib.parse.urljoin(str(effective_internal_source_api_url), f"v0.1/requests/{_request_id}")
 
     # Setting up retries
     session = requests.Session()
     install_http_retries(session)
 
     # Get the request details
-    response = session.get(get_url, headers=_get_headers(api_token))
+    response = session.get(get_url, headers=authorization_headers(effective_source_api_token))
 
     if response.status_code == 401:
         exit_error(f"API token is invalid. See {settings.ONBOARDING_DOCS} for more information.")
@@ -1316,10 +1381,11 @@ def restart(
     # The API token is valid, but it doesn't own the request
     if response.status_code == 403:
         console.print(
-            "⚠️ [yellow] You are not the owner of this request. Any secrets associated with the request will not be included on the restart.[/yellow]"  # noqa: E501
+            "⚠️ [yellow] You are not the owner of this request. Any secrets associated with the "
+            "request will not be included on the restart.[/yellow]"
         )
-        # Construct URL to the internal API
-        get_url = urllib.parse.urljoin(str(api_url), f"v0.1/requests/{_request_id}")
+        # Construct URL to the API
+        get_url = urllib.parse.urljoin(str(effective_source_api_url), f"v0.1/requests/{_request_id}")
 
         # Get the request details
         response = session.get(get_url)
@@ -1332,9 +1398,9 @@ def restart(
     # Transform to a request
     request['environments'] = request['environments_requested']
 
-    # Remove all keys except test and environments
+    # Remove all keys except test, environments and settings
     for key in list(request):
-        if key not in ['test', 'environments']:
+        if key not in ['test', 'environments', 'settings']:
             del request[key]
 
     test = request['test']
@@ -1406,6 +1472,14 @@ def restart(
         for environment in request["environments"]:
             environment["tmt"]["extra_args"]["finish"] = tmt_finish
 
+    if cli_tmt_context:
+        for environment in request["environments"]:
+            environment["tmt"]["context"] = options_to_dict("tmt context", cli_tmt_context)
+
+    if variables:
+        for environment in request["environments"]:
+            environment["variables"] = options_to_dict("environment variables", variables)
+
     test_type = "fmf" if "fmf" in request["test"] else "sti"
 
     if tmt_plan_name:
@@ -1420,7 +1494,7 @@ def restart(
 
     if test_type == "fmf":
         # The method explained in https://github.com/fastapi/typer/discussions/668
-        if context.get_parameter_source("tmt_path") == ParameterSource.COMMANDLINE:  # pyre-ignore[16]
+        if context.get_parameter_source("tmt_path") == ParameterSource.COMMANDLINE:
             request["test"][test_type]["path"] = tmt_path
 
     # worker image
@@ -1460,7 +1534,10 @@ def restart(
         if len(request["environments"]) > 1:
             exit_error("Reservations are currently supported for a single plan, cannot continue")
 
-        rules = _parse_security_group_rules([_localhost_ingress_rule(session)], [])
+        # support cases where the user has multiple localhost addresses
+        rules = _parse_security_group_rules(
+            list({_localhost_ingress_rule(requests.Session()) for _ in range(0, settings.PUBLIC_IP_RESOLVE_TRIES)}), []
+        )
 
         for environment in request["environments"]:
             _add_reservation(
@@ -1478,6 +1555,18 @@ def restart(
             f"🕗 {machine_pre} will be reserved after testing for [blue]{str(reservation_duration)}[/blue] minutes"
         )
 
+    # edit request if requested
+    if edit:
+        while True:
+            try:
+                request = json.loads(edit_with_editor(json.dumps(request, indent=2), "editing request"))
+                break
+            except (TypeError, ValueError) as error:
+                console.print(f"⛔ Edited request is not a valid JSON, cannot continue: {error}", style="red")
+                if typer.confirm("❓️ Edit again?"):
+                    continue
+                raise typer.Exit(code=255)
+
     # dry run
     if dry_run:
         console.print("🔍 Dry run, showing POST json only", style="bright_yellow")
@@ -1485,10 +1574,10 @@ def restart(
         raise typer.Exit()
 
     # submit request to Testing Farm
-    post_url = urllib.parse.urljoin(str(api_url), "v0.1/requests")
+    post_url = urllib.parse.urljoin(str(effective_target_api_url), "v0.1/requests")
 
     # handle errors
-    response = session.post(post_url, json=request, headers=_get_headers(api_token))
+    response = session.post(post_url, json=request, headers=authorization_headers(effective_target_api_token))
     if response.status_code == 401:
         exit_error(f"API token is invalid. See {settings.ONBOARDING_DOCS} for more information.")
 
@@ -1505,7 +1594,7 @@ def restart(
     # watch
     watch(
         context,
-        str(api_url),
+        str(effective_target_api_url),
         response.json()['id'],
         no_wait,
         reserve=reserve,
@@ -1586,7 +1675,7 @@ def run(
             raise typer.Exit()
 
     # handle errors
-    response = session.post(post_url, json=request, headers=_get_headers(api_token))
+    response = session.post(post_url, json=request, headers=authorization_headers(api_token))
     if response.status_code == 401:
         exit_error(f"API token is invalid. See {settings.ONBOARDING_DOCS} for more information.")
 
@@ -1630,7 +1719,7 @@ def run(
             state = request["state"]
 
             if state == current_state:
-                time.sleep(1)
+                time.sleep(settings.WATCH_TICK)
                 continue
 
             current_state = state
@@ -1642,7 +1731,7 @@ def run(
                 progress.stop()
                 exit_error("Request canceled.")
 
-            time.sleep(1)
+            time.sleep(settings.WATCH_TICK)
 
         # workaround TFT-1690
         install_http_retries(session, status_forcelist_extend=[404], timeout=60, retry_backoff_factor=0.1)
@@ -1786,7 +1875,7 @@ def reserve(
 
     if kickstart:
         # Typer escapes newlines in options, we need to unescape them
-        kickstart = [codecs.decode(value, 'unicode_escape') for value in kickstart]  # pyre-ignore[6]
+        kickstart = [codecs.decode(value, 'unicode_escape') for value in kickstart]
         environment["kickstart"] = options_to_dict("environment kickstart", kickstart)
 
     if redhat_brew_build:
@@ -1826,7 +1915,10 @@ def reserve(
     if not skip_workstation_access or security_group_rule_ingress or security_group_rule_egress:
         ingress_rules = security_group_rule_ingress or []
         if not skip_workstation_access:
-            ingress_rules.append(_localhost_ingress_rule(session))
+            # support cases where the user has multiple localhost addresses
+            ingress_rules.extend(
+                {_localhost_ingress_rule(requests.Session()) for _ in range(0, settings.PUBLIC_IP_RESOLVE_TRIES)}
+            )
 
         rules = _parse_security_group_rules(ingress_rules, security_group_rule_egress or [])
         environment["settings"]["provisioning"].update(rules)
@@ -1880,7 +1972,7 @@ def reserve(
         raise typer.Exit()
 
     # handle errors
-    response = session.post(post_url, json=request, headers=_get_headers(api_token))
+    response = session.post(post_url, json=request, headers=authorization_headers(api_token))
     if response.status_code == 401:
         exit_error(f"API token is invalid. See {settings.ONBOARDING_DOCS} for more information.")
 
@@ -1933,7 +2025,7 @@ def reserve(
             state = request["state"]
 
             if state == current_state:
-                time.sleep(1)
+                time.sleep(settings.WATCH_TICK)
                 continue
 
             current_state = state
@@ -1948,7 +2040,7 @@ def reserve(
             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]")
 
-            time.sleep(1)
+            time.sleep(settings.WATCH_TICK)
 
         while current_state != "ready":
             if not print_only_request_id and task_id:
@@ -2015,7 +2107,7 @@ def reserve(
                 current_state = "ready"
                 guest = search.group(1)
 
-            time.sleep(1)
+            time.sleep(settings.WATCH_TICK)
 
     console.print(f"🌎 ssh root@{guest}")
 
@@ -2046,23 +2138,13 @@ def cancel(
     # Accept these arguments only via environment variables
     check_unexpected_arguments(context, "api_url", "api_token")
 
-    # UUID pattern
-    uuid_pattern = re.compile('[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}')
-
-    # Find the UUID in the string
-    uuid_match = uuid_pattern.search(request_id)
-
-    if not uuid_match:
-        exit_error(f"Could not find a valid Testing Farm request id in '{request_id}'.")
-        return
+    # Extract the UUID from the request_id string
+    _request_id = extract_uuid(request_id)
 
     if not api_token:
         exit_error("No API token found in the environment, please export 'TESTING_FARM_API_TOKEN' variable.")
         return
 
-    # Extract the UUID from the match object
-    _request_id = uuid_match.group()
-
     # Construct URL to the internal API
     request_url = urllib.parse.urljoin(str(api_url), f"v0.1/requests/{_request_id}")
 
@@ -2071,11 +2153,17 @@ def cancel(
     install_http_retries(session)
 
     # Get the request details
-    response = session.delete(request_url, headers=_get_headers(api_token))
+    response = session.delete(request_url, headers=authorization_headers(api_token))
 
     if response.status_code == 401:
         exit_error(f"API token is invalid. See {settings.ONBOARDING_DOCS} for more information.")
 
+    if response.status_code == 403:
+        exit_error(
+            "You cannot cancel foreign requests. You can only cancel your own requests "
+            "or must have 'admin' permissions."
+        )
+
     if response.status_code == 404:
         exit_error("Request was not found. Verify the request ID is correct.")
 

tft/cli/config.py

@@ -1,7 +1,7 @@
 # Copyright Contributors to the Testing Farm project.
 # SPDX-License-Identifier: Apache-2.0
 
-from dynaconf import LazySettings
+from dynaconf import LazySettings  # type: ignore
 
 settings = LazySettings(
     # all environment variables have `TESTING_FARM_` prefix
@@ -10,11 +10,18 @@ settings = LazySettings(
     API_URL="https://api.dev.testing-farm.io/v0.1",
     INTERNAL_API_URL="https://internal.api.dev.testing-farm.io/v0.1",
     API_TOKEN=None,
+    # Restart command specific source API configuration (fallback to general settings)
+    SOURCE_API_URL=None,
+    INTERNAL_SOURCE_API_URL=None,
+    SOURCE_API_TOKEN=None,
+    # Restart command specific target API configuration (fallback to general settings)
+    TARGET_API_URL=None,
+    TARGET_API_TOKEN=None,
     ISSUE_TRACKER="https://gitlab.com/testing-farm/general/-/issues/new",
     STATUS_PAGE="https://status.testing-farm.io",
-    ONBOARDING_DOCS="https://docs.testing-farm.io/general/0.1/onboarding.html",
+    ONBOARDING_DOCS="https://docs.testing-farm.io/Testing%20Farm/0.1/onboarding.html",
     CONTAINER_SIGN="/.testing-farm-container",
-    WATCH_TICK=3,
+    WATCH_TICK=30,
     DEFAULT_API_TIMEOUT=10,
     DEFAULT_API_RETRIES=7,
     # default reservation duration in minutes
@@ -27,4 +34,6 @@ settings = LazySettings(
     TESTING_FARM_TESTS_GIT_URL="https://gitlab.com/testing-farm/tests",
     TESTING_FARM_SANITY_PLAN="/testing-farm/sanity",
     PUBLIC_IP_CHECKER_URL="https://ipv4.icanhazip.com",
+    # number or tries for resolving localhost public IP, useful if the user has multiple IPs
+    PUBLIC_IP_RESOLVE_TRIES=1,
 )

tft/cli/tool.py

@@ -6,11 +6,13 @@ import os
 import typer
 
 import tft.cli.commands as commands
+from tft.cli.command.listing import listing
 from tft.cli.config import settings
 
 app = typer.Typer()
 
 app.command()(commands.cancel)
+app.command(name="list")(listing)
 app.command()(commands.request)
 app.command()(commands.restart)
 app.command()(commands.reserve)