opensearch-pyd/DEVELOPER_GUIDE.md

• Developer Guide
  • Prerequisites
  • Install Docker Image
  • Running Tests
  • Linter
  • Documentation
  • Client Code Generator

Developer Guide

Prerequisites

Python 3.6 or newer is required.

$ python --version
Python 3.11.1

You can install dev requirements with pip install -r dev-requirements.txt, but it's better to use the docker setup described below.

Install Nox for task management.

$ python -m pip install nox

Install Docker Image

Integration tests require docker.

Run the following commands to install the docker image:

docker pull opensearchproject/opensearch:latest

Integration tests will auto-start the docker image. To start it manually:

docker run -d -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" opensearchproject/opensearch:latest

Running Tests

Tests require a live instance of OpenSearch running in docker.

If you have one running.

python setup.py test

To run tests in a specific test file.

python setup.py test -s test_opensearchpy/test_connection.py

If you want to auto-start one, the following will start a new instance and run tests against the latest version of OpenSearch.

./.ci/run-tests

If your OpenSearch docker instance is running, you can execute the test suite directly.

$ nox -rs test-3.9

Substitute 3.9 with your Python version above, or use nox -rs test to run with multiple.

To run tests against different versions of OpenSearch, use run-tests [with/without security] [version]:

./.ci/run-tests true 1.3.0

The first argument tells whether to run server with security plugin enabled or not. The second argument specifies the version of OpenSearch the tests should run against, if not specified, the tests run against the latest version. You can also run tests against a current SNAPSHOT.

The following example runs tests against the latest SNAPSHOT build of OpenSearch without security.

./.ci/run-tests opensearch false SNAPSHOT

You can also run individual tests matching a pattern (pytest -k [pattern]).

./.ci/run-tests true 1.3.0 test_no_http_compression

test_opensearchpy/test_connection.py::TestUrllib3HttpConnection::test_no_http_compression PASSED [ 33%]
test_opensearchpy/test_connection.py::TestRequestsConnection::test_no_http_compression PASSED [ 66%]
test_opensearchpy/test_async/test_connection.py::TestAIOHttpConnection::test_no_http_compression PASSED [100%]

Note that integration tests require docker to be installed and running, and downloads quite a bit of data from over the internet and hence take few minutes to complete.

Linter

Run the linter and test suite to ensure your changes do not break existing code. The following will auto-format your changes.

$ nox -rs format

Documentation

To build the documentation with Sphinx.

pip install -e .[docs]
cd docs
make html

Open opensearch-py/docs/build/html/index.html to see results.

Client Code Generator

OpenSearch publishes an OpenAPI specification in the opensearch-api-specification repository, which is used to auto-generate the less interesting parts of the client.

nox -rs generate