dev-server.sh

#!/usr/bin/env bash

BASE_TAG="latest"

CONTAINER_NAME=epfl-lasa-control-libraries-protocol-development-ssh
BRANCH=$(git branch --show-current)

SSH_PORT=2244
SSH_KEY_FILE="${HOME}/.ssh/id_rsa.pub"

HELP_MESSAGE="Usage: ./dev-server.sh [-b <branch>] [-p <port>] [-k <file>] [--base-tag <base-tag>] [-r]

Build and run a docker container as an SSH toolchain server for remote development.

The server is bound to the specified port on localhost (127.0.0.1)
and uses passwordless RSA key-pair authentication. The host public key
is read from the specified key file and copied to the server on startup.
On linux hosts, the UID and GID of the specified user will also be
set to match the UID and GID of the host user by the entry script.

The server will run in the background as ${CONTAINER_NAME}.

You can connect with 'ssh developer@localhost -p <port>'.

Close the server with 'docker stop ${CONTAINER_NAME}'.

Options:
  -b, --branch <branch>    Specify the branch of control libraries
                           that should be used to build the image.
  -p, --port <XXXX>        Specify the port to bind for SSH
                           connection.
                           (default: ${SSH_PORT})
  -k, --key-file <path>    Specify the path of the RSA
                           public key file.
                           (default: ${SSH_KEY_FILE})
  --base-tag <base-tag>    Tag of the development image.
                           (default: ${BASE_TAG})
  -r, --rebuild            Rebuild the image with the --no-cache option.
  -h, --help               Show this help message."

BUILD_FLAGS=()
while [ "$#" -gt 0 ]; do
  case "$1" in
  -b|--branch) BRANCH=$2; shift 2;;
  -p|--port) SSH_PORT=$2; shift 2;;
  -k|--key-file) SSH_KEY_FILE=$2; shift 2;;
  --base-tag) BASE_TAG=$2; shift 2;;
  -h|--help) echo "${HELP_MESSAGE}"; exit 0;;
  -r|--rebuild) BUILD_FLAGS+=(--no-cache); shift 1;;
  *) echo 'Error in command line parsing' >&2
     echo -e "\n${HELP_MESSAGE}"
     exit 1
  esac
done

PUBLIC_KEY=$(cat "${SSH_KEY_FILE}")

COMMAND_FLAGS=()
COMMAND_FLAGS+=(--key "${PUBLIC_KEY}")
COMMAND_FLAGS+=(--user developer)

if [[ "${OSTYPE}" != "darwin"* ]]; then
  USER_ID=$(id -u "${USER}")
  GROUP_ID=$(id -g "${USER}")
  COMMAND_FLAGS+=(--uid "${USER_ID}")
  COMMAND_FLAGS+=(--gid "${GROUP_ID}")
fi

IMAGE_NAME=epfl-lasa/control-libraries/protocol/development:"${BASE_TAG}"
BUILD_FLAGS+=(--build-arg BASE_TAG="${BASE_TAG}")
BUILD_FLAGS+=(-t "${IMAGE_NAME}")

echo "Using control libraries branch ${BRANCH}"
BUILD_FLAGS+=(--build-arg BRANCH="${BRANCH}")
BUILD_FLAGS+=(--target source)
docker pull ghcr.io/epfl-lasa/control-libraries/development-dependencies:"${BASE_TAG}" || exit 1
DOCKER_BUILDKIT=1 docker build . --file ./Dockerfile.protocol "${BUILD_FLAGS[@]}" || exit 1

docker container stop "${CONTAINER_NAME}" >/dev/null 2>&1
docker rm --force "${CONTAINER_NAME}" >/dev/null 2>&1

echo "Starting background container with access port ${SSH_PORT} for user developer"
docker run -d --rm --cap-add sys_ptrace \
  --user root \
  --publish 127.0.0.1:"${SSH_PORT}":22 \
  --name "${CONTAINER_NAME}" \
  --hostname "${CONTAINER_NAME}" \
  "${IMAGE_NAME}" /sshd_entrypoint.sh "${COMMAND_FLAGS[@]}"

echo "${CONTAINER_NAME}"