pytest-elasticsearch 1.0.0

pytest-elasticsearch

Package status

What is this?

This is a pytest plugin, that enables you test your code that relies on an Elasticsearch search engine. It allows you to specify fixtures for Elasticsearch process and client.

How to use

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

You can set and run elasticsearch process with your own settings (i.e. use random port or define your own logsdir)

elasticsearch_proc = factories.elasticsearch_proc(
    port=None, logsdir='/tmp')

You can use elasticsearch client fixture to run your test. (Remember that client fixture requires a process fixture to work properly.)

elasticsearch = factories.elasticsearch(elasticsearch_proc)

To check if everything is ready to go, you can always test both fixtures:

def test_elastic_process(elasticsearch_proc):
    """Simple test for starting elasticsearch_proc."""
    assert elasticsearch_proc.running() is True


def test_elasticsarch(elasticsearch):
    """Tests if elasticsearch fixtures connects to process."""

    info = elasticsearch.info()
    assert info['status'] == 200

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

Example of use: logs directory:

• pass it as an argument in your own fixture

  elasticsearch_proc = factories.elasticsearch_proc(
      logsdir='/tmp')

• use --elasticsearch-logsdir command line option when you run your tests

  py.test tests --elasticsearch-logsdir=/tmp

• specify your directory as logsdir in your pytest.ini file.

  To do so, put a line like the following under the [pytest] section of your pytest.ini:

  [pytest]
  elasticsearch_logsdir =
    /tmp/elasticsearch/logs

If you don’t want to define your own settings in any given way, you can always use a default values.

CHANGELOG

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