Test Anything Protocol (TAP) plugin for Kiwi TCMS
=================================================
.. image:: https://img.shields.io/pypi/v/kiwitcms-tap-plugin.svg
:target: https://pypi.org/project/kiwitcms-tap-plugin
:alt: PyPI version
.. image:: https://travis-ci.org/kiwitcms/tap-plugin.svg?branch=master
:target: https://travis-ci.org/kiwitcms/tap-plugin
:alt: Travis CI
.. image:: https://coveralls.io/repos/github/kiwitcms/tap-plugin/badge.svg?branch=master
:target: https://coveralls.io/github/kiwitcms/tap-plugin?branch=master
:alt: Code coverage
.. image:: https://pyup.io/repos/github/kiwitcms/tap-plugin/shield.svg
:target: https://pyup.io/repos/github/kiwitcms/tap-plugin/
:alt: Python updates
.. image:: https://img.shields.io/badge/kiwi%20tcms-results-9ab451.svg
:target: https://tcms.kiwitcms.org/plan/6/
:alt: TP for kiwitcms/tap-plugin (master)
.. image:: https://tidelift.com/badges/package/pypi/kiwitcms-tap-plugin
:target: https://tidelift.com/subscription/pkg/pypi-kiwitcms-tap-plugin?utm_source=pypi-kiwitcms-tap-plugin&utm_medium=github&utm_campaign=readme
:alt: Tidelift
.. image:: https://opencollective.com/kiwitcms/tiers/sponsor/badge.svg?label=sponsors&color=brightgreen
:target: https://opencollective.com/kiwitcms#contributors
:alt: Become a sponsor
.. image:: https://img.shields.io/twitter/follow/KiwiTCMS.svg
:target: https://twitter.com/KiwiTCMS
:alt: Kiwi TCMS on Twitter
This package allows you to read Test Anything Protocol (TAP) files and
send the results to `Kiwi TCMS <http://kiwitcms.org>`_.
Installation
------------
::
pip install kiwitcms-tap-plugin
Note: this plugin should be installed on the system executing your automated tests
or a separate system whose task is to parse the results and import them into Kiwi TCMS.
This is usually not your Kiwi TCMS container!
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 <https://tcms-api.readthedocs.io>`_.
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 inside
`.github/workflows/testing.yml <https://github.com/kiwitcms/tap-plugin/blob/master/.github/workflows/testing.yml>`_
this looks like::
export TCMS_PRODUCT=$GITHUB_REPOSITORY
export TCMS_PRODUCT_VERSION=$(echo $GITHUB_REF | sed "s|refs/heads/||" | sed "s|refs/||" | sed "s|/merge||")
export TCMS_BUILD=$(echo $GITHUB_SHA | cut -c1-7)
Further documentation and behavior specification can be found
`here <https://tcms-api.readthedocs.io/en/latest/modules/tcms_api.plugin_helpers.html>`_.
The above configuration creates a separate TestPlan for each branch, for example
`TP-6: [TAP] Plan for kiwitcms/tap-plugin (master) <https://tcms.kiwitcms.org/plan/6/>`_,
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
---------
v12.8.1 (22 Dec 2023)
~~~~~~~~~~~~~~~~~~~~~
- Update tcms-api from 12.7 to 12.8.1
- Relax dependency requirement towards tcms-api for easier upgrade
v12.7 (11 Dec 2023)
~~~~~~~~~~~~~~~~~~~
- Update tcms-api from 11.3 to 12.7
- Update README to avoid confusions where to install this package. Closes
`Issue #62 <https://github.com/kiwitcms/tap-plugin/issues/62>`_
- Build and test with Python 3.11
- Reformat source code with Black
- Enable CodeQL for code scanning
- Small refactoring internally
v11.3 (17 May 2022)
~~~~~~~~~~~~~~~~~~~
- Update tcms-api from 11.2 to 11.3
- Print information about created recrods if ``-v`` or ``--verbose``
is specified on the command line
- Allow multiple TAP files to be specified on the command line. Fixes
`Issue #57 <https://github.com/kiwitcms/tap-plugin/issues/57>`_
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 <https://github.com/kiwitcms/tap-plugin/issues/5>`_ and
`Issue #13 <https://github.com/kiwitcms/tap-plugin/issues/13>`_
- Fix bug with traceback not being posted as comment.
`Issue #48 <https://github.com/kiwitcms/tap-plugin/issues/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 <https://github.com/kiwitcms/tcms-api/#v830-10-april-2020>`_
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 <https://github.com/kiwitcms/tap-plugin/issues/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 <https://github.com/kiwitcms/tap-plugin/issues/7>`_
(Christophe CHAUVET)
v0.3 (10 April 2019)
~~~~~~~~~~~~~~~~~~~~
- Works with Kiwi TCMS v6.7 or newer
- Uses new names of API methods
Raw data
{
"_id": null,
"home_page": "https://github.com/kiwitcms/tap-plugin",
"name": "kiwitcms-tap-plugin",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Kiwi TCMS",
"author_email": "info@kiwitcms.org",
"download_url": "https://files.pythonhosted.org/packages/3d/c9/330b0841052307368343b24df6404f2eff58acae8f2157d58428f2679fa3/kiwitcms-tap-plugin-12.8.1.tar.gz",
"platform": null,
"description": "Test Anything Protocol (TAP) plugin for Kiwi TCMS\n=================================================\n\n.. image:: https://img.shields.io/pypi/v/kiwitcms-tap-plugin.svg\n :target: https://pypi.org/project/kiwitcms-tap-plugin\n :alt: PyPI version\n\n.. image:: https://travis-ci.org/kiwitcms/tap-plugin.svg?branch=master\n :target: https://travis-ci.org/kiwitcms/tap-plugin\n :alt: Travis CI\n\n.. image:: https://coveralls.io/repos/github/kiwitcms/tap-plugin/badge.svg?branch=master\n :target: https://coveralls.io/github/kiwitcms/tap-plugin?branch=master\n :alt: Code coverage\n\n.. image:: https://pyup.io/repos/github/kiwitcms/tap-plugin/shield.svg\n :target: https://pyup.io/repos/github/kiwitcms/tap-plugin/\n :alt: Python updates\n\n.. image:: https://img.shields.io/badge/kiwi%20tcms-results-9ab451.svg\n :target: https://tcms.kiwitcms.org/plan/6/\n :alt: TP for kiwitcms/tap-plugin (master)\n\n.. image:: https://tidelift.com/badges/package/pypi/kiwitcms-tap-plugin\n :target: https://tidelift.com/subscription/pkg/pypi-kiwitcms-tap-plugin?utm_source=pypi-kiwitcms-tap-plugin&utm_medium=github&utm_campaign=readme\n :alt: Tidelift\n\n.. image:: https://opencollective.com/kiwitcms/tiers/sponsor/badge.svg?label=sponsors&color=brightgreen\n :target: https://opencollective.com/kiwitcms#contributors\n :alt: Become a sponsor\n\n.. image:: https://img.shields.io/twitter/follow/KiwiTCMS.svg\n :target: https://twitter.com/KiwiTCMS\n :alt: Kiwi TCMS on Twitter\n\nThis package allows you to read Test Anything Protocol (TAP) files and\nsend the results to `Kiwi TCMS <http://kiwitcms.org>`_.\n\n\nInstallation\n------------\n\n::\n\n pip install kiwitcms-tap-plugin\n\n\nNote: this plugin should be installed on the system executing your automated tests\nor a separate system whose task is to parse the results and import them into Kiwi TCMS.\nThis is usually not your Kiwi TCMS container!\n\n\nConfiguration and environment\n-----------------------------\n\nMinimal config file `~/.tcms.conf`::\n\n [tcms]\n url = https://tcms.server/xml-rpc/\n username = your-username\n password = your-password\n\n\nFor more info see `tcms-api docs <https://tcms-api.readthedocs.io>`_.\n\nThis plugin is only concerned with parsing the TAP format and executing\n``tcms-api`` functions which will create/reuse test cases, test plans and test runs.\n``tcms-api`` behavior is controlled via environment variables.\n\nFor example inside\n`.github/workflows/testing.yml <https://github.com/kiwitcms/tap-plugin/blob/master/.github/workflows/testing.yml>`_\nthis looks like::\n\n export TCMS_PRODUCT=$GITHUB_REPOSITORY\n export TCMS_PRODUCT_VERSION=$(echo $GITHUB_REF | sed \"s|refs/heads/||\" | sed \"s|refs/||\" | sed \"s|/merge||\")\n export TCMS_BUILD=$(echo $GITHUB_SHA | cut -c1-7)\n\n\nFurther documentation and behavior specification can be found\n`here <https://tcms-api.readthedocs.io/en/latest/modules/tcms_api.plugin_helpers.html>`_.\n\nThe above configuration creates a separate TestPlan for each branch, for example\n`TP-6: [TAP] Plan for kiwitcms/tap-plugin (master) <https://tcms.kiwitcms.org/plan/6/>`_,\na separate TestPlan for each pull request (recording possible multiple test runs) and\nseparate TestPlan and TestRun for each tag on GitHub! ``tcms-api`` has default behavior\nfor Travis CI and Jenkins and allows endless configuration via environment variables.\n\n\nUsage\n-----\n\n::\n\n # define environment variables\n tcms-tap-plugin /path/to/results.tap\n\n\nChangelog\n---------\n\nv12.8.1 (22 Dec 2023)\n~~~~~~~~~~~~~~~~~~~~~\n\n- Update tcms-api from 12.7 to 12.8.1\n- Relax dependency requirement towards tcms-api for easier upgrade\n\n\nv12.7 (11 Dec 2023)\n~~~~~~~~~~~~~~~~~~~\n\n- Update tcms-api from 11.3 to 12.7\n- Update README to avoid confusions where to install this package. Closes\n `Issue #62 <https://github.com/kiwitcms/tap-plugin/issues/62>`_\n- Build and test with Python 3.11\n- Reformat source code with Black\n- Enable CodeQL for code scanning\n- Small refactoring internally\n\n\nv11.3 (17 May 2022)\n~~~~~~~~~~~~~~~~~~~\n\n- Update tcms-api from 11.2 to 11.3\n- Print information about created recrods if ``-v`` or ``--verbose``\n is specified on the command line\n- Allow multiple TAP files to be specified on the command line. Fixes\n `Issue #57 <https://github.com/kiwitcms/tap-plugin/issues/57>`_\n\n\nv11.2 (15 May 2022)\n~~~~~~~~~~~~~~~~~~~\n\n- Update tap.py from 3.0 to 3.1\n- Update tcms-api from 11.0 to 11.2. Closes\n `Issue #5 <https://github.com/kiwitcms/tap-plugin/issues/5>`_ and\n `Issue #13 <https://github.com/kiwitcms/tap-plugin/issues/13>`_\n- Fix bug with traceback not being posted as comment.\n `Issue #48 <https://github.com/kiwitcms/tap-plugin/issues/48>`_\n\n\nv11.0 (05 Dec 2021)\n~~~~~~~~~~~~~~~~~~~\n\n- Future compatible with upcoming Kiwi TCMS v11.0\n- Update tcms-api from 10.0 to 11.0\n- Pylint fixes\n\n\nv10.0 (02 Mar 2021)\n~~~~~~~~~~~~~~~~~~~\n\n- Compatible with Kiwi TCMS v10.0\n- Update tcms-api to 10.0\n\n\nv9.0 (13 Jan 2021)\n~~~~~~~~~~~~~~~~~~\n\n- Compatible with Kiwi TCMS v9.0\n- Update tcms-api to 9.0\n- Resolve a dependency issue in tests\n\n\nv8.4 (28 Oct 2020)\n~~~~~~~~~~~~~~~~~~\n\n- Update tcms-api to 8.6.0\n\n\nv8.3 (10 Apr 2020)\n~~~~~~~~~~~~~~~~~~\n\n- Update to\n `tcms-api v8.3.0 <https://github.com/kiwitcms/tcms-api/#v830-10-april-2020>`_\n which uses ``gssapi`` for Kerberos\n- Requires MIT Kerberos for Windows if installed on Windows\n\n\nv8.2 (03 Apr 2020)\n~~~~~~~~~~~~~~~~~~\n\nThis version works only with Kiwi TCMS v8.2 or later!\n\n- Update to tcms-api==8.2.0\n- Patch for changed return value in\n ``plugin_helpers.Backend.test_case_get_or_create()``\n- Call ``plugin_helpers.backend.finish_test_run()`` when done. Fixes\n `Issue #9 <https://github.com/kiwitcms/tap-plugin/issues/9>`_\n\n\nv8.0.1 (10 February 2020)\n~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThis version works only with Kiwi TCMS v8.0 or later!\n\n- Update to tcms-api==8.0.1\n\n\nv8.0 (09 February 2020)\n~~~~~~~~~~~~~~~~~~~~~~~\n\nThis version works only with Kiwi TCMS v8.0 or later!\n\n- Adjust plugin due to API changes in Kiwi TCMS v8.0\n- Update ``tap.py`` from 2.6.2 to 3.0\n- Require ``tcms-api>=8.0``\n\n\nv0.5 (07 January 2020)\n~~~~~~~~~~~~~~~~~~~~~~\n\n- Update ``tap.py`` dependency from 2.6.1 to 2.6.2\n\n\nv0.4 (23 September 2019)\n~~~~~~~~~~~~~~~~~~~~~~~~\n\n- Include traceback from TAP file as TE comment. Fixes\n `Issue #7 <https://github.com/kiwitcms/tap-plugin/issues/7>`_\n (Christophe CHAUVET)\n\n\nv0.3 (10 April 2019)\n~~~~~~~~~~~~~~~~~~~~\n\n- Works with Kiwi TCMS v6.7 or newer\n- Uses new names of API methods\n",
"bugtrack_url": null,
"license": "GPLv3+",
"summary": "Test Anything Protocol (TAP) plugin for Kiwi TCMS test case management system",
"version": "12.8.1",
"project_urls": {
"Homepage": "https://github.com/kiwitcms/tap-plugin"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "52b7d3238e7f63aed61e7f71f403c35e8a967cb71c1fb3435bbb811e5882de40",
"md5": "e3703bb172ad6f5b14e282ddddc9d4d2",
"sha256": "cb5e7323973b84c61dd684c4816a9fe208b04dbee0ae88aea2507fa67d67c9c6"
},
"downloads": -1,
"filename": "kiwitcms_tap_plugin-12.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e3703bb172ad6f5b14e282ddddc9d4d2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 17965,
"upload_time": "2023-12-22T11:19:50",
"upload_time_iso_8601": "2023-12-22T11:19:50.939796Z",
"url": "https://files.pythonhosted.org/packages/52/b7/d3238e7f63aed61e7f71f403c35e8a967cb71c1fb3435bbb811e5882de40/kiwitcms_tap_plugin-12.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3dc9330b0841052307368343b24df6404f2eff58acae8f2157d58428f2679fa3",
"md5": "cec4e1c9cb780bff8bb1d9eb419592de",
"sha256": "3ffe6cd37be166b58e8fe66ff982d98a87ac0f2e5ac68eecddfefbb7e794129d"
},
"downloads": -1,
"filename": "kiwitcms-tap-plugin-12.8.1.tar.gz",
"has_sig": false,
"md5_digest": "cec4e1c9cb780bff8bb1d9eb419592de",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17701,
"upload_time": "2023-12-22T11:19:52",
"upload_time_iso_8601": "2023-12-22T11:19:52.958816Z",
"url": "https://files.pythonhosted.org/packages/3d/c9/330b0841052307368343b24df6404f2eff58acae8f2157d58428f2679fa3/kiwitcms-tap-plugin-12.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-22 11:19:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kiwitcms",
"github_project": "tap-plugin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "kiwitcms-tap-plugin"
}
JSON
