Check in generated code and update according to buf lint (#62)

* checking in generated code and updating according to buf lint

* adding exception in buf lint for enums, removing org from package name

* fixing enum name, and ENV_VARS.md

* using go as package name for generated files, adding exception for enum in buf

* chore: makes sure go gets generated and can be consume seamless.

* chore: removes protolint.

* chore: tweaks env var generation.

* chore: fix replace directive.

* updating package names, and exceptions in buf

* chore: simplify packages.

* chore: ignore directory structure for config.proto.

* chore: adds go generated code from proto.

* fix: sets the right go package

* chore: improves the generated code and the generate command.

* fix: sets the right make targets

* chore: sets the right path for env vars generation

* docs: update env vars.

* chore: removes unused files in the generated code.

* chore: fix loader for when default value for fields is nil.

* chore: fixes pointer for loading options to avoid the copy of a lock field.

* chore: improves the package structure by simplfying it and shorten it.

Co-authored-by: José Carlos Chávez <[email protected]>

Author: shashank11p

.github/workflows/linter.yml .github/workflows/pr.yml

@@ -8,7 +8,10 @@ jobs:
       - name: checkout source
         uses: actions/checkout@v1
 
-      - name: run protolint
-        uses: plexsystems/[email protected]
+      - name: Install buf
+        uses: wizhi/setup-buf@v1
         with:
-          configDirectory: .
+          version: 0.36.0
+
+      - name: Lint proto
+        run: make lint-proto

.gitignore

@@ -3,6 +3,3 @@
 .vscode
 .idea
 *~
-
-# Generated code
-**/*.pb.go

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "tools/env-vars-generator/protobuf"]
 	path = tools/env-vars-generator/protobuf
 	url = https://github.com/protocolbuffers/protobuf.git
+[submodule "tools/go-generator/cmd/generator/_protobuf"]
+	path = tools/go-generator/cmd/generator/_protobuf
+	url = https://github.com/protocolbuffers/protobuf.git

.protolint.yaml

@@ -25,4 +25,4 @@ Agents can be configured using environment variables:
 | HT_DATA_CAPTURE_BODY_MAX_SIZE_BYTES | Maximum size of captured body in bytes. Default should be 131_072 (128 KiB). |
 | HT_PROPAGATION_FORMATS | List the supported propagation formats e.g. `HT_PROPAGATION_FORMATS="B3,TRACECONTEXT"`. |
 | HT_ENABLED | When `false`, disables the agent |
-| HT_JAVAAGENT_FILTER_JAR_PATHS | Is the list of path to filter jars, separated by `,`. |
+| HT_JAVAAGENT_FILTER_JAR_PATHS | Is the list of path to filter jars, separated by `,`. The values should be separated by `,`. |

ENV_VARS.md

@@ -1,18 +1,42 @@
-.PHONY: default help lint generate-env-vars init-git-submodule
+.PHONY: default help lint-proto generate-env-vars init-git-submodule breaking-proto generate-proto clean
 
 default: help
 
 help: ## Prints this help.
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-18s\033[0m %s\n", $$1, $$2}'
 
-lint: ## Lints the proto files.
-	protolint config.proto
+clean: ## Cleans all build generated artifacts
+	rm -rf ./gen
+
+install:
+	go install -mod=mod \
+		google.golang.org/grpc/cmd/protoc-gen-go-grpc \
+		google.golang.org/protobuf/cmd/protoc-gen-go \
+		github.com/bufbuild/buf/cmd/buf
+
+lint-proto:
+	$(MAKE) -C ./proto lint
+
+breaking-proto:
+	$(MAKE) -C ./proto breaking
+
+generate-proto:
+	@# Generates pb struct
+	$(MAKE) -C ./proto generate
+	
+	@# Generates pb loaders
+	@ROOT=$(PWD)/proto OUT_DIR=$(PWD)/gen/go \
+	$(MAKE) -C ./tools/go-generator
+
+	@echo "Tidy generated modules."
+	@find $(PWD)/gen/go \( -name vendor -o -name '[._].*' -o -name node_modules \) -prune -o -name go.mod -print | sed 's:/go.mod::' | xargs -I {} bash -c 'cd {}; go mod tidy'
 
 generate-env-vars: init-git-submodule ## Generates the ENV_VARS.md with all environment variables.
 	docker build -t hypertrace/agent-config/env-vars-generator tools/env-vars-generator
+	touch $(PWD)/ENV_VARS.md # makes sure this is created as a file and not as a directory
 	docker run \
 	-v $(PWD)/ENV_VARS.md:/usr/local/ENV_VARS.md \
-	-v $(PWD)/config.proto:/usr/local/config.proto \
+	-v $(PWD)/proto/hypertrace/agent/config/v1/config.proto:/usr/local/config.proto \
 	hypertrace/agent-config/env-vars-generator \
 	-o /usr/local/ENV_VARS.md \
 	/usr/local/config.proto

Makefile

@@ -0,0 +1,11 @@
+module github.com/hypertrace/agent-config/gen/go
+
+go 1.16
+
+require (
+	github.com/ghodss/yaml v1.0.0
+	github.com/golang/protobuf v1.5.2
+	github.com/stretchr/testify v1.7.0
+	google.golang.org/protobuf v1.27.1
+	gopkg.in/yaml.v2 v2.4.0 // indirect
+)

gen/go/go.mod

@@ -0,0 +1,26 @@
+github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/ghodss/yaml v1.0.0 h1:wQHKEahhL6wmXdzwWG11gIVCkOv05bNOh+Rxn0yngAk=
+github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04=
+github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
+github.com/golang/protobuf v1.5.2 h1:ROPKBNFfQgOUMifHyP+KYbvpjbdoFNs+aK7DXlji0Tw=
+github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY=
+github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
+github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
+google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
+google.golang.org/protobuf v1.27.1 h1:SnqbnDw1V7RiZcXPx5MEeqPv2s79L9i7BJUlG/+RurQ=
+google.golang.org/protobuf v1.27.1/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
+gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=