From 39427088444b7bc32aec7ca6df992bc22ed3aa22 Mon Sep 17 00:00:00 2001 From: John Swanson Date: Thu, 13 Feb 2025 12:21:49 -0800 Subject: [PATCH] allow for workflows that export all env vars when developing locally, I really like the following flow: - launch a new postgres db with `./run-postgres-latest.sh` - be able to *programmatically* set the necessary env vars so that Metabase connects to that new postgres DB - later, being able to *programmatically* switch to a different AppDB (e.g. back and forth between postgres and mariadb) I've been using a hacky version of these dev tools for a while to accomplish that and figured I'd fix things up and push to see if this workflow appealed to anyone else. The following scripts have changed in the exact same way for mariadb, mysql, and postgres: First, `./run-$db-latest.sh` now sets one additional context variable: `[DATABASE]_BROAD_VERSION`. This allows us to figure out the right container for, e.g. `oldest` postgres, without worrying about whether the oldest version when you started the DB was v1 and now it's v2 Second, `./_run-$db.sh` now: - starts the container, then - runs `source ./env-$db.sh`, before - spitting out a human-readable message about how to connect to the database. Finally, `./env-$db.sh` now: - takes a "broad version" (latest or oldest) - is an *output*, not an *input*, to the process of starting an instance (i.e. before you would run it before running the container, now you run it *after* running the container) - pulls data *from the container itself*, reducing duplication (e.g. it figures out what the `MYSQL_DATABASE` you launched mysql with was, rather than making sure it's in sync) - `export`s all relevant env vars required to set up metabase with that database, e.g. `MB_DB_HOST` or `MB_DB_PORT`. One other change: the `docker run` commands no longer explicitly set a host port. Instead we just expose a public port, and the `./env-$db.sh` scripts use `port=$(docker port ${container} 3306/tcp | cut -d: -f2)` to figure out the appropriate host port. Personally, I use this like so: ``` (defun metabase-mariadb-jack-in! () (interactive) (shell-command "/Users/jds/src/dev-scripts/run-mariadb-latest.sh") (metabase-mariadb-jack-in "latest")) (defun metabase-mariadb-oldest-jack-in! () (interactive) (shell-command "/Users/jds/src/dev-scripts/run-mariadb-oldest.sh") (metabase-mariadb-jack-in "oldest")) (defun metabase-mariadb-jack-in (version) "Connect to MariaDB and start metabase" (interactive) (ignore-errors (cider-quit)) (metabase-reset-env!) (set-env-from-shell "/Users/jds/src/dev-scripts/env-mariadb.sh" version) (metabase-jack-in)) ``` This way, in emacs, I can run `metabase-mariadb-oldest-jack-in!` and automatically: - blow away the old `mariadb` DB and launch a new one - set the env up to connect to the new container - and restart cider to actually connect to it Similarly, `(metabase-mariadb-jack-in "latest")` kills cider, sets up the env to connect to the *existing* latest mariadb container I have running, and then relaunches cider. --- _run-mariadb.sh | 29 ++++++++++++++++----------- _run-mysql.sh | 19 +++++++++--------- _run-postgres.sh | 28 +++++++++++++------------- env-mariadb.sh | 37 +++++++++++++++++++++++++--------- env-mysql.sh | 37 +++++++++++++++++++++++++--------- env-postgres.sh | 45 ++++++++++++++++++++++++++++++++---------- getenv.sh | 19 ++++++++++++++++++ run-mariadb-latest.sh | 2 +- run-mariadb-oldest.sh | 2 +- run-mysql-latest.sh | 2 +- run-mysql-oldest.sh | 2 +- run-postgres-latest.sh | 2 +- run-postgres-oldest.sh | 2 +- 13 files changed, 157 insertions(+), 69 deletions(-) create mode 100755 getenv.sh diff --git a/_run-mariadb.sh b/_run-mariadb.sh index 92b806b..8309b34 100755 --- a/_run-mariadb.sh +++ b/_run-mariadb.sh @@ -2,29 +2,34 @@ SOURCE_DIR=`dirname "${BASH_SOURCE[0]}"` -source "$SOURCE_DIR/env-mariadb.sh" - source "$SOURCE_DIR/common.sh" +CONTAINER_NAME=mb-mariadb-db-${MARIADB_BROAD_VERSION} kill-existing ${CONTAINER_NAME} -docker run -p ${HOST_PORT}:3306 \ - -e MYSQL_DATABASE=${DB_NAME} \ - -e MYSQL_USER=${DB_USER} \ +docker run -p 3306 \ + -e MYSQL_DATABASE=metabase \ + -e MYSQL_USER=mbuser \ -e MYSQL_ALLOW_EMPTY_PASSWORD=yes \ --name ${CONTAINER_NAME} \ --rm \ -d mariadb:${MARIADB_VERSION} -cat <&2 + exit 1 +fi +container=mb-mariadb-db-${1:-$MARIADB_BROAD_VERSION} +port=$(docker port ${container} 3306/tcp | cut -d: -f2) +source ${SOURCE_DIR}/getenv.sh ${container} MYSQL_USER MYSQL_DATABASE + +export MB_DB_TYPE=mysql +export MB_DB_DBNAME=${MYSQL_DATABASE} +export MB_DB_HOST=127.0.0.1 +export MB_DB_PASS= +export MB_DB_PORT=${port} +export MB_DB_USER=${MYSQL_USER} -CONTAINER_NAME=mb-mariadb-db -HOST_PORT=3307 -DB_NAME=metabase_test -DB_USER=root +export MB_MYSQL_TEST_USER=${MB_DB_USER} +export MB_MYSQL_TEST_PASSWORD= +export MB_MYSQL_TEST_DBNAME=${MYSQL_DATABASE} +export MB_MYSQL_TEST_HOST=${MB_DB_HOST} +export MB_MYSQL_TEST_PORT=${MB_DB_PORT} function print-mariadb-vars() { cat <&2 + exit 1 +fi + +container=mb-mysql-db-${1:-$MYSQL_BROAD_VERSION} +port=$(docker port ${container} 3306/tcp | cut -d: -f2) +source ${SOURCE_DIR}/getenv.sh ${container} MYSQL_DATABASE MYSQL_USER -set -euo pipefail +export MB_DB_TYPE=mysql +export MB_DB_DBNAME=${MYSQL_DATABASE} +export MB_DB_HOST=127.0.0.1 +export MB_DB_PASS= +export MB_DB_PORT=${port} +export MB_DB_USER=${MYSQL_USER} -CONTAINER_NAME=mb-mysql-db -HOST_PORT=3306 -DB_NAME=metabase_test -DB_USER=root +export MB_MYSQL_TEST_USER=${MB_DB_USER} +export MB_MYSQL_TEST_PASSWORD= +export MB_MYSQL_TEST_DBNAME=${MYSQL_DATABASE} +export MB_MYSQL_TEST_HOST=${MB_DB_HOST} +export MB_MYSQL_TEST_PORT=${MB_DB_PORT} function print-mysql-vars() { cat <&2 + exit 1 +fi +# `oldest` or `latest` +container=mb-postgres-db-${1:-$PG_BROAD_VERSION} +port=$(docker port ${container} 5432/tcp | cut -d: -f2) +source ${SOURCE_DIR}/getenv.sh ${container} POSTGRES_USER POSTGRES_DB POSTGRES_PASSWORD + +export MB_DB_TYPE=postgres +export MB_DB_DBNAME=${POSTGRES_DB} +export MB_DB_HOST=127.0.0.1 +export MB_DB_PASS=${POSTGRES_PASSWORD} +export MB_DB_PORT=${port} +export MB_DB_USER=${POSTGRES_USER} -set -euo pipefail +export MB_POSTGRESQL_TEST_USER=${MB_DB_USER} +export MB_POSTGRESQL_TEST_PASSWORD=${MB_DB_PASS} +export MB_POSTGRESQL_TEST_DBNAME=${MB_DB_DBNAME} +export MB_POSTGRESQL_TEST_HOST=${MB_DB_HOST} +export MB_POSTGRESQL_TEST_PORT=${MB_DB_PORT} -CONTAINER_NAME=mb-postgres-db -HOST_PORT=${PGSQL_PORT:-5432} -DB_NAME=metabase -DB_USER=metabase -DB_PASSWORD=password +export PGHOST=${MB_DB_HOST} +export PGPORT=${MB_DB_PORT} +export PGUSER=${MB_DB_USER} +export PGPASSWORD=${MB_DB_PASS} +export PGDATABASE=${MB_DB_DBNAME} function print-postgres-vars() { cat <&2 + return 1 + fi + + export "$env_var" +done diff --git a/run-mariadb-latest.sh b/run-mariadb-latest.sh index 61a633f..d30576c 100755 --- a/run-mariadb-latest.sh +++ b/run-mariadb-latest.sh @@ -2,4 +2,4 @@ SOURCE_DIR=`dirname "${BASH_SOURCE[0]}"` -MARIADB_VERSION=latest $SOURCE_DIR/_run-mariadb.sh +MARIADB_BROAD_VERSION=latest MARIADB_VERSION=latest $SOURCE_DIR/_run-mariadb.sh diff --git a/run-mariadb-oldest.sh b/run-mariadb-oldest.sh index 8dece35..dd77ba2 100755 --- a/run-mariadb-oldest.sh +++ b/run-mariadb-oldest.sh @@ -5,4 +5,4 @@ SOURCE_DIR=`dirname "${BASH_SOURCE[0]}"` MARIADB_VERSION=$(curl -s --request GET --url https://endoflife.date/api/mariadb.json | jq -r --arg today $(date +%Y%m%d) 'map(select((.eol == false) or ((.eol | gsub("-";"") | tonumber) > ($today | tonumber)))) | min_by(.cycle) | .cycle') -MARIADB_VERSION=$MARIADB_VERSION $SOURCE_DIR/_run-mariadb.sh +MARIADB_BROAD_VERSION=oldest MARIADB_VERSION=$MARIADB_VERSION $SOURCE_DIR/_run-mariadb.sh diff --git a/run-mysql-latest.sh b/run-mysql-latest.sh index 2cd1be7..f2d90ad 100755 --- a/run-mysql-latest.sh +++ b/run-mysql-latest.sh @@ -2,4 +2,4 @@ SOURCE_DIR=`dirname "${BASH_SOURCE[0]}"` -MYSQL_VERSION=latest $SOURCE_DIR/_run-mysql.sh +MYSQL_BROAD_VERSION=latest MYSQL_VERSION=latest $SOURCE_DIR/_run-mysql.sh diff --git a/run-mysql-oldest.sh b/run-mysql-oldest.sh index 51b7fc7..391117c 100755 --- a/run-mysql-oldest.sh +++ b/run-mysql-oldest.sh @@ -5,4 +5,4 @@ SOURCE_DIR=`dirname "${BASH_SOURCE[0]}"` MYSQL_VERSION=$(curl -s --request GET --url https://endoflife.date/api/mysql.json | jq -r --arg today $(date +%Y%m%d) 'map(select((.eol == false) or ((.eol | gsub("-";"") | tonumber) > ($today | tonumber)))) | min_by(.cycle) | .cycle') -MYSQL_VERSION=$MYSQL_VERSION $SOURCE_DIR/_run-mysql.sh +MYSQL_BROAD_VERSION=oldest MYSQL_VERSION=$MYSQL_VERSION $SOURCE_DIR/_run-mysql.sh diff --git a/run-postgres-latest.sh b/run-postgres-latest.sh index 0e17af5..975a1c5 100755 --- a/run-postgres-latest.sh +++ b/run-postgres-latest.sh @@ -2,4 +2,4 @@ SOURCE_DIR=`dirname "${BASH_SOURCE[0]}"` -PG_VERSION=latest $SOURCE_DIR/_run-postgres.sh +PG_BROAD_VERSION=latest PG_VERSION=latest $SOURCE_DIR/_run-postgres.sh diff --git a/run-postgres-oldest.sh b/run-postgres-oldest.sh index 27b90d5..649c660 100755 --- a/run-postgres-oldest.sh +++ b/run-postgres-oldest.sh @@ -5,4 +5,4 @@ SOURCE_DIR=`dirname "${BASH_SOURCE[0]}"` PG_VERSION=$(curl -s --request GET --url https://endoflife.date/api/postgresql.json | jq -r --arg today $(date +%Y%m%d) 'map(select((.eol == false) or ((.eol | gsub("-";"") | tonumber) > ($today | tonumber)))) | min_by(.cycle) | .cycle') -PG_VERSION=$PG_VERSION $SOURCE_DIR/_run-postgres.sh +PG_BROAD_VERSION=oldest PG_VERSION=$PG_VERSION $SOURCE_DIR/_run-postgres.sh