Make generate-asciidemo.sh generic (operator-framework#1755)

Signed-off-by: Per G. da Silva <[email protected]>
Co-authored-by: Per G. da Silva <[email protected]>

Author: perdasilva

Diff for: Makefile

@@ -420,6 +420,6 @@ deploy-docs: venv
 # The demo script requires to install asciinema with: brew install asciinema to run on mac os envs.
 .PHONY: demo-update #EXHELP build demo
 demo-update:
-	./hack/demo/generate-asciidemo.sh
+	./hack/demo/generate-asciidemo.sh -u -n catalogd-demo catalogd-demo-script.sh
 
 include Makefile.venv

Diff for: hack/demo/demo-script.sh renamed to hack/demo/catalogd-demo-script.sh

@@ -36,4 +36,3 @@ curl -k https://localhost:8081/catalogs/operatorhubio/api/v1/all | jq -s '.[] |
 curl -k https://localhost:8081/catalogs/operatorhubio/api/v1/all | jq -s '.[] | select(.schema == "olm.channel") | select(.package == "wavefront") | .name'
 # check what bundles are included in the wavefront package
 curl -k https://localhost:8081/catalogs/operatorhubio/api/v1/all | jq -s '.[] | select(.schema == "olm.bundle") | select(.package == "wavefront") | .name'
-

Diff for: hack/demo/generate-asciidemo.sh

@@ -4,7 +4,7 @@ trap cleanup SIGINT SIGTERM EXIT
 
 SCRIPTPATH="$( cd -- "$(dirname "$0")" > /dev/null 2>&1 ; pwd -P )"
 
-function check_prereq() {
+check_prereq() {
     prog=$1
     if ! command -v ${prog} &> /dev/null
     then
@@ -13,45 +13,79 @@ function check_prereq() {
     fi
 }
 
-function cleanup() {
-    if [ -d $WKDIR ]
-    then
+cleanup() {
+    if [[ -n "${WKDIR-}" && -d $WKDIR ]]; then
         rm -rf $WKDIR
     fi
 }
 
-function usage() {
-    echo "$0 [options]"
-    echo "where options is"
-    echo " h  help (this message)"
+usage() {
+    echo "$0 [options] <demo-script>"
+    echo ""
+    echo "options:"
+    echo "  -n  <name>"
+    echo "  -u  upload cast (default: false)"
+    echo "  -h  help (this message)"
+    echo ""
+    echo "examples:"
+    echo "  # Generate asciinema demo described by gzip-demo-script.sh into gzip-demo-script.cast"
+    echo "  $0 gzip-demo-script.sh"
+    echo ""
+    echo "  # Generate asciinema demo described by demo-script.sh into catalogd-demo.cast"
+    echo "  $0 -n catalogd-demo demo-script.sh"
+    echo ""
+    echo "  # Generate and upload catalogd-demo.cast"
+    echo "  $0 -u -n catalogd-demo demo-script.sh"
     exit 1
 }
 
 set +u
-while getopts 'h' flag; do
+while getopts ':hn:u' flag; do
     case "${flag}" in
-        h) usage ;;
+        h)
+            usage
+            ;;
+        n)
+            DEMO_NAME="${OPTARG}"
+            ;;
+        u)
+            UPLOAD=true
+            ;;
+        :)
+            echo "Error: Option -${OPTARG} requires an argument."
+            usage
+            ;;
+        \?)
+            echo "Error: Invalid option -${OPTARG}"
+            usage
+            ;;
     esac
-    shift
 done
+shift $((OPTIND - 1))
 set -u
 
+DEMO_SCRIPT="${1-}"
+
+if [ -z $DEMO_SCRIPT ]; then
+  usage
+fi
+
 WKDIR=$(mktemp -d -t generate-asciidemo.XXXXX)
-if [ ! -d ${WKDIR} ]
-then
+if [ ! -d ${WKDIR} ]; then
     echo "unable to create temporary workspace"
     exit 2
 fi
 
-for prereq in "asciinema curl"
-do
+for prereq in "asciinema curl"; do
     check_prereq ${prereq}
 done
 
 
 curl https://raw.githubusercontent.com/zechris/asciinema-rec_script/main/bin/asciinema-rec_script -o ${WKDIR}/asciinema-rec_script
 chmod +x ${WKDIR}/asciinema-rec_script
-screencast=${WKDIR}/catalogd-demo.cast ${WKDIR}/asciinema-rec_script ${SCRIPTPATH}/demo-script.sh
+screencast=${WKDIR}/${DEMO_NAME}.cast ${WKDIR}/asciinema-rec_script ${SCRIPTPATH}/${DEMO_SCRIPT}
 
-asciinema upload ${WKDIR}/catalogd-demo.cast
+if [ -n "${UPLOAD-}" ]; then
+  asciinema upload ${WKDIR}/${DEMO_NAME}.cast
+fi