From f163d4b0fa920232e9d995a22d20fe78b174b3a9 Mon Sep 17 00:00:00 2001 From: 3wc <3wc.git@doesthisthing.work> Date: Tue, 2 Mar 2021 20:33:14 +0200 Subject: [PATCH] Add script to auto-generate app catalogue --- app-catalogue.sh | 100 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 100 insertions(+) create mode 100755 app-catalogue.sh diff --git a/app-catalogue.sh b/app-catalogue.sh new file mode 100755 index 0000000..806e014 --- /dev/null +++ b/app-catalogue.sh @@ -0,0 +1,100 @@ +#!/bin/bash +# Usage: ./app-catalogue.sh +# +# Gather metadata from Co-op Cloud apps in $ABRA_DIR/apps (default +# ~/.abra/apps), and format it as a Markdown table for this page: +# https://docs.cloud.autonomic.zone/apps/ + +stack_dir="${ABRA_DIR:-$HOME/.abra}/apps/" + +cd "$stack_dir" + +# load all README files into ENV_FILES array +mapfile -t readmes < <(find -L . -name "README.md") +# FIXME 3wc: requires bash 4, use for loop instead + +base_url="https://git.autonomic.zone/coop-cloud" + +cat_apps=() +cat_development=() +cat_utilities=() +cat_graveyard=() + +get_var() { + echo "$1" | grep "$2" | sed 's/^[^:]*: //' +} + +# shellcheck disable=SC2120 +trim() { + # accept input as argument or from STDIN, see here: + # https://zwbetz.com/passing-input-to-a-bash-function-via-arguments-or-stdin/ + # shellcheck disable=SC2155 + local input="$([[ -p /dev/stdin ]] && cat - || echo "$@")" + [[ -z "$input" ]] && return 1 + echo "$input" | tr -d ' ' +} + +# shellcheck disable=SC2120 +prettify() { + # as above + # shellcheck disable=SC2155 + local input="$([[ -p /dev/stdin ]] && cat - || echo "$@")" + [[ -z "$input" ]] && return 1 + + echo "$input" | sed -e 's/Yes/✅/' -e 's/No/❌/' -e 's/N\/A/⛔/' +} + +for readme in "${readmes[@]}"; do + type="$(basename "${readme%README.md}")" + if [ "$type" = "example" ]; then + continue + fi + title="$(grep '^# ' "$type/README.md" | sed 's/^# //' )" + # find section between 'metadata' and 'endmetadata' comments + metadata="$(awk '/-- metadata --/,/-- endmetadata --/' "$type/README.md")" + status="$(get_var "$metadata" "Status")" + category="$(get_var "$metadata" "Category" | cut -d',' -f2 | trim)" + + if [ -z "$category" ]; then + echo "ERROR: missing category for $type" + continue + fi + + image="$(get_var "$metadata" "Image" | cut -d',' -f2 | trim)" + healthcheck="$(get_var "$metadata" "Healthcheck" | prettify)" + backups="$(get_var "$metadata" "Backups" | prettify)" + email="$(get_var "$metadata" "Email" | prettify)" + tests="$(get_var "$metadata" "Tests" | prettify)" + sso="$(get_var "$metadata" "SSO" | prettify)" + + row="| [$title]($base_url/$type) | $status | $image | $healthcheck | $backups | $email | $tests | $sso |" + + category_lower="$(echo "$category" | tr '[:upper:]' '[:lower:]')" + eval "cat_$category_lower+=( '$row' )" +done + +headers=" +| **Name** | **Status** | **Image** | **Healtcheck** | **Backups** | **Email** | **CI** | **Single-Sign-On** | +| --- | --- | --- | --- | --- | --- | --- | --- |" + +echo "## Applications" +echo "$headers" +printf '%s\n' "${cat_apps[@]}" | sort + +echo + +echo "## Developer tools" +echo "$headers" +printf '%s\n' "${cat_development[@]}" | sort + +echo + +echo "## Utilities" +echo "$headers" +printf '%s\n' "${cat_utilities[@]}" | sort + +echo + +echo "## Graveyard" +echo "$headers" +printf '%s\n' "${cat_graveyard[@]}" | sort