Metadata-Version: 1.1
Name: pytest-jira
Version: 0.2.1
Summary: py.test JIRA integration plugin, using markers
Home-page: http://github.com/rhevm-qe-automation/pytest_jira
Author: James Laska
Author-email: james.laska@gmail.com
License: GPLv2
Description: |Build Status| |Code Health| |Code Coverage|
        
        Intro
        =====
        
        A `pytest <http://pytest.org/latest/>`__ plugin for JIRA integration.
        
        This plugin links tests with JIRA tickets. The plugin behaves similar to
        the `pytest-bugzilla <https://pypi.python.org/pypi/pytest-bugzilla>`__
        plugin.
        
        The plugin does not close JIRA tickets, or create them. It just allows
        you to link tests to existing tickets.
        
        Please feel free to contribute by forking and submitting pull requests
        or by submitting feature requests or issues to
        `issues <https://github.com/rhevm-qe-automation/pytest_jira/issues>`__.
        
        Test results
        ------------
        -  If the test **unresolved** ...
        
           -  and the *run=False*, the test is **skiped**
        
           -  and the *run=True* or not set, the test is executed and based on it
              the result is **xpassed** (e.g. unexpected pass) or **xfailed** (e.g. expected fail)
        
        -  If the test **resolved** ...
        
           -  the test is executed and based on it
              the result is **passed** or **failed**
        
        Marking tests
        -------------
        You can specify jira issue ID in docstring or in pytest.mark.jira decorator.
        
        If you use decorator you can specify optional parameter ``run``. If it's false
        and issue is unresolved, the test will be skipped.
        
        Example
        ^^^^^^^
         .. code:: python
        
            @pytest.mark.jira("ORG-1382", run=False)
            def test_skip(): # will be skipped if unresolved
                assert False
        
            @pytest.mark.jira("ORG-1382")
            def test_xfail(): # will run and xfail if unresolved
                assert False
        
            def test_xpass(): # will run and xpass if unresolved
            """issue: ORG-1382"""
                assert True
        
        Status evaluation
        -----------------
        Issues are consider **resolved** if their status is "Resolved" or "Closed".
        If you specify components (in command line or jira.cfg), open issues will be considered
        **unresolved** only if they are also open for at least one used component.
        
        If you specify version, open issues will be **unresolved** only if they also affects your version.
        Even when the issue is closed, but your version was affected and it was not fixed for your version,
        the issue will be considered **unresolved**.
        
        Requires
        ========
        
        -  pytest >= 2.2.3
        -  jira >= 0.43
        -  six
        
        Installation
        ============
        
        ``pip install pytest_jira``
        
        Usage
        =====
        
        
        1. Create a ``jira.cfg`` in the root of your tests: ::
        
            [DEFAULT]
            url = https://jira.atlassian.com
            username = USERNAME (or blank for no authentication
            password = PASSWORD (or blank for no authentication)
            # ssl_verification = True/False
            # version = foo-1.0
            # components = com1,second component,com3
        
           Options can be overridden with command line options. The configuration
           file can also be placed in ``/etc/jira.cfg`` and ``~/jira.cfg``.
        
        2. Mark your tests with jira marker and issue id.
           ``@pytest.mark.jira('issue_id')``
        
           You can put Jira ID into doc string of test case as well.
        
        3. Run py.test with jira option to enable the plugin. ``py.test --jira``
        
        .. |Build Status| image:: https://travis-ci.org/rhevm-qe-automation/pytest_jira.svg?branch=master
           :target: https://travis-ci.org/rhevm-qe-automation/pytest_jira
        .. |Code Health| image:: https://landscape.io/github/rhevm-qe-automation/pytest_jira/master/landscape.svg?style=flat
           :target: https://landscape.io/github/rhevm-qe-automation/pytest_jira/master
        .. |Code Coverage| image:: https://codecov.io/gh/rhevm-qe-automation/pytest_jira/branch/master/graph/badge.svg
           :target: https://codecov.io/gh/rhevm-qe-automation/pytest_jira
        
        
Keywords: pytest
jira
plugin
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Plugins
Classifier: Framework :: Pytest
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Utilities
