242 lines
8.9 KiB
Makefile
242 lines
8.9 KiB
Makefile
#!/usr/bin/make -f
|
|
|
|
PACKAGES_NOSIMULATION=$(shell go list ./... | grep -v '/simulation')
|
|
PACKAGES_SIMTEST=$(shell go list ./... | grep '/simulation')
|
|
VERSION := $(shell echo $(shell git describe --tags) | sed 's/^v//')
|
|
COMMIT := $(shell git log -1 --format='%H')
|
|
LEDGER_ENABLED ?= true
|
|
BINDIR ?= $(GOPATH)/bin
|
|
SIMAPP = ./simapp
|
|
MOCKS_DIR = $(CURDIR)/tests/mocks
|
|
|
|
export GO111MODULE = on
|
|
|
|
# The below include contains the tools and runsim targets.
|
|
include contrib/devtools/Makefile
|
|
|
|
all: tools build lint test
|
|
|
|
###############################################################################
|
|
### Build ###
|
|
###############################################################################
|
|
|
|
build: go.sum
|
|
@go build -mod=readonly ./...
|
|
.PHONY: build
|
|
|
|
mocks: $(MOCKS_DIR)
|
|
mockgen -source=x/auth/types/account_retriever.go -package mocks -destination tests/mocks/account_retriever.go
|
|
.PHONY: mocks
|
|
|
|
$(MOCKS_DIR):
|
|
mkdir -p $(MOCKS_DIR)
|
|
|
|
distclean:
|
|
rm -rf \
|
|
gitian-build-darwin/ \
|
|
gitian-build-linux/ \
|
|
gitian-build-windows/ \
|
|
.gitian-builder-cache/
|
|
.PHONY: distclean
|
|
|
|
###############################################################################
|
|
### Tools & Dependencies ###
|
|
###############################################################################
|
|
|
|
go-mod-cache: go.sum
|
|
@echo "--> Download go modules to local cache"
|
|
@go mod download
|
|
.PHONY: go-mod-cache
|
|
|
|
go.sum: go.mod
|
|
@echo "--> Ensure dependencies have not been modified"
|
|
@go mod verify
|
|
@go mod tidy
|
|
|
|
###############################################################################
|
|
### Documentation ###
|
|
###############################################################################
|
|
|
|
update-swagger-docs: statik
|
|
$(BINDIR)/statik -src=client/lcd/swagger-ui -dest=client/lcd -f -m
|
|
@if [ -n "$(git status --porcelain)" ]; then \
|
|
echo "\033[91mSwagger docs are out of sync!!!\033[0m";\
|
|
exit 1;\
|
|
else \
|
|
echo "\033[92mSwagger docs are in sync\033[0m";\
|
|
fi
|
|
.PHONY: update-swagger-docs
|
|
|
|
godocs:
|
|
@echo "--> Wait a few seconds and visit http://localhost:6060/pkg/github.com/cosmos/cosmos-sdk/types"
|
|
godoc -http=:6060
|
|
|
|
build-docs:
|
|
@cd docs && \
|
|
while read p; do \
|
|
(git checkout $${p} && npm install && VUEPRESS_BASE="/$${p}/" npm run build) ; \
|
|
mkdir -p ~/output/$${p} ; \
|
|
cp -r .vuepress/dist/* ~/output/$${p}/ ; \
|
|
cp ~/output/$${p}/index.html ~/output ; \
|
|
done < versions ;
|
|
|
|
sync-docs:
|
|
cd ~/output && \
|
|
echo "role_arn = ${DEPLOYMENT_ROLE_ARN}" >> /root/.aws/config ; \
|
|
echo "CI job = ${CIRCLE_BUILD_URL}" >> version.html ; \
|
|
aws s3 sync . s3://${WEBSITE_BUCKET} --profile terraform --delete ; \
|
|
aws cloudfront create-invalidation --distribution-id ${CF_DISTRIBUTION_ID} --profile terraform --path "/*" ;
|
|
.PHONY: sync-docs
|
|
|
|
###############################################################################
|
|
### Tests & Simulation ###
|
|
###############################################################################
|
|
|
|
test: test-unit
|
|
test-all: test-unit test-ledger-mock test-race test-cover
|
|
|
|
test-ledger-mock:
|
|
@go test -mod=readonly `go list github.com/cosmos/cosmos-sdk/crypto` -tags='cgo ledger test_ledger_mock'
|
|
|
|
test-ledger: test-ledger-mock
|
|
@go test -mod=readonly -v `go list github.com/cosmos/cosmos-sdk/crypto` -tags='cgo ledger'
|
|
|
|
test-unit:
|
|
@VERSION=$(VERSION) go test -mod=readonly $(PACKAGES_NOSIMULATION) -tags='ledger test_ledger_mock'
|
|
|
|
test-race:
|
|
@VERSION=$(VERSION) go test -mod=readonly -race $(PACKAGES_NOSIMULATION)
|
|
|
|
.PHONY: test test-all test-ledger-mock test-ledger test-unit test-race
|
|
|
|
test-sim-nondeterminism:
|
|
@echo "Running non-determinism test..."
|
|
@go test -mod=readonly $(SIMAPP) -run TestAppStateDeterminism -Enabled=true \
|
|
-NumBlocks=100 -BlockSize=200 -Commit=true -Period=0 -v -timeout 24h
|
|
|
|
test-sim-custom-genesis-fast:
|
|
@echo "Running custom genesis simulation..."
|
|
@echo "By default, ${HOME}/.gaiad/config/genesis.json will be used."
|
|
@go test -mod=readonly $(SIMAPP) -run TestFullAppSimulation -Genesis=${HOME}/.gaiad/config/genesis.json \
|
|
-Enabled=true -NumBlocks=100 -BlockSize=200 -Commit=true -Seed=99 -Period=5 -v -timeout 24h
|
|
|
|
test-sim-import-export: runsim
|
|
@echo "Running application import/export simulation. This may take several minutes..."
|
|
@$(BINDIR)/runsim -Jobs=4 -SimAppPkg=$(SIMAPP) 50 5 TestAppImportExport
|
|
|
|
test-sim-after-import: runsim
|
|
@echo "Running application simulation-after-import. This may take several minutes..."
|
|
@$(BINDIR)/runsim -Jobs=4 -SimAppPkg=$(SIMAPP) 50 5 TestAppSimulationAfterImport
|
|
|
|
test-sim-custom-genesis-multi-seed: runsim
|
|
@echo "Running multi-seed custom genesis simulation..."
|
|
@echo "By default, ${HOME}/.gaiad/config/genesis.json will be used."
|
|
@$(BINDIR)/runsim -Genesis=${HOME}/.gaiad/config/genesis.json -SimAppPkg=$(SIMAPP) 400 5 TestFullAppSimulation
|
|
|
|
test-sim-multi-seed-long: runsim
|
|
@echo "Running long multi-seed application simulation. This may take awhile!"
|
|
@$(BINDIR)/runsim -Jobs=4 -SimAppPkg=$(SIMAPP) 500 50 TestFullAppSimulation
|
|
|
|
test-sim-multi-seed-short: runsim
|
|
@echo "Running short multi-seed application simulation. This may take awhile!"
|
|
@$(BINDIR)/runsim -Jobs=4 -SimAppPkg=$(SIMAPP) 50 10 TestFullAppSimulation
|
|
|
|
test-sim-benchmark-invariants:
|
|
@echo "Running simulation invariant benchmarks..."
|
|
@go test -mod=readonly $(SIMAPP) -benchmem -bench=BenchmarkInvariants -run=^$ \
|
|
-Enabled=true -NumBlocks=1000 -BlockSize=200 \
|
|
-Period=1 -Commit=true -Seed=57 -v -timeout 24h
|
|
|
|
.PHONY: \
|
|
test-sim-nondeterminism \
|
|
test-sim-custom-genesis-fast \
|
|
test-sim-import-export \
|
|
test-sim-after-import \
|
|
test-sim-custom-genesis-multi-seed \
|
|
test-sim-multi-seed-short \
|
|
test-sim-multi-seed-long \
|
|
test-sim-benchmark-invariants
|
|
|
|
SIM_NUM_BLOCKS ?= 500
|
|
SIM_BLOCK_SIZE ?= 200
|
|
SIM_COMMIT ?= true
|
|
|
|
test-sim-benchmark:
|
|
@echo "Running application benchmark for numBlocks=$(SIM_NUM_BLOCKS), blockSize=$(SIM_BLOCK_SIZE). This may take awhile!"
|
|
@go test -mod=readonly -benchmem -run=^$$ $(SIMAPP) -bench ^BenchmarkFullAppSimulation$$ \
|
|
-Enabled=true -NumBlocks=$(SIM_NUM_BLOCKS) -BlockSize=$(SIM_BLOCK_SIZE) -Commit=$(SIM_COMMIT) -timeout 24h
|
|
|
|
test-sim-profile:
|
|
@echo "Running application benchmark for numBlocks=$(SIM_NUM_BLOCKS), blockSize=$(SIM_BLOCK_SIZE). This may take awhile!"
|
|
@go test -mod=readonly -benchmem -run=^$$ $(SIMAPP) -bench ^BenchmarkFullAppSimulation$$ \
|
|
-Enabled=true -NumBlocks=$(SIM_NUM_BLOCKS) -BlockSize=$(SIM_BLOCK_SIZE) -Commit=$(SIM_COMMIT) -timeout 24h -cpuprofile cpu.out -memprofile mem.out
|
|
|
|
.PHONY: test-sim-profile test-sim-benchmark
|
|
|
|
test-cover:
|
|
@export VERSION=$(VERSION); bash -x tests/test_cover.sh
|
|
.PHONY: test-cover
|
|
|
|
benchmark:
|
|
@go test -mod=readonly -bench=. $(PACKAGES_NOSIMULATION)
|
|
.PHONY: benchmark
|
|
|
|
###############################################################################
|
|
### Linting ###
|
|
###############################################################################
|
|
|
|
lint:
|
|
golangci-lint run
|
|
find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" | xargs gofmt -d -s
|
|
go mod verify
|
|
.PHONY: lint
|
|
|
|
format: tools
|
|
find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -path "./client/lcd/statik/statik.go" | xargs gofmt -w -s
|
|
find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -path "./client/lcd/statik/statik.go" | xargs misspell -w
|
|
find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -path "./client/lcd/statik/statik.go" | xargs goimports -w -local github.com/cosmos/cosmos-sdk
|
|
.PHONY: format
|
|
|
|
###############################################################################
|
|
### Devdoc ###
|
|
###############################################################################
|
|
|
|
DEVDOC_SAVE = docker commit `docker ps -a -n 1 -q` devdoc:local
|
|
|
|
devdoc-init:
|
|
docker run -it -v "$(CURDIR):/go/src/github.com/cosmos/cosmos-sdk" -w "/go/src/github.com/cosmos/cosmos-sdk" tendermint/devdoc echo
|
|
# TODO make this safer
|
|
$(call DEVDOC_SAVE)
|
|
|
|
devdoc:
|
|
docker run -it -v "$(CURDIR):/go/src/github.com/cosmos/cosmos-sdk" -w "/go/src/github.com/cosmos/cosmos-sdk" devdoc:local bash
|
|
|
|
devdoc-save:
|
|
# TODO make this safer
|
|
$(call DEVDOC_SAVE)
|
|
|
|
devdoc-clean:
|
|
docker rmi -f $$(docker images -f "dangling=true" -q)
|
|
|
|
devdoc-update:
|
|
docker pull tendermint/devdoc
|
|
|
|
.PHONY: devdoc devdoc-clean devdoc-init devdoc-save devdoc-update
|
|
|
|
###############################################################################
|
|
### Protobuf ###
|
|
###############################################################################
|
|
|
|
proto-all: proto-gen proto-lint proto-check-breaking
|
|
|
|
proto-gen:
|
|
@./scripts/protocgen.sh
|
|
|
|
proto-lint:
|
|
@buf check lint --error-format=json
|
|
|
|
proto-check-breaking:
|
|
@buf check breaking --against-input '.git#branch=master'
|
|
|
|
.PHONY: proto-all proto-gen proto-lint proto-check-breaking
|