A simple plugin to use with pytest
Project description
pytest-elk-reporter
A plugin to send pytest test results to ELK stack, with extra context data
Features
- Reporting into Elasticsearch each test result, as the test finish
- Automaticlly append context data to each test:
- git inforamtion such as
branch
orlast commit
and more - all of Jenkins env variables
- username if availavle
- git inforamtion such as
- Report a test summery to Elastic for each session with all the context data
- can append any user data into the context sent to elastic
Requirements
- having pytest tests written
Installation
You can install "pytest-elk-reporter" via pip from PyPI
pip install pytest-elk-reporter
Usage
Run and configure from command line:
pytest --es-address 127.0.0.1:9200
# or if you need user/password to authenticate
pytest --es-address my-elk-server.io:9200 --es-username fruch --es-password 'passwordsarenicetohave'
Configure from code
import pytest
@pytest.fixture(scope='session', autouse=True)
def configure_es(elk_reporter):
# TODO: get cerdentials in more secure fashion programtically, maybe AWS secrects or the likes
# or put them in plain-text in the code... what can ever go wrong...
elk_reporter.es_address = "my-elk-server.io:9200"
elk_reporter.es_user = 'fruch'
elk_reporter.es_password = 'passwordsarenicetohave'
Collect context data for the whole session
For example, with this I'll be able to build a dash board per version
@pytest.fixture(scope="session", autouse=True)
def report_formal_version_to_elk(request):
"""
Append my own data specific, for example which of the code uner test is used
"""
# TODO: take it programticly of of the code under test...
my_data = {"formal_version": "1.0.0-rc2" }
elk = request.config.pluginmanager.get_plugin("elk-reporter-runtime")
elk.session_data.update(**my_data)
Collect data for specific tests
def test_my_service_and_collect_timings(request, elk_reporter):
response = requests.get("http://my-server.io/api/do_something")
assert response.status_code == 200
elk_reporter.append_test_data(request, {"do_something_response_time": response.elapsed.total_seconds() })
# now doing response time per version dashboard quite easy
# and yeah, it's not exactly real usable metric, it's just an example...
Contributing
Contributions are very welcome. Tests can be run with tox
, please ensure
the coverage at least stays the same before you submit a pull request.
License
Distributed under the terms of the MIT license, "pytest-elk-reporter" is free and open source software
Issues
If you encounter any problems, please file an issue along with a detailed description.
Thanks
This pytest plugin was generated with Cookiecutter along with @hackebrot's cookiecutter-pytest-plugin template.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for pytest-elk-reporter-0.1.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5c053f19e2bbc27c81a23665283ee6104d81600319e07c3ade829e2b73df84df |
|
MD5 | 38c49ba1c016954cec659dd044630613 |
|
BLAKE2b-256 | b37026a8c93ed4f05a21ec1d40ad4cd3211b007880c0bf546342c41ead4ac453 |
Hashes for pytest_elk_reporter-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2495f0f21ca87cd3637b52cea1a7fa5c774ead762adb6f0c327e0f588af575eb |
|
MD5 | 1935ac87d5a7ed4e8d78e654a00d5ffa |
|
BLAKE2b-256 | 10cb700f210078a6932397a3f683044805d66429b017a86c2fdf615e8bd8ffab |
Hashes for pytest_elk_reporter-0.1.4-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 53d90f1ae814f8d17a27c673e52edd870c020257e7a918bf1383609aa9a6afb6 |
|
MD5 | ae1c5c1881d81a1bb0c07f1e4be9194e |
|
BLAKE2b-256 | 69aab38a123f7f05a6ef3433d263052459c85f714706700473890c7a6e1d06a6 |