pytest-solr 1.0.0

Solr Process

The solr_process factory starts and stops a the Solr process. An existing Solr executable is required for this.

‘executable’:

path to the Solr executable. Default value is ‘downloads/solr-<SOLR_VERSION>/bin/solr’

‘host’:

hostname where Solr runs. Default value is ‘localhost’.

‘port’:

port Solr uses. Default is value is ‘18983’.

‘core’:

Solr core that is used. Default value is ‘solr’.

‘timeout’:

timeout to wait for Solr to start. Default value is ‘60’ (seconds).

Example:

from pytest_solr.factories import solr_process

solr_process = solr_process(
  executable='solr-6.5.0/bin/solr',
  host='localhost',
  port=8983,
  core='default',
  version='6.5.0',
  timeout=60
)

Solr Core

The solr_core factory adds and removes a Solr core configuration. It expects two parameters, the Solr Process fixture name and the Solr core name.

‘solr_process_fixture_name’:

String with the name of the Solr Process. This is a required parameter.

‘solr_core_name’:

String with the name of the Solr core. Default value is ‘default’.

Example:

from pytest_solr.factories import solr_core

my_solr_core = solr_core('solr_process', 'my_solr_core')

Solr

The Solr factory connects to Solr via pysolr. It expects a single parameter, the Solr core fixture name.

‘solr_core_fixture_name’:

String with the name of the Solr core. This is a required parameter.

Example:

# -*- coding: utf-8 -*-
from pytest_solr.factories import solr_core
from pytest_solr.factories import solr

minimal = solr_core('solr_process', 'minimal')
solr = solr('minimal')

def test_exact_term_match(solr):
    solr.add([{'id': '1', 'title': 'bananas'}])
    assert 1 == solr.search('title:bananas').hits

The solr fixture can then be injected into the test function and used to add documents to solr or search for terms.

See the pysolr documentation. for more details.