skip to navigation
skip to content

p01.elasticstub 0.5.1

Elasticsearch server stub setup

Latest Version: 0.5.4

This package provides a elasticsearch server stub setup based on a real elasticsearch server.



This test is using an elasticsearch server. The test setUp method used for this test is calling our startElasticSearchServer method which is starting an elasticsearch server. The first time a test get called a new elasticsearch server will get downloaded (by default version 0.19.2). The test setup looks like:

def test_suite():
    return unittest.TestSuite((
            setUp=testing.doctestSetUp, tearDown=testing.doctestTearDown,

If you like to set some custom settings, you can use the confSource which must point to a config folder with elasticsearch.yml, logging.yml and optinal mapping definitions. Your custom doctest setUp and tearDown method could look like:

def mySetUp(test):
    # use default elasticsearch with our server and conf source dir
    here = os.path.dirname(__file__)
    serverDir = os.path.join(here, 'server')
    confSource = os.path.join(here, 'config')

def myTearDown(test):
    # do some custom teardown stuff here


First import simplejson as json and define a method which helps to convert differences in json and simplejson in different python versions:

>>> import simplejson
>>> def jsonLoads(jsonStr):
...     return simplejson.loads(unicode(jsonStr))

Let’s setup a python httplib connection:

>>> import httplib
>>> conn = httplib.HTTPConnection('localhost', 45200)

and test the cluster state:

>>> conn.request('GET', '_cluster/state')
>>> response = conn.getresponse()
>>> response.status
>>> from pprint import pprint
>>> body =
>>> pprint(jsonLoads(body))
{u'allocations': [],
 u'blocks': {},
 u'cluster_name': u'p01_elasticstub_testing',
 u'master_node': u'...',
 u'metadata': {u'indices': {}, u'templates': {}},
 u'nodes': {u'...': {u'attributes': {},
                                        u'name': u...,
                                        u'transport_address': u'inet[...]'}},
 u'routing_nodes': {u'nodes': {}, u'unassigned': []},
 u'routing_table': {u'indices': {}}}

As you can see our mapping is empty:

>>> conn.request('GET', '/testing/test/_mapping')
>>> response = conn.getresponse()
>>> body =
>>> pprint(jsonLoads(body))
{u'error': u'IndexMissingException[[testing] missing]', u'status': 404}

Let’s index a simple item:

>>> body = simplejson.dumps({u'title': u'Title'})
>>> conn.request('POST', '/testing/test/1', body)
>>> response = conn.getresponse()
>>> body =
>>> pprint(jsonLoads(body))
{u'_id': u'1',
 u'_index': u'testing',
 u'_type': u'test',
 u'_version': 1,
 u'ok': True}


>>> conn.request('GET', '/testing/test/_refresh')
>>> response = conn.getresponse()
>>> body =
>>> pprint(jsonLoads(body))
{u'_id': u'_refresh',
 u'_index': u'testing',
 u'_type': u'test',
 u'exists': False}

and test our mapping again:

>>> conn.request('GET', '/testing/test/_mapping')
>>> response = conn.getresponse()
>>> body =
>>> pprint(jsonLoads(body))
{u'test': {u'properties': {u'title': {u'type': u'string'}}}}


0.5.1 (2012-12-10)

  • switch to elasticsearch 0.20.0
  • added version argument to startElasticSearchServer
  • cleanup imports

0.5.0 (2012-11-18)

  • initial release tested on win 32bit and posix 32bit. NOT tested on win 64bit, posix 64bit and mac 32/64bit systems.
File Type Py Version Uploaded on Size (md5) Source 2012-12-10 28KB