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 Become a sponsor TP for kiwitcms/tap-plugin (master)

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

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-0.4.tar.gz (17.8 kB view details)

Uploaded Source

Built Distribution

kiwitcms_tap_plugin-0.4-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kiwitcms-tap-plugin-0.4.tar.gz
  • Upload date:
  • Size: 17.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.7.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.6.3

File hashes

Hashes for kiwitcms-tap-plugin-0.4.tar.gz
Algorithm Hash digest
SHA256 5f30172eed1765416dc949a147740c9e803107969ab18f57ec94d2fc43ea2ead
MD5 3169b882f026d672cd77e791b364dd83
BLAKE2b-256 d041c94bc17db498d4608f335c65aa0ef65ebde660daa0f75ba664ad0f760412

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kiwitcms_tap_plugin-0.4-py3-none-any.whl
  • Upload date:
  • Size: 6.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.7.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.6.3

File hashes

Hashes for kiwitcms_tap_plugin-0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 00b37defdf6891b026a084bdb2b8325dc3cd331b57763e7c90eb47a4a60ad9f9
MD5 94128bbda861709e6d7c0bc3fab6e7d4
BLAKE2b-256 ab3969a0f0f3f03a8e70c143347a2cdaa457529b91456260055fe03db8f92223

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