You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

285 lines
10 KiB

[RPC] Static swagger (#3880) * manually swagging Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * three definitions with polymorphism Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * added blockchain and block Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * low quality generation, commit, block_response and validators Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * genesis and consensus states endpoints Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * fix indentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * consensus parameters Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * fix indentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add height to consensus parameters endpoint Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * unconfirmed_txs and num_unconfirmed_txs Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add missing query parameter Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add ABCI queries Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * added index document for swagger documentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add missing routes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * contract tests added on CCI Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * contract tests job should be in the test suite Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * simplify requirements to test Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * typo Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * build is a prerequisite to start localnet Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * reduce nodejs size, move goodman to get_tools, add docs, fix comments Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Update scripts/get_tools.sh That's cleaner, thanks! Co-Authored-By: Anton Kaliaev <anton.kalyaev@gmail.com> * xz not supported by cci image, let's keep it simple Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * REMOVE-indirect debug of CCI paths Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment, volume is empty but binary has been produced Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment, volume is empty but binary has been produced Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment going on Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * locally works, CCI have difficulties with second layaer containers volumes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * restore experiment, use machine instead of docker for contract tests Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * simplify a bit Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * rollback on machine golang Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Document the changes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Changelog Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * comments Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
5 years ago
[RPC] Static swagger (#3880) * manually swagging Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * three definitions with polymorphism Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * added blockchain and block Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * low quality generation, commit, block_response and validators Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * genesis and consensus states endpoints Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * fix indentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * consensus parameters Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * fix indentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add height to consensus parameters endpoint Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * unconfirmed_txs and num_unconfirmed_txs Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add missing query parameter Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add ABCI queries Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * added index document for swagger documentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add missing routes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * contract tests added on CCI Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * contract tests job should be in the test suite Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * simplify requirements to test Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * typo Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * build is a prerequisite to start localnet Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * reduce nodejs size, move goodman to get_tools, add docs, fix comments Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Update scripts/get_tools.sh That's cleaner, thanks! Co-Authored-By: Anton Kaliaev <anton.kalyaev@gmail.com> * xz not supported by cci image, let's keep it simple Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * REMOVE-indirect debug of CCI paths Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment, volume is empty but binary has been produced Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment, volume is empty but binary has been produced Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment going on Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * locally works, CCI have difficulties with second layaer containers volumes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * restore experiment, use machine instead of docker for contract tests Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * simplify a bit Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * rollback on machine golang Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Document the changes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Changelog Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * comments Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
5 years ago
  1. #!/usr/bin/make -f
  2. PACKAGES=$(shell go list ./...)
  3. BUILDDIR ?= $(CURDIR)/build
  4. BUILD_TAGS?=tendermint
  5. # If building a release, please checkout the version tag to get the correct version setting
  6. ifneq ($(shell git symbolic-ref -q --short HEAD),)
  7. VERSION := unreleased-$(shell git symbolic-ref -q --short HEAD)-$(shell git rev-parse HEAD)
  8. else
  9. VERSION := $(shell git describe)
  10. endif
  11. LD_FLAGS = -X github.com/tendermint/tendermint/version.TMCoreSemVer=$(VERSION)
  12. BUILD_FLAGS = -mod=readonly -ldflags "$(LD_FLAGS)"
  13. HTTPS_GIT := https://github.com/tendermint/tendermint.git
  14. DOCKER_BUF := docker run -v $(shell pwd):/workspace --workdir /workspace bufbuild/buf
  15. CGO_ENABLED ?= 0
  16. # handle nostrip
  17. ifeq (,$(findstring nostrip,$(TENDERMINT_BUILD_OPTIONS)))
  18. BUILD_FLAGS += -trimpath
  19. LD_FLAGS += -s -w
  20. endif
  21. # handle race
  22. ifeq (race,$(findstring race,$(TENDERMINT_BUILD_OPTIONS)))
  23. CGO_ENABLED=1
  24. BUILD_FLAGS += -race
  25. endif
  26. # handle cleveldb
  27. ifeq (cleveldb,$(findstring cleveldb,$(TENDERMINT_BUILD_OPTIONS)))
  28. CGO_ENABLED=1
  29. BUILD_TAGS += cleveldb
  30. endif
  31. # handle badgerdb
  32. ifeq (badgerdb,$(findstring badgerdb,$(TENDERMINT_BUILD_OPTIONS)))
  33. BUILD_TAGS += badgerdb
  34. endif
  35. # handle rocksdb
  36. ifeq (rocksdb,$(findstring rocksdb,$(TENDERMINT_BUILD_OPTIONS)))
  37. CGO_ENABLED=1
  38. BUILD_TAGS += rocksdb
  39. endif
  40. # handle boltdb
  41. ifeq (boltdb,$(findstring boltdb,$(TENDERMINT_BUILD_OPTIONS)))
  42. BUILD_TAGS += boltdb
  43. endif
  44. # allow users to pass additional flags via the conventional LDFLAGS variable
  45. LD_FLAGS += $(LDFLAGS)
  46. all: check build test install
  47. .PHONY: all
  48. # The below include contains the tools.
  49. include tools/Makefile
  50. include test/Makefile
  51. ###############################################################################
  52. ### Build Tendermint ###
  53. ###############################################################################
  54. build: $(BUILDDIR)/
  55. CGO_ENABLED=$(CGO_ENABLED) go build $(BUILD_FLAGS) -tags '$(BUILD_TAGS)' -o $(BUILDDIR)/ ./cmd/tendermint/
  56. .PHONY: build
  57. install:
  58. CGO_ENABLED=$(CGO_ENABLED) go install $(BUILD_FLAGS) -tags $(BUILD_TAGS) ./cmd/tendermint
  59. .PHONY: install
  60. $(BUILDDIR)/:
  61. mkdir -p $@
  62. ###############################################################################
  63. ### Protobuf ###
  64. ###############################################################################
  65. proto-all: proto-gen proto-lint proto-check-breaking
  66. .PHONY: proto-all
  67. proto-gen:
  68. ## If you get the following error,
  69. ## "error while loading shared libraries: libprotobuf.so.14: cannot open shared object file: No such file or directory"
  70. ## See https://stackoverflow.com/a/25518702
  71. ## Note the $< here is substituted for the %.proto
  72. ## Note the $@ here is substituted for the %.pb.go
  73. @sh scripts/protocgen.sh
  74. .PHONY: proto-gen
  75. proto-gen-docker:
  76. @echo "Generating Protobuf files"
  77. @docker run -v $(shell pwd):/workspace --workdir /workspace tendermintdev/docker-build-proto sh ./scripts/protocgen.sh
  78. .PHONY: proto-gen-docker
  79. proto-lint:
  80. @$(DOCKER_BUF) check lint --error-format=json
  81. .PHONY: proto-lint
  82. proto-format:
  83. @echo "Formatting Protobuf files"
  84. docker run -v $(shell pwd):/workspace --workdir /workspace tendermintdev/docker-build-proto find ./ -not -path "./third_party/*" -name *.proto -exec clang-format -i {} \;
  85. .PHONY: proto-format
  86. proto-check-breaking:
  87. @$(DOCKER_BUF) check breaking --against-input .git#branch=master
  88. .PHONY: proto-check-breaking
  89. proto-check-breaking-ci:
  90. @$(DOCKER_BUF) check breaking --against-input $(HTTPS_GIT)#branch=master
  91. .PHONY: proto-check-breaking-ci
  92. ###############################################################################
  93. ### Build ABCI ###
  94. ###############################################################################
  95. build_abci:
  96. @go build -mod=readonly -i ./abci/cmd/...
  97. .PHONY: build_abci
  98. install_abci:
  99. @go install -mod=readonly ./abci/cmd/...
  100. .PHONY: install_abci
  101. ###############################################################################
  102. ### Distribution ###
  103. ###############################################################################
  104. # dist builds binaries for all platforms and packages them for distribution
  105. # TODO add abci to these scripts
  106. dist:
  107. @BUILD_TAGS=$(BUILD_TAGS) sh -c "'$(CURDIR)/scripts/dist.sh'"
  108. .PHONY: dist
  109. go-mod-cache: go.sum
  110. @echo "--> Download go modules to local cache"
  111. @go mod download
  112. .PHONY: go-mod-cache
  113. go.sum: go.mod
  114. @echo "--> Ensure dependencies have not been modified"
  115. @go mod verify
  116. @go mod tidy
  117. draw_deps:
  118. @# requires brew install graphviz or apt-get install graphviz
  119. go get github.com/RobotsAndPencils/goviz
  120. @goviz -i github.com/tendermint/tendermint/cmd/tendermint -d 3 | dot -Tpng -o dependency-graph.png
  121. .PHONY: draw_deps
  122. get_deps_bin_size:
  123. @# Copy of build recipe with additional flags to perform binary size analysis
  124. $(eval $(shell go build -work -a $(BUILD_FLAGS) -tags $(BUILD_TAGS) -o $(BUILDDIR)/ ./cmd/tendermint/ 2>&1))
  125. @find $(WORK) -type f -name "*.a" | xargs -I{} du -hxs "{}" | sort -rh | sed -e s:${WORK}/::g > deps_bin_size.log
  126. @echo "Results can be found here: $(CURDIR)/deps_bin_size.log"
  127. .PHONY: get_deps_bin_size
  128. ###############################################################################
  129. ### Libs ###
  130. ###############################################################################
  131. # generates certificates for TLS testing in remotedb and RPC server
  132. gen_certs: clean_certs
  133. certstrap init --common-name "tendermint.com" --passphrase ""
  134. certstrap request-cert --common-name "server" -ip "127.0.0.1" --passphrase ""
  135. certstrap sign "server" --CA "tendermint.com" --passphrase ""
  136. mv out/server.crt rpc/jsonrpc/server/test.crt
  137. mv out/server.key rpc/jsonrpc/server/test.key
  138. rm -rf out
  139. .PHONY: gen_certs
  140. # deletes generated certificates
  141. clean_certs:
  142. rm -f rpc/jsonrpc/server/test.crt
  143. rm -f rpc/jsonrpc/server/test.key
  144. .PHONY: clean_certs
  145. ###############################################################################
  146. ### Formatting, linting, and vetting ###
  147. ###############################################################################
  148. format:
  149. find . -name '*.go' -type f -not -path "*.git*" -not -name '*.pb.go' -not -name '*pb_test.go' | xargs gofmt -w -s
  150. find . -name '*.go' -type f -not -path "*.git*" -not -name '*.pb.go' -not -name '*pb_test.go' | xargs goimports -w -local github.com/tendermint/tendermint
  151. .PHONY: format
  152. lint:
  153. @echo "--> Running linter"
  154. @golangci-lint run
  155. .PHONY: lint
  156. DESTINATION = ./index.html.md
  157. ###############################################################################
  158. ### Documentation ###
  159. ###############################################################################
  160. # todo remove once tendermint.com DNS is solved
  161. build-docs:
  162. @cd docs && \
  163. while read -r branch path_prefix; do \
  164. (git checkout $${branch} && npm install && VUEPRESS_BASE="/$${path_prefix}/" npm run build) ; \
  165. mkdir -p ~/output/$${path_prefix} ; \
  166. cp -r .vuepress/dist/* ~/output/$${path_prefix}/ ; \
  167. cp ~/output/$${path_prefix}/index.html ~/output ; \
  168. done < versions ;
  169. .PHONY: build-docs
  170. ###############################################################################
  171. ### Docker image ###
  172. ###############################################################################
  173. build-docker: build-linux
  174. cp $(BUILDDIR)/tendermint DOCKER/tendermint
  175. docker build --label=tendermint --tag="tendermint/tendermint" DOCKER
  176. rm -rf DOCKER/tendermint
  177. .PHONY: build-docker
  178. ###############################################################################
  179. ### Local testnet using docker ###
  180. ###############################################################################
  181. # Build linux binary on other platforms
  182. build-linux: tools
  183. GOOS=linux GOARCH=amd64 $(MAKE) build
  184. .PHONY: build-linux
  185. build-docker-localnode:
  186. @cd networks/local && make
  187. .PHONY: build-docker-localnode
  188. # Runs `make build TENDERMINT_BUILD_OPTIONS=cleveldb` from within an Amazon
  189. # Linux (v2)-based Docker build container in order to build an Amazon
  190. # Linux-compatible binary. Produces a compatible binary at ./build/tendermint
  191. build_c-amazonlinux:
  192. $(MAKE) -C ./DOCKER build_amazonlinux_buildimage
  193. docker run --rm -it -v `pwd`:/tendermint tendermint/tendermint:build_c-amazonlinux
  194. .PHONY: build_c-amazonlinux
  195. # Run a 4-node testnet locally
  196. localnet-start: localnet-stop build-docker-localnode
  197. @if ! [ -f build/node0/config/genesis.json ]; then docker run --rm -v $(CURDIR)/build:/tendermint:Z tendermint/localnode testnet --config /etc/tendermint/config-template.toml --o . --starting-ip-address 192.167.10.2; fi
  198. docker-compose up
  199. .PHONY: localnet-start
  200. # Stop testnet
  201. localnet-stop:
  202. docker-compose down
  203. .PHONY: localnet-stop
  204. # Build hooks for dredd, to skip or add information on some steps
  205. build-contract-tests-hooks:
  206. ifeq ($(OS),Windows_NT)
  207. go build -mod=readonly $(BUILD_FLAGS) -o build/contract_tests.exe ./cmd/contract_tests
  208. else
  209. go build -mod=readonly $(BUILD_FLAGS) -o build/contract_tests ./cmd/contract_tests
  210. endif
  211. .PHONY: build-contract-tests-hooks
  212. # Run a nodejs tool to test endpoints against a localnet
  213. # The command takes care of starting and stopping the network
  214. # prerequisits: build-contract-tests-hooks build-linux
  215. # the two build commands were not added to let this command run from generic containers or machines.
  216. # The binaries should be built beforehand
  217. contract-tests:
  218. dredd
  219. .PHONY: contract-tests
  220. clean:
  221. rm -rf $(CURDIR)/artifacts/ $(BUILDDIR)/
  222. build-reproducible:
  223. docker rm latest-build || true
  224. docker run --volume=$(CURDIR):/sources:ro \
  225. --env TARGET_PLATFORMS='linux/amd64 linux/arm64 darwin/amd64 windows/amd64' \
  226. --env APP=tendermint \
  227. --env COMMIT=$(shell git rev-parse --short=8 HEAD) \
  228. --env VERSION=$(shell git describe --tags) \
  229. --name latest-build cosmossdk/rbuilder:latest
  230. docker cp -a latest-build:/home/builder/artifacts/ $(CURDIR)/
  231. .PHONY: build-reproducible