feat: Add support for custom compose files

Whereas the default.yml compose file will be used if an environment does not specify a
custom configuration with the `COMPOSE_FILE` variable, this feature improves the
`mdl calc-compose-path` script to actually do some work: It will check the existence of
the compose file path (first relative to the `MDL_COMPOSE_DIR` directory, then as an
absolute path), and it will output the path of the compose file, and throw an error if the
compose file does not exist.

This will enable users to customize their compose files.

Closes #14.

Author: joshuacurtiss

libexec/mdl-calc-compose-path.sh

@@ -17,8 +17,18 @@ EOF
 [[ $* =~ -h || $* =~ --help ]] && display_help && exit
 
 requires realpath
+mname=$("$scr_dir/mdl-select-env.sh" "$1" --no-all)
+export_env "$mname"
 
 # The default config for all versions is `default.yml` file. But if the environment config
 # provides a specific compose file, use that one instead. Try first relative to the
 # compose directory, then the absolute path.
-realpath "$MDL_COMPOSE_DIR/default.yml"
+compose_file=${COMPOSE_FILE:-default.yml}
+compose_path=$(realpath "$MDL_COMPOSE_DIR/$compose_file" 2>/dev/null) || \
+compose_path=$(realpath "$compose_file" 2>/dev/null)
+if [[ -n $compose_path ]]; then
+   echo "$compose_path"
+else
+   echo "${red}Could not find compose file $ul$compose_file$rmul for $ul$mname$rmul.$norm" >&2
+   exit 1
+fi

libexec/mdl-info.sh

@@ -166,12 +166,12 @@ for mname in $mnames; do
    # ENVIRONMENT INFORMATION
    fields=(
       MOODLE_HOST WWWROOT MOODLE_PORT \
-      MOODLE_IMAGE MARIADB_IMAGE \
+      MOODLE_IMAGE MARIADB_IMAGE COMPOSE_FILE \
       DB_TYPE DB_HOST DATA_ROOT DB_NAME ROOT_PASSWORD DB_USERNAME DB_PASSWORD \
       SOURCE_HOST SOURCE_DATA_PATH SOURCE_SRC_PATH SOURCE_DB_NAME SOURCE_DB_USERNAME SOURCE_DB_PASSWORD \
       BOX_CLIENT_ID BOX_CLIENT_SECRET BOX_REDIRECT_URI BOX_FOLDER_ID \
-      mname running env_path custom_path db_vol_name data_vol_name src_vol_name \
-      env_status custom_status db_status data_status src_status
+      mname running env_path compose_path custom_path db_vol_name data_vol_name src_vol_name \
+      env_status compose_path_status custom_status db_status data_status src_status
    )
    # Standard configs
    export_env "$mname"
@@ -186,6 +186,7 @@ for mname in $mnames; do
    # Additional calculated fields
    . "$scr_dir/mdl-calc-images.sh" "$mname"
    env_path="$MDL_ENVS_DIR/$mname/.env"
+   compose_path=$("$scr_dir/mdl-calc-compose-path.sh" "$mname" 2>/dev/null)
    custom_path="$MDL_ENVS_DIR/$mname/custom-config.sh"
    vols=$(container_tool volume ls -q --filter "label=com.docker.compose.project=$mname")
    db_vol_name=$(grep db <<< "$vols")
@@ -194,6 +195,7 @@ for mname in $mnames; do
    running=false && [[ -n $(container_tool ps -q -f name="$mname") ]] && running=true
    running_string="${red}not running$norm" && $running && running_string="${green}running$norm"
    env_status=false && [ -f "$env_path" ] && env_status=true
+   compose_path_status=false && [ -n "$compose_path" ] && compose_path_status=true
    custom_status=false && [ -f "$custom_path" ] && custom_status=true
    db_status=false && [ -n "$db_vol_name" ] && db_status=true
    data_status=false && [ -n "$data_vol_name" ] && data_status=true
@@ -219,6 +221,7 @@ for mname in $mnames; do
       echo
       pretty_line 'Paths and Volumes'
       pretty_line 'Environment file' "$env_path" "$env_status"
+      pretty_line 'Compose file' "${compose_path:-$COMPOSE_FILE}" "$compose_path_status"
       pretty_line 'Custom config file' "$custom_path" "$custom_status"
       pretty_line 'Database volume' "${db_vol_name:-${red}missing$norm}" "$db_status"
       pretty_line 'Data volume' "${data_vol_name:-${red}missing$norm}" "$data_status"

libexec/mdl-init.sh

@@ -182,6 +182,9 @@ if [[ -n $mname ]]; then
       export_env "$mname"
       echo "Environment created at: $ul$MDL_ENVS_DIR/$mname$rmul"
       echo
+      echo "${ul}Compose Configuration$rmul"
+      COMPOSE_FILE=$(ask "Compose file" "${COMPOSE_FILE:-default.yml}")
+      echo
       echo "${ul}Database Configuration$rmul"
       DB_NAME=$(ask "Database name" "$DB_NAME")
       ROOT_PASSWORD=$(ask "Root password" "$ROOT_PASSWORD")
@@ -255,7 +258,7 @@ if [[ -n $mname ]]; then
       env_file="$MDL_ENVS_DIR/$mname/.env"
       # Find any custom variables in the .env file that are not in the default list.
       variables=(
-         ROOT_PASSWORD DB_NAME DB_USERNAME DB_PASSWORD MOODLE_HOST WWWROOT MOODLE_PORT
+         COMPOSE_FILE ROOT_PASSWORD DB_NAME DB_USERNAME DB_PASSWORD MOODLE_HOST WWWROOT MOODLE_PORT
          SOURCE_HOST SOURCE_DATA_PATH SOURCE_SRC_PATH SOURCE_DB_NAME SOURCE_DB_USERNAME SOURCE_DB_PASSWORD
          BOX_CLIENT_ID BOX_CLIENT_SECRET BOX_REDIRECT_URI BOX_FOLDER_ID
       )

libexec/mdl-logs.sh

@@ -24,6 +24,7 @@ containers="$(container_tool ps -q -f name="$mname" 2> /dev/null)"
 [ -z "$containers" ] && echo "The $mname stack is not running." && exit 1
 
 compose_path=$("$scr_dir/mdl-calc-compose-path.sh" "$mname")
+[[ -z $compose_path ]] && exit 1
 . "$scr_dir/mdl-calc-images.sh" "$mname"
 export_env_and_update_config "$mname"
 compose_tool -p "$mname" -f "$compose_path" logs "${@:2}"

libexec/mdl-start.sh

@@ -43,6 +43,7 @@ done
 for mname in $mnames; do
 
    compose_path=$("$scr_dir/mdl-calc-compose-path.sh" "$mname")
+   [[ -z $compose_path ]] && continue
    $quiet || echo "Starting $mname..."
    . "$scr_dir/mdl-calc-images.sh" "$mname"
    export_env_and_update_config "$mname"

libexec/mdl-status.sh

@@ -35,6 +35,7 @@ for mname in $mnames; do
    data_vol_name=$(grep data <<< "$vols")
    src_vol_name=$(grep src <<< "$vols")
    compose_path=$("$scr_dir/mdl-calc-compose-path.sh" "$mname")
+   [[ -z $compose_path ]] && continue
 
    $quiet || echo "${ul}Environment: $bold$mname$norm"
    # Status

libexec/mdl-stop.sh

@@ -32,6 +32,7 @@ for mname in $mnames; do
    fi
 
    compose_path=$("$scr_dir/mdl-calc-compose-path.sh" "$mname")
+   [[ -z $compose_path ]] && continue
 
    $quiet || echo "Stopping $mname..."
    . "$scr_dir/mdl-calc-images.sh" "$mname"