Elasticsearch fixtures and fixture factories for Pytest.
Project description
pytest-elasticsearch
What is this?
This is a pytest plugin that enables you to test your code that relies on a running Elasticsearch search engine. It allows you to specify fixtures for Elasticsearch process and client.
How to use
The plugin contains two fixtures:
elasticsearch - a client fixture that has functional scope, and which cleans Elasticsearch at the end of each test.
elasticsearch_proc - a session scoped fixture, that starts Elasticsearch instance at its first use and stops at the end of the tests.
elasticsearch_nooproc - a nooprocess fixture, that’s holds connection data to already running elasticsearch
Simply include one of these fixtures into your tests fixture list.
You can also create additional elasticsearch client and process fixtures if you’d need to:
from pytest_elasticsearch import factories
elasticsearch_my_proc = factories.elasticsearch_proc(
port=None, logsdir='/tmp')
elasticsearch_my = factories.elasticsearch('elasticsearch_my_proc')Connecting to already existing Elasticsearch service
Some projects are using already running Elasticsearch servers (ie on docker instances). In order to connect to them, one would be using the elasticsearch_nooproc fixture.
es_external = factories.elasticsearch('elasticsearch_nooproc')By default the elasticsearch_nooproc fixture would connect to elasticsearch instance using 9300 port.
Configuration
You can define your settings in three ways, it’s fixture factory argument, command line option and pytest.ini configuration option. You can pick which you prefer, but remember that these settings are handled in the following order:
Fixture factory argument
Command line option
Configuration option in your pytest.ini file
ElasticSearch option |
Fixture factory argument |
Command line option |
pytest.ini option |
Noop process fixture |
Default |
|---|---|---|---|---|---|
Elasticsearch executable |
executable |
–elasticsearch-executable |
elasticsearch_executable |
/usr/share/elasticsearch/bin/elasticsearch |
|
logs directory |
logsdir |
–elasticsearch-logsdir |
elasticsearch_logsdir |
$TMPDIR |
|
host |
host |
–elasticsearch-host |
elasticsearch_host |
host |
127.0.0.1 |
port |
port |
-elasticsearch-port |
elasticsearch_port |
6300 |
random |
Elasticsearch cluster name |
cluster_name |
–elasticsearch-cluster-name |
elasticsearch_cluster_name |
elasticsearch_cluster_<port> |
|
index storage type |
index_store_type |
–elasticsearch-index-store-type |
elasticsearch_index_store_type |
mmapfs |
|
network publish host |
network_publish_host |
–elasticsearch-network-publish-host |
elasticsearch_network_publish_host |
127.0.0.1 |
|
logs prefix |
logs_prefix |
–elasticsearch-logs-prefix |
elasticsearch_logs_prefix |
||
transport tcp port |
transport_tcp_port |
–elasticsearch-transport-tcp-port |
elasticsearch_transport_tcp_port |
random |
Example usage:
pass it as an argument in your own fixture
elasticsearch_proc = factories.elasticsearch_proc( cluster_name='awsome_cluster)use --elasticsearch-logsdir command line option when you run your tests
py.test tests --elasticsearch-cluster-name=awsome_clusterspecify your directory as elasticsearch_cluster_name in your pytest.ini file.
To do so, put a line like the following under the [pytest] section of your pytest.ini:
[pytest] elasticsearch_cluster_name = awsome_cluster
Known issues
It might happen, that the process can’t be started due to lack of permissions. The files that user running tests has to have access to are:
/etc/default/elasticsearch
Make sure that you either run tests as a user that has access to these files, or you give user proper permissions or add it to proper user groups.
In CI at the moment, we install elasticsearch from tar/zip archives, which do not set up additional permission restrictions, so it’s not a problem on the CI/CD.
Package resources
CHANGELOG
2.1.0
Features
Add command line and ini configuration option for the executable.
Require python 3.7 and up
Unify handling of a temporary directory, now temporary directory holding logs, workdir, pid will be named after fixture name.
Deprecations
Deprecated logs_prefix process fixture parameter, –elasticsearch-logsdir command parameter and elasticsearch_logsdir ini configuration option
Deprecated elasticsearch_logsdir process fixture parameter –elasticsearch-logs-prefix command parameter and elasticsearch_logs_prefix ini configuration option
Bugfix
Handle properly elasticsearch versions with two-digit minor version
Misc
Migrated CI/CD to Github Actions
Blackified Codebase
2.0.1
[cleanup] Drop support for python versions older than 3.6
[fix] Adjust for mirakuru 2.2.0 and up
2.0.0
[enhancement] Created a specified Executor to manage elasticsearch
[enhancement] added new elasticsearch_nooproc fixture to connect to already existing elasticsearch index
[cleanup] Drop support for unused discovery_zen_ping_multicast and elasticsearch_configuration_path option
[cleanup] Drop support for elasticsearch older than 5
[cleanup] Drop support for python versions older than 3.5
[bugfix] changed default index.memory type to mmapfs, over long invalid memory type
1.3.0
[feature] - Support for major elasticsearch versions
1.2.1
[cleanup] - removed path.py dependency
1.2.0
[feature] - migrate usage of getfuncargvalue to getfixturevalue. require at least pytest 3.0.0
[feature] - default logsdir to $TMPDIR
[feature] - run process on random port by default - enhances xdist experience
1.1.0
[feature] use tmpfile.gettempdir instead of hardcoded /tmp directory
[docs] added description to all command line and ini options
[bugfix] made command line option’s dests more distinc, to prevent from influencing other pytest plugins
1.0.0
[feature] pytest.ini option for every command line option
[feature] Command line options for every fixture factory argument
Extracted original code from pytest-dbfixtures
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 Distribution
File details
Details for the file pytest-elasticsearch-2.1.0.tar.gz.
File metadata
- Download URL: pytest-elasticsearch-2.1.0.tar.gz
- Upload date:
- Size: 29.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1b5205658f16cc040e5bbe87e73472cb1a561c8220f6b67297d73cd1395e00cc |
|
| MD5 | 1b1010cf959fbbb17dcceaabf4cbaad6 |
|
| BLAKE2b-256 | 1e1e084f87237b7d00b42cdbe57aee2623621ab2a9d0b4e602f8913b7ce7ee40 |
File details
Details for the file pytest_elasticsearch-2.1.0-py3-none-any.whl.
File metadata
- Download URL: pytest_elasticsearch-2.1.0-py3-none-any.whl
- Upload date:
- Size: 27.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 28dfabf5ef686251ef4281f225f3968f60987e9e35ef9069ccf9121e5baa808a |
|
| MD5 | 5d2a11a5a5c2ecadea7fad8823ee8a50 |
|
| BLAKE2b-256 | d2f6b0a6f64f4d31cc0d269fc7495dafe0098efd5f9309300d11ba4d4b00d4ed |
