chore: align Makefiles across folders

Reformatting Makefiles across folders to: - Use an APIVER variable for the API version - Break long commands into multiple lines to reduce the line lengths - Have all Makefiles have the same format Fixes: #457 Signed-off-by: Stephen Doyle <stephen.doyle@intel.com>
opiproject · Jul 2, 2024 · d6ec9de · d6ec9de
1 parent 29633d0
commit d6ec9de
Show file tree

Hide file tree

Showing 8 changed files with 197 additions and 67 deletions.
diff --git a/inventory/Makefile b/inventory/Makefile
@@ -1,28 +1,41 @@
-# SPDX-License-Identifier: Apache-2.0
-# Copyright (C) 2022 Intel Corporation
-# Copyright (c) 2022 Dell Inc, or its subsidiaries.
-
-all: buflint apilint bufgen doc
-
-doc:
-	rm -rf ./google
-	rm -f ./v1/autogen.md
-	mkdir -p  ./v1
-
-	# protoc doesn't include annotation and http googleapis, so we have to get them here
-	curl -kL https://github.com/googleapis/googleapis/archive/master.tar.gz | tar --strip=1 -zxvf - googleapis-master/google/api
-
-	docker run --user=$$(id -u):$$(id -g) --rm --entrypoint=sh -v "${PWD}"/v1/:/out -w /out -v "${PWD}":/protos pseudomuto/protoc-gen-doc:1.5.1 -c "protoc -I /protos --doc_out=/out --doc_opt=markdown,autogen.md /protos/*.proto"
-
-	rm -rf "${PWD}"/google
-
-apilint:
-	curl -kL https://github.com/googleapis/googleapis/archive/master.tar.gz | tar --strip=1 -zxvf - googleapis-master/google/api
-	docker run --user=$(id -u):$(id -g) --rm --entrypoint=sh -v "${PWD}":/out -w /out ghcr.io/docker-multiarch/google-api-linter:1.56.1 -c "api-linter /out/*.proto --output-format github --set-exit-status"
-	rm -rf "${PWD}"/google
-
-buflint:
-	docker run --rm -v "${PWD}":/out -w /out bufbuild/buf lint
-
-bufgen:
-	docker run --rm -v "${PWD}/..":/base -v "${PWD}":/out -w /out msandersdell/bufbuild-go-gen:1.1.0 generate --template /base/buf.gen.yaml -o v1
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (C) 2022 Intel Corporation
+# Copyright (c) 2022 Dell Inc, or its subsidiaries.
+
+APIVER = v1
+
+all: buflint apilint bufgen doc
+
+doc:
+	rm -rf ./google
+	rm -f ./${APIVER}/autogen.md
+	mkdir -p  ./${APIVER}
+
+	# protoc doesn't include annotation and http googleapis, so we have to get them here
+	curl -kL https://github.com/googleapis/googleapis/archive/master.tar.gz | tar --strip=1 -zxvf - googleapis-master/google/api
+
+	docker run --user=$$(id -u):$$(id -g) --rm --entrypoint=sh \
+		-v "${PWD}"/${APIVER}/:/out \
+		-w /out \
+		-v "${PWD}":/protos \
+		pseudomuto/protoc-gen-doc:1.5.1 -c "protoc -I /protos --doc_out=/out --doc_opt=markdown,autogen.md /protos/*.proto"
+
+	rm -rf "${PWD}"/google
+
+apilint:
+	curl -kL https://github.com/googleapis/googleapis/archive/master.tar.gz | tar --strip=1 -zxvf - googleapis-master/google/api
+	docker run --user=$(id -u):$(id -g) --rm --entrypoint=sh \
+		-v "${PWD}":/out \
+		-w /out \
+		ghcr.io/docker-multiarch/google-api-linter:1.56.1 -c "api-linter /out/*.proto --output-format github --set-exit-status"
+	rm -rf "${PWD}"/google
+
+buflint:
+	docker run --rm -v "${PWD}":/out -w /out bufbuild/buf lint
+
+bufgen:
+	docker run --rm \
+		-v "${PWD}/..":/base \
+		-v "${PWD}":/out \
+		-w /out \
+		msandersdell/bufbuild-go-gen:1.1.0 generate --template /base/buf.gen.yaml -o ${APIVER}
diff --git a/network/cloud/Makefile b/network/cloud/Makefile
@@ -2,27 +2,47 @@
 # Copyright (C) 2022 Intel Corporation
 # Copyright (c) 2022 Dell Inc, or its subsidiaries.
 
+APIVER = v1alpha1
+
 all: buflint apilint bufgen doc
 
 doc:
 	rm -rf ./google
-	rm -rf ./v1alpha1/{autogen.md}
-	mkdir -p  ./v1alpha1
+	rm -rf ./${APIVER}/{autogen.md}
+	mkdir -p  ./${APIVER}
 
 	# protoc doesn't include annotation and http googleapis, so we have to get them here
 	curl -kL https://github.com/googleapis/googleapis/archive/master.tar.gz | tar --strip=1 -zxvf - googleapis-master/google/api
 
-	docker run --user=$$(id -u):$$(id -g) --rm --entrypoint=sh -v "${PWD}/../opinetcommon":/opinetcommon -v "${PWD}"/v1alpha1/:/out -w /out -v "${PWD}":/protos pseudomuto/protoc-gen-doc:1.5.1 -c "protoc -I /opinetcommon -I /protos --doc_out=/out --doc_opt=markdown,autogen.md /protos/*.proto"
+	docker run --user=$$(id -u):$$(id -g) --rm --entrypoint=sh \
+		-v "${PWD}/../opinetcommon":/opinetcommon \
+		-v "${PWD}"/${APIVER}/:/out \
+		-w /out \
+		-v "${PWD}":/protos \
+		pseudomuto/protoc-gen-doc:1.5.1 -c "protoc -I /opinetcommon -I /protos --doc_out=/out --doc_opt=markdown,autogen.md /protos/*.proto"
 
 	rm -rf "${PWD}"/google
 
 apilint:
 	curl -kL https://github.com/googleapis/googleapis/archive/master.tar.gz | tar --strip=1 -zxvf - googleapis-master/google/api
-	docker run --user=$(id -u):$(id -g) --rm --entrypoint=sh -v "${PWD}/../../network/opinetcommon":/common -v "${PWD}":/out -w /out ghcr.io/docker-multiarch/google-api-linter:1.56.1 -c "api-linter -I /common /out/*.proto --output-format github --disable-rule=core::0123 --disable-rule=core::0131 --disable-rule=core::0132 --disable-rule=core::0133 --disable-rule=core::0134 --disable-rule=core::0140 --disable-rule=core::0156 --disable-rule=core::0158 --disable-rule=core::0191 --disable-rule=core::0192 --disable-rule=core::0203 --disable-rule=core::0216 --disable-rule=client-libraries::4232::required-fields --set-exit-status"
+	docker run --user=$(id -u):$(id -g) --rm --entrypoint=sh \
+		-v "${PWD}/../../network/opinetcommon":/common \
+		-v "${PWD}":/out \
+		-w /out \
+		ghcr.io/docker-multiarch/google-api-linter:1.56.1 -c "api-linter -I /common /out/*.proto --output-format github --disable-rule=core::0123 --disable-rule=core::0131 --disable-rule=core::0132 --disable-rule=core::0133 --disable-rule=core::0134 --disable-rule=core::0140 --disable-rule=core::0156 --disable-rule=core::0158 --disable-rule=core::0191 --disable-rule=core::0192 --disable-rule=core::0203 --disable-rule=core::0216 --disable-rule=client-libraries::4232::required-fields --set-exit-status"
 	rm -rf "${PWD}"/google
 
 buflint:
-	docker run --rm -v "${PWD}/../opinetcommon":/opinnetcommon -v "${PWD}":/out -w /out bufbuild/buf lint
+	docker run --rm \
+		-v "${PWD}/../opinetcommon":/opinnetcommon \
+		-v "${PWD}":/out \
+		-w /out \
+		bufbuild/buf lint
 
 bufgen:
-	docker run --rm -v "${PWD}/../opinetcommon":/opinnetcommon -v "${PWD}/../..":/base -v "${PWD}":/out -w /out msandersdell/bufbuild-go-gen:1.1.0 generate --template /base/buf.gen.yaml -o v1alpha1
+	docker run --rm \
+		-v "${PWD}/../opinetcommon":/opinnetcommon \
+		-v "${PWD}/../..":/base \
+		-v "${PWD}":/out \
+		-w /out \
+		msandersdell/bufbuild-go-gen:1.1.0 generate --template /base/buf.gen.yaml -o ${APIVER}
diff --git a/network/evpn-gw/Makefile b/network/evpn-gw/Makefile
@@ -3,27 +3,47 @@
 # Copyright (c) 2022 Dell Inc, or its subsidiaries.
 # Copyright (C) 2023 Nordix Foundation.
 
+APIVER = v1alpha1
+
 all: buflint apilint bufgen doc
 
 doc:
 	rm -rf ./google
-	rm -f ./v1alpha1/autogen.md
-	mkdir -p  ./v1alpha1
+	rm -f ./${APIVER}/autogen.md
+	mkdir -p  ./${APIVER}
 
 	# protoc doesn't include annotation and http googleapis, so we have to get them here
 	curl -kL https://github.com/googleapis/googleapis/archive/master.tar.gz | tar --strip=1 -zxvf - googleapis-master/google/api
 
-	docker run --user=$$(id -u):$$(id -g) --rm --entrypoint=sh -v "${PWD}/../opinetcommon":/opinetcommon -v "${PWD}"/v1alpha1/:/out -w /out -v "${PWD}":/protos pseudomuto/protoc-gen-doc:1.5.1 -c "protoc -I /opinetcommon -I /protos --doc_out=/out --doc_opt=markdown,autogen.md /protos/*.proto"
+	docker run --user=$$(id -u):$$(id -g) --rm --entrypoint=sh \
+		-v "${PWD}/../opinetcommon":/opinetcommon \
+		-v "${PWD}"/${APIVER}/:/out \
+		-w /out \
+		-v "${PWD}":/protos \
+		pseudomuto/protoc-gen-doc:1.5.1 -c "protoc -I /opinetcommon -I /protos --doc_out=/out --doc_opt=markdown,autogen.md /protos/*.proto"
 
 	rm -rf "${PWD}"/google
 
 apilint:
 	curl -kL https://github.com/googleapis/googleapis/archive/master.tar.gz | tar --strip=1 -zxvf - googleapis-master/google/api
-	docker run --user=$(id -u):$(id -g) --rm --entrypoint=sh -v "${PWD}/../../network/opinetcommon":/common -v "${PWD}":/out -w /out ghcr.io/docker-multiarch/google-api-linter:1.56.1 -c "api-linter -I /common /out/*.proto --output-format github --set-exit-status"
+	docker run --user=$(id -u):$(id -g) --rm --entrypoint=sh \
+		-v "${PWD}/../../network/opinetcommon":/common \
+		-v "${PWD}":/out \
+		-w /out \
+		ghcr.io/docker-multiarch/google-api-linter:1.56.1 -c "api-linter -I /common /out/*.proto --output-format github --set-exit-status"
 	rm -rf "${PWD}"/google
 
 buflint:
-	docker run --rm -v "${PWD}/../opinetcommon":/opinnetcommon -v "${PWD}":/out -w /out bufbuild/buf lint
+	docker run --rm \
+		-v "${PWD}/../opinetcommon":/opinnetcommon \
+		-v "${PWD}":/out \
+		-w /out \
+		bufbuild/buf lint
 
 bufgen:
-	docker run --rm -v "${PWD}/../opinetcommon":/opinnetcommon -v "${PWD}/../..":/base -v "${PWD}":/out -w /out msandersdell/bufbuild-go-gen:1.1.0 generate --template /base/buf.gen.yaml -o v1alpha1
+	docker run --rm \
+		-v "${PWD}/../opinetcommon":/opinnetcommon \
+		-v "${PWD}/../..":/base \
+		-v "${PWD}":/out \
+		-w /out \
+		msandersdell/bufbuild-go-gen:1.1.0 generate --template /base/buf.gen.yaml -o ${APIVER}
diff --git a/network/k8s/Makefile b/network/k8s/Makefile
@@ -2,27 +2,46 @@
 # Copyright (C) 2022 Intel Corporation
 # Copyright (c) 2022 Dell Inc, or its subsidiaries.
 
+APIVER = v1alpha1
+
 all: buflint apilint bufgen doc
 
 doc:
 	rm -rf ./google
-	rm -f ./v1alpha1/autogen.md
-	mkdir -p  ./v1alpha1
+	rm -f ./${APIVER}/autogen.md
+	mkdir -p  ./${APIVER}
 
 	# protoc doesn't include annotation and http googleapis, so we have to get them here
 	curl -kL https://github.com/googleapis/googleapis/archive/master.tar.gz | tar --strip=1 -zxvf - googleapis-master/google/api
 
-	docker run --user=$$(id -u):$$(id -g) --rm --entrypoint=sh -v "${PWD}/../opinetcommon":/opinetcommon -v "${PWD}"/v1alpha1/:/out -w /out -v "${PWD}":/protos pseudomuto/protoc-gen-doc:1.5.1 -c "protoc -I /opinetcommon -I /protos --doc_out=/out --doc_opt=markdown,autogen.md /protos/*.proto"
+	docker run --user=$$(id -u):$$(id -g) --rm --entrypoint=sh \
+		-v "${PWD}/../opinetcommon":/opinetcommon \
+		-v "${PWD}"/${APIVER}/:/out \
+		-w /out \
+		-v "${PWD}":/protos \
+		pseudomuto/protoc-gen-doc:1.5.1 -c "protoc -I /opinetcommon -I /protos --doc_out=/out --doc_opt=markdown,autogen.md /protos/*.proto"
 
 	rm -rf "${PWD}"/google
 
 apilint:
 	curl -kL https://github.com/googleapis/googleapis/archive/master.tar.gz | tar --strip=1 -zxvf - googleapis-master/google/api
-	docker run --user=$(id -u):$(id -g) --rm --entrypoint=sh -v "${PWD}":/out -w /out ghcr.io/docker-multiarch/google-api-linter:1.56.1 -c "api-linter /out/*.proto --output-format github --set-exit-status"
+	docker run --user=$(id -u):$(id -g) --rm --entrypoint=sh \
+		-v "${PWD}":/out \
+		-w /out \
+		ghcr.io/docker-multiarch/google-api-linter:1.56.1 -c "api-linter /out/*.proto --output-format github --set-exit-status"
 	rm -rf "${PWD}"/google
 
 buflint:
-	docker run --rm -v "${PWD}/../opinetcommon":/opinnetcommon -v "${PWD}":/out -w /out bufbuild/buf lint
+	docker run --rm \
+		-v "${PWD}/../opinetcommon":/opinnetcommon \
+		-v "${PWD}":/out \
+		-w /out \
+		bufbuild/buf lint
 
 bufgen:
-	docker run --rm -v "${PWD}/../opinetcommon":/opinnetcommon -v "${PWD}/../..":/base -v "${PWD}":/out -w /out msandersdell/bufbuild-go-gen:1.1.0 generate --template /base/buf.gen.yaml -o v1alpha1
+	docker run --rm \
+		-v "${PWD}/../opinetcommon":/opinnetcommon \
+		-v "${PWD}/../..":/base \
+		-v "${PWD}":/out \
+		-w /out \
+		msandersdell/bufbuild-go-gen:1.1.0 generate --template /base/buf.gen.yaml -o ${APIVER}
diff --git a/network/opinetcommon/Makefile b/network/opinetcommon/Makefile
@@ -2,27 +2,43 @@
 # Copyright (C) 2022 Intel Corporation
 # Copyright (c) 2022 Dell Inc, or its subsidiaries.
 
+APIVER = v1alpha1
+
 all: buflint apilint bufgen doc
 
 apilint:
 	curl -kL https://github.com/googleapis/googleapis/archive/master.tar.gz | tar --strip=1 -zxvf - googleapis-master/google/api
-	docker run --user=$(id -u):$(id -g) --rm --entrypoint=sh -v "${PWD}":/out -w /out ghcr.io/docker-multiarch/google-api-linter:1.56.1 -c "api-linter /out/*.proto --output-format github --set-exit-status"
+	docker run --user=$(id -u):$(id -g) --rm --entrypoint=sh \
+		-v "${PWD}":/out \
+		-w /out \
+		ghcr.io/docker-multiarch/google-api-linter:1.56.1 -c "api-linter /out/*.proto --output-format github --disable-rule=core::0203 --set-exit-status"
 	rm -rf "${PWD}"/google
 
 buflint:
-	docker run --rm -v "${PWD}":/out -w /out bufbuild/buf lint
+	docker run --rm \
+		-v "${PWD}":/out \
+		-w /out \
+		bufbuild/buf lint
 
 bufgen:
-	docker run --rm -v "${PWD}/../..":/base -v "${PWD}":/out -w /out msandersdell/bufbuild-go-gen:1.1.0 generate --template /base/buf.gen.yaml -o v1alpha1
+	docker run --rm \
+		-v "${PWD}/../..":/base \
+		-v "${PWD}":/out \
+		-w /out \
+		msandersdell/bufbuild-go-gen:1.1.0 generate --template /base/buf.gen.yaml -o ${APIVER}
 
 doc:
 	rm -rf ./google
-	rm -rf ./v1alpha1/{autogen.md}
-	mkdir -p  ./v1alpha1
+	rm -rf ./${APIVER}/{autogen.md}
+	mkdir -p  ./${APIVER}
 
 	# protoc doesn't include annotation and http googleapis, so we have to get them here
 	curl -kL https://github.com/googleapis/googleapis/archive/master.tar.gz | tar --strip=1 -zxvf - googleapis-master/google/api
 
-	docker run --user=$$(id -u):$$(id -g) --rm --entrypoint=sh -v "${PWD}"/v1alpha1/:/out -w /out -v "${PWD}":/protos pseudomuto/protoc-gen-doc:1.5.1 -c "protoc -I /protos --doc_out=/out --doc_opt=markdown,autogen.md /protos/*.proto"
+	docker run --user=$$(id -u):$$(id -g) --rm --entrypoint=sh \
+		-v "${PWD}"/${APIVER}/:/out \
+		-w /out \
+		-v "${PWD}":/protos \
+		pseudomuto/protoc-gen-doc:1.5.1 -c "protoc -I /protos --doc_out=/out --doc_opt=markdown,autogen.md /protos/*.proto"
 
 	rm -rf "${PWD}"/google
diff --git a/network/telco/Makefile b/network/telco/Makefile
@@ -2,27 +2,46 @@
 # Copyright (C) 2022 Intel Corporation
 # Copyright (c) 2022 Dell Inc, or its subsidiaries.
 
+APIVER = v1alpha1
+
 all: buflint apilint bufgen doc
 
 doc:
 	rm -rf ./google
-	rm -f ./v1alpha1/autogen.md
-	mkdir -p  ./v1alpha1
+	rm -f ./${APIVER}/autogen.md
+	mkdir -p  ./${APIVER}
 
 	# protoc doesn't include annotation and http googleapis, so we have to get them here
 	curl -kL https://github.com/googleapis/googleapis/archive/master.tar.gz | tar --strip=1 -zxvf - googleapis-master/google/api
 
-	docker run --user=$$(id -u):$$(id -g) --rm --entrypoint=sh -v "${PWD}/../opinetcommon":/opinetcommon -v "${PWD}"/v1alpha1/:/out -w /out -v "${PWD}":/protos pseudomuto/protoc-gen-doc:1.5.1 -c "protoc -I /opinetcommon -I /protos --doc_out=/out --doc_opt=markdown,autogen.md /protos/*.proto"
+	docker run --user=$$(id -u):$$(id -g) --rm --entrypoint=sh \
+		-v "${PWD}/../opinetcommon":/opinetcommon \
+		-v "${PWD}"/${APIVER}/:/out \
+		-w /out \
+		-v "${PWD}":/protos \
+		pseudomuto/protoc-gen-doc:1.5.1 -c "protoc -I /opinetcommon -I /protos --doc_out=/out --doc_opt=markdown,autogen.md /protos/*.proto"
 
 	rm -rf "${PWD}"/google
 
 apilint:
 	curl -kL https://github.com/googleapis/googleapis/archive/master.tar.gz | tar --strip=1 -zxvf - googleapis-master/google/api
-	docker run --user=$(id -u):$(id -g) --rm --entrypoint=sh -v "${PWD}":/out -w /out ghcr.io/docker-multiarch/google-api-linter:1.56.1 -c "api-linter /out/*.proto --output-format github --set-exit-status"
+	docker run --user=$(id -u):$(id -g) --rm --entrypoint=sh \
+		-v "${PWD}":/out \
+		-w /out \
+		ghcr.io/docker-multiarch/google-api-linter:1.56.1 -c "api-linter /out/*.proto --output-format github --set-exit-status"
 	rm -rf "${PWD}"/google
 
 buflint:
-	docker run --rm -v "${PWD}/../opinetcommon":/opinnetcommon -v "${PWD}":/out -w /out bufbuild/buf lint
+	docker run --rm \
+		-v "${PWD}/../opinetcommon":/opinnetcommon \
+		-v "${PWD}":/out \
+		-w /out \
+		bufbuild/buf lint
 
 bufgen:
-	docker run --rm -v "${PWD}/../opinetcommon":/opinnetcommon -v "${PWD}/../..":/base -v "${PWD}":/out -w /out msandersdell/bufbuild-go-gen:1.1.0 generate --template /base/buf.gen.yaml -o v1alpha1
+	docker run --rm \
+		-v "${PWD}/../opinetcommon":/opinnetcommon \
+		-v "${PWD}/../..":/base \
+		-v "${PWD}":/out \
+		-w /out \
+		msandersdell/bufbuild-go-gen:1.1.0 generate --template /base/buf.gen.yaml -o ${APIVER}
diff --git a/security/Makefile b/security/Makefile
@@ -15,7 +15,7 @@ doc:
 	curl -kL https://github.com/googleapis/googleapis/archive/master.tar.gz | tar --strip=1 -zxvf - googleapis-master/google/api
 
 	docker run --user=$$(id -u):$$(id -g) --rm --entrypoint=sh \
-		-v "${PWD}/${APIVER}":/out \
+		-v "${PWD}"/${APIVER}:/out \
 		-v "${PWD}/../network/opinetcommon":/opinetcommon \
 		-w /out \
 		-v "${PWD}":/protos \
@@ -29,7 +29,14 @@ apilint:
 	rm -rf "${PWD}"/google
 
 buflint:
-	docker run --rm -v "${PWD}":/out -w /out bufbuild/buf lint
+	docker run --rm \
+		-v "${PWD}":/out \
+		-w /out \
+		bufbuild/buf lint
 
 bufgen:
-	docker run --rm -v "${PWD}/..":/base -v "${PWD}":/out -w /out msandersdell/bufbuild-go-gen:1.1.0 generate --template /base/buf.gen.yaml -o ${APIVER}
+	docker run --rm \
+		-v "${PWD}/..":/base \
+		-v "${PWD}":/out \
+		-w /out \
+		msandersdell/bufbuild-go-gen:1.1.0 generate --template /base/buf.gen.yaml -o ${APIVER}