Skip to main content
https://travis-ci.org/gdyuldin/testrail_reporter.svg?branch=master https://codecov.io/gh/gdyuldin/testrail_reporter/branch/master/graph/badge.svg

This reporter helps to send xUnit XML report from automated tests to TestRail.

Matching rules

For correct reporting, reporter makes indentifications strings for all xUnit and TestRail cases. Identification strings are makes by templates - one for xUnit and one for TestRail Case. Templates are just Format Strings. Next reporter searchs xUnit testcase indentification string in all TestRail cases indentifications strings.

xUnit template variables

  • classname (like tempest.api.network.test_routers.RoutersIpV6Test)

  • methodname (from report, like test_update_router_admin_state[id-a8902683-c788-4246-95c7-ad9c6d63a4d9])

  • id (extracts from methodname, e.g. for test_a[(12345)] it will be 12345)

  • uuid (extracts from methodname, e.g. for test_quotas[network,id-2390f766-836d-40ef-9aeb-e810d78207fb,network] it will be 2390f766-836d-40ef-9aeb-e810d78207fb)

Argument name: --xunit-name-template

Default value: {id}

xUnit template may looks like '{classname}.{methodname}' or just '{id}'.

TestRail template variables

  • custom_report_label (Report Label in UI)

  • custom_test_group (Test Group in UI)

  • title

Argument name: --testrail-name-template

Default value: {custom_report_label}

Also possible to use other variables (full list here - TestRail Api Documentation)

TestRail template may looks like '{custom_report_label}' or '{custom_test_group}.{title}'.

Collisions

If one xUnit case matches to more than one TestRail case or one TestRail case matches to more than one xUnit case - reporter stops work, print out this cases and exits with error.

Usage

usage: report [-h] [--xunit-name-template XUNIT_NAME_TEMPLATE]
              [--testrail-name-template TESTRAIL_NAME_TEMPLATE]
              [--env-description ENV_DESCRIPTION]
              (--iso-id ISO_ID | --testrail-plan-name TESTRAIL_PLAN_NAME)
              [--test-results-link TEST_RESULTS_LINK]
              [--testrail-url TESTRAIL_URL] [--testrail-user TESTRAIL_USER]
              [--testrail-password TESTRAIL_PASSWORD]
              [--testrail-project TESTRAIL_PROJECT]
              [--testrail-milestone TESTRAIL_MILESTONE]
              [--testrail-suite TESTRAIL_SUITE] [--send-skipped]
              [--paste-url PASTE_URL] [--verbose]
              xunit_report

Report to testrail

positional arguments:
  xunit_report          xUnit report XML file

optional arguments:
  -h, --help            show this help message and exit
  --xunit-name-template XUNIT_NAME_TEMPLATE
                        template for xUnit cases to make id string
  --testrail-name-template TESTRAIL_NAME_TEMPLATE
                        template for TestRail cases to make id string
  --env-description ENV_DESCRIPTION
                        env deploy type description (for TestRun name)
  --iso-id ISO_ID       id of build Fuel iso (DEPRECATED)
  --testrail-plan-name TESTRAIL_PLAN_NAME
                        name of test plan to be displayed in testrail
  --test-results-link TEST_RESULTS_LINK
                        link to test job results
  --testrail-url TESTRAIL_URL
                        base url of testrail
  --testrail-user TESTRAIL_USER
                        testrail user
  --testrail-password TESTRAIL_PASSWORD
                        testrail password
  --testrail-project TESTRAIL_PROJECT
                        testrail project name
  --testrail-milestone TESTRAIL_MILESTONE
                        testrail project milestone
  --testrail-suite TESTRAIL_SUITE
                        testrail project suite name
  --send-skipped        send skipped cases to testrail
  --paste-url PASTE_URL
                        paste service to send test case logs and trace
  --verbose, -v         Verbose mode

Release files for xunit2testrail 0.7.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for xunit2testrail 0.7.3
File Size Uploaded
xunit2testrail-0.7.3.tar.gz 16.3 kB Details

Release files / xunit2testrail-0.7.3.tar.gz

Download URL xunit2testrail-0.7.3.tar.gz
Size 16.3 kB
Tags Source
SHA-256 checksum
How to use checksums
b97c8807c2fee21d9b7ed15609a1b94f165613531a41dbd3dc41d3cc85de50ad
BLAKE2b-256 checksum
How to use checksums
3fb47c2005791cb758d8a196ca8f5a3b70ddd9fbaedbfb995a206e5090bc1064
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.7.3 This release

1 release file

0.7.2

1 release file

0.7.1

1 release file

0.7.0

0.6.1

1 release file

0.6.0

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page