Metadata-Version: 2.1
Name: pytest-railflow-testrail-reporter
Version: 0.1.2
Summary: Generate json reports along with specified metadata defined in test markers.
Home-page: https://github.com/railflow/railflow-pytest-plugin
Author: Railflow
License: MIT License
Keywords: py.test pytest json railflow report
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Pytest
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/markdown
Requires-Dist: pytest

# pytest-railflow-testrail-reporter

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pytest-railflow-testrail-reporter?style=plastic)](https://pypi.org/project/pytest-railflow-testrail-reporter/)
[![Build](https://github.com/railflow/railflow-pytest-plugin/actions/workflows/testing.yml/badge.svg)](https://github.com/railflow/railflow-pytest-plugin/actions/workflows/testing.yml)
[![Cov](https://codecov.io/gh/railflow/railflow-pytest-plugin/branch/main/graph/badge.svg?token=7SB1JK4HWO)](https://codecov.io/gh/railflow/railflow-pytest-plugin)
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/pytest-railflow-testrail-reporter)](https://pypi.org/project/pytest-railflow-testrail-reporter/)

Pytest-Railflow-Testrail-reporter is the Pytest plugin generates json
outputs with predefined metadata as json attributes defined during the
tests.

It is designed for generating testrail outputs.

Requirements
============

In order to use pytest-railflow-testrail-reporter plugin, following
prerequsites should be met.

> -   Python 2.7, 3.4 or greater
> -   Pytest

Installation
============

Using Pip
---------

To install the pytest-railflow-testrail-reporter plugin using pip,run
the following command in terminal:

    pip install pytest-railflow-testrail-reporter

This will install the plugin to the system.

Usage
=====

Currently the plugin supports the metadata attributes given below. All
other undefined metadata attributes will be rejected with a warning.


  Function level Attributes | Class level Attributes
  --------------------------|-----------------------
  testrail\_user | testrail\_user
  description | testrail\_project
  jira\_id | case\_fields
  test\_path | result\_fields
  case\_fields | test\_path
  result\_fields | case\_type
  test\_mappings | case\_priority
  case\_type | smart\_assign
  case\_priority | 

To run the test, enter the following command in the terminal from test
directory.

    pytest --jsonfile output.json

Please check
[examples](https://github.com/railflow/railflow-pytest-plugin/tree/main/examples)
for more information and sample tests.


