Skip to main content

Elasticsearch process and client fixtures for py.test.

Project description


Latest PyPI version Wheel Status Supported Python Versions License

Package status

Tests Coverage Status Requirements Status

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


This fixture requires at least version 1.0 of elasticsearch to work.

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.

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')


Each elasticsearch process fixture can be configured in a different way than the others through the fixture factory arguments.


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:

  1. Fixture factory argument
  2. Command line option
  3. Configuration option in your pytest.ini file
Elasticsearch option Fixture factory argument Command line option pytest.ini option Default
logs directory logsdir –elasticsearch-logsdir elasticsearch_logsdir $TMPDIR
host host –elasticsearch-host elasticsearch_host
port port –elasticsearch-port elasticsearch_port random
cluster_name cluster_name –elasticsearch-cluster-name elasticsearch_cluster_name elasticsearch_cluster_<port>
index store type index_store_type –elasticsearch-index-store-type elasticsearch_index_store_type memory
network publish host network_publish_host –elasticsearch-network-publish-host elasticsearch_network_publish_host
logs prefix logs_prefix –elasticsearch-logs-prefix elasticsearch_logs_prefix  
enable zen discovery discovery_zen_ping_multicast_enabled –elasticsearch-discovery-zen-ping-multicast-enabled elasticsearch_discovery_zen_ping_multicast_enabled False
transport tcp port transport_tcp_port –elasticsearch-transport-tcp-port elasticsearch_transport_tcp_port random
configuration path configuration_path –elasticsearch-configuration-path elasticsearch_configuration_path /etc/elasticsearch

Example usage:

  • pass it as an argument in your own fixture

    elasticsearch_proc = factories.elasticsearch_proc(
  • use --elasticsearch-logsdir command line option when you run your tests

    py.test tests --elasticsearch-cluster-name=awsome_cluster
  • specify 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:

    elasticsearch_cluster_name = awsome_cluster



  • [feature] - Support for major elasticsearch versions


  • [cleanup] - removed dependency


  • [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


  • [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


  • [feature] pytest.ini option for every command line option
  • [feature] Command line options for every fixture factory argument
  • Extracted original code from pytest-dbfixtures

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pytest-elasticsearch, version 1.3.0
Filename, size File type Python version Upload date Hashes
Filename, size pytest_elasticsearch-1.3.0-py2.py3-none-any.whl (13.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size pytest-elasticsearch-1.3.0.tar.gz (32.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page