Pytest confluence report

Pytest plugin to convert test results into confluence page report to proceed with tests analysis.

It will combine unique fail assertion messages to failed testcases and convert those into confluence tables which is omitted in other plugins such as pytest-html.

⚠️ Note: the project is under construction.

Tools

Production

• python 3.6, 3.7, 3.8, 3.9
• typer
• loguru
• pytest

Development

• travis
• black
• mypy
• pylint
• flake8
• pydocstyle
• interrogate
• bats

Usage

Installation

pip install pytest-confluence-report
✨ 🍰 ✨

Quick start

Please make sure your settings.yml file is properly configured before execution.

pytest --junit-xml=pytest.xml --confluence-upload

Source code

git clone [email protected]:vyahello/pytest-confluence-report.git
pip install -e .

Or using direct release:

pip install git+https://github.com/vyahello/[email protected]

Local debug

git clone [email protected]:vyahello/pytest-confluence-report.git
python -m report --settings-path settings.yml --xml-path pytest.xml

⬆ back to top

Development notes

Configuration

In order to enable plugin automatically within your pytest.ini configuration file, please set an appropriate flag:

[pytest]
addopts = --confluence-upload

or a shorten version:

[pytest]
addopts = --cu

Testing

Generally, pytest tool is used to organize testing procedure.

Please follow next command to run unittests:

pytest

In addition, package unit tests are implemented with bats framework:

PACKAGE_NAME and PACKAGE_VERSION environment variables should be set to run tests.

bats --pretty test-package.bats

CI

Project has Travis CI integration using .travis.yml file thus code analysis (black, pylint, flake8, mypy, pydocstyle and interrogate) and unittests (pytest, bats) will be run automatically after every made change to the repository.

To be able to run code analysis, please execute command below:

./analyse-source-code.sh

Release notes

Please check changelog file to get more details about actual versions and it's release notes.

Meta

Author – Volodymyr Yahello. Please check authors file for more details.

Distributed under the MIT license. See license for more information.

You can reach out me at:

• [email protected]
• https://twitter.com/vyahello
• https://www.linkedin.com/in/volodymyr-yahello-821746127

Contributing

I would highly appreciate any contribution and support. If you are interested to add your ideas into project please do the following simple steps:

1. Clone the repository.
2. Configure git for the first time after cloning with your name and email.
3. pip install -r requirements.txt to install all project dependencies.
4. pip install -r requirements-dev.txt to install all development project dependencies.
5. Create your feature branch (git checkout -b feature/fooBar).
6. Commit your changes (git commit -am 'Add some fooBar').
7. Push to the branch (git push origin feature/fooBar).
8. Create a new Pull Request.

What's next

All recent activities and ideas are described at project issues page. If you have ideas you want to change/implement please do not hesitate and create an issue.

⬆ back to top