Use Docker to generate swagger files

[amaury1093]

Summary

To not install binaries on the user's local machine, use Docker for proto swagger generation.

Problem Definition

In protoc-swagger-gen.sh, we rely on a globally installed swagger-combine binary to combine all the generated swagger files into one. This may lead to incompatible versions used by different devs on the cosmos-sdk, leading to unwanted file diff in generated files.

cosmos-sdk/scripts/protoc-swagger-gen.sh

Lines 21 to 24 in 4b529a4

	# combine swagger files
	# uses nodejs package `swagger-combine`.
	# all the individual swagger files need to be configured in `config.json` for merging
	swagger-combine ./client/docs/config.json -o ./client/docs/swagger-ui/swagger.yaml -f yaml --continueOnConflictingPaths true --includeDefinitions true

Proposal

Following #7332, we should containerize swagger-combine (maybe in the same Dockerfile as buf/protoc?), and update the following Makefile target to use Docker:

cosmos-sdk/Makefile

Lines 380 to 381 in 4b529a4

	proto-swagger-gen:
	@./scripts/protoc-swagger-gen.sh

---

For Admin Use

• Not duplicate issue
• Appropriate labels applied
• Appropriate contributors tagged
• Contributor assigned/self-assigned

[amaury1093]

How should we move forward for dockerizing proto-swagger-gen (which requires installing another npm binary called swagger-combine):

1. add swagger-combine somewhere in the tendermintdev/sdk-proto-gen dockerfile we use.
2. create a new dockerfile on the sdk which is tendermintdev/sdk-proto-gen + swagger-combine
3. Remove swagger-combine from the protoc-swagger-gen.sh file, and use 2 lines for the make command:

proto-swagger-gen:
	$(DOCKER) run --rm -v $(CURDIR):/workspace --workdir /workspace tendermintdev/sdk-proto-gen sh ./scripts/protoc-swagger-gen.sh
	$(DOCKER) run --rm -v $(CURDIR):/workspace --workdir /workspace courtapi/swagger-combine {swagger combine arguments}

(we use an external dockerfile for swagger-combine)

4. Don't use docker at all for this command.

I have a slight preference for 2 or 3.

[alexanderbez]

Why not (1)? It's not difficult to rebuild the image with that dependency added.

[hallazzang]

I'm working on this issue