Skip to main content

Test Anything Protocol (TAP) plugin for Kiwi TCMS test case management system

Project description

PyPI version Travis CI Code coverage Python updates TP for kiwitcms/tap-plugin (master) Tidelift Become a sponsor Kiwi TCMS on Twitter

This package allows you to read Test Anything Protocol (TAP) files and send the results to Kiwi TCMS.


pip install kiwitcms-tap-plugin

Configuration and environment

Minimal config file ~/.tcms.conf:

url = https://tcms.server/xml-rpc/
username = your-username
password = your-password

For more info see tcms-api docs.

This plugin is only concerned with parsing the TAP format and executing tcms-api functions which will create/reuse test cases, test plans and test runs. tcms-api behavior is controlled via environment variables.

For example this is how our own environment looks like:


if [ "$TRAVIS_EVENT_TYPE" == "push" ]; then
    # same as $TRAVIS_TAG when building tags

if [ "$TRAVIS_EVENT_TYPE" == "pull_request" ]; then


Further documentation and behavior specification can be found here.

The above configuration creates a separate TestPlan for each branch, see TP-6: [TAP] Plan for kiwitcms/tap-plugin (master), a separate TestPlan for each pull request (recording possible multiple test runs) and separate TestPlan and TestRun for each tag on GitHub! tcms-api has default behavior for Travis CI and Jenkins and allows endless configuration via environment variables.


# define environment variables
tcms-tap-plugin /path/to/results.tap


v10.0 (02 Mar 2021)

  • Compatible with Kiwi TCMS v10.0
  • Update tcms-api to 10.0

v9.0 (13 Jan 2021)

  • Compatible with Kiwi TCMS v9.0
  • Update tcms-api to 9.0
  • Resolve a dependency issue in tests

v8.4 (28 Oct 2020)

  • Update tcms-api to 8.6.0

v8.3 (10 Apr 2020)

  • Update to tcms-api v8.3.0 which uses gssapi for Kerberos
  • Requires MIT Kerberos for Windows if installed on Windows

v8.2 (03 Apr 2020)

This version works only with Kiwi TCMS v8.2 or later!

  • Update to tcms-api==8.2.0
  • Patch for changed return value in plugin_helpers.Backend.test_case_get_or_create()
  • Call plugin_helpers.backend.finish_test_run() when done. Fixes Issue #9

v8.0.1 (10 February 2020)

This version works only with Kiwi TCMS v8.0 or later!

  • Update to tcms-api==8.0.1

v8.0 (09 February 2020)

This version works only with Kiwi TCMS v8.0 or later!

  • Adjust plugin due to API changes in Kiwi TCMS v8.0
  • Update from 2.6.2 to 3.0
  • Require tcms-api>=8.0

v0.5 (07 January 2020)

  • Update dependency from 2.6.1 to 2.6.2

v0.4 (23 September 2019)

  • Include traceback from TAP file as TE comment. Fixes Issue #7 (Christophe CHAUVET)

v0.3 (10 April 2019)

  • Works with Kiwi TCMS v6.7 or newer
  • Uses new names of API methods

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for kiwitcms-tap-plugin, version 10.0
Filename, size File type Python version Upload date Hashes
Filename, size kiwitcms_tap_plugin-10.0-py3-none-any.whl (7.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size kiwitcms-tap-plugin-10.0.tar.gz (19.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page