tcms.issuetracker package

Kiwi TCMS supports internal bug tracking functionality and integration between external bug trackers and the rest of the system. The integration interface is defined in tcms.issuetracker.base and can be overridden in subsequent implementations if desired.

The current scope is:

• 1-click bug report - by clicking a UI element inside TestExecution Kiwi TCMS will try to automatically report a new bug in the selected bug tracker. If this fails will fall back to opening a new browser window to manually enter the required information. Fields will be pre-filled with correct information when possible.

• automatic bug update - when linking existing bug reports to TestExecution the bug report will be “linked” back to the TE. By default this is achieved by adding a comment to the bug report.

• show bug info - on pages which display bugs the tester could see more contextual information by hovering the mouse over an info icon. A tooltip will appear. Default implementation is to display OpenGraph Protocol data for that URL. Information is cached.

Important

Kiwi TCMS’ own internal bug tracker is a light-weight solution for small teams. You can disable it by defining KIWI_DISABLE_BUGTRACKER=yes in your environment variables!

Important

Integration details for supported bug trackers can be found at tcms.issuetracker.types! Additional integrations are provided via add-ons. For more information see trackers_integration.issuetracker!

Important

Most integrations expect product names in Kiwi TCMS to match product names in the external issue tracker database. See individual documentation for specifics.

Submodules

• tcms.issuetracker.azure_boards module
  • AzureBoards
    • AzureBoards.details()
    • AzureBoards.is_adding_testcase_to_issue_disabled()
    • AzureBoards.post_comment()
• tcms.issuetracker.base module
  • IssueTrackerType
    • IssueTrackerType.add_testexecution_to_issue()
    • IssueTrackerType.bug_id_from_url()
    • IssueTrackerType.details()
    • IssueTrackerType.get_case_components()
    • IssueTrackerType.is_adding_testcase_to_issue_disabled()
    • IssueTrackerType.post_comment()
    • IssueTrackerType.post_process_new_issue()
    • IssueTrackerType.report_issue_from_testexecution()
    • IssueTrackerType.rpc
    • IssueTrackerType.rpc_credentials
    • IssueTrackerType.text()
    • IssueTrackerType.truncate()
• tcms.issuetracker.bitbucket module
  • BitBucket
    • BitBucket.details()
    • BitBucket.is_adding_testcase_to_issue_disabled()
    • BitBucket.post_comment()
• tcms.issuetracker.bugzilla_integration module
  • Bugzilla
    • Bugzilla.one_click_report()
    • Bugzilla.post_comment()
• tcms.issuetracker.kiwitcms module
  • KiwiTCMS
    • KiwiTCMS.bug_id_from_url()
    • KiwiTCMS.details()
    • KiwiTCMS.is_adding_testcase_to_issue_disabled()
    • KiwiTCMS.post_comment()
• tcms.issuetracker.types module
  • GitHub
    • GitHub.details()
    • GitHub.is_adding_testcase_to_issue_disabled()
    • GitHub.post_comment()
    • GitHub.repo_id
  • Gitlab
    • Gitlab.details()
    • Gitlab.is_adding_testcase_to_issue_disabled()
    • Gitlab.post_comment()
    • Gitlab.repo_id
  • JIRA
    • JIRA.bug_id_from_url()
    • JIRA.details()
    • JIRA.get_issue_type_from_jira()
    • JIRA.get_project_from_jira()
    • JIRA.is_adding_testcase_to_issue_disabled()
    • JIRA.post_comment()
  • Redmine
    • Redmine.details()
    • Redmine.is_adding_testcase_to_issue_disabled()
    • Redmine.post_comment()
    • Redmine.redmine_priority_by_name()
    • Redmine.redmine_project_by_name()
    • Redmine.redmine_tracker_by_name()