tft-cli 0.0.28__tar.gz → 0.0.29__tar.gz

{tft_cli-0.0.28 → tft_cli-0.0.29}/PKG-INFO

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

{tft_cli-0.0.28 → tft_cli-0.0.29}/pyproject.toml

@@ -4,7 +4,7 @@ name = "tft-cli"
 
 [tool.poetry]
 name = "tft-cli"
-version = "0.0.28"
+version = "0.0.29"
 description = "Testing Farm CLI tool"
 authors = ["Miroslav Vadkerti <mvadkert@redhat.com>"]
 license = "Apache-2.0"

{tft_cli-0.0.28 → tft_cli-0.0.29}/src/tft/cli/commands.py

@@ -68,7 +68,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
@@ -329,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:
@@ -478,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],
@@ -878,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,
@@ -914,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,
@@ -1070,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
@@ -1217,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")
@@ -1230,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}
 
@@ -1423,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:
@@ -1793,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"),
@@ -1908,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)