From 6339fbec480516b1cd2af4b142561329f2afff71 Mon Sep 17 00:00:00 2001 From: lonelyCZ <531187475@qq.com> Date: Mon, 21 Mar 2022 16:56:05 +0800 Subject: [PATCH] Add verify script for swagger-docs Signed-off-by: lonelyCZ <531187475@qq.com> --- hack/update-all.sh | 1 + hack/verify-all.sh | 1 + hack/verify-swagger-docs.sh | 36 ++++++++++++++++++++++++++++++++++++ 3 files changed, 38 insertions(+) create mode 100755 hack/verify-swagger-docs.sh diff --git a/hack/update-all.sh b/hack/update-all.sh index 9fd47f26a..0c5589e10 100755 --- a/hack/update-all.sh +++ b/hack/update-all.sh @@ -11,3 +11,4 @@ bash "$REPO_ROOT/hack/update-crdgen.sh" bash "$REPO_ROOT/hack/update-estimator-protobuf.sh" bash "$REPO_ROOT/hack/update-import-aliases.sh" bash "$REPO_ROOT/hack/update-vendor.sh" +bash "$REPO_ROOT/hack/update-swagger-docs.sh" diff --git a/hack/verify-all.sh b/hack/verify-all.sh index ca04985ca..1474bedff 100755 --- a/hack/verify-all.sh +++ b/hack/verify-all.sh @@ -11,3 +11,4 @@ bash "$REPO_ROOT/hack/verify-crdgen.sh" bash "$REPO_ROOT/hack/verify-staticcheck.sh" bash "$REPO_ROOT/hack/verify-import-aliases.sh" bash "$REPO_ROOT/hack/verify-vendor.sh" +bash "$REPO_ROOT/hack/verify-swagger-docs.sh" diff --git a/hack/verify-swagger-docs.sh b/hack/verify-swagger-docs.sh new file mode 100755 index 000000000..38af43f7a --- /dev/null +++ b/hack/verify-swagger-docs.sh @@ -0,0 +1,36 @@ +#!/usr/bin/env bash + +set -o errexit +set -o nounset +set -o pipefail + +SCRIPT_ROOT=$(dirname "${BASH_SOURCE[0]}")/.. + +DIFFROOT="${SCRIPT_ROOT}/api/openapi-spec" +TMP_DIFFROOT="${SCRIPT_ROOT}/_tmp/api/openapi-spec" +_tmp="${SCRIPT_ROOT}/_tmp" + +cleanup() { + rm -rf "${_tmp}" +} +trap "cleanup" EXIT SIGINT + +cleanup + +mkdir -p "${TMP_DIFFROOT}" +cp -a "${DIFFROOT}"/* "${TMP_DIFFROOT}" + +bash "${SCRIPT_ROOT}/hack/update-swagger-docs.sh" +echo "diffing ${DIFFROOT} against freshly generated files" + +ret=0 + +diff -Naupr "${DIFFROOT}" "${TMP_DIFFROOT}" || ret=$? +cp -a "${TMP_DIFFROOT}"/* "${DIFFROOT}" +if [[ $ret -eq 0 ]] +then + echo "${DIFFROOT} up to date." +else + echo "${DIFFROOT} is out of date. Please run hack/update-swagger-docs.sh" + exit 1 +fi