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.

Installation

pip install kiwitcms-tap-plugin

Configuration and environment

Minimal config file ~/.tcms.conf:

[tcms]
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:

#!/bin/bash

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

if [ "$TRAVIS_EVENT_TYPE" == "pull_request" ]; then
    export TCMS_PRODUCT_VERSION="PR-$TRAVIS_PULL_REQUEST"
fi

export TCMS_BUILD="$TRAVIS_BUILD_NUMBER-$(echo $TRAVIS_COMMIT | cut -c1-7)"

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.

Usage

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

Changelog

v11.2 (15 May 2022)

  • Update tap.py from 3.0 to 3.1

  • Update tcms-api from 11.0 to 11.2. Closes Issue #5 and Issue #13

  • Fix bug with traceback not being posted as comment. Issue #48

v11.0 (05 Dec 2021)

  • Future compatible with upcoming Kiwi TCMS v11.0

  • Update tcms-api from 10.0 to 11.0

  • Pylint fixes

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 tap.py from 2.6.2 to 3.0

  • Require tcms-api>=8.0

v0.5 (07 January 2020)

  • Update tap.py 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.

Source Distribution

kiwitcms-tap-plugin-11.2.tar.gz (17.1 kB view details)

Uploaded Source

Built Distribution

kiwitcms_tap_plugin-11.2-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

Details for the file kiwitcms-tap-plugin-11.2.tar.gz.

File metadata

  • Download URL: kiwitcms-tap-plugin-11.2.tar.gz
  • Upload date:
  • Size: 17.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.8.10

File hashes

Hashes for kiwitcms-tap-plugin-11.2.tar.gz
Algorithm Hash digest
SHA256 c8051fb0aec61d0851a1391500a4be5c1e8fcc7fb59c699641344dc61ba6541e
MD5 1fd319deb452fa91b4a7dcc7a09ddd33
BLAKE2b-256 e8e9ca341d2f6910fb47192aeabc172ca641d443977409e75ebb5de25d231f7b

See more details on using hashes here.

File details

Details for the file kiwitcms_tap_plugin-11.2-py3-none-any.whl.

File metadata

File hashes

Hashes for kiwitcms_tap_plugin-11.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5b280deb0a89469978ff6cb07be5e857bd0e67a1b2712bfb3d8484bb7f34cf2a
MD5 0bc947bd7fe19a2bffcfb3f1aec42043
BLAKE2b-256 cd0c88021f5a655136333eea317fd970e010c6e2f3c9b7c7476d37459ee9f8a2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page