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

tft/cli/command/composes.py

@@ -0,0 +1,200 @@
+# Copyright Contributors to the Testing Farm project.
+# SPDX-License-Identifier: Apache-2.0
+
+import io
+import json
+import re
+import urllib.parse
+from typing import Any, List, Optional
+
+import requests
+import typer
+from rich.progress import Progress, SpinnerColumn
+from rich.syntax import Syntax
+from rich.table import Table  # type: ignore
+from ruamel.yaml import YAML  # type: ignore
+
+from tft.cli.commands import ARGUMENT_API_TOKEN, ARGUMENT_API_URL
+from tft.cli.config import settings
+from tft.cli.utils import (
+    OutputFormat,
+    StrEnum,
+    authorization_headers,
+    check_unexpected_arguments,
+    console,
+    exit_error,
+    handle_response_errors,
+    install_http_retries,
+)
+
+
+class Ranch(StrEnum):
+    public = "public"
+    redhat = "redhat"
+
+
+def render_text(composes_json: Any, show_regex: bool) -> None:
+    """
+    Show list of composes as a text.
+    """
+
+    lines: list[str] = []
+
+    for compose in sorted(composes_json, key=lambda compose: compose["name"]):
+        text = f"{compose['name']}"
+
+        if show_regex:
+            if compose["type"] == "regex":
+                text += " [bold][green]regex[/green][/bold]"
+            else:
+                text += " [bold][green]compose[/green][/bold]"
+
+        lines.append(text)
+
+    console.print("\n".join(lines))
+
+
+def render_table(composes_json: Any, show_regex: bool) -> None:
+    """
+    Show list of composes as a table.
+    """
+    table = Table(show_header=True, header_style="bold magenta")
+
+    table.add_column("name", justify="left")
+
+    if show_regex:
+        table.add_column("type", justify="left")
+
+    for compose in sorted(composes_json, key=lambda compose: compose["name"]):
+        row = [compose["name"]]
+
+        if show_regex:
+            row.append(compose["type"])
+
+        table.add_row(*row)
+
+    console.print(table)
+
+
+def composes(
+    context: typer.Context,
+    api_token: str = ARGUMENT_API_TOKEN,
+    api_url: str = ARGUMENT_API_URL,
+    ranch: Optional[Ranch] = typer.Option(
+        None, help="List composes for this ranch, instead of the ranch of your token."
+    ),
+    search: Optional[str] = typer.Option(
+        None,
+        "-s",
+        "--search",
+        help="Search for composes based on the given regular expression. For searching `re.search` is used.",
+    ),
+    show_regex: bool = typer.Option(
+        False,
+        help="Show also regular expressions used to accept additional composes.",
+    ),
+    validate: Optional[List[str]] = typer.Option(
+        None,
+        "-v",
+        "--validate",
+        help="Verify that given compose would be accepted by Testing Farm. Can be specified multiple times.",
+    ),
+    format: OutputFormat = typer.Option(
+        "text", help=f"Output format to use. Possible formats: {OutputFormat.available_formats()}"
+    ),
+):
+    """
+    List composes accepted by Testing Farm.
+
+    When Testing Farm token is provided, the command uses the ranch corresponding to your token.
+    To force listing of composes for a specific ranch, use the `--ranch` option.
+    """
+
+    # Accept these arguments only via environment variables
+    check_unexpected_arguments(context, "api_url", "api_token")
+
+    # Setting up HTTP retries
+    session = requests.Session()
+    install_http_retries(session)
+
+    # check for token
+    if not api_token and not ranch:
+        exit_error("No API token found and no ranch specified. Cannot determine ranch.")
+
+    # Validate token if provided
+    if api_token and not ranch:
+        whoami_url = urllib.parse.urljoin(api_url, "v0.1/whoami")
+        try:
+            with Progress(SpinnerColumn(), transient=True) as progress:
+                progress.add_task(description="")
+
+                response = session.get(whoami_url, headers=authorization_headers(api_token))
+                handle_response_errors(response)
+
+                ranch = response.json()['token']['ranch']
+
+        except requests.RequestException as e:
+            exit_error(f"Failed to validate token: {e}")
+
+    # Compile the search regular expression
+    search_pattern = re.compile(search) if search else None
+
+    # Fetch composes
+    with Progress(SpinnerColumn(), transient=True) as progress:
+        progress.add_task(description="")
+
+        composes_url = urllib.parse.urljoin(api_url, f"v0.2/composes/{ranch}")
+
+        response = session.get(composes_url)
+        handle_response_errors(response)
+
+        composes_json = response.json().get("composes") or []
+
+        if not composes_json:
+            exit_error(f"No composes found in Testing Farm. Please file an issue to {settings.ISSUE_TRACKER}")
+
+    if search_pattern:
+        composes_json = [compose for compose in composes_json if search_pattern.search(compose["name"])]
+
+        if not composes_json:
+            exit_error(f"No composes found for '{search_pattern.pattern}'.")
+
+    if validate:
+
+        def _compose_accepted(compose: str):
+            console.print(f"✅ Compose '{compose}' is valid")
+
+        for validated_compose in validate:
+            for compose in composes_json:
+                if compose["type"] == "compose" and validated_compose == compose["name"]:
+                    _compose_accepted(validated_compose)
+                    break
+
+                if compose["type"] == "regex" and re.match(compose["name"], validated_compose):
+                    _compose_accepted(validated_compose)
+                    break
+            else:
+                console.print(f"❌ Compose '{validated_compose}' is invalid")
+
+        return
+
+    if not show_regex:
+        composes_json = [compose for compose in composes_json if compose["type"] != "regex"]
+
+    if format == OutputFormat.json:
+        json_dump = json.dumps(composes_json) or '[]'
+        console.print_json(json_dump)
+        return
+
+    if format == OutputFormat.yaml:
+        yaml_dump = io.StringIO()
+        YAML().dump(composes_json, yaml_dump)
+        syntax = Syntax(yaml_dump.getvalue(), "yaml")
+        console.print(syntax)
+        return
+
+    if format == OutputFormat.table:
+        render_table(composes_json, show_regex)
+        return
+
+    render_text(composes_json, show_regex)

tft/cli/command/listing.py

@@ -7,7 +7,6 @@ import re
 import sys
 import urllib.parse
 from concurrent.futures import ThreadPoolExecutor
-from enum import Enum
 from typing import Any, List, Optional, Tuple
 
 import pendulum
@@ -24,16 +23,20 @@ from tft.cli.commands import (
     ARGUMENT_API_URL,
     ARGUMENT_INTERNAL_API_URL,
     PipelineState,
+    check_token,
 )
 from tft.cli.config import settings
 from tft.cli.utils import (
     Age,
     OutputFormat,
+    StrEnum,
     authorization_headers,
     check_unexpected_arguments,
     console,
     exit_error,
     extract_uuid,
+    handle_401_response,
+    handle_response_errors,
     install_http_retries,
     uuid_valid,
 )
@@ -42,7 +45,7 @@ from tft.cli.utils import (
 MAX_COMPOSE_LENGTH = 30
 
 
-class Ranch(str, Enum):
+class Ranch(StrEnum):
     public = "public"
     redhat = "redhat"
 
@@ -201,11 +204,11 @@ def render_reservation_table(requests_json: Any, show_utc: bool) -> None:
             os_compose = os_info.get('compose')
             if os_compose:
                 if len(os_compose) > MAX_COMPOSE_LENGTH:
-                    envs.append(f"{arch:>7} (<too-long>)")
+                    envs.append(f"{arch:>7} (<too-long>)")  # noqa: E231
                 else:
-                    envs.append(f"{arch:>7} ({os_compose})")
+                    envs.append(f"{arch:>7} ({os_compose})")  # noqa: E231
             else:
-                envs.append(f"{arch:>7} (container)")
+                envs.append(f"{arch:>7} (container)")  # noqa: E231
         envs = list(dict.fromkeys(envs))
 
         # Get time info
@@ -311,11 +314,11 @@ def render_table(
             if os_compose:
                 # Check if compose contains disk_image or boot_image and display <hidden-flasher-image> instead
                 if len(os_compose) > 20:
-                    envs.append(f"{arch:>7} (<too-long>)")
+                    envs.append(f"{arch:>7} (<too-long>)")  # noqa: E231
                 else:
-                    envs.append(f"{arch:>7} ({os_compose})")
+                    envs.append(f"{arch:>7} ({os_compose})")  # noqa: E231
             else:
-                envs.append(f"{arch:>7} (container)")
+                envs.append(f"{arch:>7} (container)")  # noqa: E231
         envs = list(dict.fromkeys(envs))  # Remove duplicates while preserving order
 
         git_type, git_url = shorten_git_url(url)
@@ -395,7 +398,7 @@ def _format_time(seconds):
     try:
         seconds = float(seconds)
         minutes, seconds = divmod(seconds, 60)
-        return f"{int(minutes)}m {seconds:.2f}s"
+        return f"{int(minutes)}m {seconds:.2f}s"  # noqa: E231
     except (ValueError, TypeError):
         return "N/A"
 
@@ -697,24 +700,13 @@ def listing(
     session = requests.Session()
     install_http_retries(session)
 
-    def handle_response_errors(response: requests.Response) -> None:
-        if response.status_code == 401:
-            exit_error(f"API token is invalid. See {settings.ONBOARDING_DOCS} for more information.")
-
-        if response.status_code != 200:
-            exit_error(
-                f"Unexpected error {response.text}. "
-                f"Check {settings.STATUS_PAGE}. "
-                f"File an issue to {settings.ISSUE_TRACKER} if needed."
-            )
-
     # Handle minimum age
     if min_age:
         base_request_url = f"{base_request_url}&created_before={min_age.to_string()}"
 
     # check for token
     if not api_token and (mine or show_secrets):
-        exit_error("No API token found, export `TESTING_FARM_API_TOKEN` environment variable")
+        api_token = check_token(api_url, api_token)
 
     # Validate token if provided
     if api_token:
@@ -722,7 +714,7 @@ def listing(
         try:
             response = session.get(whoami_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.")
+                handle_401_response(response)
             elif response.status_code != 200:
                 exit_error(
                     f"Token validation failed with status {response.status_code}. "

tft/cli/commands.py

@@ -15,7 +15,6 @@ import textwrap
 import time
 import urllib.parse
 import xml.etree.ElementTree as ET
-from enum import Enum
 from typing import Any, Dict, List, Optional
 
 import requests
@@ -27,6 +26,7 @@ from rich.table import Table  # type: ignore
 
 from tft.cli.config import settings
 from tft.cli.utils import (
+    StrEnum,
     artifacts,
     authorization_headers,
     check_unexpected_arguments,
@@ -36,6 +36,7 @@ from tft.cli.utils import (
     edit_with_editor,
     exit_error,
     extract_uuid,
+    handle_401_response,
     hw_constraints,
     install_http_retries,
     normalize_multistring_option,
@@ -68,7 +69,10 @@ 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
@@ -80,16 +84,16 @@ SSH_RESERVATION_OPTIONS = (
 SECURITY_GROUP_RULE_FORMAT = re.compile(r"(tcp|ip|icmp|udp|-1|[0-255]):(.*):(\d{1,5}-\d{1,5}|\d{1,5}|-1)")
 
 
-class WatchFormat(str, Enum):
+class WatchFormat(StrEnum):
     text = 'text'
     json = 'json'
 
 
-class PipelineType(str, Enum):
+class PipelineType(StrEnum):
     tmt_multihost = "tmt-multihost"
 
 
-class PipelineState(str, Enum):
+class PipelineState(StrEnum):
     new = "new"
     queued = "queued"
     running = "running"
@@ -98,7 +102,7 @@ class PipelineState(str, Enum):
     canceled = "canceled"
 
 
-class Ranch(str, Enum):
+class Ranch(StrEnum):
     public = "public"
     redhat = "redhat"
 
@@ -160,43 +164,32 @@ ARGUMENT_TARGET_API_TOKEN: str = typer.Argument(
 OPTION_TMT_PLAN_NAME: Optional[str] = typer.Option(
     None,
     "--plan",
-    help=(
-        'Select plans to be executed. '
-        'Passed as `--name` option to the `tmt plan` command. '
-        'Can be a regular expression.'
-    ),
+    help=('A regular expression to select plans to be executed. Passed to the `tmt plan ls` command. '),
     rich_help_panel=REQUEST_PANEL_TMT,
 )
 OPTION_TMT_PLAN_FILTER: Optional[str] = typer.Option(
     None,
     "--plan-filter",
     help=(
-        'Filter tmt plans. '
-        'Passed as `--filter` option to the `tmt plan` command. '
-        'By default, `enabled:true` filter is applied. '
-        'Plan filtering is similar to test filtering, '
-        'see https://tmt.readthedocs.io/en/stable/examples.html#filter-tests for more information.'
+        'Apply an advanced filter using key:value pairs and logical operators to filter plans. '
+        'Passed as `--filter` option to the `tmt plan ls` command. '
+        'See `pydoc fmf.filter` for detailed documentation on the syntax.'
     ),
     rich_help_panel=REQUEST_PANEL_TMT,
 )
 OPTION_TMT_TEST_NAME: Optional[str] = typer.Option(
     None,
     "--test",
-    help=(
-        'Select tests to be executed. '
-        'Passed as `--name` option to the `tmt test` command. '
-        'Can be a regular expression.'
-    ),
+    help=('Regular expression to select tests to be executed. Passed to the `tmt test ls` command. '),
     rich_help_panel=REQUEST_PANEL_TMT,
 )
 OPTION_TMT_TEST_FILTER: Optional[str] = typer.Option(
     None,
     "--test-filter",
     help=(
-        'Filter tmt tests. '
-        'Passed as `--filter` option to the `tmt test` command. '
-        'It overrides any test filter defined in the plan. '
-        'See https://tmt.readthedocs.io/en/stable/examples.html#filter-tests for more information.'
+        'Apply an advanced filter using key:value pairs and logical operators to filter tests. '
+        'Passed as `--filter` option to the `tmt test ls` command. '
+        'See `pydoc fmf.filter` for detailed documentation on the syntax.'
     ),
     rich_help_panel=REQUEST_PANEL_TMT,
 )
@@ -271,6 +264,7 @@ OPTION_REPOSITORY: List[str] = typer.Option(
 OPTION_REPOSITORY_FILE: List[str] = typer.Option(
     None,
     help="URL to a repository file which should be added to /etc/yum.repos.d, e.g. https://example.com/repository.repo",  # noqa
+    rich_help_panel=RESERVE_PANEL_ENVIRONMENT,
 )
 OPTION_DRY_RUN: bool = typer.Option(
     False, help="Do not submit a request to Testing Farm, just print it.", rich_help_panel=RESERVE_PANEL_GENERAL
@@ -280,14 +274,14 @@ OPTION_VARIABLES: Optional[List[str]] = typer.Option(
     "-e",
     "--environment",
     metavar="key=value|@file",
-    help="Variables to pass to the test environment. The @ prefix marks a yaml file to load.",
+    help="Variables to pass to the test environment. The @ prefix marks a yaml or dotenv file to load.",
 )
 OPTION_SECRETS: Optional[List[str]] = typer.Option(
     None,
     "-s",
     "--secret",
     metavar="key=value|@file",
-    help="Secret variables to pass to the test environment. The @ prefix marks a yaml file to load.",
+    help="Secret variables to pass to the test environment. The @ prefix marks a yaml or dotenv file to load.",
 )
 OPTION_HARDWARE: List[str] = typer.Option(
     None,
@@ -329,6 +323,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:
@@ -478,6 +483,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}"  # noqa: E231
+    return None
+
+
 def _add_reservation(
     ssh_public_keys: List[str],
     rules: Dict[str, Any],
@@ -585,7 +608,7 @@ def _parse_security_group_rules(ingress_rules: List[str], egress_rules: List[str
     return security_group_rules
 
 
-def _parse_xunit(xunit: str):
+def _parse_xunit(xunit: str, multihost: bool = False):
     """
     A helper that parses xunit file into sets of passed_plans/failed_plans/errored_plans per arch.
 
@@ -609,9 +632,12 @@ def _parse_xunit(xunit: str):
 
     results_root = ET.fromstring(xunit)
     for plan in results_root.findall('./testsuite'):
-        # Try to get information about the environment (stored under ./testing-environment), may be
-        # absent if state is undefined
-        testing_environment: Optional[ET.Element] = plan.find('./testing-environment[@name="requested"]')
+        testing_environment = plan.find(
+            './testing-environment[@name="requested"]'
+            if not multihost
+            else './guest/testing-environment[@name="provisioned"]'
+        )
+
         if not testing_environment:
             console_stderr.print(
                 f'Could not find env specifications for {plan.get("name")}, assuming fail for all arches'
@@ -646,6 +672,7 @@ def _get_request_summary(request: dict, session: requests.Session):
     artifacts_url = (request.get('run') or {}).get('artifacts')
     xpath_url = f'{artifacts_url}/results.xml' if artifacts_url else ''
     xunit = (request.get('result') or {}).get('xunit') or '<testsuites></testsuites>'
+    multihost = ((request.get('settings') or {}).get('pipeline') or {}).get('type') == 'tmt-multihost'
     if state not in ['queued', 'running'] and artifacts_url:
         # NOTE(ivasilev) xunit can be None (ex. in case of timed out requests) so let's fetch results.xml and use it
         # as source of truth
@@ -655,7 +682,7 @@ def _get_request_summary(request: dict, session: requests.Session):
                 xunit = response.text
         except requests.exceptions.ConnectionError:
             console_stderr.print("Could not get xunit results")
-    passed_plans, failed_plans, skipped_plans, errored_plans = _parse_xunit(xunit)
+    passed_plans, failed_plans, skipped_plans, errored_plans = _parse_xunit(xunit, multihost=multihost)
     overall = (request.get("result") or {}).get("overall")
     arches_requested = [env['arch'] for env in request['environments_requested']]
 
@@ -874,13 +901,43 @@ def version():
     console.print(f"{cli_version}")
 
 
+def check_token(api_url: str, api_token: Optional[str]):
+    """Check for API token, falling back to keyring if not provided. Exits on failure."""
+
+    running_in_container = os.path.exists(settings.CONTAINER_SIGN)
+
+    # Keyring is not supported inside container environment
+    if not api_token and not running_in_container:
+        try:
+            import keyring
+
+            api_token = keyring.get_password(api_url, 'api-token')
+        except ImportError as e:
+            console.print(f"⚠️  keyring import error: {e}", style="yellow")
+        except Exception as e:
+            console.print(f"⚠️  keyring error: {e}", style="yellow")
+
+    if not api_token:
+        message = "No API token found, export `TESTING_FARM_API_TOKEN` environment variable."
+        if not running_in_container:
+            message += f" Or store it in keyring using `keyring set {api_url} api-token`."
+        exit_error(message)
+
+    return api_token
+
+
 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,
@@ -914,17 +971,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,
@@ -959,6 +1006,7 @@ def request(
     parallel_limit: Optional[int] = OPTION_PARALLEL_LIMIT,
     tmt_discover: Optional[List[str]] = _generate_tmt_extra_args("discover"),
     tmt_prepare: Optional[List[str]] = _generate_tmt_extra_args("prepare"),
+    tmt_report: Optional[List[str]] = _generate_tmt_extra_args("report"),
     tmt_finish: Optional[List[str]] = _generate_tmt_extra_args("finish"),
     reserve: bool = OPTION_RESERVE,
     ssh_public_keys: List[str] = _option_ssh_public_keys(REQUEST_PANEL_RESERVE),
@@ -978,9 +1026,7 @@ def request(
 
     git_available = bool(shutil.which("git"))
 
-    # check for token
-    if not api_token:
-        exit_error("No API token found, export `TESTING_FARM_API_TOKEN` environment variable")
+    api_token = check_token(api_url, api_token)
 
     if not compose and arches != ['x86_64']:
         exit_error(
@@ -1070,10 +1116,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
@@ -1130,7 +1182,7 @@ def request(
         if tmt_environment:
             environment["tmt"].update({"environment": options_to_dict("tmt environment variables", tmt_environment)})
 
-        if tmt_discover or tmt_prepare or tmt_finish:
+        if tmt_discover or tmt_prepare or tmt_report or tmt_finish:
             if "extra_args" not in environment["tmt"]:
                 environment["tmt"]["extra_args"] = {}
 
@@ -1140,6 +1192,9 @@ def request(
         if tmt_prepare:
             environment["tmt"]["extra_args"]["prepare"] = tmt_prepare
 
+        if tmt_report:
+            environment["tmt"]["extra_args"]["report"] = tmt_report
+
         if tmt_finish:
             environment["tmt"]["extra_args"]["finish"] = tmt_finish
 
@@ -1217,11 +1272,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")
@@ -1230,7 +1288,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}
 
@@ -1264,7 +1322,7 @@ def request(
     # handle errors
     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.")
+        handle_401_response(response)
 
     if response.status_code == 400:
         exit_error(
@@ -1315,6 +1373,7 @@ def restart(
     tmt_path: Optional[str] = OPTION_TMT_PATH,
     tmt_discover: Optional[List[str]] = _generate_tmt_extra_args("discover"),
     tmt_prepare: Optional[List[str]] = _generate_tmt_extra_args("prepare"),
+    tmt_report: Optional[List[str]] = _generate_tmt_extra_args("report"),
     tmt_finish: Optional[List[str]] = _generate_tmt_extra_args("finish"),
     worker_image: Optional[str] = OPTION_WORKER_IMAGE,
     no_wait: bool = typer.Option(False, help="Skip waiting for request completion."),
@@ -1376,7 +1435,7 @@ def restart(
     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.")
+        handle_401_response(response)
 
     # The API token is valid, but it doesn't own the request
     if response.status_code == 403:
@@ -1423,10 +1482,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:
@@ -1453,7 +1518,7 @@ def restart(
         for environment in request['environments']:
             environment["pool"] = pool
 
-    if tmt_discover or tmt_prepare or tmt_finish:
+    if tmt_discover or tmt_prepare or tmt_report or tmt_finish:
         for environment in request["environments"]:
             if "tmt" not in environment:
                 environment["tmt"] = {"extra_args": {}}
@@ -1468,6 +1533,10 @@ def restart(
         for environment in request["environments"]:
             environment["tmt"]["extra_args"]["prepare"] = tmt_prepare
 
+    if tmt_report:
+        for environment in request["environments"]:
+            environment["tmt"]["extra_args"]["report"] = tmt_report
+
     if tmt_finish:
         for environment in request["environments"]:
             environment["tmt"]["extra_args"]["finish"] = tmt_finish
@@ -1579,7 +1648,7 @@ def restart(
     # handle errors
     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.")
+        handle_401_response(response)
 
     if response.status_code == 400:
         exit_error(
@@ -1626,9 +1695,7 @@ def run(
     Run an arbitrary script via Testing Farm.
     """
 
-    # check for token
-    if not api_token:
-        exit_error("No API token found, export `TESTING_FARM_API_TOKEN` environment variable.")
+    api_token = check_token(api_url, api_token)
 
     # create request
     request = TestingFarmRequestV1
@@ -1677,7 +1744,7 @@ def run(
     # handle errors
     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.")
+        handle_401_response(response)
 
     if response.status_code == 400:
         exit_error(f"Request is invalid. Please file an issue to {settings.ISSUE_TRACKER}")
@@ -1793,8 +1860,10 @@ 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_report: Optional[List[str]] = _generate_tmt_extra_args("report"),
     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,
@@ -1828,9 +1897,7 @@ def 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.")
+    api_token = check_token(api_url, api_token)
 
     pool_info = f"via pool [blue]{pool}[/blue]" if pool else ""
     console.print(f"💻 [blue]{compose}[/blue] on [blue]{arch}[/blue] {pool_info}")
@@ -1896,7 +1963,7 @@ def reserve(
     if post_install_script:
         environment["settings"]["provisioning"]["post_install_script"] = post_install_script
 
-    if tmt_discover or tmt_prepare or tmt_finish:
+    if tmt_discover or tmt_prepare or tmt_report or tmt_finish:
         environment["tmt"] = {"extra_args": {}}
 
         if tmt_discover:
@@ -1905,9 +1972,18 @@ def reserve(
         if tmt_prepare:
             environment["tmt"]["extra_args"]["prepare"] = tmt_prepare
 
+        if tmt_report:
+            environment["tmt"]["extra_args"]["report"] = tmt_report
+
         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)
@@ -1974,7 +2050,7 @@ def reserve(
     # handle errors
     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.")
+        handle_401_response(response)
 
     if response.status_code == 400:
         exit_error(
@@ -2141,9 +2217,7 @@ def cancel(
     # 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
+    api_token = check_token(api_url, api_token)
 
     # Construct URL to the internal API
     request_url = urllib.parse.urljoin(str(api_url), f"v0.1/requests/{_request_id}")
@@ -2156,7 +2230,7 @@ def cancel(
     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.")
+        handle_401_response(response)
 
     if response.status_code == 403:
         exit_error(
@@ -2201,9 +2275,7 @@ def encrypt(
     # 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")
+    api_token = check_token(api_url, api_token)
 
     git_available = bool(shutil.which("git"))
 
@@ -2235,7 +2307,7 @@ def encrypt(
 
     # handle errors
     if response.status_code == 401:
-        exit_error(f"API token is invalid. See {settings.ONBOARDING_DOCS} for more information.")
+        handle_401_response(response)
 
     if response.status_code == 400:
         exit_error(

tft/cli/tool.py

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

tft/cli/utils.py

@@ -20,6 +20,7 @@ import requests
 import requests.adapters
 import typer
 from click.core import ParameterSource
+from dotenv import dotenv_values
 from rich.console import Console
 from ruamel.yaml import YAML  # type: ignore
 from urllib3 import Retry
@@ -69,7 +70,16 @@ class Age:
         return f"{self.value}{self.unit}"
 
 
-class OutputFormat(str, Enum):
+# Use built-in StrEnum for Python 3.11+, otherwise define a compatible version
+if sys.version_info >= (3, 11):
+    from enum import StrEnum
+else:
+
+    class StrEnum(str, Enum):
+        pass
+
+
+class OutputFormat(StrEnum):
     text = "text"
     json = "json"
     yaml = "yaml"
@@ -77,7 +87,7 @@ class OutputFormat(str, Enum):
 
     @staticmethod
     def available_formats():
-        return "text, json or table"
+        return "text, json, yaml or table"
 
 
 def exit_error(error: str) -> NoReturn:
@@ -86,6 +96,24 @@ def exit_error(error: str) -> NoReturn:
     raise typer.Exit(code=255)
 
 
+def handle_401_response(response: requests.Response) -> NoReturn:
+    """Handle 401 Unauthorized responses with appropriate error message.
+
+    Differentiates between expired tokens and invalid tokens based on
+    the API response message.
+    """
+    try:
+        error_msg = response.json().get('message', '')
+        if error_msg == "Token has expired":
+            exit_error(
+                f"API token has expired. Please generate a new token at "
+                f"{settings.ONBOARDING_DOCS} and update your TESTING_FARM_API_TOKEN."
+            )
+    except requests.exceptions.JSONDecodeError:
+        pass
+    exit_error(f"API token is invalid. See {settings.ONBOARDING_DOCS} for more information.")
+
+
 def cmd_output_or_exit(command: str, error: str) -> str:
     """Return local command output or exit with given error message"""
     try:
@@ -180,42 +208,68 @@ def hw_constraints(hardware: List[str]) -> Dict[Any, Any]:
         elif value.lower() in ['false']:
             value_mixed = False
 
-        container[path_splitted.pop()] = value_mixed
-
-        # Only process additional path elements if they exist
-        if path_splitted:
-            next_path = path_splitted.pop()
+        final_key = path_splitted.pop()
 
-            # handle compatible.distro
-            if next_path == 'distro':
-                container[next_path] = (
-                    container[next_path].append(value_mixed) if next_path in container else [value_mixed]
-                )
-            else:
-                container[next_path] = value_mixed
+        # Handle compatible.distro as a list
+        if final_key == 'distro':
+            if final_key not in container:
+                container[final_key] = []
+            container[final_key].append(value_mixed)
+        else:
+            container[final_key] = value_mixed
 
     return constraints
 
 
-def options_from_file(filepath) -> Dict[str, str]:
-    """Read environment variables from a yaml file."""
+def options_from_yaml(filepath: str) -> Optional[Dict[str, Optional[str]]]:
+    """Read environment variables from yaml content.
+
+    Raises:
+        ValueError: If the file cannot be parsed as YAML or has invalid structure.
+    """
 
     with open(filepath, 'r') as file:
-        try:
-            yaml = YAML(typ="safe").load(file.read())
-        except Exception:
-            exit_error(f"Failed to load variables from yaml file {filepath}.")
+        content = file.read()
 
-        if not yaml:  # pyre-ignore[61]  # pyre ignores NoReturn in exit_error
-            return {}
+    try:
+        yaml = YAML(typ="safe").load(content)
+    except Exception:
+        return None
+
+    if not yaml:
+        return {}
+
+    if not isinstance(yaml, dict):
+        exit_error(f"Environment file {filepath} is not a dict.")
+
+    if any([isinstance(value, (list, dict)) for value in yaml.values()]):
+        exit_error(f"Values of environment file {filepath} are not primitive types.")
+
+    return yaml
+
+
+def options_from_dotenv(filepath: str) -> Dict[str, Optional[str]]:
+    """Read environment variables from dotenv file.
 
-        if not isinstance(yaml, dict):  # pyre-ignore[61]  # pyre ignores NoReturn in exit_error
-            exit_error(f"Environment file {filepath} is not a dict.")
+    Raises:
+        Exception: If the file cannot be parsed as dotenv.
+    """
+    try:
+        return dotenv_values(filepath)
+    except Exception:
+        exit_error(f"Failed to load variables from file {filepath}.")
+
+
+def options_from_file(filepath) -> Dict[str, Optional[str]]:
+    """Read environment variables from a yaml or dotenv file."""
+    # Try to load from yaml first
+    # If that fails, try to load from dotenv
+    yaml = options_from_yaml(filepath)
 
-        if any([isinstance(value, (list, dict)) for value in yaml.values()]):
-            exit_error(f"Values of environment file {filepath} are not primitive types.")
+    if yaml is None:
+        return options_from_dotenv(filepath)
 
-        return yaml  # pyre-ignore[61]  # pyre ignores NoReturn in exit_error
+    return yaml
 
 
 def options_to_dict(name: str, options: List[str]) -> Dict[str, str]:
@@ -412,3 +466,15 @@ def edit_with_editor(data: Any, description: Optional[str]) -> Any:
         # Read the modified content
         with open(temp_file.name, 'r') as modified_file:
             return modified_file.read()
+
+
+def handle_response_errors(response: requests.Response) -> None:
+    if response.status_code == 401:
+        exit_error(f"API token is invalid. See {settings.ONBOARDING_DOCS} for more information.")
+
+    if response.status_code != 200:
+        exit_error(
+            f"Unexpected error {response.text}. "
+            f"Check {settings.STATUS_PAGE}. "
+            f"File an issue to {settings.ISSUE_TRACKER} if needed."
+        )

{tft_cli-0.0.28.dist-info → tft_cli-0.0.31.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tft-cli
-Version: 0.0.28
+Version: 0.0.31
 Summary: Testing Farm CLI tool
 License: Apache-2.0
 Author: Miroslav Vadkerti
@@ -14,7 +14,9 @@ Classifier: Programming Language :: Python :: 3.11
 Requires-Dist: click (>=8.0.4,<9.0.0)
 Requires-Dist: colorama (>=0.4.4,<0.5.0)
 Requires-Dist: dynaconf (>=3.1.2,<4.0.0)
+Requires-Dist: keyring (>=25.7.0,<26.0.0)
 Requires-Dist: pendulum (>=3.0.0,<4.0.0)
+Requires-Dist: python-dotenv (>=1.2.1,<2.0.0)
 Requires-Dist: requests (>=2.27.1,<3.0.0)
 Requires-Dist: rich (>=12)
 Requires-Dist: ruamel-yaml (>=0.18.5,<0.19.0)

tft_cli-0.0.31.dist-info/RECORD

@@ -0,0 +1,13 @@
+tft/cli/__init__.py,sha256=uEJkNJbqC583PBtNI30kxWdeOr3Wj6zJzIYKf0AD72I,92
+tft/cli/command/__init__.py,sha256=uEJkNJbqC583PBtNI30kxWdeOr3Wj6zJzIYKf0AD72I,92
+tft/cli/command/composes.py,sha256=85xdTqgCIINl4XDhOAZq2EWI_KhitvGGMlneyK7xpc4,6126
+tft/cli/command/listing.py,sha256=a0DDdXQ84qL5v6lpOEuF-UiBkD6Zr7yr02Oa3t1cd6I,30863
+tft/cli/commands.py,sha256=fX08gLXDosZC06YBt5igiFsprJBOHAxclR44ptCwxu0,88374
+tft/cli/config.py,sha256=9JWjEwBiS4_Eq1B53lxxCIceERJ7AeryUyqxj9fm9c4,1714
+tft/cli/tool.py,sha256=xGBqfk8te63cijhhWtP1SopiHugTHPLp2crGx-LoLXg,1045
+tft/cli/utils.py,sha256=9LRNTfG1zTD65_foF6IGD9H3JoYJVeJHzhI7siNv20I,15449
+tft_cli-0.0.31.dist-info/LICENSE,sha256=YpVAQfXkIyzQAdm5LZkI6L5UWqLppa6O8_tgDSdoabQ,574
+tft_cli-0.0.31.dist-info/METADATA,sha256=kpgBJALq0mpq8v1WntORVmdoNQYRD6mB_YQRADNf0ck,918
+tft_cli-0.0.31.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+tft_cli-0.0.31.dist-info/entry_points.txt,sha256=xzdebHkH5Bx-YRf-XPMsIoVpvgfUqqcRQGuo8DFkiao,49
+tft_cli-0.0.31.dist-info/RECORD,,

tft_cli-0.0.28.dist-info/RECORD

@@ -1,12 +0,0 @@
-tft/cli/__init__.py,sha256=uEJkNJbqC583PBtNI30kxWdeOr3Wj6zJzIYKf0AD72I,92
-tft/cli/command/__init__.py,sha256=uEJkNJbqC583PBtNI30kxWdeOr3Wj6zJzIYKf0AD72I,92
-tft/cli/command/listing.py,sha256=gEkoeKHOcEiBt2TyLzSAongOKHKi7BgEO7GQ0AAa0Ss,31276
-tft/cli/commands.py,sha256=aZ_P7B9z4IorT6ksQH0ciCY6KxvL5q5NJdWuHNv9fHE,85890
-tft/cli/config.py,sha256=9JWjEwBiS4_Eq1B53lxxCIceERJ7AeryUyqxj9fm9c4,1714
-tft/cli/tool.py,sha256=AaJ7RZwWEoP7WA_f2NbmcZSolNETkTWvVAt9pgt9j-o,975
-tft/cli/utils.py,sha256=j8B30qpieBUieaiVo_3h5bRqoKnGeGKxR9eJ7GZcNiM,13702
-tft_cli-0.0.28.dist-info/LICENSE,sha256=YpVAQfXkIyzQAdm5LZkI6L5UWqLppa6O8_tgDSdoabQ,574
-tft_cli-0.0.28.dist-info/METADATA,sha256=MybsQ9HApc32-yILZ14mMu8YcWCSlhtH0gioJoMI8ZM,830
-tft_cli-0.0.28.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-tft_cli-0.0.28.dist-info/entry_points.txt,sha256=xzdebHkH5Bx-YRf-XPMsIoVpvgfUqqcRQGuo8DFkiao,49
-tft_cli-0.0.28.dist-info/RECORD,,