angel-docker-build.sh

#!/bin/bash
#
# Build the docker images.
#
set -e
SCRIPT_DIR="$(cd "$(dirname "${0}")" && pwd)"
export DOCKER_BUILDKIT=1

# source common functionalities
. "${SCRIPT_DIR}/scripts/common.bash"

pushd "$SCRIPT_DIR"

function usage()
{
  echo "
Usage: $0 [-h|--help] [--force]

Build the PTG ANGEL system docker container images.

Options:
  -h | --help   Display this message.
  -f | --force  Force image building regardless of workspace hygiene.
"
}

# Option parsing
dc_forward_params=()
while [[ $# -gt 0 ]]
do
  key="$1"
  shift
  case "$key" in
    -h|--help)
      usage
      exit 0
      ;;
    -f|--force)
      log "Forcing build regardless of workspace hygiene."
      FORCE_BUILD=1
      ;;
    --)
      # Escape the remainder of args as to be considered passthrough
      dc_forward_params+=("${@}")
      break
      ;;
    *)  # anything else
      dc_forward_params+=("$key")
  esac
done

# Check if there are modified or "new" files in the workspace.
# NODE: `warn_build_spaces` should be expanded if more things start to become
#       part of docker builds. Maybe read this in from somewhere else instead
#       of encoding here?
warn_build_spaces=(
  "ros"
  "docker"
  "pyproject.toml"
  "poetry.lock"
  "angel_system"
  "tmux"
)
# Check if there are tracked file modifications.
git_status="$(cd "${SCRIPT_DIR}" && git status --porcelain "${warn_build_spaces[@]}")"
git_sm_status="$(cd "${SCRIPT_DIR}" && git submodule foreach git status --porcelain)"
git_sm_q_status="$(cd "${SCRIPT_DIR}" && git submodule --quiet foreach git status --porcelain)"
# Check if there are ignored files in the workspace that should not be there.
# Items that are excluded here (-e) are paths that are included in *both* the
# .gitignore and .dockerignore files.
git_clean_dr_cmd=(
  git clean
  "${warn_build_spaces[@]}"
  -e "ros/angel_utils/multi_task_demo_ui/node_modules/"
  -xdn
)
git_clean_dr="$(cd "${SCRIPT_DIR}" && "${git_clean_dr_cmd[@]}")"
# Check for unclean files in submodules not caught by the above.
# Quiet version is for checking, non-quiet version is for reporting (it's
# informational).
git_sm_clean_dr_cmd=( git submodule foreach --recursive git clean -xdn )
git_sm_q_clean_dr_cmd=( git submodule --quiet foreach --recursive git clean -xdn )
# shellcheck disable=SC2068
git_sm_clean_dr="$(cd "${SCRIPT_DIR}" && ${git_sm_clean_dr_cmd[@]})"
# shellcheck disable=SC2068
git_sm_q_clean_dr="$(cd "${SCRIPT_DIR}" && ${git_sm_q_clean_dr_cmd[@]})"
if [[ -n "${git_status}" ]] || [[ -n "${git_sm_q_status}" ]] || [[ -n "${git_clean_dr}" ]] || [[ -n "${git_sm_q_clean_dr}" ]]
then
  log "WARNING: Docker/ROS workspace subtree is modified and/or un-clean."
  if [[ -n "${git_status}" ]]
  then
    log "WARNING: -- There are modified / new files (check git status)."
    log "${git_status}"
  fi
  if [[ -n "${git_sm_q_status}" ]]
  then
    log "WARNING: -- There are modified / new files in sub-modules."
    log "${git_sm_status}"
  fi
  if [[ -n "${git_clean_dr}" ]]
  then
    log "WARNING: -- There are unexpected ignored files (check \`${git_clean_dr_cmd[*]}\`)."
    log "${git_clean_dr}"
  fi
  if [[ -n "${git_sm_q_clean_dr}" ]]
  then
    log "WARNING: -- Submodules have unclean states (check \`${git_sm_clean_dr_cmd[*]}\`).)"
    log "${git_sm_clean_dr}"
  fi
  if [[ -n "$FORCE_BUILD" ]]
  then
    log "WARNING: Force enabled, building anyway."
  else
    log "ERROR: Refusing to build images."
    exit 1
  fi
fi

if [[ "${#dc_forward_params[@]}" -gt 0 ]]
then
  log "Forwarding to docker-compose: ${dc_forward_params[*]}"
fi

get_docker_compose_cmd DC_CMD

"${DC_CMD[@]}" \
  --env-file "$SCRIPT_DIR"/docker/.env \
  -f "$SCRIPT_DIR"/docker/docker-compose.yml \
  --profile build-only \
  build "${dc_forward_params[@]}"