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'
elk_reporter.es_index_name = 'test_data'
Configure from pytest ini file
# put this in pytest.ini / tox.ini / setup.cfg
[pytest]
es_address = my-elk-server.io:9200
es_user = fruch
es_password = passwordsarenicetohave
es_index_name = test_data
see pytest docs for more about how to configure using .ini files
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.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 685fa5dcb9976928e020902c7cb766f7a3a7b78b9190f9cf8b1df394fa780fb3 |
|
MD5 | 66707e9f8f699f28e186f4078800eb9c |
|
BLAKE2b-256 | 3699aa831922422497a1247c5a0ccbdf765bc0f3c2055a3aaebddbb1ef768983 |
Hashes for pytest_elk_reporter-0.1.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e4a7a7aedb0d77d42cb87f06efacca7c5a441528772f6cddda9a9d0b6476516a |
|
MD5 | 20b8d4be2d9e2743e1fc3fb1bb1ee856 |
|
BLAKE2b-256 | ca5a05a1801481ce8c23a6e170c93cca1b366386febbbb450d037490bda0003c |
Hashes for pytest_elk_reporter-0.1.5-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 51fed198810c526e9ff93e55f412c87ff8f06ea5df4b59f6ae88f8babfc461e2 |
|
MD5 | 9087eb5aa23e91fb7c9791176020f42c |
|
BLAKE2b-256 | b332210dfe83d80343886b39e167f6503a504a51049a38697e3f87d6bae04919 |