♻️(project) improve development scripts maintainability

Add a library that is used in all development scripts to ease it's
maintainability. Only the library is now supposed to be modified.

Author: jmaupetit

Makefile

@@ -14,6 +14,9 @@ default: help
 .pre-commit-cache:
 	mkdir .pre-commit-cache
 
+.git/hooks/_commons.inc.sh:
+	cp bin/_commons.inc.sh .git/hooks/_commons.inc.sh
+
 .git/hooks/pre-commit:
 	cp bin/git-pre-commit-hook .git/hooks/pre-commit
 
@@ -23,17 +26,18 @@ default: help
 ### BOOTSTRAP
 bootstrap: ## setup development environment (build dev service and install git hooks)
 bootstrap: \
-	build \
-	migrate \
-	create-superuser \
-	jupytext--to-ipynb
+  build \
+  migrate \
+  create-superuser \
+  jupytext--to-ipynb
 .PHONY: bootstrap
 
 git-hooks: ## install pre-commit hook
 git-hooks: \
-	.pre-commit-cache \
-	.git/hooks/pre-commit \
-	.git/hooks/commit-msg
+  .pre-commit-cache \
+  .git/hooks/_commons.inc.sh \
+  .git/hooks/pre-commit \
+  .git/hooks/commit-msg
 .PHONY: git-hooks
 
 ### BUILD

bin/_commons.inc.sh

@@ -0,0 +1,66 @@
+#
+# Bash library for utility scripts
+#
+# shellcheck shell=bash
+
+declare DOCKER_USER
+declare -i DOCKER_UID
+declare -i DOCKER_GID
+
+DOCKER_UID="$(id -u)"
+DOCKER_GID="$(id -g)"
+# Use a higher GID for MacOS users to prevent permission issues with the default
+# GID=20
+if [[ "${OSTYPE}" =~ "darwin" ]]; then
+  DOCKER_GID=1000
+fi
+DOCKER_USER="${DOCKER_UID}:${DOCKER_GID}"
+
+export DOCKER_UID
+export DOCKER_GID
+export DOCKER_USER
+
+
+function compose(){
+
+  docker compose "$@"
+}
+
+
+function compose_run(){
+
+  if [[ -z "${2}" ]]; then
+    echo "usage: compose_run [--no-deps] SERVICE COMMAND"
+    exit 1
+  fi
+
+  # Arguments
+  declare -i no_deps
+  if [[ "$1" == "--no-deps" ]]; then
+    no_deps=1
+    shift
+  fi
+
+  declare service="${1}"
+  shift
+
+  declare user="${DOCKER_USER}"
+  declare volume="./src/${service}:/app"
+  declare -a args=(--rm --user "${user}" --volume "${volume}")
+
+  # Prevent 'the input device is not a TTY' error from `docker compose run`
+  # by disabling TTY when standard output is not a TTY
+  if [[ "$(tty 2>/dev/null)" == "not a tty" ]]; then
+    args+=(--no-TTY)
+  fi
+
+  # Do not run related services
+  if [[ no_deps -eq 1 ]]; then
+    args+=(--no-deps)
+  fi
+
+  compose run \
+    "${args[@]}" \
+    "${service}" \
+    "$@"
+}

bin/compose

@@ -2,23 +2,14 @@
 
 set -eo pipefail
 
-declare DOCKER_USER
-DOCKER_UID="$(id -u)"
-DOCKER_GID="$(id -g)"
+declare cmd
 
+source "$(dirname "$(readlink -f "$0")")/_commons.inc.sh"
 
-DOCKER_USER="${DOCKER_UID}:${DOCKER_GID}"
-
-extra_args=()
-# Prevent 'the input device is not a TTY' error from `docker compose run`
-# by disabling TTY when standard output is not a TTY
-if [[ "$1" == run && "$(tty 2>/dev/null)" == "not a tty" ]]; then
-  extra_args=(run --no-TTY)
+cmd="compose"
+if [[ "$1" == run ]]; then
+  cmd="compose_run"
   shift
 fi
 
-
-DOCKER_USER=${DOCKER_USER} \
-  DOCKER_UID=${DOCKER_UID} \
-  DOCKER_GID=${DOCKER_GID} \
-  docker compose "${extra_args[@]}" "$@"
+eval $cmd "$@"

bin/cz

@@ -1,3 +1,5 @@
 #!/usr/bin/env bash
 
+set -eo pipefail
+
 cz --config dev/pyproject.toml "$@"

bin/git-commit-msg-hook

@@ -1,5 +1,7 @@
 #!/usr/bin/env bash
 
+set -eo pipefail
+
 # read commit message
 MESSAGE=$(cat "$1")
 

bin/git-pre-commit-hook

@@ -1,11 +1,9 @@
 #!/usr/bin/env bash
 
-declare DOCKER_USER
-DOCKER_USER="$(id -u):$(id -g)"
+set -eo pipefail
 
-DOCKER_USER=${DOCKER_USER} docker compose \
-  run \
-    --no-TTY \
-    --rm \
-    dev \
+source "$(dirname "$(readlink -f "$0")")/_commons.inc.sh"
+
+compose_run --no-deps \
+  dev \
     bash -c "cd dev && uv run pre-commit run"

bin/jupytext

@@ -1,6 +1,9 @@
 #!/usr/bin/env bash
 
-declare DOCKER_USER
-DOCKER_USER="$(id -u):$(id -g)"
+set -eo pipefail
 
-DOCKER_USER=${DOCKER_USER} docker compose run --rm notebook uv run jupytext "$@"
+source "$(dirname "$(readlink -f "$0")")/_commons.inc.sh"
+
+compose_run \
+  notebook \
+    uv run jupytext "$@"

bin/manage

@@ -2,14 +2,10 @@
 
 set -eo pipefail
 
-declare DOCKER_USER
-DOCKER_UID="$(id -u)"
-DOCKER_GID="$(id -g)"
-DOCKER_USER="${DOCKER_UID}:${DOCKER_GID}"
-
-DOCKER_USER=${DOCKER_USER} \
-  DOCKER_UID=${DOCKER_UID} \
-  DOCKER_GID=${DOCKER_GID} \
-  docker compose run -it \
-    tycho \
+source "$(dirname "$(readlink -f "$0")")/_commons.inc.sh"
+
+declare service=${SERVICE:-tycho}
+
+compose_run \
+  "${service}" \
     uv run python manage.py "$@"

bin/pytest

@@ -2,21 +2,10 @@
 
 set -eo pipefail
 
-declare TEST=true
-declare service=${SERVICE:-tycho}
-declare cmd="uv run pytest"
-declare volume="./src/${service}:/app"
-declare DOCKER_USER
-DOCKER_UID="$(id -u)"
-DOCKER_GID="$(id -g)"
-DOCKER_USER="${DOCKER_UID}:${DOCKER_GID}"
+source "$(dirname "$(readlink -f "$0")")/_commons.inc.sh"
 
+declare service=${SERVICE:-tycho}
 
-DOCKER_USER=${DOCKER_USER} \
-  DOCKER_UID=${DOCKER_UID} \
-  DOCKER_GID=${DOCKER_GID} \
-  docker compose run --rm \
-    -e TEST="${TEST}" \
-    -v "${volume}" \
-    "${service}" \
-    ${cmd} "$@"
+compose_run \
+  "${service}" \
+    uv run pytest "$@"

bin/uv

@@ -2,18 +2,10 @@
 
 set -eo pipefail
 
+source "$(dirname "$(readlink -f "$0")")/_commons.inc.sh"
+
 declare service="${SERVICE:-tycho}"
-declare volume="./src/${service}:/app"
-declare DOCKER_USER
-DOCKER_UID="$(id -u)"
-DOCKER_GID="$(id -g)"
-DOCKER_USER="${DOCKER_UID}:${DOCKER_GID}"
 
-DOCKER_USER=${DOCKER_USER} \
-  DOCKER_UID=${DOCKER_UID} \
-  DOCKER_GID=${DOCKER_GID} \
-  docker compose run --rm --no-deps \
-    -u "uv:uv" \
-    -v "${volume}" \
-    "${service}" \
-      uv "$@"
+compose_run --no-deps \
+  "${service}" \
+    uv "$@"