Metadata-Version: 1.1
Name: pytest-bugzilla-notifier
Version: 1.1.1
Summary: A plugin that allows you to post test runs to BugZilla tickets and create new tickets
Home-page: https://github.com/mozilla-services/pytest-bugzilla-notifier
Author: Chris Hartjes
Author-email: chartjes@mozilla.com
License: Mozilla Public License 2.0
Description-Content-Type: UNKNOWN
Description: pytest-bugzilla-notifier
        ===================================
        
        This plugin currently has the following functionality:
        
        * posts the results of test runs to be added to existing Bugzilla tickets
        * create new tickets as part of a pytest test
        * read bugs given a bug ID
        * search for bugs given a search
        
        
        
        Installation
        ------------
        
        You can install "pytest-bugzilla-notifier" via `pip`_ from `PyPI`_::
        
            $ pip install pytest-bugzilla-notifier
        
        Pre-requisites
        --------------
        
        To use this plugin you need to have a username and password for a Bugzilla
        account. First, you need to copy bugzilla.ini-dist to bugzilla.ini and add in
        the BugZilla API key you will be using to access Bugzilla.
        
        Reporting test runs
        -------------------
        
        You can use the plugin to update a ticket with the results by using the following command::
        
            $ pytest --bug=<bug ID> --config=./bugzilla.ini --bugzilla-url=<server> /path/to/tests
        
        <bug ID>
        The ID that Bugzilla assigned to the bug you wish to have the test
        results sent to.
        
        <server>
        The full URL to the Bugzilla instance you wish to send test results to
        (eg https://bugzilla.mozilla.com)
        
        
        Creating new tickets
        --------------------
        
        To create a new ticket in Bugzilla, you need to import the library using::
        
            from pytest_bugzilla_notifier.bugzilla_rest_client import BugzillaRESTClient
        
        and then you can create bugs using code similar to this::
        
            api_details = {
                'bugzilla_host': '<bugzilla host you are using>',
                'bugzilla_api_key': '<bugzilla API key>'
            }
            rest_client = BugzillaRESTClient(api_details)
            bug_data = {
                'product': 'Firefox',
                'component': 'Developer Tools',
                'summary': 'Test Bug',
                'version': 'unspecified'
            }
            bug_id = rest_client.bug_create(bug_data)
        
        If everything worked as expected, ``bug_id`` will contain the ID BugZilla has assigned to your ticket.
        
        Reading Bug Details
        -------------------
        
        If you know the ID for a bug, you can read in the details::
        
            api_details = {
                'bugzilla_host': '<bugzilla host you are using>',
                'bugzilla_api_key': '<bugzilla API key>'
            }
            rest_client = BugzillaRESTClient(api_details)
            bug_id = <bug ID>
            response = rest_client.bug_read(bug_id)
        
        
        
        Searching For Bugs
        ------------------
        
        You can follow the outlines for `search parameters`_ and then submit your search request::
        
            api_details = {
                'bugzilla_host': '<bugzilla host you are using>',
                'bugzilla_api_key': '<bugzilla API key>'
            }
            rest_client = BugzillaRESTClient(api_details)
            search_details = {
                'product': 'Firefox',
                'component': 'Developer Tools',
                'summary': 'Test Bug',
            }
            bug_id = rest_client.bug_search(search_details)
        
        
        
        
        Contributing
        ------------
        Contributions are very welcome. Tests can be run with `tox`_, please ensure
        that the test suite passed before submitting a pull request.
        
        
        License
        -------
        
        Distributed under the terms of the `Mozilla Public License 2.0`_ license, "pytest-bugzilla-notifier" is free and open source software.
        
        
        Issues
        ------
        
        If you encounter any problems, please `file an issue`_ along with a detailed description.
        
        .. _`Mozilla Public License 2.0`: http://mozilla.org/MPL/2.0/
        .. _`file an issue`: https://github.com/mozilla-services/pytest-bugzilla-notifier/issues
        .. _`pytest`: https://github.com/pytest-dev/pytest
        .. _`tox`: https://tox.readthedocs.io/en/latest/
        .. _`pip`: https://pypi.python.org/pypi/pip/
        .. _`PyPI`: https://pypi.python.org/pypi
        .. _`search parameters`: http://bugzilla.readthedocs.io/en/latest/api/core/v1/bug.html#search-bugs
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Pytest
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Testing
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Operating System :: OS Independent
