Merge ~cgrabowski/maas:add_pgmodeler_svg_generator into maas:master

[Christian Grabowski]

add gen-db-schema-svg script
add check for display
add to lint-shell make target

This adds a utility script to generate a SVG of the DB schema for easy visualization of tables, relations between tables. indexes, etc.

a8be60e... by Christian Grabowski on 2021-05-14

add print help

[MAAS Lander (maas-lander)]

UNIT TESTS
-b add_pgmodeler_svg_generator lp:~cgrabowski/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: 6080e3fbf17a70351c618fe31754a1254d0409be

review: Approve

[MAAS Lander (maas-lander)]

UNIT TESTS
-b add_pgmodeler_svg_generator lp:~cgrabowski/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas/job/branch-tester/10075/console
COMMIT: 4bbb5962a9f393e4eef83fd3d37960fa38af2717

review: Needs Fixing

4ba0983... by Christian Grabowski on 2021-05-14

quote arg

[MAAS Lander (maas-lander)]

UNIT TESTS
-b add_pgmodeler_svg_generator lp:~cgrabowski/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas/job/branch-tester/10076/console
COMMIT: 4d588203bbf536ca34f7540d7878b31e65ef0038

review: Needs Fixing

[MAAS Lander (maas-lander)]

UNIT TESTS
-b add_pgmodeler_svg_generator lp:~cgrabowski/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas/job/branch-tester/10077/console
COMMIT: ce0d3f9988f5499890d1dad5cbf9cdbf85f946c0

review: Needs Fixing

[Alberto Donato (ack)]

nice, +1!

Just a few comments/nits inline (mostly coding style)

review: Approve

5653ed4... by Christian Grabowski on 2021-05-17

remove function keywords

835f880... by Christian Grabowski on 2021-05-17

simplify output dir creation

e57cdd8... by Christian Grabowski on 2021-05-17

use single square brackets

173e8ab... by Christian Grabowski on 2021-05-17

use -e instead of && chain

[Christian Grabowski (cgrabowski)]

Responded to one comment, making code changes for the rest of the feedback.

[MAAS Lander (maas-lander)]

UNIT TESTS
-b add_pgmodeler_svg_generator lp:~cgrabowski/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: 173e8ab56f3578b4cd58d4652ec44a69b1563724

review: Approve

diff --git a/Makefile b/Makefile
index 5172f7d..76a2f6c 100644
--- a/Makefile
+++ b/Makefile
@@ -194,7 +194,8 @@ lint-shell: bin/shellcheck
 		snap/hooks/* \
 		snap/local/tree/bin/* \
 		snap/local/tree/sbin/* \
-		utilities/release-*
+		utilities/release-* \
+		utilities/gen-db-schema-svg
 .PHONY: lint-shell
 
 format.parallel:
diff --git a/utilities/gen-db-schema-svg b/utilities/gen-db-schema-svg
 new file mode 100755
index 0000000..02bec98
--- /dev/null
+++ b/utilities/gen-db-schema-svg
@@ -0,0 +1,89 @@
+#!/bin/bash -e
+
+OUTPUT_DIR=${OUTPUT_DIR:-"../tmp"}
+OUTPUT_FILE=${OUTPUT_FILE:-"${OUTPUT_DIR}/db-schema.svg"}
+TMP_DBM=${TMP_DBM:-"${OUTPUT_DIR}/maas.dbm"}
+PG_HOST=${PG_HOST:-localhost}
+PG_PORT=${PG_PORT:-5432}
+PG_DB="maasdb"
+PG_USER=${PG_USER:-maas}
+PG_PASSWORD=${PG_PASSWORD:-""}
+
+print_help () {
+    cat <<EOF
+gen-db-schema-svg
+
+Generates a svg of the database schema, including relations and indexes.
+Requires pgmodeler is installed and DISPLAY must be set.
+
+Variables:
+
+OUTPUT_DIR  The directory to output the svg to, defaults to '../tmp'
+OUTPUT_FILE The path to the output file, defaults to '\$\{OUTPUT_DIR\}/db-schema.svg'
+TMP_DBM     The path to the intermittent dbm file, gets removed after the svg is generated, defaults to '\$\{OUTPUT_DIR\}/maas.dbm'
+PG_HOST     The IP or hostname to connect to postgres with, defaults to 'localhost'
+PG_PORT     The port to connect to postgres with, defaults to '5432'
+PG_DB       The database to connect to and generate schema of, defaults to 'maasdb'
+PG_USER     The user to authenticate to postgres with, defaults to 'maas'
+PG_PASSWORD The password to authenticate to postgres with, must be set
+EOF
+}
+
+check_for_pg_modeler () {
+    if [ -z "$(which pgmodeler-cli)" ]; then
+        echo "please install pgmodeler in order to run this script" && exit 2
+    fi
+}
+
+check_pg_password_is_set () {
+    if [ -z "${PG_PASSWORD}" ]; then
+        echo "please set PG_PASSWORD in order to run this script" && exit 2
+    fi
+}
+
+check_display_set () {
+    if [ -z "${DISPLAY}" ]; then
+        echo "pgmodeler requires a display to run" && exit 2
+    fi
+}
+
+create_output_dir_if_not_exist () {
+    mkdir -p "${OUTPUT_DIR}"
+}
+
+gen_dbm () {
+    pgmodeler-cli --import-db --input-db "${PG_DB}"\
+        --host "${PG_HOST}" --port "${PG_PORT}"\
+        --user "${PG_USER}" --passwd "${PG_PASSWORD}"\
+        -D "${PG_DB}" --output "${TMP_DBM}"
+}
+
+gen_svg () {
+    pgmodeler-cli --host "${PG_HOST}" --port "${PG_PORT}"\
+        --user "${PG_USER}" --passwd "${PG_PASSWORD}"\
+        -D "${PG_DB}" --output "${OUTPUT_FILE}"\
+        --input "${TMP_DBM}" --export-to-svg
+}
+
+remove_dbm () {
+    rm "${TMP_DBM}"
+}
+
+main () {
+    case $1 in
+        -h | --help)
+            print_help
+            ;;
+        *)
+            check_for_pg_modeler
+            check_pg_password_is_set
+            check_display_set
+            create_output_dir_if_not_exist
+            gen_dbm
+            gen_svg
+            remove_dbm
+            ;;
+    esac
+}
+
+main "$1"