So you want to contribute code to the OpenSearch Java client? Excellent! We're glad you're here. Here's what you need to do.
Fork opensearch-project/opensearch-java and clone locally, e.g. git clone https://github.com/[your username]/opensearch-java.git.
To run the full suite of tests, download and install JDK 14. Any JDK >= 11 works.
Download and install Docker, required for running integration tests for the repo.
To build the java-client:
./gradlew clean build -x test
To run unit tests for the java-client:
./gradlew clean unitTest
To run integration tests for the java-client, start an OpenSearch cluster using docker and pass the OpenSearch version:
docker-compose --project-directory .ci/opensearch build --build-arg OPENSEARCH_VERSION=1.3.0
docker-compose --project-directory .ci/opensearch up -d
Run integration tests after starting OpenSearch cluster:
./gradlew clean integrationTest
To run integration tests for the AWS transport client, ensure working AWS credentials in /.aws/credentials and specify your OpenSearch domain and region as follows:
./gradlew integrationTest --tests "*AwsSdk2*" -Dtests.awsSdk2support.domainHost=search-...us-west-2.es.amazonaws.com -Dtests.awsSdk2support.domainRegion=us-west-2 -Dtests.awsSdk2support.serviceName=es
For OpenSearch Serverless, change the signing service name.
./gradlew integrationTest --tests "*AwsSdk2*" -Dtests.awsSdk2support.domainHost=....us-west-2.aoss.amazonaws.com -Dtests.awsSdk2support.domainRegion=us-west-2 -Dtests.awsSdk2support.serviceName=aoss
When importing into IntelliJ you will need to define an appropriate JDK. The convention is that this SDK should be named "11", and the project import will detect it automatically. For more details on defining an SDK in IntelliJ please refer to this documentation. Note that SDK definitions are global, so you can add the JDK from any project, or after project import. Importing with a missing JDK will still work, IntelliJ will report a problem and will refuse to build until resolved.
You can import the opensearch-java project into IntelliJ IDEA as follows:
- Select File > Open
- In the subsequent dialog navigate to the root
build.gradle.ktsfile - In the subsequent dialog select Open as Project
Follow links in the Java Tutorial to install the coding pack and extensions for Java, Gradle tasks, etc. Open the source code directory.
Java files in the opensearch-java codebase are formatted with the checkstyle plugin. This plugin is configured using checkstyle.xml. To run the formatting checks:
./gradlew checkstyleMain checkstyleTest
See CONTRIBUTING.