Package: tcms-api
This package allows to connect and access Kiwi TCMS API.DOCUMENTATIONhttps://tcms-api.readthedocs.io/en/latest/modules/tcms_api.htmlCHANGELOGv12.9.1 (13 Jan 2024)Refactor RPC connection refresh using a proxy-class pattern which also
takes care to call.login()upon refreshv12.9 (12 Jan 2024)Refresh internal https transport every 4 minutes to avoid anssl.SSLEOFError: EOF occurred in violation of protocolerror
on Python 3.10 and later when executing very long running tests.
Limited to non-kerberos connections!Include Python version inUser-AgentheaderSend XML-RPC method name inReferer:header to improve logsv12.8.2 (23 Dec 2023)Refactor calling.login()method as part of__init__again
because the entire Kiwi TCMS test suite depends on this behaviorv12.8.1 (22 Dec 2023)Limit TestPlan.name and TestCase.summary length before any usage
avoiding possible records mismatch between filter & create operationsv12.8 (17 Dec 2023)When creating a TestPlan limit name to 255 charactersWhen creating a TestCase limit summary to 255 charactersv12.7 (10 Dec 2023)Build & test this package with Python 3.11Replaceurllib.parsefunctions deprecated since Python 3.8Refactor issues reported by newer version of pylintRefactor issues reported by CodeQLReformat source code with BlackEnable ReadTheDocs CIv12.2 (04 Apr 2023)New arguments forplugin_helpers.Backend.update_test_execution()method.
Now accepts thestart_dateandstop_datearguments at the end of its
signatureStart testing the client library with Python 3.9v11.4 (15 Jul 2022)Fallback to C:tcms.conf in case we’re on Windows[pre-commit.ci] pre-commit autoupdatev11.3 (17 May 2022)Make it possible for plugins to print info about created/reused TP/TRSpecify start_date when creating a TestRunv11.2 (15 May 2022)Make plugin prefix configurable viaTCMS_PREFIXenvironment variable.
FixesIssue #6UseTCMS_PARENT_PLANenvironment variable if specified. Will configure
a parent TestPlan. FixesIssue #4Introduceplugin_helpers.Backend.nameandplugin_helpers.Backend.versionattributesConvertplugin_helpers.Backend.default_tester_idinto a cached propertyUse the account sending the API request ifdefault_tester_idis None.
That avoide the use ofUser.filterAPI method for which most users may
not be authorizedSanity check and sanitize URL config. RefsIssue #45v11.1 (13 May 2022)Allow the environment variableTCMS_DEFAULT_TESTER_IDto override
internal queries, pointing directly to the user who will create new
test plans, test runs and update test executions.Internal updates around CIv11.0 (05 Dec 2021)WARNING:contains backwards incompatible changes!Methodplugin_helpers.Backend.add_test_case_to_run()now returns a listAdjust internal API calls for upcoming Kiwi TCMS v11.0Still compatible with Kiwi TCMS v10.x APIStart using f-strings. Available since Python 3.6 which is the minimum
required version fortcms-apianywayv10.0 (02 March 2021)WARNING:contains backwards incompatible changes!Compatible with Kiwi TCMS v10.0 or laterv9.0 (12 January 2021)WARNING:contains backwards incompatible changes!Compatible with Kiwi TCMS v9.0 or laterMethodBackend.build_id()doesn’t receiveproduct_idas firsts
parameter anymore! Related to Kiwi TCMSIssue #246v8.6.0 (28 October 2020)Use a sub-package to install gssapi, see installation instructionsv8.5.0 (04 August 2020)Fixsuper()call inCookieTransportclass to make this package
compatible with Python 3.8 (Václav Klikar)v8.4.0 (25 June 2020)Add instructions how to installgssapibecause they don’t ship binary
packages on LinuxProvideplugin_helpers.Backend.get_statuses_by_weight()and fall-back
to it if TestExecutionStatus can’t be found by name. This is to be used
by Kiwi TCMS plugins (Bryan Mutai)v8.3.0 (10 April 2020)Usegssapilibrary for kerberos communications on both Linux and WindowsRequires MIT Kerberos for Windows, see installation instructionsv8.2.0 (02 April 2020)This version adds additional methods and functionality that can be used
by Kiwi TCMS plugins written in Python.Modifyplugin_helpers.Backend.test_case_get_or_create()to return
tuple (dict, bool). WARNING: this will break existing pluginsplugin_helpers.Backendwill useTCMS_PLAN_IDenvironment variable
if specified. This allows the user to select an existing TestPlan to save
new results into. FixesIssue #5Addplugin_helpers.Backend.finish_test_run()which may be
called by plugins to indicate that a TestRun has been finishedAddplugin_helpers.Backend.default_tester_id()and updateTestExecution.tested_bywhen changing statusUsedefault_tester_id()when creating a new TestRunWhen creating new test run always set TR.manager := TP.author
and make sure thatTestPlan.create()will also specify authorv8.1.1 (23 March 2020)Usewinkerberosdependency on Microsoft Windows platform
(@mtg-edmund-tse)Setting rename in config file:use_mod_kerb->use_kerberosBug-fix: don’t fall back to user/pass if kerberos is configuredBug-fix: send correctly formatted authorization request header,
per RFC-4459Bug-fix: properly authenticate with Kiwi TCMS via kerberos ticket
if requested to do soStart sendingUser-Agent:tcms-api/<version>for all requestsEnable integration testing with and without KerberosEnable testing on Windowsv8.0.1 (10 February 2020)This version is compatible only with Kiwi TCMS v8.0 or later!Do not use deprecated fieldproductinTestCase.createAPI
methodSetTestCase.is_automatedtoTruev8.0 (09 February 2020)This version is compatible only with Kiwi TCMS v8.0 or later!Adjustsplugin_helpersmodule to reflect backwards incompatible
API changes introduced in Kiwi TCMS v8.0v6.7.1 (07 February 2020)Fix a bug in howuse_mod_kerbsetting was evaluated which
lead to always preferring Kerberos which in turn was causing
issues on Windows.v6.7 (10 April 2019)This version is compatible only with Kiwi TCMS v6.7 or later!
For older server versions use tcms-api==5.3!This version contains breaking changes inplugin_helpers!Switch fromTestCaseRuntoTestExecutionAPI. FixesIssue #7Renameplugin_helpers.Backend.update_test_case_run()toplugin_helpers.Backend.update_test_execution()COPYRIGHTCopyright (c) 2012 Red Hat, Inc. All rights reserved.Copyright (c) 2017-2023 Kiwi TCMS Project and its contributors. All rights reserved.This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.