This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description

pytest-elasticsearch

Package 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

Warning

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

Plugin contains two fixtures

  • elasticsearch - it’s a client fixture that has functional scope, and which cleans Elasticsearch at the end of each test.
  • elasticsearch_proc - session scoped fixture, that starts Elasticsearch instance at it’s 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')

Note

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

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 Default
logs directory logsdir –elasticsearch-logsdir elasticsearch_logsdir $TMPDIR
host host –elasticsearch-host elasticsearch_host 127.0.0.1
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 127.0.0.1
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

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_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:

    [pytest]
    elasticsearch_cluster_name = awsome_cluster
    

CHANGELOG

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 History

1.2.0

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

1.1.0

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

1.0.0

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.0.0

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
pytest_elasticsearch-1.2.0-py2.7.egg (15.0 kB) Copy SHA256 Checksum SHA256 2.7 Egg Oct 24, 2016
pytest_elasticsearch-1.2.0-py2.py3-none-any.whl (12.5 kB) Copy SHA256 Checksum SHA256 py2.py3 Wheel Oct 24, 2016
pytest-elasticsearch-1.2.0.tar.gz (30.5 kB) Copy SHA256 Checksum SHA256 Source Oct 24, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting