testit-cli 2.11.0__tar.gz → 2.12.0__tar.gz

{testit_cli-2.11.0 → testit_cli-2.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: testit-cli
-Version: 2.11.0
+Version: 2.12.0
 Summary: This tool is the command line wrapper of Test IT allowing you to upload the test results in real time to Test IT
 Home-page: https://pypi.org/project/testit-cli/
 Author: Integration team
@@ -65,6 +65,68 @@ You can see more information in [official documentation](https://docs.testit.sof
 2. Starting with 5.2, we have added a TMS postscript, which means that the utility is compatible with a specific enterprise version.
 3. If you are in doubt about which version to use, check with the support staff. support@yoonion.ru
 
+## Launch a filled test run (`testrun create launch`)
+
+Unlike `testrun create` (empty run), `testrun create launch` creates a **filled** test run.
+
+Provide **exactly one** source:
+
+| Source            | Flag                                   | Behaviour                                         |
+|-------------------|----------------------------------------|---------------------------------------------------|
+| Test plan         | `--test-plan-id` / `-tpi`              | Search automated test points in the TMS test plan |
+| Tags              | `--filter tags=smoke,nightly`          | Search autotests in TMS                           |
+| External IDs file | `--autotest-external-ids-file` / `-af` | One external ID per line in file                  |
+
+Required: `--url`, `--token`, `--project-id`, `--configuration-id`. Optional: `--testrun-name`, `--output` (also write ID to a file).
+
+The command prints `testRunId` to **stdout** (suitable for `export TMS_TEST_RUN_ID=$(...)`).
+
+```bash
+export TMS_TEST_RUN_ID=$(testit testrun create launch \
+  --url "$TMS_URL" \
+  --token "$TMS_TOKEN" \
+  --project-id "$TMS_PROJECT_ID" \
+  --configuration-id "$TMS_CONFIGURATION_ID" \
+  --filter tags=smoke \
+  --testrun-name "CI smoke")
+```
+
+From a test plan:
+
+```bash
+testit testrun create launch \
+  -u "$TMS_URL" -t "$TMS_TOKEN" \
+  -pi "$TMS_PROJECT_ID" -ci "$TMS_CONFIGURATION_ID" \
+  --test-plan-id "$TMS_TEST_PLAN_ID" \
+  -o ./testrun.id
+```
+
+### Autotest external IDs file
+
+`--autotest-external-ids-file` / `-af` expects a plain-text file of **autotest external IDs** (the same values as in TMS / `autoTestExternalIds`, not internal UUIDs or global IDs):
+
+- one external ID per line;
+- empty lines are ignored;
+- lines starting with `#` are comments;
+- duplicate IDs are ignored.
+
+Example `autotest-external-ids.txt`:
+
+```text
+# smoke suite
+login-test-ext-id
+checkout-test-ext-id
+
+payment-test-ext-id
+```
+
+```bash
+testit testrun create launch \
+  -u "$TMS_URL" -t "$TMS_TOKEN" \
+  -pi "$TMS_PROJECT_ID" -ci "$TMS_CONFIGURATION_ID" \
+  -af ./autotest-external-ids.txt
+```
+
 ## Test run tags and links
 
 You can attach **test run** tags and links (for example a CI job URL) via CLI flags or environment variables.  

{testit_cli-2.11.0 → testit_cli-2.12.0}/README.md

@@ -31,6 +31,68 @@ You can see more information in [official documentation](https://docs.testit.sof
 2. Starting with 5.2, we have added a TMS postscript, which means that the utility is compatible with a specific enterprise version.
 3. If you are in doubt about which version to use, check with the support staff. support@yoonion.ru
 
+## Launch a filled test run (`testrun create launch`)
+
+Unlike `testrun create` (empty run), `testrun create launch` creates a **filled** test run.
+
+Provide **exactly one** source:
+
+| Source            | Flag                                   | Behaviour                                         |
+|-------------------|----------------------------------------|---------------------------------------------------|
+| Test plan         | `--test-plan-id` / `-tpi`              | Search automated test points in the TMS test plan |
+| Tags              | `--filter tags=smoke,nightly`          | Search autotests in TMS                           |
+| External IDs file | `--autotest-external-ids-file` / `-af` | One external ID per line in file                  |
+
+Required: `--url`, `--token`, `--project-id`, `--configuration-id`. Optional: `--testrun-name`, `--output` (also write ID to a file).
+
+The command prints `testRunId` to **stdout** (suitable for `export TMS_TEST_RUN_ID=$(...)`).
+
+```bash
+export TMS_TEST_RUN_ID=$(testit testrun create launch \
+  --url "$TMS_URL" \
+  --token "$TMS_TOKEN" \
+  --project-id "$TMS_PROJECT_ID" \
+  --configuration-id "$TMS_CONFIGURATION_ID" \
+  --filter tags=smoke \
+  --testrun-name "CI smoke")
+```
+
+From a test plan:
+
+```bash
+testit testrun create launch \
+  -u "$TMS_URL" -t "$TMS_TOKEN" \
+  -pi "$TMS_PROJECT_ID" -ci "$TMS_CONFIGURATION_ID" \
+  --test-plan-id "$TMS_TEST_PLAN_ID" \
+  -o ./testrun.id
+```
+
+### Autotest external IDs file
+
+`--autotest-external-ids-file` / `-af` expects a plain-text file of **autotest external IDs** (the same values as in TMS / `autoTestExternalIds`, not internal UUIDs or global IDs):
+
+- one external ID per line;
+- empty lines are ignored;
+- lines starting with `#` are comments;
+- duplicate IDs are ignored.
+
+Example `autotest-external-ids.txt`:
+
+```text
+# smoke suite
+login-test-ext-id
+checkout-test-ext-id
+
+payment-test-ext-id
+```
+
+```bash
+testit testrun create launch \
+  -u "$TMS_URL" -t "$TMS_TOKEN" \
+  -pi "$TMS_PROJECT_ID" -ci "$TMS_CONFIGURATION_ID" \
+  -af ./autotest-external-ids.txt
+```
+
 ## Test run tags and links
 
 You can attach **test run** tags and links (for example a CI job URL) via CLI flags or environment variables.  

{testit_cli-2.11.0 → testit_cli-2.12.0}/setup.py

@@ -1,6 +1,6 @@
 from setuptools import find_packages, setup
 
-VERSION = "2.11.0"
+VERSION = "2.12.0"
 
 ADAPTERS_ROOT = "src/testit_cli/adapters_api"
 ADAPTERS_PACKAGES = ["adapters_api"] + [

{testit_cli-2.11.0 → testit_cli-2.12.0}/src/testit_cli/click_commands.py

@@ -3,10 +3,11 @@ from itertools import chain
 
 import click
 
+from .launch_filter import LaunchFilterError, parse_launch_filter, read_autotest_external_ids_file
 from .models.config import Config
 from .service_factory import ServiceFactory
 from .testrun_metadata import parse_testrun_links, parse_testrun_tags
-from .validation import validate_url, validate_uuid
+from .validation import validate_url, validate_url_optional, validate_uuid
 
 
 @click.group()
@@ -178,19 +179,71 @@ def testrun():
     pass
 
 
-@testrun.command("create")
-@click.option("-u", "--url", type=str, envvar='TMS_URL', required=True, help="Set url address of the Test IT instance (https://demo.testit.software)", callback=validate_url)
-@click.option("-t", "--token", type=str, envvar='TMS_TOKEN', required=True, help="Set API token (T2lKd2pLZGI4WHRhaVZUejNl)")
-@click.option("-pi", "--project-id", type=str, envvar='TMS_PROJECT_ID', required=True, help="Set project id (5236eb3f-7c05-46f9-a609-dc0278896464)", callback=validate_uuid)
-@click.option("-tn", "--testrun-name", type=str, envvar='TMS_TEST_RUN_NAME', help="Set test run name (TestRun01)", default=None)
+def _require_create_options(**required_options):
+    """Validate empty-create required options when no subcommand is invoked."""
+    for flag, value in required_options.items():
+        if value is None or value == "":
+            raise click.UsageError(f"Missing option '{flag}'.")
+
+
+def _require_exactly_one_launch_source(
+    test_plan_id: typing.Optional[str],
+    launch_filter: typing.Optional[str],
+    autotest_external_ids_file: typing.Optional[str],
+) -> None:
+    sources = [
+        bool(test_plan_id),
+        bool(launch_filter),
+        bool(autotest_external_ids_file),
+    ]
+    if sum(sources) != 1:
+        raise click.UsageError(
+            "Provide exactly one of: --test-plan-id, --filter, or --autotest-external-ids-file"
+        )
+
+
+def _parse_launch_tags(launch_filter: typing.Optional[str]) -> typing.Optional[typing.List[str]]:
+    if not launch_filter:
+        return None
+    try:
+        return parse_launch_filter(launch_filter)
+    except LaunchFilterError as exc:
+        raise click.BadParameter(str(exc), param_hint="--filter") from exc
+
+
+def _load_autotest_external_ids(path: typing.Optional[str]) -> typing.Optional[typing.List[str]]:
+    if not path:
+        return None
+    autotest_external_ids = read_autotest_external_ids_file(path)
+    if not autotest_external_ids:
+        raise click.BadParameter(
+            "Autotest external ids file is empty (no external IDs)",
+            param_hint="--autotest-external-ids-file",
+        )
+    return autotest_external_ids
+
+
+@testrun.group("create", invoke_without_command=True)
+@click.pass_context
+@click.option("-u", "--url", type=str, envvar='TMS_URL', default=None, help="Set url address of the Test IT instance (https://demo.testit.software)", callback=validate_url_optional)
+@click.option("-t", "--token", type=str, envvar='TMS_TOKEN', default=None, help="Set API token (T2lKd2pLZGI4WHRhaVZUejNl)")
+@click.option("-pi", "--project-id", type=str, envvar='TMS_PROJECT_ID', default=None, help="Set project id (5236eb3f-7c05-46f9-a609-dc0278896464)", callback=validate_uuid)
+@click.option("-tn", "--testrun-name", type=str, envvar='TMS_TEST_RUN_NAME', default=None, help="Set test run name (TestRun01)")
 @click.option("-trt", "--testruntags", type=str, envvar='TMS_TEST_RUN_TAGS', default=None, help=_TESTRUN_TAGS_HELP)
 @click.option("-trl", "--testrunlinks", type=str, envvar='TMS_TEST_RUN_LINKS', default=None, help=_TESTRUN_LINKS_HELP)
-@click.option("-o", "--output", type=str, required=True, help="Set file path for output (FILE)")
+@click.option("-o", "--output", type=str, default=None, help="Set file path for output (FILE)")
 @click.option("-a", "--attachments", multiple=True, type=list, help="Path to attachments for test run (multiple)", default=[], cls=ExtraArgsForOption)
 @click.option("-d", "--debug", is_flag=True, help="Set debug logs")
 @click.option("-dcv", "--disable-cert-validation", is_flag=True, help="Disables certificate validation")
-def create_test_run(url, token, project_id, testrun_name, testruntags, testrunlinks, output, debug, attachments, disable_cert_validation):
+def create_test_run(ctx, url, token, project_id, testrun_name, testruntags, testrunlinks, output, debug, attachments, disable_cert_validation):
     """Creating a new test run"""
+    if ctx.invoked_subcommand is not None:
+        return
+
+    _require_create_options(
+        **{"--url": url, "--token": token, "--project-id": project_id, "--output": output}
+    )
+
     config = Config(
         url=url,
         token=token,
@@ -208,6 +261,41 @@ def create_test_run(url, token, project_id, testrun_name, testruntags, testrunli
     service.create_test_run()
 
 
+@create_test_run.command("launch")
+@click.option("-u", "--url", type=str, envvar='TMS_URL', required=True, help="Set url address of the Test IT instance (https://demo.testit.software)", callback=validate_url)
+@click.option("-t", "--token", type=str, envvar='TMS_TOKEN', required=True, help="Set API token (T2lKd2pLZGI4WHRhaVZUejNl)")
+@click.option("-pi", "--project-id", type=str, envvar='TMS_PROJECT_ID', required=True, help="Set project id (5236eb3f-7c05-46f9-a609-dc0278896464)", callback=validate_uuid)
+@click.option("-ci", "--configuration-id", type=str, envvar='TMS_CONFIGURATION_ID', required=True, help="Set configuration id (15dbb164-c1aa-4cbf-830c-8c01ae14f4fb)", callback=validate_uuid)
+@click.option("-tpi", "--test-plan-id", type=str, envvar='TMS_TEST_PLAN_ID', default=None, help="Create run from test plan (UUID)", callback=validate_uuid)
+@click.option("-f", "--filter", "launch_filter", type=str, default=None, help="TMS filter, e.g. tags=smoke,nightly")
+@click.option("-af", "--autotest-external-ids-file", type=click.Path(exists=True, dir_okay=False, readable=True), default=None, help="File with autotest external IDs (one per line)")
+@click.option("-tn", "--testrun-name", type=str, envvar='TMS_TEST_RUN_NAME', help="Set test run name (TestRun01)", default=None)
+@click.option("-o", "--output", type=str, default=None, help="Optional file path to write test run id")
+@click.option("-d", "--debug", is_flag=True, help="Set debug logs")
+@click.option("-dcv", "--disable-cert-validation", is_flag=True, help="Disables certificate validation")
+def create_launch(url, token, project_id, configuration_id, test_plan_id, launch_filter, autotest_external_ids_file, testrun_name, output, debug, disable_cert_validation):
+    """Create and fill a test run (by plan, tags, or external IDs)"""
+    _require_exactly_one_launch_source(test_plan_id, launch_filter, autotest_external_ids_file)
+    launch_tags = _parse_launch_tags(launch_filter)
+    autotest_external_ids = _load_autotest_external_ids(autotest_external_ids_file)
+
+    config = Config(
+        url=url,
+        token=token,
+        project_id=project_id,
+        configuration_id=configuration_id,
+        test_plan_id=test_plan_id,
+        launch_tags=launch_tags,
+        autotest_external_ids=autotest_external_ids,
+        testrun_name=testrun_name,
+        is_debug=debug,
+        output=output or "",
+        disable_cert_validation=disable_cert_validation,
+    )
+    service = ServiceFactory().get(config)
+    service.launch_test_run()
+
+
 @testrun.command("complete")
 @click.option("-u", "--url", type=str, envvar='TMS_URL', required=True, help="Set url address of the Test IT instance (https://demo.testit.software)", callback=validate_url)
 @click.option("-t", "--token", type=str, envvar='TMS_TOKEN', required=True, help="Set API token (T2lKd2pLZGI4WHRhaVZUejNl)")
@@ -297,7 +385,7 @@ def rerun_test_run(url, token, testrun_id, configuration_id, status_code, failur
 
 
 PYTHON_FRAMEWORKS = ['pytest', 'robotframework', 'behave', 'nose']
-JAVA_FRAMEWORKS = ['gradle-testng', 'gradle-junit5', 'gradle-junit4', 'gradle-cucumber', 'maven-testng', 'maven-junit5', 'maven-junit4', 'maven-cucumber']
+JAVA_FRAMEWORKS = ['gradle-testng', 'gradle-junit6', 'gradle-junit5', 'gradle-junit4', 'gradle-cucumber', 'maven-testng', 'maven-junit6', 'maven-junit5', 'maven-junit4', 'maven-cucumber']
 KOTLIN_FRAMEWORKS = ['kotest']
 JAVASCRIPT_FRAMEWORKS = ['cucumberjs', 'codeceptjs', 'jest', 'mocha', 'playwright', 'testcafe', 'cypress']
 DOTNET_FRAMEWORKS = ['mstest', 'nunit', 'xunit', 'specflow']

{testit_cli-2.11.0 → testit_cli-2.12.0}/src/testit_cli/filter_factory.py

@@ -12,14 +12,16 @@ class FilterFactory:
             'robotframework': cls.__initialize_robotframework_filter,
             'behave': cls.__initialize_behave_filter,
             'nose': cls.__initialize_nose_filter,
-            'gradle-testng': cls.__initialize_gradle_testng_junit4_junit5_filter,
-            'gradle-junit4': cls.__initialize_gradle_testng_junit4_junit5_filter,
-            'gradle-junit5': cls.__initialize_gradle_testng_junit4_junit5_filter,
+            'gradle-testng': cls.__initialize_gradle_testng_junit4_junit5_junit6_filter,
+            'gradle-junit4': cls.__initialize_gradle_testng_junit4_junit5_junit6_filter,
+            'gradle-junit5': cls.__initialize_gradle_testng_junit4_junit5_junit6_filter,
+            'gradle-junit6': cls.__initialize_gradle_testng_junit4_junit5_junit6_filter,
             # 'gradle-jbehave': cls.__initialize_jbehave_filter,
             'gradle-cucumber': cls.__initialize_cucumber_cucumberjs_jest_golang_filter,
-            'maven-testng': cls.__initialize_maven_testng_junit4_junit5_filter,
-            'maven-junit4': cls.__initialize_maven_testng_junit4_junit5_filter,
-            'maven-junit5': cls.__initialize_maven_testng_junit4_junit5_filter,
+            'maven-testng': cls.__initialize_maven_testng_junit4_junit5_junit6_filter,
+            'maven-junit4': cls.__initialize_maven_testng_junit4_junit5_junit6_filter,
+            'maven-junit5': cls.__initialize_maven_testng_junit4_junit5_junit6_filter,
+            'maven-junit6': cls.__initialize_maven_testng_junit4_junit5_junit6_filter,
             # 'maven-jbehave': cls.__initialize_jbehave_filter,
             'maven-cucumber': cls.__initialize_cucumber_cucumberjs_jest_golang_filter,
             'cucumberjs': cls.__initialize_cucumber_cucumberjs_jest_golang_filter,
@@ -65,8 +67,8 @@ class FilterFactory:
         return ' '.join(external_keys)
 
     @staticmethod
-    def __initialize_gradle_testng_junit4_junit5_filter(external_keys: typing.List[str]) -> str:
-        """Initialize filter for gradle TestNG or JUnit4 or JUnit5 run with gradle"""
+    def __initialize_gradle_testng_junit4_junit5_junit6_filter(external_keys: typing.List[str]) -> str:
+        """Initialize filter for gradle TestNG or JUnit4 or JUnit5 or JUnit6 run with gradle"""
         autotest_keys = []
 
         for external_key in external_keys:
@@ -90,8 +92,8 @@ class FilterFactory:
     #     return '+' + ' '.join(external_keys)
 
     @staticmethod
-    def __initialize_maven_testng_junit4_junit5_filter(external_keys: typing.List[str]) -> str:
-        """Initialize filter for TestNG or JUnit4 or JUnit5 run with maven"""
+    def __initialize_maven_testng_junit4_junit5_junit6_filter(external_keys: typing.List[str]) -> str:
+        """Initialize filter for TestNG or JUnit4 or JUnit5 or JUnit6 run with maven"""
         autotest_keys = []
 
         for external_key in external_keys:

testit_cli-2.12.0/src/testit_cli/launch_filter.py

@@ -0,0 +1,57 @@
+"""Parsers for `testrun create launch` filter and autotest external ids file."""
+import typing
+
+
+class LaunchFilterError(ValueError):
+    """Invalid --filter or external ids file content."""
+
+
+def parse_launch_filter(raw: str) -> typing.List[str]:
+    """
+    Parse `--filter tags=tag1,tag2` into a list of tags.
+
+    Only the `tags=` key is supported.
+    """
+    if raw is None:
+        raise LaunchFilterError("Filter value is required")
+
+    value = str(raw).strip()
+    if not value:
+        raise LaunchFilterError("Filter value is empty")
+
+    if "=" not in value:
+        raise LaunchFilterError(
+            f'Unsupported filter "{value}". Expected format: tags=tag1,tag2'
+        )
+
+    key, _, rest = value.partition("=")
+    key = key.strip().lower()
+    if key != "tags":
+        raise LaunchFilterError(
+            f'Unsupported filter key "{key}". Only tags=... is supported'
+        )
+
+    tags = [t.strip() for t in rest.split(",") if t.strip()]
+    if not tags:
+        raise LaunchFilterError("Filter tags=... must list at least one tag")
+    return tags
+
+
+def read_autotest_external_ids_file(path: str) -> typing.List[str]:
+    """
+    Read autotest external IDs from a file: one ID per line.
+    Empty lines and lines starting with # are ignored.
+    """
+    ids: typing.List[str] = []
+    seen = set()
+
+    with open(path, "r", encoding="utf-8") as handle:
+        for line in handle:
+            stripped = line.strip()
+            if not stripped or stripped.startswith("#"):
+                continue
+            if stripped not in seen:
+                seen.add(stripped)
+                ids.append(stripped)
+
+    return ids

{testit_cli-2.11.0 → testit_cli-2.12.0}/src/testit_cli/models/config.py

@@ -38,3 +38,6 @@ class Config:
     framework: str = ""
     ignore_flaky_failure: bool = False
     autotest_layer: typing.Optional[str] = None
+    test_plan_id: typing.Optional[str] = None
+    launch_tags: typing.Optional[list[str]] = None
+    autotest_external_ids: typing.Optional[list[str]] = None

{testit_cli-2.11.0 → testit_cli-2.12.0}/src/testit_cli/service.py

@@ -1,6 +1,7 @@
 import logging
 import typing
 
+import click
 from adapters_api.model.assign_attachment_api_model import AssignAttachmentApiModel
 from adapters_api.model.attachment_put_model import AttachmentPutModel
 from .apiclient import ApiClient
@@ -13,6 +14,7 @@ from .models.config import Config
 from .models.testrun import TestRun
 from .parser import Parser
 from .testrun_metadata import merge_links, merge_tags, to_create_link_models, to_update_link_models
+from .v2_client import V2Client
 
 
 class Service:
@@ -22,13 +24,15 @@ class Service:
         api_client: ApiClient,
         parser: Parser,
         importer: Importer,
-        autotests_filter: AutotestsFilter
+        autotests_filter: AutotestsFilter,
+        v2_client: typing.Optional[V2Client] = None,
     ):
         self.__config = config
         self.__api_client = api_client
         self.__parser = parser
         self.__importer = importer
         self.__autotests_filter = autotests_filter
+        self.__v2_client = v2_client
 
     def import_results(self):
         self.__upload_results()
@@ -43,6 +47,49 @@ class Service:
 
         self.__write_to_output(test_run.id)
 
+    def launch_test_run(self) -> None:
+        if self.__v2_client is None:
+            raise RuntimeError("V2Client is required for testrun create launch")
+
+        if self.__config.test_plan_id:
+            work_item_ids = self.__v2_client.search_test_point_work_item_ids(
+                self.__config.test_plan_id,
+                self.__config.configuration_id,
+            )
+            if not work_item_ids:
+                raise ValueError(
+                    "No automated work items found for the given test plan and configuration"
+                )
+            test_run_id = self.__v2_client.create_run_by_work_items(
+                self.__config.project_id,
+                self.__config.test_plan_id,
+                self.__config.configuration_id,
+                work_item_ids,
+                name=self.__config.testrun_name,
+            )
+        else:
+            external_ids = self.__config.autotest_external_ids
+            if external_ids is None and self.__config.launch_tags:
+                external_ids = self.__v2_client.search_autotest_external_ids(
+                    self.__config.project_id,
+                    self.__config.launch_tags,
+                )
+            if not external_ids:
+                raise ValueError(
+                    "No autotest external IDs resolved for launch "
+                    "(empty search result or empty ids file)"
+                )
+            test_run_id = self.__v2_client.create_run_by_auto_tests(
+                self.__config.project_id,
+                self.__config.configuration_id,
+                external_ids,
+                name=self.__config.testrun_name,
+            )
+
+        click.echo(test_run_id)
+        if self.__config.output:
+            self.__write_to_output(test_run_id)
+
     def rerun_test_run(self) -> None:
         self.__api_client.rerun_test_run(
             self.__config.testrun_id,

{testit_cli-2.11.0 → testit_cli-2.12.0}/src/testit_cli/service_factory.py

@@ -5,6 +5,7 @@ from .logger import Logger
 from .models.config import Config
 from .parser import Parser
 from .service import Service
+from .v2_client import V2Client
 
 
 class ServiceFactory:
@@ -13,8 +14,9 @@ class ServiceFactory:
         Logger.register_logger(config.is_debug)
 
         api_client = ApiClient(config.url, config.token, config.disable_cert_validation)
+        v2_client = V2Client(config.url, config.token, config.disable_cert_validation)
         parser = Parser(config)
         importer = Importer(api_client, config)
         autotests_filter = AutotestsFilter(api_client, config)
 
-        return Service(config, api_client, parser, importer, autotests_filter)
+        return Service(config, api_client, parser, importer, autotests_filter, v2_client)