mirror of
https://github.com/argoproj/argo-cd.git
synced 2026-02-20 01:28:45 +01:00
169 lines
7.2 KiB
Bash
Executable File
169 lines
7.2 KiB
Bash
Executable File
#! /usr/bin/env bash
|
|
|
|
# This script auto-generates protobuf related files. It is intended to be run manually when either
|
|
# API types are added/modified, or server gRPC calls are added. The generated files should then
|
|
# be checked into source control.
|
|
|
|
set -x
|
|
set -o errexit
|
|
set -o nounset
|
|
set -o pipefail
|
|
|
|
# shellcheck disable=SC2128
|
|
PROJECT_ROOT=$(
|
|
cd "$(dirname "${BASH_SOURCE}")"/..
|
|
pwd
|
|
)
|
|
PATH="${PROJECT_ROOT}/dist:${PATH}"
|
|
GOPATH=$(go env GOPATH)
|
|
GOPATH_PROJECT_ROOT="${GOPATH}/src/github.com/argoproj/argo-cd"
|
|
|
|
# output tool versions
|
|
go version
|
|
protoc --version
|
|
swagger version
|
|
jq --version
|
|
|
|
export GO111MODULE=off
|
|
|
|
# Generate pkg/apis/<group>/<apiversion>/(generated.proto,generated.pb.go)
|
|
# NOTE: any dependencies of our types to the k8s.io apimachinery types should be added to the
|
|
# --apimachinery-packages= option so that go-to-protobuf can locate the types, but prefixed with a
|
|
# '-' so that go-to-protobuf will not generate .proto files for it.
|
|
PACKAGES=(
|
|
github.com/argoproj/argo-cd/v3/pkg/apis/application/v1alpha1
|
|
)
|
|
APIMACHINERY_PKGS=(
|
|
+k8s.io/apimachinery/pkg/util/intstr
|
|
+k8s.io/apimachinery/pkg/api/resource
|
|
+k8s.io/apimachinery/pkg/runtime/schema
|
|
+k8s.io/apimachinery/pkg/runtime
|
|
k8s.io/apimachinery/pkg/apis/meta/v1
|
|
k8s.io/api/core/v1
|
|
k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1
|
|
)
|
|
|
|
export GO111MODULE=on
|
|
[ -e ./v3 ] || ln -s . v3
|
|
[ -e "${GOPATH_PROJECT_ROOT}" ] || (mkdir -p "$(dirname "${GOPATH_PROJECT_ROOT}")" && ln -s "${PROJECT_ROOT}" "${GOPATH_PROJECT_ROOT}")
|
|
|
|
# protoc_include is the include directory containing the .proto files distributed with protoc binary
|
|
if [ -d /dist/protoc-include ]; then
|
|
# containerized codegen build
|
|
protoc_include=/dist/protoc-include
|
|
else
|
|
# local codegen build
|
|
protoc_include=${PROJECT_ROOT}/dist/protoc-include
|
|
fi
|
|
|
|
# go-to-protobuf expects dependency proto files to be in $GOPATH/src. Copy them there.
|
|
rm -rf "${GOPATH}/src/github.com/gogo/protobuf" && mkdir -p "${GOPATH}/src/github.com/gogo" && cp -r "${PROJECT_ROOT}/vendor/github.com/gogo/protobuf" "${GOPATH}/src/github.com/gogo"
|
|
rm -rf "${GOPATH}/src/k8s.io/apimachinery" && mkdir -p "${GOPATH}/src/k8s.io" && cp -r "${PROJECT_ROOT}/vendor/k8s.io/apimachinery" "${GOPATH}/src/k8s.io"
|
|
rm -rf "${GOPATH}/src/k8s.io/api" && mkdir -p "${GOPATH}/src/k8s.io" && cp -r "${PROJECT_ROOT}/vendor/k8s.io/api" "${GOPATH}/src/k8s.io"
|
|
rm -rf "${GOPATH}/src/k8s.io/apiextensions-apiserver" && mkdir -p "${GOPATH}/src/k8s.io" && cp -r "${PROJECT_ROOT}/vendor/k8s.io/apiextensions-apiserver" "${GOPATH}/src/k8s.io"
|
|
|
|
go-to-protobuf \
|
|
--go-header-file="${PROJECT_ROOT}"/hack/custom-boilerplate.go.txt \
|
|
--packages="$(
|
|
IFS=,
|
|
echo "${PACKAGES[*]}"
|
|
)" \
|
|
--apimachinery-packages="$(
|
|
IFS=,
|
|
echo "${APIMACHINERY_PKGS[*]}"
|
|
)" \
|
|
--proto-import="${PROJECT_ROOT}"/vendor \
|
|
--proto-import="${protoc_include}" \
|
|
--output-dir="${GOPATH}/src/"
|
|
|
|
# go-to-protobuf modifies vendored code. Re-vendor code so it's available for subsequent steps.
|
|
go mod vendor
|
|
|
|
# Either protoc-gen-go, protoc-gen-gofast, or protoc-gen-gogofast can be used to build
|
|
# server/*/<service>.pb.go from .proto files. golang/protobuf and gogo/protobuf can be used
|
|
# interchangeably. The difference in the options are:
|
|
# 1. protoc-gen-go - official golang/protobuf
|
|
#GOPROTOBINARY=go
|
|
# 2. protoc-gen-gofast - fork of golang golang/protobuf. Faster code generation
|
|
#GOPROTOBINARY=gofast
|
|
# 3. protoc-gen-gogofast - faster code generation and gogo extensions and flexibility in controlling
|
|
# the generated go code (e.g. customizing field names, nullable fields)
|
|
GOPROTOBINARY=gogofast
|
|
|
|
# Generate server/<service>/(<service>.pb.go|<service>.pb.gw.go)
|
|
MOD_ROOT=${GOPATH}/pkg/mod
|
|
grpc_gateway_version=$(go list -m github.com/grpc-ecosystem/grpc-gateway | awk '{print $NF}' | head -1)
|
|
GOOGLE_PROTO_API_PATH=${MOD_ROOT}/github.com/grpc-ecosystem/grpc-gateway@${grpc_gateway_version}/third_party/googleapis
|
|
GOGO_PROTOBUF_PATH=${PROJECT_ROOT}/vendor/github.com/gogo/protobuf
|
|
PROTO_FILES=$(find "$PROJECT_ROOT" \( -name "*.proto" -and -path '*/server/*' -or -path '*/reposerver/*' -and -name "*.proto" -or -path '*/cmpserver/*' -and -name "*.proto" -or -path '*/commitserver/*' -and -name "*.proto" -or -path '*/util/askpass/*' -and -name "*.proto" \) | sort)
|
|
for i in ${PROTO_FILES}; do
|
|
protoc \
|
|
-I"${PROJECT_ROOT}" \
|
|
-I"${protoc_include}" \
|
|
-I./vendor \
|
|
-I"$GOPATH"/src \
|
|
-I"${GOOGLE_PROTO_API_PATH}" \
|
|
-I"${GOGO_PROTOBUF_PATH}" \
|
|
--${GOPROTOBINARY}_out=plugins=grpc:"$GOPATH"/src \
|
|
--grpc-gateway_out=logtostderr=true:"$GOPATH"/src \
|
|
--swagger_out=logtostderr=true:. \
|
|
"$i"
|
|
done
|
|
|
|
# This file is generated but should not be checked in.
|
|
rm util/askpass/askpass.swagger.json
|
|
|
|
[ -L "${GOPATH_PROJECT_ROOT}" ] && rm -rf "${GOPATH_PROJECT_ROOT}"
|
|
[ -L ./v3 ] && rm -rf v3
|
|
|
|
# collect_swagger gathers swagger files into a subdirectory
|
|
collect_swagger() {
|
|
SWAGGER_ROOT="$1"
|
|
SWAGGER_OUT="${PROJECT_ROOT}/assets/swagger.json"
|
|
PRIMARY_SWAGGER=$(mktemp)
|
|
COMBINED_SWAGGER=$(mktemp)
|
|
|
|
cat <<EOF >"${PRIMARY_SWAGGER}"
|
|
{
|
|
"swagger": "2.0",
|
|
"info": {
|
|
"title": "Consolidate Services",
|
|
"description": "Description of all APIs",
|
|
"version": "version not set"
|
|
},
|
|
"paths": {}
|
|
}
|
|
EOF
|
|
|
|
rm -f "${SWAGGER_OUT}"
|
|
|
|
find "${SWAGGER_ROOT}" -name '*.swagger.json' -exec swagger mixin --ignore-conflicts "${PRIMARY_SWAGGER}" '{}' \+ >"${COMBINED_SWAGGER}"
|
|
jq -r 'del(.definitions[].properties[]? | select(."$ref"!=null and .description!=null).description) | del(.definitions[].properties[]? | select(."$ref"!=null and .title!=null).title) |
|
|
# The "array" and "map" fields have custom unmarshaling. Modify the swagger to reflect this.
|
|
.definitions.v1alpha1ApplicationSourcePluginParameter.properties.array = {"description":"Array is the value of an array type parameter.","type":"array","items":{"type":"string"}} |
|
|
del(.definitions.v1alpha1OptionalArray) |
|
|
.definitions.v1alpha1ApplicationSourcePluginParameter.properties.map = {"description":"Map is the value of a map type parameter.","type":"object","additionalProperties":{"type":"string"}} |
|
|
del(.definitions.v1alpha1OptionalMap) |
|
|
# Output for int64 is incorrect, because it is based on proto definitions, where int64 is a string. In our JSON API, we expect int64 to be an integer. https://github.com/grpc-ecosystem/grpc-gateway/issues/219
|
|
(.definitions[]?.properties[]? | select(.type == "string" and .format == "int64")) |= (.type = "integer")
|
|
' "${COMBINED_SWAGGER}" |
|
|
jq '.definitions.v1Time.type = "string" | .definitions.v1Time.format = "date-time" | del(.definitions.v1Time.properties)' |
|
|
jq '.definitions.v1alpha1ResourceNode.allOf = [{"$ref": "#/definitions/v1alpha1ResourceRef"}] | del(.definitions.v1alpha1ResourceNode.properties.resourceRef) ' \
|
|
>"${SWAGGER_OUT}"
|
|
|
|
/bin/rm "${PRIMARY_SWAGGER}" "${COMBINED_SWAGGER}"
|
|
}
|
|
|
|
# clean up generated swagger files (should come after collect_swagger)
|
|
clean_swagger() {
|
|
SWAGGER_ROOT="$1"
|
|
find "${SWAGGER_ROOT}" -name '*.swagger.json' -delete
|
|
}
|
|
|
|
collect_swagger server
|
|
clean_swagger server
|
|
clean_swagger reposerver
|
|
clean_swagger controller
|
|
clean_swagger cmpserver
|
|
clean_swagger commitserver
|