tft-cli 0.0.26__py3-none-any.whl → 0.0.29__py3-none-any.whl

tft/cli/commands.py

@@ -20,19 +20,22 @@ from typing import Any, Dict, List, Optional
 
 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,
@@ -65,8 +68,12 @@ RESERVE_URL = os.getenv("TESTING_FARM_RESERVE_URL", "https://gitlab.com/testing-
 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}"
 
+# NOTE(mvadkert): note that reservation duration is different per ranch,
+# ignore this fact for now here for reservations
 DEFAULT_PIPELINE_TIMEOUT = 60 * 12
 
+DEFAULT_AGE = "7d"
+
 # SSH command options for reservation connections
 SSH_RESERVATION_OPTIONS = (
     "ssh -oStrictHostKeyChecking=no -oUserKnownHostsFile=/dev/null -oServerAliveInterval=60 -oServerAliveCountMax=3"
@@ -85,6 +92,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 +120,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 +133,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",
@@ -278,6 +332,17 @@ OPTION_TMT_CONTEXT: Optional[List[str]] = typer.Option(
     metavar="key=value|@file",
     help="Context variables to pass to `tmt`. The @ prefix marks a yaml file to load.",
 )
+OPTION_TMT_ENVIRONMENT: Optional[List[str]] = typer.Option(
+    None,
+    "-T",
+    "--tmt-environment",
+    metavar="key=value|@file",
+    help=(
+        "Environment variables to pass to the tmt process. "
+        "Used to configure tmt report plugins like reportportal or polarion. "
+        "The @ prefix marks a yaml file to load."
+    ),
+)
 
 
 def _option_autoconnect(panel: str) -> bool:
@@ -427,6 +492,24 @@ def _localhost_ingress_rule(session: requests.Session) -> str:
         exit_error(f"Got {get_ip.status_code} while checking {settings.PUBLIC_IP_CHECKER_URL}")
 
 
+def _extend_test_name_for_reservation(tmt_test_name: Optional[str]) -> Optional[str]:
+    """
+    Extend test name to include the reservation test when --reserve is used.
+    """
+    if tmt_test_name:
+        return f"{tmt_test_name}|{RESERVE_TEST}"
+    return None
+
+
+def _extend_test_filter_for_reservation(tmt_test_filter: Optional[str]) -> Optional[str]:
+    """
+    Extend test filter to include the reservation test when --reserve is used.
+    """
+    if tmt_test_filter:
+        return f"{tmt_test_filter} | name:{RESERVE_TEST}"
+    return None
+
+
 def _add_reservation(
     ssh_public_keys: List[str],
     rules: Dict[str, Any],
@@ -534,14 +617,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.
@@ -835,9 +910,14 @@ def request(
     context: typer.Context,
     api_url: str = ARGUMENT_API_URL,
     api_token: str = ARGUMENT_API_TOKEN,
-    timeout: int = typer.Option(
-        DEFAULT_PIPELINE_TIMEOUT,
-        help="Set the timeout for the request in minutes. If the test takes longer than this, it will be terminated.",
+    timeout: Optional[int] = typer.Option(
+        None,
+        help=(
+            "Set the timeout for the request in minutes. "
+            "If the request takes longer than this, it will be terminated. "
+            "The timeout is counted from the time the request is switched to the running state."
+            "For default timeout see https://docs.testing-farm.io/Testing%20Farm/0.1/test-request.html."
+        ),
     ),
     test_type: str = typer.Option("fmf", help="Test type to use, if not set autodetected."),
     tmt_plan_name: Optional[str] = OPTION_TMT_PLAN_NAME,
@@ -871,17 +951,7 @@ def request(
     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(
-        None,
-        "-T",
-        "--tmt-environment",
-        metavar="key=value|@file",
-        help=(
-            "Environment variables to pass to the tmt process. "
-            "Used to configure tmt report plugins like reportportal or polarion. "
-            "The @ prefix marks a yaml file to load."
-        ),
-    ),
+    tmt_environment: Optional[List[str]] = OPTION_TMT_ENVIRONMENT,
     no_wait: bool = typer.Option(False, help="Skip waiting for request completion."),
     worker_image: Optional[str] = OPTION_WORKER_IMAGE,
     redhat_brew_build: List[str] = OPTION_REDHAT_BREW_BUILD,
@@ -1027,10 +1097,16 @@ def request(
         test["plan_filter"] = tmt_plan_filter
 
     if tmt_test_name:
-        test["test_name"] = tmt_test_name
+        if reserve:
+            test["test_name"] = _extend_test_name_for_reservation(tmt_test_name)
+        else:
+            test["test_name"] = tmt_test_name
 
     if tmt_test_filter:
-        test["test_filter"] = tmt_test_filter
+        if reserve:
+            test["test_filter"] = _extend_test_filter_for_reservation(tmt_test_filter)
+        else:
+            test["test_filter"] = tmt_test_filter
 
     if sti_playbooks:
         test["playbooks"] = sti_playbooks
@@ -1066,7 +1142,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:
@@ -1113,7 +1189,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(
@@ -1171,11 +1250,14 @@ def request(
     request["environments"] = environments
     request["settings"] = {}
 
-    if reserve or pipeline_type or parallel_limit or timeout != DEFAULT_PIPELINE_TIMEOUT:
+    forced_pipeline_timeout = context.get_parameter_source("timeout") == ParameterSource.COMMANDLINE
+
+    if reserve or pipeline_type or parallel_limit or forced_pipeline_timeout:
         request["settings"]["pipeline"] = {}
 
     # in case the reservation duration is more than the pipeline timeout, adjust also the pipeline timeout
     if reserve:
+        timeout = timeout or DEFAULT_PIPELINE_TIMEOUT
         if reservation_duration > timeout:
             request["settings"]["pipeline"] = {"timeout": reservation_duration}
             console.print(f"⏳ Maximum reservation time is {reservation_duration} minutes")
@@ -1184,7 +1266,7 @@ def request(
             console.print(f"⏳ Maximum reservation time is {timeout} minutes")
 
     # forced pipeline timeout
-    elif timeout != DEFAULT_PIPELINE_TIMEOUT:
+    elif forced_pipeline_timeout:
         console.print(f"⏳ Pipeline timeout forced to {timeout} minutes")
         request["settings"]["pipeline"] = {"timeout": timeout}
 
@@ -1216,7 +1298,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.")
 
@@ -1240,13 +1322,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
@@ -1280,6 +1362,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.
@@ -1288,30 +1377,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.")
@@ -1319,10 +1417,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)
@@ -1360,10 +1459,16 @@ def restart(
         test["ref"] = git_ref
 
     if tmt_test_name:
-        test["test_name"] = tmt_test_name
+        if reserve:
+            test["test_name"] = _extend_test_name_for_reservation(tmt_test_name)
+        else:
+            test["test_name"] = tmt_test_name
 
     if tmt_test_filter:
-        test["test_filter"] = tmt_test_filter
+        if reserve:
+            test["test_filter"] = _extend_test_filter_for_reservation(tmt_test_filter)
+        else:
+            test["test_filter"] = tmt_test_filter
 
     merge_sha_info = ""
     if git_merge_sha:
@@ -1431,7 +1536,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
@@ -1471,7 +1576,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(
@@ -1489,6 +1597,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")
@@ -1496,10 +1616,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.")
 
@@ -1516,7 +1636,7 @@ def restart(
     # watch
     watch(
         context,
-        str(api_url),
+        str(effective_target_api_url),
         response.json()['id'],
         no_wait,
         reserve=reserve,
@@ -1597,7 +1717,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.")
 
@@ -1715,6 +1835,7 @@ def reserve(
     repository: List[str] = OPTION_REPOSITORY,
     repository_file: List[str] = OPTION_REPOSITORY_FILE,
     redhat_brew_build: List[str] = OPTION_REDHAT_BREW_BUILD,
+    tmt_environment: Optional[List[str]] = OPTION_TMT_ENVIRONMENT,
     tmt_discover: Optional[List[str]] = _generate_tmt_extra_args("discover"),
     tmt_prepare: Optional[List[str]] = _generate_tmt_extra_args("prepare"),
     tmt_finish: Optional[List[str]] = _generate_tmt_extra_args("finish"),
@@ -1797,7 +1918,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:
@@ -1830,6 +1951,12 @@ def reserve(
         if tmt_finish:
             environment["tmt"]["extra_args"]["finish"] = tmt_finish
 
+    if tmt_environment:
+        if "tmt" not in environment:
+            environment["tmt"] = {}
+
+        environment["tmt"].update({"environment": options_to_dict("tmt environment variables", tmt_environment)})
+
     # Setting up retries
     session = requests.Session()
     install_http_retries(session)
@@ -1837,7 +1964,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)
@@ -1891,7 +2021,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.")
 
@@ -2057,23 +2187,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}")
 
@@ -2082,11 +2202,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,6 +10,13 @@ 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/Testing%20Farm/0.1/onboarding.html",
@@ -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)