So you want to contribute code to the OpenSearch Go Client? Excellent! We're glad you're here. Here's what you need to do:
Fork opensearch-project/opensearch-go and clone locally, e.g. git clone https://github.com/[your username]/opensearch-go.git.
OpenSearch Go Client builds using Go 1.21 at a minimum.
Docker is required for building some OpenSearch artifacts and executing integration tests.
To build the project on Windows, use WSL2, the compatibility layer for running Linux applications.
Install make
sudo apt install make
Go has a simple tool for running tests, and we simplified it further by creating this make command:
make test-unit
Individual unit tests can be run with the following command:
cd folder-path/to/test;
go test -v -run TestName;
In order to test opensearch-go client, you need a running OpenSearch cluster. You can use Docker to accomplish this. The Docker Compose file supports the ability to run integration tests for the project in local environments. If you have not installed docker-compose, you can install it from this link.
Ensure that Docker is installed on your local machine. You can check by running docker --version. Next, navigate to your local opensearch-go repository. Run the following command to build and start the OpenSearch docker container.
make cluster.build cluster.start
This command will start the OpenSearch container using the docker-compose.yaml configuration file. During the build process, the necessary dependencies and files will be downloaded, which may take some time depending on your internet connection and system resources.
Once the container is built and running, you can open a web browser and navigate to localhost:9200 to access the OpenSearch docker container.
In order to differentiate unit tests from integration tests, Go has a built-in mechanism for allowing you to logically separate your tests with build tags. The build tag needs to be placed as close to the top of the file as possible, and must have a blank line beneath it. Hence, create all integration tests with build tag 'integration'.
- Run below command to start containers. By default, it will launch latest OpenSearch cluster.
make cluster.build cluster.start - Run all integration tests.
make test-integ race=true - Stop and clean containers.
make cluster.stop cluster.clean
To keep all the code in a certain uniform format, it was decided to use some writing rules. If you wrote something wrong, it's okay, you can simply run the script to check the necessary files, and optionally format the content. But keep in mind that all these checks are repeated on the pipeline, so it's better to check locally.
To check the markdown files, run the following command:
make lint.markdown
To check all go files, run the following command:
make linters
To get the repository test coverage, run the following command:
For the results to be display in your terminal:
make coverage
For the results to be display in your browser:
make coverage-html
You can import the OpenSearch project into GoLand as follows:
- Select File | Open
- In the subsequent dialog navigate to the ~/go/src/opensearch-go and click Open
After you have opened your project, you need to specify the location of the Go SDK. You can either specify a local path to the SDK or download it. To set the Go SDK, navigate to Go | GOROOT and set accordingly.
To improve your vim experience with Go, you might want to check out fatih/vim-go. For example it correctly formats the file and validates it on save.