Test IT CLI

This tool is the command line wrapper of Test IT allowing you to upload the test results in real time to Test IT. You can see more information in official documentation

Compatibility

1. For current versions, see the releases tab.
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:

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=$(...)).

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:

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:

# smoke suite
login-test-ext-id
checkout-test-ext-id

payment-test-ext-id

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.
They are applied when the test run is created, or merged into an existing run as early as possible (not only after results upload finishes).

Supported commands: testrun create, results import, results upload.

Tags format

Comma-separated list or JSON array:

--testruntags "smoke,nightly"
--testruntags '["smoke","nightly"]'

Links format

JSON array of objects. url is required; title, description, and type are optional.

Link types for a test run:

• Related
• BlockedBy
• Defect
• Issue
• Requirement
• Repository

If type is omitted, Related is used.

--testrunlinks '[{"url":"https://gitlab.example.com/group/project/-/jobs/12345","title":"CI Job","type":"Related"}]'

Examples

Create a test run with tags and a CI job link (visible while the run is still In progress):

testit testrun create \
  --url "$TMS_URL" \
  --token "$TMS_TOKEN" \
  --project-id "$TMS_PROJECT_ID" \
  --testruntags "smoke,ci" \
  --testrunlinks "[{\"url\":\"$CI_JOB_URL\",\"title\":\"CI Job\",\"type\":\"Related\"}]" \
  --output ./testrun.id

Same via env vars:

export TMS_TEST_RUN_TAGS='smoke,ci'
export TMS_TEST_RUN_LINKS="[{\"url\":\"$CI_JOB_URL\",\"title\":\"CI Job\",\"type\":\"Related\"}]"
testit testrun create -u "$TMS_URL" -t "$TMS_TOKEN" -pi "$TMS_PROJECT_ID" -o ./testrun.id

Merge tags/links into an existing run when uploading results:

testit results upload \
  --url "$TMS_URL" \
  --token "$TMS_TOKEN" \
  --configuration-id "$TMS_CONFIGURATION_ID" \
  --testrun-id "$TMS_TEST_RUN_ID" \
  --testruntags "nightly" \
  --testrunlinks "[{\"url\":\"$CI_JOB_URL\",\"title\":\"CI Job\",\"type\":\"Related\"}]" \
  --results ./results

Notes:

• Test run tags/links are independent from autotest/result tags and links.
• On an existing run, new tags/links are merged (existing values are kept; duplicates by tag name / link URL are skipped).
• Empty or omitted values mean “do not change tags/links”.

Autotest layer (test pyramid)

When importing XML results, CLI can set the autotest pyramid layer for every upserted autotest (create/update).
This is a run-level default for file-based import; adapters still read layer from test code annotations.

Supported commands: results import, results upload.

Recommended values: E2E, UI, API, Contract, Integration, Component, Unit. Any other non-empty string is accepted.

export TMS_AUTOTEST_LAYER=API
testit results import \
  --url "$TMS_URL" \
  --token "$TMS_TOKEN" \
  --project-id "$TMS_PROJECT_ID" \
  --configuration-id "$TMS_CONFIGURATION_ID" \
  --results ./results

Behaviour (aligned with adapters API):

• Layer set → send layer: { name, source: Run } on create/update.
• Layer not set → do not send layer; on update always send resetLayer: false.