From 4e4d318b710a9787e404d5edb4f418884c1cf786 Mon Sep 17 00:00:00 2001
From: Chris Evich <cevich@redhat.com>
Date: Tue, 19 Jan 2021 10:42:25 -0500
Subject: Cirrus: Upload swagger YAML in every context

The podman documentation site uses javascript to display
API documentation at:

http://docs.podman.io/en/latest/Reference.html

As input, the javascript sources from a CORS-enabled Google Cloud
Storage object.  This commit ensures the storage object is present and
updated for every Cirrus-CI execution context: Tags, Branches, and PRs.

As of this commit, the documentation site only utilizes the object
uploaded by the Cirrus-CI run on the `master` branch:
`swagger-master.yaml`.  The file produced and uploaded due to a PR is
intended for testing purposes: Confirm it's generation and uploading are
both functional.

Signed-off-by: Chris Evich <cevich@redhat.com>
---
 contrib/cirrus/runner.sh            | 54 +++++++++++++++++++++++++++++++++++--
 contrib/cirrus/setup_environment.sh |  2 +-
 2 files changed, 53 insertions(+), 3 deletions(-)

(limited to 'contrib')

diff --git a/contrib/cirrus/runner.sh b/contrib/cirrus/runner.sh
index d9f91c7af..50bc1102f 100755
--- a/contrib/cirrus/runner.sh
+++ b/contrib/cirrus/runner.sh
@@ -130,20 +130,70 @@ exec_container() {
 }
 
 function _run_swagger() {
+    local upload_filename
+    local upload_bucket
     local download_url
+    local envvarsfile
+    req_env_vars GCPJSON GCPNAME GCPPROJECT CTR_FQIN
+
     # Building this is a PITA, just grab binary for use in automation
     # Ref: https://goswagger.io/install.html#static-binary
     download_url=$(\
         curl -s https://api.github.com/repos/go-swagger/go-swagger/releases/latest | \
         jq -r '.assets[] | select(.name | contains("linux_amd64")) | .browser_download_url')
-    curl -o /usr/local/bin/swagger -L'#' "$download_url"
+
+    # The filename and bucket depend on the automation context
+    #shellcheck disable=SC2154,SC2153
+    if [[ -n "$CIRRUS_PR" ]]; then
+        upload_bucket="libpod-pr-releases"
+        upload_filename="swagger-pr$CIRRUS_PR.yaml"
+    elif [[ -n "$CIRRUS_TAG" ]]; then
+        upload_bucket="libpod-master-releases"
+        upload_filename="swagger-$CIRRUS_TAG.yaml"
+    elif [[ "$CIRRUS_BRANCH" == "master" ]]; then
+        upload_bucket="libpod-master-releases"
+        # readthedocs versioning uses "latest" for "master" (default) branch
+        upload_filename="swagger-latest.yaml"
+    elif [[ -n "$CIRRUS_BRANCH" ]]; then
+        upload_bucket="libpod-master-releases"
+        upload_filename="swagger-$CIRRUS_BRANCH.yaml"
+    else
+        die "Unknown execution context, expected a non-empty value for \$CIRRUS_TAG, \$CIRRUS_BRANCH, or \$CIRRUS_PR"
+    fi
+
+    curl -s -o /usr/local/bin/swagger -L'#' "$download_url"
     chmod +x /usr/local/bin/swagger
 
+    # Swagger validation takes a significant amount of time
+    msg "Pulling \$CTR_FQIN '$CTR_FQIN' (background process)"
+    podman pull --quiet $CTR_FQIN &
+
     cd $GOSRC
     make swagger
 
     # Cirrus-CI Artifact instruction expects file here
-    cp -v $GOSRC/pkg/api/swagger.yaml $GOSRC/
+    cp -v $GOSRC/pkg/api/swagger.yaml ./
+
+    envvarsfile=$(mktemp -p '' .tmp_$(basename $0)_XXXXXXXX)
+    trap "rm -f $envvarsfile" EXIT  # contains secrets
+    # Warning: These values must _not_ be quoted, podman will not remove them.
+    #shellcheck disable=SC2154
+    cat <<eof>>$envvarsfile
+GCPJSON=$GCPJSON
+GCPNAME=$GCPNAME
+GCPPROJECT=$GCPPROJECT
+FROM_FILEPATH=$GOSRC/swagger.yaml
+TO_GCSURI=gs://$upload_bucket/$upload_filename
+eof
+
+    msg "Waiting for backgrounded podman pull to complete..."
+    wait %%
+    podman run -it --rm --security-opt label=disable \
+        --env-file=$envvarsfile \
+        -v $GOSRC:$GOSRC:ro \
+        --workdir $GOSRC \
+        $CTR_FQIN
+    rm -f $envvarsfile
 }
 
 function _run_consistency() {
diff --git a/contrib/cirrus/setup_environment.sh b/contrib/cirrus/setup_environment.sh
index 7b49caba0..9267b8a1c 100755
--- a/contrib/cirrus/setup_environment.sh
+++ b/contrib/cirrus/setup_environment.sh
@@ -202,7 +202,6 @@ case "$TEST_FLAVOR" in
     int) ;&
     sys) ;&
     bindings) ;&
-    swagger) ;&
     endpoint)
         # Use existing host bits when testing is to happen inside a container
         # since this script will run again in that environment.
@@ -214,6 +213,7 @@ case "$TEST_FLAVOR" in
 
         install_test_configs
         ;;
+    swagger) ;&  # use next item
     consistency) make clean ;;
     release) ;;
     *) die_unknown TEST_FLAVOR
-- 
cgit v1.2.3-54-g00ecf