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.

267 lines
9.5 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. PACKAGES=$(shell go list ./...)
  2. OUTPUT?=build/tendermint
  3. BUILD_TAGS?=tendermint
  4. VERSION := $(shell git describe --always)
  5. LD_FLAGS = -X github.com/tendermint/tendermint/version.TMCoreSemVer=$(VERSION)
  6. BUILD_FLAGS = -mod=readonly -ldflags "$(LD_FLAGS)"
  7. HTTPS_GIT := https://github.com/tendermint/tendermint.git
  8. DOCKER_BUF := docker run -v $(shell pwd):/workspace --workdir /workspace bufbuild/buf
  9. CGO_ENABLED ?= 0
  10. # handle nostrip
  11. ifeq (,$(findstring nostrip,$(TENDERMINT_BUILD_OPTIONS)))
  12. BUILD_FLAGS += -trimpath
  13. LD_FLAGS += -s -w
  14. endif
  15. # handle race
  16. ifeq (race,$(findstring race,$(TENDERMINT_BUILD_OPTIONS)))
  17. CGO_ENABLED=1
  18. BUILD_FLAGS += -race
  19. endif
  20. # handle cleveldb
  21. ifeq (cleveldb,$(findstring cleveldb,$(TENDERMINT_BUILD_OPTIONS)))
  22. CGO_ENABLED=1
  23. BUILD_TAGS += cleveldb
  24. endif
  25. # handle badgerdb
  26. ifeq (badgerdb,$(findstring badgerdb,$(TENDERMINT_BUILD_OPTIONS)))
  27. BUILD_TAGS += badgerdb
  28. endif
  29. # handle rocksdb
  30. ifeq (rocksdb,$(findstring rocksdb,$(TENDERMINT_BUILD_OPTIONS)))
  31. CGO_ENABLED=1
  32. BUILD_TAGS += rocksdb
  33. endif
  34. # handle boltdb
  35. ifeq (boltdb,$(findstring boltdb,$(TENDERMINT_BUILD_OPTIONS)))
  36. BUILD_TAGS += boltdb
  37. endif
  38. # allow users to pass additional flags via the conventional LDFLAGS variable
  39. LD_FLAGS += $(LDFLAGS)
  40. all: check build test install
  41. .PHONY: all
  42. # The below include contains the tools.
  43. include tools.mk
  44. include tests.mk
  45. ###############################################################################
  46. ### Build Tendermint ###
  47. ###############################################################################
  48. build:
  49. CGO_ENABLED=$(CGO_ENABLED) go build $(BUILD_FLAGS) -tags '$(BUILD_TAGS)' -o $(OUTPUT) ./cmd/tendermint/
  50. .PHONY: build
  51. install:
  52. CGO_ENABLED=$(CGO_ENABLED) go install $(BUILD_FLAGS) -tags $(BUILD_TAGS) ./cmd/tendermint
  53. .PHONY: install
  54. ###############################################################################
  55. ### Protobuf ###
  56. ###############################################################################
  57. proto-all: proto-gen proto-lint proto-check-breaking
  58. .PHONY: proto-all
  59. proto-gen:
  60. ## If you get the following error,
  61. ## "error while loading shared libraries: libprotobuf.so.14: cannot open shared object file: No such file or directory"
  62. ## See https://stackoverflow.com/a/25518702
  63. ## Note the $< here is substituted for the %.proto
  64. ## Note the $@ here is substituted for the %.pb.go
  65. @sh scripts/protocgen.sh
  66. .PHONY: proto-gen
  67. proto-gen-docker:
  68. @echo "Generating Protobuf files"
  69. @docker run -v $(shell pwd):/workspace --workdir /workspace tendermintdev/docker-build-proto sh ./scripts/protocgen.sh
  70. .PHONY: proto-gen-docker
  71. proto-lint:
  72. @$(DOCKER_BUF) check lint --error-format=json
  73. .PHONY: proto-lint
  74. proto-format:
  75. @echo "Formatting Protobuf files"
  76. docker run -v $(shell pwd):/workspace --workdir /workspace tendermintdev/docker-build-proto find ./ -not -path "./third_party/*" -name *.proto -exec clang-format -i {} \;
  77. .PHONY: proto-format
  78. proto-check-breaking:
  79. @$(DOCKER_BUF) check breaking --against-input .git#branch=master
  80. .PHONY: proto-check-breaking
  81. proto-check-breaking-ci:
  82. @$(DOCKER_BUF) check breaking --against-input $(HTTPS_GIT)#branch=master
  83. .PHONY: proto-check-breaking-ci
  84. ###############################################################################
  85. ### Build ABCI ###
  86. ###############################################################################
  87. build_abci:
  88. @go build -mod=readonly -i ./abci/cmd/...
  89. .PHONY: build_abci
  90. install_abci:
  91. @go install -mod=readonly ./abci/cmd/...
  92. .PHONY: install_abci
  93. ###############################################################################
  94. ### Distribution ###
  95. ###############################################################################
  96. # dist builds binaries for all platforms and packages them for distribution
  97. # TODO add abci to these scripts
  98. dist:
  99. @BUILD_TAGS=$(BUILD_TAGS) sh -c "'$(CURDIR)/scripts/dist.sh'"
  100. .PHONY: dist
  101. go-mod-cache: go.sum
  102. @echo "--> Download go modules to local cache"
  103. @go mod download
  104. .PHONY: go-mod-cache
  105. go.sum: go.mod
  106. @echo "--> Ensure dependencies have not been modified"
  107. @go mod verify
  108. @go mod tidy
  109. draw_deps:
  110. @# requires brew install graphviz or apt-get install graphviz
  111. go get github.com/RobotsAndPencils/goviz
  112. @goviz -i github.com/tendermint/tendermint/cmd/tendermint -d 3 | dot -Tpng -o dependency-graph.png
  113. .PHONY: draw_deps
  114. get_deps_bin_size:
  115. @# Copy of build recipe with additional flags to perform binary size analysis
  116. $(eval $(shell go build -work -a $(BUILD_FLAGS) -tags $(BUILD_TAGS) -o $(OUTPUT) ./cmd/tendermint/ 2>&1))
  117. @find $(WORK) -type f -name "*.a" | xargs -I{} du -hxs "{}" | sort -rh | sed -e s:${WORK}/::g > deps_bin_size.log
  118. @echo "Results can be found here: $(CURDIR)/deps_bin_size.log"
  119. .PHONY: get_deps_bin_size
  120. ###############################################################################
  121. ### Libs ###
  122. ###############################################################################
  123. # generates certificates for TLS testing in remotedb and RPC server
  124. gen_certs: clean_certs
  125. certstrap init --common-name "tendermint.com" --passphrase ""
  126. certstrap request-cert --common-name "server" -ip "127.0.0.1" --passphrase ""
  127. certstrap sign "server" --CA "tendermint.com" --passphrase ""
  128. mv out/server.crt rpc/jsonrpc/server/test.crt
  129. mv out/server.key rpc/jsonrpc/server/test.key
  130. rm -rf out
  131. .PHONY: gen_certs
  132. # deletes generated certificates
  133. clean_certs:
  134. rm -f rpc/jsonrpc/server/test.crt
  135. rm -f rpc/jsonrpc/server/test.key
  136. .PHONY: clean_certs
  137. ###############################################################################
  138. ### Formatting, linting, and vetting ###
  139. ###############################################################################
  140. format:
  141. find . -name '*.go' -type f -not -path "*.git*" -not -name '*.pb.go' -not -name '*pb_test.go' | xargs gofmt -w -s
  142. 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
  143. .PHONY: format
  144. lint:
  145. @echo "--> Running linter"
  146. @golangci-lint run
  147. .PHONY: lint
  148. DESTINATION = ./index.html.md
  149. ###############################################################################
  150. ### Documentation ###
  151. ###############################################################################
  152. build-docs:
  153. cd docs && \
  154. while read p; do \
  155. (git checkout $${p} . && npm install && VUEPRESS_BASE="/$${p}/" npm run build) ; \
  156. mkdir -p ~/output/$${p} ; \
  157. cp -r .vuepress/dist/* ~/output/$${p}/ ; \
  158. cp ~/output/$${p}/index.html ~/output ; \
  159. done < versions ;
  160. .PHONY: build-docs
  161. sync-docs:
  162. cd ~/output && \
  163. echo "role_arn = ${DEPLOYMENT_ROLE_ARN}" >> /root/.aws/config ; \
  164. echo "CI job = ${CIRCLE_BUILD_URL}" >> version.html ; \
  165. aws s3 sync . s3://${WEBSITE_BUCKET} --profile terraform --delete ; \
  166. aws cloudfront create-invalidation --distribution-id ${CF_DISTRIBUTION_ID} --profile terraform --path "/*" ;
  167. .PHONY: sync-docs
  168. ###############################################################################
  169. ### Docker image ###
  170. ###############################################################################
  171. build-docker: build-linux
  172. cp $(OUTPUT) DOCKER/tendermint
  173. docker build --label=tendermint --tag="tendermint/tendermint" DOCKER
  174. rm -rf DOCKER/tendermint
  175. .PHONY: build-docker
  176. ###############################################################################
  177. ### Local testnet using docker ###
  178. ###############################################################################
  179. # Build linux binary on other platforms
  180. build-linux: tools
  181. GOOS=linux GOARCH=amd64 $(MAKE) build
  182. .PHONY: build-linux
  183. build-docker-localnode:
  184. @cd networks/local && make
  185. .PHONY: build-docker-localnode
  186. # Runs `make build TENDERMINT_BUILD_OPTIONS=cleveldb` from within an Amazon
  187. # Linux (v2)-based Docker build container in order to build an Amazon
  188. # Linux-compatible binary. Produces a compatible binary at ./build/tendermint
  189. build_c-amazonlinux:
  190. $(MAKE) -C ./DOCKER build_amazonlinux_buildimage
  191. docker run --rm -it -v `pwd`:/tendermint tendermint/tendermint:build_c-amazonlinux
  192. .PHONY: build_c-amazonlinux
  193. # Run a 4-node testnet locally
  194. localnet-start: localnet-stop build-docker-localnode
  195. @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
  196. docker-compose up
  197. .PHONY: localnet-start
  198. # Stop testnet
  199. localnet-stop:
  200. docker-compose down
  201. .PHONY: localnet-stop
  202. # Build hooks for dredd, to skip or add information on some steps
  203. build-contract-tests-hooks:
  204. ifeq ($(OS),Windows_NT)
  205. go build -mod=readonly $(BUILD_FLAGS) -o build/contract_tests.exe ./cmd/contract_tests
  206. else
  207. go build -mod=readonly $(BUILD_FLAGS) -o build/contract_tests ./cmd/contract_tests
  208. endif
  209. .PHONY: build-contract-tests-hooks
  210. # Run a nodejs tool to test endpoints against a localnet
  211. # The command takes care of starting and stopping the network
  212. # prerequisits: build-contract-tests-hooks build-linux
  213. # the two build commands were not added to let this command run from generic containers or machines.
  214. # The binaries should be built beforehand
  215. contract-tests:
  216. dredd
  217. .PHONY: contract-tests