tft-cli 0.0.26__py3-none-any.whl → 0.0.28__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,
@@ -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",
@@ -534,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.
@@ -1066,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:
@@ -1113,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(
@@ -1216,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.")
 
@@ -1240,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
@@ -1280,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.
@@ -1288,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.")
@@ -1319,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)
@@ -1431,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
@@ -1471,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(
@@ -1489,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")
@@ -1496,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.")
 
@@ -1516,7 +1594,7 @@ def restart(
     # watch
     watch(
         context,
-        str(api_url),
+        str(effective_target_api_url),
         response.json()['id'],
         no_wait,
         reserve=reserve,
@@ -1597,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.")
 
@@ -1797,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:
@@ -1837,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)
@@ -1891,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.")
 
@@ -2057,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}")
 
@@ -2082,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,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)

tft/cli/utils.py

@@ -4,18 +4,24 @@
 import glob
 import itertools
 import os
+import re
 import shlex
+import shutil
 import subprocess
 import sys
+import tempfile
 import uuid
+from dataclasses import dataclass
+from enum import Enum
 from typing import Any, Dict, List, NoReturn, Optional, Union
 
+import pendulum
 import requests
 import requests.adapters
 import typer
-from click.core import ParameterSource  # pyre-ignore[21]
+from click.core import ParameterSource
 from rich.console import Console
-from ruamel.yaml import YAML
+from ruamel.yaml import YAML  # type: ignore
 from urllib3 import Retry
 
 from tft.cli.config import settings
@@ -24,6 +30,56 @@ console = Console(soft_wrap=True)
 console_stderr = Console(soft_wrap=True, file=sys.stderr)
 
 
+@dataclass
+class Age:
+    value: int
+    unit: str
+
+    _unit_multiplier = {"s": 1, "m": 60, "h": 3600, "d": 86400}
+    _unit_human = {"s": "second", "m": "minute", "h": "hour", "d": "day"}
+
+    @classmethod
+    def from_string(cls, age_string: str) -> 'Age':
+        value, unit = age_string[:-1], age_string[-1]
+        if unit not in cls._unit_multiplier:
+            raise typer.BadParameter(f"Age must end with {', '.join(cls._unit_multiplier.keys())}")
+
+        if not value.isdigit():
+            raise typer.BadParameter(f"Invalid age value {value}")
+
+        return cls(value=int(age_string[:-1]), unit=age_string[-1])
+
+    @property
+    def birth_date(self) -> pendulum.DateTime:
+        now = pendulum.now(tz="UTC")
+        return now - pendulum.duration(seconds=self.value * self._unit_multiplier[self.unit])
+
+    @property
+    def human(self) -> str:
+        return f"{self.value} {self._unit_human[self.unit]}{'s' if self.value > 1 else ''}"
+
+    @staticmethod
+    def available_units() -> str:
+        return "s (seconds), m (minutes), h (hours) or d (days)"
+
+    def to_string(self, format="%Y-%m-%dT%H:%M:%S") -> str:
+        return self.birth_date.strftime(format)
+
+    def __str__(self):
+        return f"{self.value}{self.unit}"
+
+
+class OutputFormat(str, Enum):
+    text = "text"
+    json = "json"
+    yaml = "yaml"
+    table = "table"
+
+    @staticmethod
+    def available_formats():
+        return "text, json or table"
+
+
 def exit_error(error: str) -> NoReturn:
     """Exit with given error message"""
     console.print(f"⛔ {error}", style="red")
@@ -125,6 +181,19 @@ def hw_constraints(hardware: List[str]) -> Dict[Any, Any]:
             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()
+
+            # 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
+
     return constraints
 
 
@@ -187,6 +256,27 @@ def uuid_valid(value: str, version: int = 4) -> bool:
         return False
 
 
+def extract_uuid(value: str) -> str:
+    """
+    Extracts a UUID from a string. If the string is already a valid UUID, returns it.
+    If the string contains a UUID, extracts and returns it.
+    Raises typer.Exit with error message if no valid UUID is found.
+    """
+    # Check if the value is already a valid UUID
+    if uuid_valid(value):
+        return value
+
+    # UUID pattern for extracting UUIDs from strings
+    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}')
+
+    # Try to extract UUID from string
+    uuid_match = uuid_pattern.search(value)
+    if uuid_match:
+        return uuid_match.group()
+
+    exit_error(f"Could not find a valid Testing Farm request id in '{value}'.")
+
+
 class TimeoutHTTPAdapter(requests.adapters.HTTPAdapter):
     def __init__(self, *args: Any, **kwargs: Any) -> None:
         self.timeout = kwargs.pop('timeout', settings.DEFAULT_API_TIMEOUT)
@@ -216,7 +306,9 @@ def install_http_retries(
 
     status_forcelist_extend = status_forcelist_extend or []
 
-    params = {
+    from typing import Any, Dict
+
+    params: Dict[str, Any] = {
         "total": retries,
         "status_forcelist": [
             429,  # Too Many Requests
@@ -226,9 +318,9 @@ def install_http_retries(
             504,  # Gateway Timeout
         ]
         + status_forcelist_extend,
-        allowed_retry_parameter: ['HEAD', 'GET', 'POST', 'DELETE', 'PUT'],
         "backoff_factor": retry_backoff_factor,
     }
+    params[allowed_retry_parameter] = ['HEAD', 'GET', 'POST', 'DELETE', 'PUT']
     retry_strategy = Retry(**params)
 
     timeout_adapter = TimeoutHTTPAdapter(timeout=timeout, max_retries=retry_strategy)
@@ -263,8 +355,60 @@ def read_glob_paths(glob_paths: List[str]) -> str:
 
 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]
+        if context.get_parameter_source(argument) == ParameterSource.COMMANDLINE:
             exit_error(
                 f"Unexpected argument '{context.params.get(argument)}'. "
                 "Please make sure you are passing the parameters correctly."
             )
+
+
+def validate_age(value: str) -> Age:
+    if value.endswith("m"):
+        return Age(int(value[:-1]), "m")
+    elif value.endswith("d"):
+        return Age(int(value[:-1]), "d")
+    else:
+        raise ValueError("Age must end with 'm' for months or 'd' for days.")
+
+
+def authorization_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 edit_with_editor(data: Any, description: Optional[str]) -> Any:
+    """
+    Open data in an editor for user modification and return it back.
+    If description specified, print it as a user message together with the used editor.
+    """
+    # Get the editor from environment variable, fallback to sensible defaults
+    editor = os.environ.get('EDITOR')
+    if not editor:
+        # Try common editors in order of preference
+        for candidate in ['vim', 'vi', 'nano', 'emacs']:
+            if shutil.which(candidate):
+                editor = candidate
+                break
+
+    if not editor:
+        exit_error("No editor found. Please set the 'EDITOR' environment variable.")
+
+    # Create a temporary file with the JSON content
+    with tempfile.NamedTemporaryFile(mode='w') as temp_file:
+        temp_file.write(data)
+        temp_file.flush()
+
+        # Open the editor
+        if description:
+            console.print(f"✏️  {description}, editor '{editor}'")
+        result = subprocess.run([editor, temp_file.name])
+
+        if result.returncode != 0:
+            exit_error(f"Editor '{editor}' exited with non-zero status: {result.returncode}")
+
+        # Read the modified content
+        with open(temp_file.name, 'r') as modified_file:
+            return modified_file.read()

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tft-cli
-Version: 0.0.26
+Version: 0.0.28
 Summary: Testing Farm CLI tool
 License: Apache-2.0
 Author: Miroslav Vadkerti
@@ -14,6 +14,7 @@ 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: pendulum (>=3.0.0,<4.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.28.dist-info/RECORD

@@ -0,0 +1,12 @@
+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,,