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

tft/cli/commands.py

@@ -2,6 +2,8 @@
 # SPDX-License-Identifier: Apache-2.0
 
 import base64
+import codecs
+import importlib.metadata
 import ipaddress
 import json
 import os
@@ -16,7 +18,6 @@ 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]
@@ -27,6 +28,7 @@ from rich.table import Table
 from tft.cli.config import settings
 from tft.cli.utils import (
     artifacts,
+    check_unexpected_arguments,
     cmd_output_or_exit,
     console,
     console_stderr,
@@ -39,7 +41,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': {}}
@@ -65,6 +67,11 @@ RESERVE_TMT_DISCOVER_EXTRA_ARGS = f"--insert --how fmf --url {RESERVE_URL} --ref
 
 DEFAULT_PIPELINE_TIMEOUT = 60 * 12
 
+# SSH command options for reservation connections
+SSH_RESERVATION_OPTIONS = (
+    "ssh -oStrictHostKeyChecking=no -oUserKnownHostsFile=/dev/null -oServerAliveInterval=60 -oServerAliveCountMax=3"
+)
+
 # Won't be validating CIDR and 65535 max port range with regex here, not worth it
 SECURITY_GROUP_RULE_FORMAT = re.compile(r"(tcp|ip|icmp|udp|-1|[0-255]):(.*):(\d{1,5}-\d{1,5}|\d{1,5}|-1)")
 
@@ -82,6 +89,9 @@ class PipelineType(str, Enum):
 ARGUMENT_API_URL: str = typer.Argument(
     settings.API_URL, envvar="TESTING_FARM_API_URL", metavar='', rich_help_panel='Environment variables'
 )
+OPTION_API_URL: str = typer.Option(
+    settings.API_URL, envvar="TESTING_FARM_API_URL", metavar='', rich_help_panel='Environment variables'
+)
 ARGUMENT_API_TOKEN: str = typer.Argument(
     settings.API_TOKEN,
     envvar="TESTING_FARM_API_TOKEN",
@@ -89,6 +99,13 @@ ARGUMENT_API_TOKEN: str = typer.Argument(
     metavar='',
     rich_help_panel='Environment variables',
 )
+OPTION_API_TOKEN: str = typer.Option(
+    settings.API_TOKEN,
+    envvar="TESTING_FARM_API_TOKEN",
+    show_default=False,
+    metavar='',
+    rich_help_panel='Environment variables',
+)
 OPTION_TMT_PLAN_NAME: Optional[str] = typer.Option(
     None,
     "--plan",
@@ -254,6 +271,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:
@@ -326,12 +350,12 @@ def _sanity_reserve() -> None:
         exit_error("No SSH identities found in the SSH agent. Please run `ssh-add`.")
 
 
-def _handle_reservation(session, request_id: str, autoconnect: bool = False) -> None:
+def _handle_reservation(session, api_url: str, request_id: str, autoconnect: bool = False) -> None:
     """
     Handle the reservation for :py:func:``request`` and :py:func:``restart`` commands.
     """
     # Get artifacts url
-    request_url = urllib.parse.urljoin(settings.API_URL, f"/v0.1/requests/{request_id}")
+    request_url = urllib.parse.urljoin(api_url, f"/v0.1/requests/{request_id}")
     response = session.get(request_url)
     artifacts_url = response.json()['run']['artifacts']
 
@@ -386,7 +410,7 @@ def _handle_reservation(session, request_id: str, autoconnect: bool = False) ->
         console.print(f"🌎 ssh root@{guests[0]}")
 
     if autoconnect:
-        os.system(f"ssh -oStrictHostKeyChecking=no -oUserKnownHostsFile=/dev/null root@{guests[0]}")  # noqa: E501
+        os.system(f"{SSH_RESERVATION_OPTIONS} root@{guests[0]}")  # noqa: E501
 
 
 def _localhost_ingress_rule(session: requests.Session) -> str:
@@ -397,7 +421,7 @@ def _localhost_ingress_rule(session: requests.Session) -> str:
 
     if get_ip.ok:
         ip = get_ip.text.strip()
-        return f"-1:{ip}:-1"
+        return f"-1:{ip}:-1"  # noqa: E231
 
     else:
         exit_error(f"Got {get_ip.status_code} while checking {settings.PUBLIC_IP_CHECKER_URL}")
@@ -666,21 +690,25 @@ def _print_summary_table(summary: dict, format: Optional[WatchFormat], show_deta
 
 
 def watch(
-    api_url: str = typer.Option(settings.API_URL, help="Testing Farm API URL."),
+    context: typer.Context,
+    api_url: str = ARGUMENT_API_URL,
     id: str = typer.Option(..., help="Request ID to watch"),
     no_wait: bool = typer.Option(False, help="Skip waiting for request completion."),
     format: Optional[WatchFormat] = typer.Option(WatchFormat.text, help="Output format"),
     autoconnect: bool = typer.Option(True, hidden=True),
     reserve: bool = typer.Option(False, hidden=True),
 ):
+    """Watch request for completion."""
+
+    # Accept these arguments only via environment variables
+    check_unexpected_arguments(context, "api_url")
+
     def _console_print(*args, **kwargs):
         """A helper function that will skip printing to console if output format is json"""
         if format == WatchFormat.json:
             return
         console.print(*args, **kwargs)
 
-    """Watch request for completion."""
-
     if not uuid_valid(id):
         exit_error("invalid request id")
 
@@ -737,10 +765,10 @@ def watch(
         if state == current_state:
             # check for reservation status and finish early if reserved
             if reserve and _is_reserved(session, request):
-                _handle_reservation(session, request["id"], autoconnect)
+                _handle_reservation(session, api_url, request["id"], autoconnect)
                 return
 
-            time.sleep(1)
+            time.sleep(settings.WATCH_TICK)
             continue
 
         current_state = state
@@ -804,6 +832,7 @@ def version():
 
 
 def request(
+    context: typer.Context,
     api_url: str = ARGUMENT_API_URL,
     api_token: str = ARGUMENT_API_TOKEN,
     timeout: int = typer.Option(
@@ -839,13 +868,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(
@@ -903,6 +926,10 @@ def request(
     """
     Request testing from Testing Farm.
     """
+
+    # Accept these arguments only via environment variables
+    check_unexpected_arguments(context, "api_url", "api_token")
+
     # Split comma separated arches
     arches = normalize_multistring_option(arches)
 
@@ -1038,6 +1065,8 @@ def request(
             environment["hardware"] = hw_constraints(hardware)
 
         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]
             environment["kickstart"] = options_to_dict("environment kickstart", kickstart)
 
         if redhat_brew_build:
@@ -1204,7 +1233,7 @@ def request(
     request_id = response.json()['id']
 
     # Watch the request and handle reservation
-    watch(api_url, request_id, no_wait, reserve=reserve, autoconnect=autoconnect, format=WatchFormat.text)
+    watch(context, api_url, request_id, no_wait, reserve=reserve, autoconnect=autoconnect, format=WatchFormat.text)
 
 
 def restart(
@@ -1226,6 +1255,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."),
@@ -1256,6 +1287,9 @@ def restart(
     Just pass a request ID or an URL with a request ID to restart it.
     """
 
+    # 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}')
 
@@ -1301,9 +1335,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']
@@ -1375,6 +1409,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:
@@ -1473,11 +1515,18 @@ def restart(
 
     # watch
     watch(
-        str(api_url), response.json()['id'], no_wait, reserve=reserve, autoconnect=autoconnect, format=WatchFormat.text
+        context,
+        str(api_url),
+        response.json()['id'],
+        no_wait,
+        reserve=reserve,
+        autoconnect=autoconnect,
+        format=WatchFormat.text,
     )
 
 
 def run(
+    context: typer.Context,
     arch: str = typer.Option("x86_64", "--arch", help="Hardware platform of the target machine."),
     compose: Optional[str] = typer.Option(
         None,
@@ -1489,6 +1538,10 @@ def run(
     secrets: Optional[List[str]] = OPTION_SECRETS,
     dry_run: bool = OPTION_DRY_RUN,
     verbose: bool = typer.Option(False, help="Be verbose."),
+    # NOTE: we cannot use ARGUMENT_API_* because it would collide with command,
+    # so use rather OPTION variants for this command
+    api_url: str = OPTION_API_URL,
+    api_token: str = OPTION_API_TOKEN,
     command: List[str] = typer.Argument(..., help="Command to run. Use `--` to separate COMMAND from CLI options."),
 ):
     """
@@ -1496,7 +1549,7 @@ def run(
     """
 
     # check for token
-    if not settings.API_TOKEN:
+    if not api_token:
         exit_error("No API token found, export `TESTING_FARM_API_TOKEN` environment variable.")
 
     # create request
@@ -1530,7 +1583,7 @@ def run(
     request["environments"] = [environment]
 
     # submit request to Testing Farm
-    post_url = urllib.parse.urljoin(str(settings.API_URL), "v0.1/requests")
+    post_url = urllib.parse.urljoin(api_url, "v0.1/requests")
 
     # Setting up retries
     session = requests.Session()
@@ -1544,7 +1597,7 @@ def run(
             raise typer.Exit()
 
     # handle errors
-    response = session.post(post_url, json=request, headers=_get_headers(settings.API_TOKEN))
+    response = session.post(post_url, json=request, headers=_get_headers(api_token))
     if response.status_code == 401:
         exit_error(f"API token is invalid. See {settings.ONBOARDING_DOCS} for more information.")
 
@@ -1556,7 +1609,7 @@ def run(
         exit_error(f"Unexpected error. Please file an issue to {settings.ISSUE_TRACKER}.")
 
     id = response.json()['id']
-    get_url = urllib.parse.urljoin(str(settings.API_URL), f"/v0.1/requests/{id}")
+    get_url = urllib.parse.urljoin(api_url, f"/v0.1/requests/{id}")
 
     if verbose:
         console.print(f"🔎 api [blue]{get_url}[/blue]")
@@ -1588,7 +1641,7 @@ def run(
             state = request["state"]
 
             if state == current_state:
-                time.sleep(1)
+                time.sleep(settings.WATCH_TICK)
                 continue
 
             current_state = state
@@ -1600,7 +1653,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)
@@ -1640,6 +1693,9 @@ def run(
 
 
 def reserve(
+    context: typer.Context,
+    api_url: str = ARGUMENT_API_URL,
+    api_token: str = ARGUMENT_API_TOKEN,
     ssh_public_keys: List[str] = _option_ssh_public_keys(RESERVE_PANEL_GENERAL),
     reservation_duration: int = _option_reservation_duration(RESERVE_PANEL_GENERAL),
     arch: str = typer.Option(
@@ -1659,6 +1715,9 @@ def reserve(
     repository: List[str] = OPTION_REPOSITORY,
     repository_file: List[str] = OPTION_REPOSITORY_FILE,
     redhat_brew_build: List[str] = OPTION_REDHAT_BREW_BUILD,
+    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"),
     dry_run: bool = OPTION_DRY_RUN,
     post_install_script: Optional[str] = OPTION_POST_INSTALL_SCRIPT,
     print_only_request_id: bool = typer.Option(
@@ -1688,6 +1747,9 @@ def reserve(
 
     _sanity_reserve()
 
+    # Accept these arguments only via environment variables
+    check_unexpected_arguments(context, "api_url", "api_token")
+
     # check for token
     if not settings.API_TOKEN:
         exit_error("No API token found, export `TESTING_FARM_API_TOKEN` environment variable.")
@@ -1734,6 +1796,8 @@ def reserve(
         environment["settings"]["provisioning"]["tags"] = options_to_dict("tags", tags)
 
     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]
         environment["kickstart"] = options_to_dict("environment kickstart", kickstart)
 
     if redhat_brew_build:
@@ -1754,6 +1818,18 @@ def reserve(
     if post_install_script:
         environment["settings"]["provisioning"]["post_install_script"] = post_install_script
 
+    if tmt_discover or tmt_prepare or tmt_finish:
+        environment["tmt"] = {"extra_args": {}}
+
+        if tmt_discover:
+            environment["tmt"]["extra_args"]["discover"] = tmt_discover
+
+        if tmt_prepare:
+            environment["tmt"]["extra_args"]["prepare"] = tmt_prepare
+
+        if tmt_finish:
+            environment["tmt"]["extra_args"]["finish"] = tmt_finish
+
     # Setting up retries
     session = requests.Session()
     install_http_retries(session)
@@ -1803,7 +1879,7 @@ def reserve(
         console.print(f"⏳ Maximum reservation time is {DEFAULT_PIPELINE_TIMEOUT} minutes")
 
     # submit request to Testing Farm
-    post_url = urllib.parse.urljoin(str(settings.API_URL), "v0.1/requests")
+    post_url = urllib.parse.urljoin(api_url, "v0.1/requests")
 
     # dry run
     if dry_run:
@@ -1815,7 +1891,7 @@ def reserve(
         raise typer.Exit()
 
     # handle errors
-    response = session.post(post_url, json=request, headers=_get_headers(settings.API_TOKEN))
+    response = session.post(post_url, json=request, headers=_get_headers(api_token))
     if response.status_code == 401:
         exit_error(f"API token is invalid. See {settings.ONBOARDING_DOCS} for more information.")
 
@@ -1830,7 +1906,7 @@ def reserve(
         exit_error(f"Unexpected error. Please file an issue to {settings.ISSUE_TRACKER}.")
 
     id = response.json()['id']
-    get_url = urllib.parse.urljoin(str(settings.API_URL), f"/v0.1/requests/{id}")
+    get_url = urllib.parse.urljoin(api_url, f"/v0.1/requests/{id}")
 
     if not print_only_request_id:
         console.print(f"🔎 [blue]{get_url}[/blue]")
@@ -1868,7 +1944,7 @@ def reserve(
             state = request["state"]
 
             if state == current_state:
-                time.sleep(1)
+                time.sleep(settings.WATCH_TICK)
                 continue
 
             current_state = state
@@ -1883,7 +1959,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:
@@ -1950,12 +2026,12 @@ def reserve(
                 current_state = "ready"
                 guest = search.group(1)
 
-            time.sleep(1)
+            time.sleep(settings.WATCH_TICK)
 
     console.print(f"🌎 ssh root@{guest}")
 
     if autoconnect:
-        os.system(f"ssh -oStrictHostKeyChecking=no -oUserKnownHostsFile=/dev/null root@{guest}")  # noqa: E501
+        os.system(f"{SSH_RESERVATION_OPTIONS} root@{guest}")  # noqa: E501
 
 
 def update():
@@ -1967,6 +2043,7 @@ def update():
 
 
 def cancel(
+    context: typer.Context,
     request_id: str = typer.Argument(
         ..., help="Testing Farm request to cancel. Specified by a request ID or a string containing it."
     ),
@@ -1977,6 +2054,9 @@ def cancel(
     Cancel a Testing Farm request.
     """
 
+    # 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}')
 
@@ -2023,6 +2103,7 @@ def cancel(
 
 
 def encrypt(
+    context: typer.Context,
     message: str = typer.Argument(..., help="Message to be encrypted."),
     api_url: str = ARGUMENT_API_URL,
     api_token: str = ARGUMENT_API_TOKEN,
@@ -2040,6 +2121,9 @@ def encrypt(
     Create secrets for use in in-repository configuration.
     """
 
+    # Accept these arguments only via environment variables
+    check_unexpected_arguments(context, "api_url", "api_token")
+
     # check for token
     if not api_token:
         exit_error("No API token found, export `TESTING_FARM_API_TOKEN` environment variable")

tft/cli/config.py

@@ -12,9 +12,9 @@ settings = LazySettings(
     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

tft/cli/utils.py

@@ -13,6 +13,7 @@ from typing import Any, Dict, List, NoReturn, Optional, Union
 import requests
 import requests.adapters
 import typer
+from click.core import ParameterSource  # pyre-ignore[21]
 from rich.console import Console
 from ruamel.yaml import YAML
 from urllib3 import Retry
@@ -89,6 +90,20 @@ def hw_constraints(hardware: List[str]) -> Dict[Any, Any]:
                 constraints[first_key].append(new_dict)
             continue
 
+        # Special handling for CPU flags as they are also a list
+        if first_key == 'cpu' and len(path_splitted) == 2 and path_splitted[1] == 'flag':
+            second_key = 'flag'
+
+            if first_key not in constraints:
+                constraints[first_key] = {}
+
+            if second_key not in constraints[first_key]:
+                constraints[first_key][second_key] = []
+
+            constraints[first_key][second_key].append(value)
+
+            continue
+
         # Walk the path, step by step, and initialize containers along the way. The last step is not
         # a name of another nested container, but actually a name in the last container.
         container: Any = constraints
@@ -244,3 +259,12 @@ def read_glob_paths(glob_paths: List[str]) -> str:
             contents.append(file.read())
 
     return ''.join(contents)
+
+
+def check_unexpected_arguments(context: typer.Context, *args: str) -> Union[None, NoReturn]:
+    for argument in args:
+        if context.get_parameter_source(argument) == ParameterSource.COMMANDLINE:  # pyre-ignore[16]
+            exit_error(
+                f"Unexpected argument '{context.params.get(argument)}'. "
+                "Please make sure you are passing the parameters correctly."
+            )

{tft_cli-0.0.24.dist-info → tft_cli-0.0.26.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tft-cli
-Version: 0.0.24
+Version: 0.0.26
 Summary: Testing Farm CLI tool
 License: Apache-2.0
 Author: Miroslav Vadkerti

tft_cli-0.0.26.dist-info/RECORD

@@ -0,0 +1,10 @@
+tft/cli/__init__.py,sha256=uEJkNJbqC583PBtNI30kxWdeOr3Wj6zJzIYKf0AD72I,92
+tft/cli/commands.py,sha256=AijL207LsDBXU7nNqWTPDFuc2QiRgFjTN6zU9sGVCFU,82931
+tft/cli/config.py,sha256=ge-uJUnjzbMlp1haRcd50PCYWwNxaEvXjH-fhrA0wW4,1262
+tft/cli/tool.py,sha256=nuz57u3yE4fKgdMgNtAFM7PCTcF6PSNFBQbCYDzxBOw,897
+tft/cli/utils.py,sha256=t3ZSnviGxVbBQ4u4ltwQwRgN647BvuyL1QrSlQAAT1Q,9136
+tft_cli-0.0.26.dist-info/LICENSE,sha256=YpVAQfXkIyzQAdm5LZkI6L5UWqLppa6O8_tgDSdoabQ,574
+tft_cli-0.0.26.dist-info/METADATA,sha256=fA7fuCqiRS-17UOI7ij1avPNLlttFKMnjEiTnyoO8XI,789
+tft_cli-0.0.26.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+tft_cli-0.0.26.dist-info/entry_points.txt,sha256=xzdebHkH5Bx-YRf-XPMsIoVpvgfUqqcRQGuo8DFkiao,49
+tft_cli-0.0.26.dist-info/RECORD,,