Skip to main content

Elasticsearch process and client fixtures fir py.test.

Project description

pytest-elasticsearch

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 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
Elasticsearch option Fixture factory argument Command line option Configuration option in pytest.ini Default
logs directory logsdir –elasticsearch-logsdir elasticsearch_logsdir /tmp
host host –elasticsearch-host elasticsearch_host ‘127.0.0.1’
port port –elasticsearch-port elasticsearch_port 9201
cluster_name cluster_name –elasticsearch-cluster-name elasticsearch_cluster_name elasticsearch_cluster_9201
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 ‘127.0.0.1’
logs prefix logs_prefix –elasticsearch-logs-prefix elasticsearch_logs_prefix ‘’
discovery en ping multicast enabled discovery_zen_ping_multicast_enabled –elasticsearch-discovery-zen-ping-multicast-enabled elasticsearch_discovery_zen_ping_multicast_enabled ‘false’
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.

Travis-ci

After creating package on github, move to tracis-ci.org, and turn on ci builds for given package.

Project details


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