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 fixtures.

Install Elasticsearch 8.x or newer following the official documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html

1. Install the plugin and your test dependencies (as you normally do for your project).
2. Ensure Elasticsearch is available (local install or container).
3. Create a test that uses the built-in fixture:

def test_can_connect(elasticsearch):
    assert elasticsearch.info()

4. Run your tests:

pytest

The plugin contains three fixtures:

• elasticsearch - a client fixture that has function-scope, and which cleans Elasticsearch at the end of each test.
• elasticsearch_proc - a session-scoped fixture that starts an Elasticsearch instance at its first use and stops at the end of the tests.
• elasticsearch_nooproc - a no-process fixture that holds connection data to an already running Elasticsearch instance

Simply include one of these fixtures in your test fixture list.

You can also create additional Elasticsearch client and process fixtures if you need to:

from pytest_elasticsearch import factories

elasticsearch_my_proc = factories.elasticsearch_proc(port=None)
elasticsearch_my = factories.elasticsearch('elasticsearch_my_proc')

Some projects use already running Elasticsearch servers (e.g., in Docker). To connect to them, use the elasticsearch_nooproc fixture.

es_external = factories.elasticsearch('elasticsearch_nooproc')

Configure the host/port to match your running Elasticsearch instance using the options below. If not provided, the noprocess fixture defaults to port 9200.

You can define your settings in three ways: fixture factory arguments, command line options, and pytest.ini configuration options. 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

Example usage:

• pass it as an argument to your own fixture

  elasticsearch_proc = factories.elasticsearch_proc(
      cluster_name='awsome_cluster')

• specify your cluster name 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

It might happen that the process can't be started due to lack of permissions. The files that the user running tests must have access to are:

• /etc/default/elasticsearch

Make sure you either run tests as a user who has access to these files, or grant the user proper permissions or add them to the proper groups.

In CI, 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.

• Bug tracker: https://github.com/dbfixtures/pytest-elasticsearch/issues