397 lines
18 KiB
Makefile
397 lines
18 KiB
Makefile
##@ Test
|
||
test-unit: ## Run unit tests
|
||
@echo "\033[2m→ Running unit tests...\033[0m"
|
||
ifdef race
|
||
$(eval testunitargs += "-race")
|
||
endif
|
||
$(eval testunitargs += "-cover" "-coverprofile=tmp/unit.cov" "./...")
|
||
@mkdir -p tmp
|
||
@if which gotestsum > /dev/null 2>&1 ; then \
|
||
echo "gotestsum --format=short-verbose --junitfile=tmp/unit-report.xml --" $(testunitargs); \
|
||
gotestsum --format=short-verbose --junitfile=tmp/unit-report.xml -- $(testunitargs); \
|
||
else \
|
||
echo "go test -v" $(testunitargs); \
|
||
go test -v $(testunitargs); \
|
||
fi;
|
||
test: test-unit
|
||
|
||
test-integ: ## Run integration tests
|
||
@echo "\033[2m→ Running integration tests...\033[0m"
|
||
$(eval testintegtags += "integration")
|
||
ifdef multinode
|
||
$(eval testintegtags += "multinode")
|
||
endif
|
||
ifdef race
|
||
$(eval testintegargs += "-race")
|
||
endif
|
||
$(eval testintegargs += "-cover" "-coverprofile=tmp/integration-client.cov" "-tags='$(testintegtags)'" "-timeout=1h")
|
||
@mkdir -p tmp
|
||
@if which gotestsum > /dev/null 2>&1 ; then \
|
||
echo "gotestsum --format=short-verbose --junitfile=tmp/integration-report.xml --" $(testintegargs); \
|
||
gotestsum --format=short-verbose --junitfile=tmp/integration-report.xml -- $(testintegargs) "."; \
|
||
gotestsum --format=short-verbose --junitfile=tmp/integration-report.xml -- $(testintegargs) "./estransport" "./esapi" "./esutil"; \
|
||
else \
|
||
echo "go test -v" $(testintegargs) "."; \
|
||
go test -v $(testintegargs) "./estransport" "./esapi" "./esutil"; \
|
||
fi;
|
||
|
||
test-api: ## Run generated API integration tests
|
||
@mkdir -p tmp
|
||
ifdef race
|
||
$(eval testapiargs += "-race")
|
||
endif
|
||
$(eval testapiargs += "-cover" "-coverpkg=github.com/elastic/go-elasticsearch/v7/esapi" "-coverprofile=$(PWD)/tmp/integration-api.cov" "-tags='integration'" "-timeout=1h")
|
||
ifdef flavor
|
||
else
|
||
$(eval flavor='core')
|
||
endif
|
||
@echo "\033[2m→ Running API integration tests for [$(flavor)]...\033[0m"
|
||
ifeq ($(flavor), xpack)
|
||
@{ \
|
||
set -e ; \
|
||
trap "git checkout $(PWD)/esapi/test/go.mod" SIGINT SIGTERM EXIT; \
|
||
export ELASTICSEARCH_URL='https://elastic:elastic@localhost:9200' && \
|
||
if which gotestsum > /dev/null 2>&1 ; then \
|
||
cd esapi/test && \
|
||
gotestsum --format=short-verbose --junitfile=$(PWD)/tmp/integration-api-report.xml -- $(testapiargs) $(PWD)/esapi/test/xpack/*_test.go && \
|
||
gotestsum --format=short-verbose --junitfile=$(PWD)/tmp/integration-api-report.xml -- $(testapiargs) $(PWD)/esapi/test/xpack/ml/*_test.go && \
|
||
gotestsum --format=short-verbose --junitfile=$(PWD)/tmp/integration-api-report.xml -- $(testapiargs) $(PWD)/esapi/test/xpack/ml-crud/*_test.go; \
|
||
else \
|
||
echo "go test -v" $(testapiargs); \
|
||
cd esapi/test && \
|
||
go test -v $(testapiargs) $(PWD)/esapi/test/xpack/*_test.go && \
|
||
go test -v $(testapiargs) $(PWD)/esapi/test/xpack/ml/*_test.go && \
|
||
go test -v $(testapiargs) $(PWD)/esapi/test/xpack/ml-crud/*_test.go; \
|
||
fi; \
|
||
}
|
||
else
|
||
$(eval testapiargs += $(PWD)/esapi/test/*_test.go)
|
||
@{ \
|
||
set -e ; \
|
||
trap "git checkout $(PWD)/esapi/test/go.mod" SIGINT SIGTERM EXIT; \
|
||
if which gotestsum > /dev/null 2>&1 ; then \
|
||
cd esapi/test && gotestsum --format=short-verbose --junitfile=$(PWD)/tmp/integration-api-report.xml -- $(testapiargs); \
|
||
else \
|
||
echo "go test -v" $(testapiargs); \
|
||
cd esapi/test && go test -v $(testapiargs); \
|
||
fi; \
|
||
}
|
||
endif
|
||
|
||
test-bench: ## Run benchmarks
|
||
@echo "\033[2m→ Running benchmarks...\033[0m"
|
||
go test -run=none -bench=. -benchmem ./...
|
||
|
||
test-examples: ## Execute the _examples
|
||
@echo "\033[2m→ Testing the examples...\033[0m"
|
||
@{ \
|
||
set -e ; \
|
||
trap "git checkout _examples/**/go.mod" SIGINT SIGTERM EXIT; \
|
||
for f in _examples/*.go; do \
|
||
echo "\033[2m────────────────────────────────────────────────────────────────────────────────"; \
|
||
echo "\033[1m$$f\033[0m"; \
|
||
echo "\033[2m────────────────────────────────────────────────────────────────────────────────\033[0m"; \
|
||
(go run $$f && true) || \
|
||
( \
|
||
echo "\033[31m────────────────────────────────────────────────────────────────────────────────\033[0m"; \
|
||
echo "\033[31;1m⨯ ERROR\033[0m"; \
|
||
false; \
|
||
); \
|
||
done; \
|
||
\
|
||
for f in _examples/*/; do \
|
||
echo "\033[2m────────────────────────────────────────────────────────────────────────────────\033[0m"; \
|
||
echo "\033[1m$$f\033[0m"; \
|
||
echo "\033[2m────────────────────────────────────────────────────────────────────────────────\033[0m"; \
|
||
(cd $$f && make test && true) || \
|
||
( \
|
||
echo "\033[31m────────────────────────────────────────────────────────────────────────────────\033[0m"; \
|
||
echo "\033[31;1m⨯ ERROR\033[0m"; \
|
||
false; \
|
||
); \
|
||
done; \
|
||
echo "\033[32m────────────────────────────────────────────────────────────────────────────────\033[0m"; \
|
||
\
|
||
echo "\033[32;1mSUCCESS\033[0m"; \
|
||
}
|
||
|
||
test-coverage: ## Generate test coverage report
|
||
@echo "\033[2m→ Generating test coverage report...\033[0m"
|
||
@go tool cover -html=tmp/unit.cov -o tmp/coverage.html
|
||
@go tool cover -func=tmp/unit.cov | 'grep' -v 'esapi/api\.' | sed 's/github.com\/elastic\/go-elasticsearch\///g'
|
||
@echo "--------------------------------------------------------------------------------\nopen tmp/coverage.html\n"
|
||
|
||
##@ Development
|
||
lint: ## Run lint on the package
|
||
@echo "\033[2m→ Running lint...\033[0m"
|
||
go vet github.com/elastic/go-elasticsearch/...
|
||
go list github.com/elastic/go-elasticsearch/... | 'grep' -v internal | xargs golint -set_exit_status
|
||
|
||
apidiff: ## Display API incompabilities
|
||
@if ! command -v apidiff > /dev/null; then \
|
||
echo "\033[31;1mERROR: apidiff not installed\033[0m"; \
|
||
echo "go get -u github.com/go-modules-by-example/apidiff"; \
|
||
echo "\033[2m→ https://github.com/go-modules-by-example/index/blob/master/019_apidiff/README.md\033[0m\n"; \
|
||
false; \
|
||
fi;
|
||
@rm -rf tmp/apidiff-OLD tmp/apidiff-NEW
|
||
@git clone --quiet --local .git/ tmp/apidiff-OLD
|
||
@mkdir -p tmp/apidiff-NEW
|
||
@tar -c --exclude .git --exclude tmp --exclude cmd . | tar -x -C tmp/apidiff-NEW
|
||
@echo "\033[2m→ Running apidiff...\033[0m"
|
||
@echo "tmp/apidiff-OLD/esapi tmp/apidiff-NEW/esapi"
|
||
@{ \
|
||
set -e ; \
|
||
output=$$(apidiff tmp/apidiff-OLD/esapi tmp/apidiff-NEW/esapi); \
|
||
echo "\n$$output\n"; \
|
||
if echo $$output | grep -i -e 'incompatible' - > /dev/null 2>&1; then \
|
||
echo "\n\033[31;1mFAILURE\033[0m\n"; \
|
||
false; \
|
||
else \
|
||
echo "\033[32;1mSUCCESS\033[0m"; \
|
||
fi; \
|
||
}
|
||
|
||
backport: ## Backport one or more commits from master into version branches
|
||
ifeq ($(origin commits), undefined)
|
||
@echo "Missing commit(s), exiting..."
|
||
@exit 2
|
||
endif
|
||
ifndef branches
|
||
$(eval branches_list = '7.x' '6.x' '5.x')
|
||
else
|
||
$(eval branches_list = $(shell echo $(branches) | tr ',' ' ') )
|
||
endif
|
||
$(eval commits_list = $(shell echo $(commits) | tr ',' ' '))
|
||
@echo "\033[2m→ Backporting commits [$(commits)]\033[0m"
|
||
@{ \
|
||
set -e -o pipefail; \
|
||
for commit in $(commits_list); do \
|
||
git show --pretty='%h | %s' --no-patch $$commit; \
|
||
done; \
|
||
echo ""; \
|
||
for branch in $(branches_list); do \
|
||
echo "\033[2m→ $$branch\033[0m"; \
|
||
git checkout $$branch; \
|
||
for commit in $(commits_list); do \
|
||
git cherry-pick -x $$commit; \
|
||
done; \
|
||
git status --short --branch; \
|
||
echo ""; \
|
||
done; \
|
||
echo "\033[2m→ Push updates to Github:\033[0m"; \
|
||
for branch in $(branches_list); do \
|
||
echo "git push --verbose origin $$branch"; \
|
||
done; \
|
||
}
|
||
|
||
release: ## Release a new version to Github
|
||
$(eval branch = $(shell git rev-parse --abbrev-ref HEAD))
|
||
$(eval current_version = $(shell cat internal/version/version.go | sed -Ee 's/const Client = "(.*)"/\1/' | tail -1))
|
||
@echo "\033[2m→ [$(branch)] Current version: $(current_version)...\033[0m"
|
||
ifndef version
|
||
@echo "\033[31m[!] Missing version argument, exiting...\033[0m"
|
||
@exit 2
|
||
endif
|
||
ifeq ($(version), "")
|
||
@echo "\033[31m[!] Empty version argument, exiting...\033[0m"
|
||
@exit 2
|
||
endif
|
||
@echo "\033[2m→ [$(branch)] Creating version $(version)...\033[0m"
|
||
@{ \
|
||
set -e -o pipefail; \
|
||
cp internal/version/version.go internal/version/version.go.OLD && \
|
||
cat internal/version/version.go.OLD | sed -e 's/Client = ".*"/Client = "$(version)"/' > internal/version/version.go && \
|
||
rm internal/version/version.go.OLD && \
|
||
go vet internal/version/version.go && \
|
||
go fmt internal/version/version.go && \
|
||
git diff --color-words internal/version/version.go | tail -n 1; \
|
||
}
|
||
@{ \
|
||
set -e -o pipefail; \
|
||
echo "\033[2m→ Commit and create Git tag? (y/n): \033[0m\c"; \
|
||
read continue; \
|
||
if [[ $$continue == "y" ]]; then \
|
||
git add internal/version/version.go && \
|
||
git commit --no-status --quiet --message "Release $(version)" && \
|
||
git tag --annotate v$(version) --message 'Release $(version)'; \
|
||
echo "\033[2m→ Push `git show --pretty='%h (%s)' --no-patch HEAD` to Github:\033[0m\n"; \
|
||
echo "\033[1m git push origin HEAD && git push origin v$(version)\033[0m\n"; \
|
||
else \
|
||
echo "Aborting..."; \
|
||
exit 1; \
|
||
fi; \
|
||
}
|
||
|
||
godoc: ## Display documentation for the package
|
||
@echo "\033[2m→ Generating documentation...\033[0m"
|
||
@echo "open http://localhost:6060/pkg/github.com/elastic/go-elasticsearch/\n"
|
||
mkdir -p /tmp/tmpgoroot/doc
|
||
rm -rf /tmp/tmpgopath/src/github.com/elastic/go-elasticsearch
|
||
mkdir -p /tmp/tmpgopath/src/github.com/elastic/go-elasticsearch
|
||
tar -c --exclude='.git' --exclude='tmp' . | tar -x -C /tmp/tmpgopath/src/github.com/elastic/go-elasticsearch
|
||
GOROOT=/tmp/tmpgoroot/ GOPATH=/tmp/tmpgopath/ godoc -http=localhost:6060 -play
|
||
|
||
cluster: ## Launch an Elasticsearch cluster with Docker
|
||
$(eval version ?= "elasticsearch-oss:7.3-SNAPSHOT")
|
||
ifeq ($(origin nodes), undefined)
|
||
$(eval nodes = 1)
|
||
endif
|
||
@echo "\033[2m→ Launching" $(nodes) "node(s) of" $(version) "...\033[0m"
|
||
ifeq ($(shell test $(nodes) && test $(nodes) -gt 1; echo $$?),0)
|
||
$(eval detached ?= "true")
|
||
else
|
||
$(eval detached ?= "false")
|
||
endif
|
||
ifdef version
|
||
ifneq (,$(findstring oss,$(version)))
|
||
else
|
||
$(eval xpack_env += --env "ELASTIC_PASSWORD=elastic")
|
||
$(eval xpack_env += --env "xpack.license.self_generated.type=trial")
|
||
$(eval xpack_env += --env "xpack.security.enabled=true")
|
||
$(eval xpack_env += --env "xpack.security.http.ssl.enabled=true")
|
||
$(eval xpack_env += --env "xpack.security.http.ssl.verification_mode=certificate")
|
||
$(eval xpack_env += --env "xpack.security.http.ssl.key=certs/testnode.key")
|
||
$(eval xpack_env += --env "xpack.security.http.ssl.certificate=certs/testnode.crt")
|
||
$(eval xpack_env += --env "xpack.security.http.ssl.certificate_authorities=certs/ca.crt")
|
||
$(eval xpack_env += --env "xpack.security.transport.ssl.enabled=true")
|
||
$(eval xpack_env += --env "xpack.security.transport.ssl.key=certs/testnode.key")
|
||
$(eval xpack_env += --env "xpack.security.transport.ssl.certificate=certs/testnode.crt")
|
||
$(eval xpack_env += --env "xpack.security.transport.ssl.certificate_authorities=certs/ca.crt")
|
||
$(eval xpack_volumes += --volume "$(PWD)/.jenkins/certs/testnode.crt:/usr/share/elasticsearch/config/certs/testnode.crt")
|
||
$(eval xpack_volumes += --volume "$(PWD)/.jenkins/certs/testnode.key:/usr/share/elasticsearch/config/certs/testnode.key")
|
||
$(eval xpack_volumes += --volume "$(PWD)/.jenkins/certs/ca.crt:/usr/share/elasticsearch/config/certs/ca.crt")
|
||
endif
|
||
endif
|
||
@docker network inspect elasticsearch > /dev/null 2>&1 || docker network create elasticsearch;
|
||
@{ \
|
||
for n in `seq 1 $(nodes)`; do \
|
||
if [[ -z "$$port" ]]; then \
|
||
hostport=$$((9199+$$n)); \
|
||
else \
|
||
hostport=$$port; \
|
||
fi; \
|
||
docker run \
|
||
--name "es$$n" \
|
||
--network elasticsearch \
|
||
--env "node.name=es$$n" \
|
||
--env "cluster.name=go-elasticsearch" \
|
||
--env "cluster.initial_master_nodes=es1" \
|
||
--env "discovery.seed_hosts=es1" \
|
||
--env "cluster.routing.allocation.disk.threshold_enabled=false" \
|
||
--env "bootstrap.memory_lock=true" \
|
||
--env "node.attr.testattr=test" \
|
||
--env "path.repo=/tmp" \
|
||
--env "repositories.url.allowed_urls=http://snapshot.test*" \
|
||
--env ES_JAVA_OPTS="-Xms1g -Xmx1g" \
|
||
$(xpack_env) \
|
||
--volume `echo $(version) | tr -C "[:alnum:]" '-'`-node-$$n-data:/usr/share/elasticsearch/data \
|
||
$(xpack_volumes) \
|
||
--publish $$hostport:9200 \
|
||
--ulimit nofile=65536:65536 \
|
||
--ulimit memlock=-1:-1 \
|
||
--detach=$(detached) \
|
||
--rm \
|
||
docker.elastic.co/elasticsearch/$(version); \
|
||
done \
|
||
}
|
||
ifdef detached
|
||
@{ \
|
||
echo "\033[2m→ Waiting for the cluster...\033[0m"; \
|
||
docker run --network elasticsearch --rm appropriate/curl --max-time 120 --retry 120 --retry-delay 1 --retry-connrefused --show-error --silent http://es1:9200; \
|
||
output="\033[2m→ Cluster ready; to remove containers:"; \
|
||
output="$$output docker rm -f"; \
|
||
for n in `seq 1 $(nodes)`; do \
|
||
output="$$output es$$n"; \
|
||
done; \
|
||
echo "$$output\033[0m"; \
|
||
}
|
||
endif
|
||
|
||
cluster-update: ## Update the Docker image
|
||
$(eval version ?= "elasticsearch-oss:7.3-SNAPSHOT")
|
||
@echo "\033[2m→ Updating the Docker image...\033[0m"
|
||
@docker pull docker.elastic.co/elasticsearch/$(version);
|
||
|
||
cluster-clean: ## Remove unused Docker volumes and networks
|
||
@echo "\033[2m→ Cleaning up Docker assets...\033[0m"
|
||
docker volume prune --force
|
||
docker network prune --force
|
||
|
||
docker: ## Build the Docker image and run it
|
||
docker build --file Dockerfile --tag elastic/go-elasticsearch .
|
||
docker run -it --network elasticsearch --volume $(PWD)/tmp:/tmp:rw,delegated --rm elastic/go-elasticsearch
|
||
|
||
##@ Generator
|
||
gen-api: ## Generate the API package from the JSON specification
|
||
$(eval input ?= tmp/elasticsearch)
|
||
$(eval output ?= esapi)
|
||
ifdef debug
|
||
$(eval args += --debug)
|
||
endif
|
||
ifdef ELASTICSEARCH_VERSION
|
||
$(eval version = $(ELASTICSEARCH_VERSION))
|
||
else
|
||
$(eval version = $(shell cat "$(input)/buildSrc/version.properties" | grep 'elasticsearch' | cut -d '=' -f 2 | tr -d ' '))
|
||
endif
|
||
ifdef ELASTICSEARCH_BUILD_HASH
|
||
$(eval build_hash = $(ELASTICSEARCH_BUILD_HASH))
|
||
else
|
||
$(eval build_hash = $(shell git --git-dir='$(input)/.git' rev-parse --short HEAD))
|
||
endif
|
||
@echo "\033[2m→ Generating API package from specification ($(version):$(build_hash))...\033[0m"
|
||
@{ \
|
||
set -e; \
|
||
trap "git checkout $(PWD)/internal/cmd/generate/go.mod" SIGINT SIGTERM EXIT; \
|
||
export ELASTICSEARCH_VERSION=$(version) && \
|
||
export ELASTICSEARCH_BUILD_HASH=$(build_hash) && \
|
||
cd internal/cmd/generate && \
|
||
go run main.go apisource --input '$(PWD)/$(input)/rest-api-spec/src/main/resources/rest-api-spec/api/*.json' --output '$(PWD)/$(output)' $(args) && \
|
||
go run main.go apisource --input '$(PWD)/$(input)/x-pack/plugin/src/test/resources/rest-api-spec/api/*.json' --output '$(PWD)/$(output)' $(args) && \
|
||
go run main.go apistruct --output '$(PWD)/$(output)'; \
|
||
}
|
||
|
||
gen-tests: ## Generate the API tests from the YAML specification
|
||
$(eval input ?= tmp/elasticsearch)
|
||
$(eval output ?= esapi/test)
|
||
ifdef debug
|
||
$(eval args += --debug)
|
||
endif
|
||
ifdef ELASTICSEARCH_VERSION
|
||
$(eval version = $(ELASTICSEARCH_VERSION))
|
||
else
|
||
$(eval version = $(shell cat "$(input)/buildSrc/version.properties" | grep 'elasticsearch' | cut -d '=' -f 2 | tr -d ' '))
|
||
endif
|
||
ifdef ELASTICSEARCH_BUILD_HASH
|
||
$(eval build_hash = $(ELASTICSEARCH_BUILD_HASH))
|
||
else
|
||
$(eval build_hash = $(shell git --git-dir='$(input)/.git' rev-parse --short HEAD))
|
||
endif
|
||
@echo "\033[2m→ Generating API tests from specification ($(version):$(build_hash))...\033[0m"
|
||
@{ \
|
||
set -e; \
|
||
trap "git checkout $(PWD)/internal/cmd/generate/go.mod" SIGINT SIGTERM EXIT; \
|
||
export ELASTICSEARCH_VERSION=$(version) && \
|
||
export ELASTICSEARCH_BUILD_HASH=$(build_hash) && \
|
||
rm -rf $(output)/*_test.go && \
|
||
rm -rf $(output)/xpack && \
|
||
cd internal/cmd/generate && \
|
||
go generate ./... && \
|
||
go run main.go apitests --input '$(PWD)/$(input)/rest-api-spec/src/main/resources/rest-api-spec/test/**/*.y*ml' --output '$(PWD)/$(output)' $(args) && \
|
||
go run main.go apitests --input '$(PWD)/$(input)/x-pack/plugin/src/test/resources/rest-api-spec/test/**/*.yml' --output '$(PWD)/$(output)/xpack' $(args) && \
|
||
go run main.go apitests --input '$(PWD)/$(input)/x-pack/plugin/src/test/resources/rest-api-spec/test/**/**/*.yml' --output '$(PWD)/$(output)/xpack' $(args) && \
|
||
mkdir -p '$(PWD)/esapi/test/xpack/ml' && \
|
||
mkdir -p '$(PWD)/esapi/test/xpack/ml-crud' && \
|
||
mv $(PWD)/esapi/test/xpack/xpack_ml* $(PWD)/esapi/test/xpack/ml/ && \
|
||
mv $(PWD)/esapi/test/xpack/ml/xpack_ml__jobs_crud_test.go $(PWD)/esapi/test/xpack/ml-crud/; \
|
||
}
|
||
|
||
##@ Other
|
||
#------------------------------------------------------------------------------
|
||
help: ## Display help
|
||
@awk 'BEGIN {FS = ":.*##"; printf "Usage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
|
||
#------------- <https://suva.sh/posts/well-documented-makefiles> --------------
|
||
|
||
.DEFAULT_GOAL := help
|
||
.PHONY: help apidiff backport cluster cluster-clean cluster-update coverage docker examples gen-api gen-tests godoc lint release test test-api test-bench test-integ test-unit
|