A script to build esp-idf projects inside a Docker - with writable /dev/ttyUSB* mounted inside the container

.dockerignore

build/
test/build/

Dockerfile

FROM espressif/idf

ARG UID=1000
RUN useradd --uid $UID --create-home idf
USER idf

esp-idf-image.sh

#!/bin/sh

IMAGE_NAME="${IMAGE_NAME:-esp-idf-build}"
DEVICE_PORT="${DEVICE_PORT:-/dev/ttyUSB}"

function echo_warn() {
  echo -e "\e[31m[!] WARNING: $1\e[0m"
}

case $1 in
  assert)
    docker images | grep $IMAGE_NAME > /dev/null

    if [ $? -ne 0 ]; then
      exit 1
    fi
    ;;

  build)
    echo "[*] building image '$IMAGE_NAME'"
    docker build -t $IMAGE_NAME --build-arg UID=$(id -u) .
    ;;

  clean)
    echo "[*] removing image '$IMAGE_NAME'"
    docker rmi -f $IMAGE_NAME
    ;;

  run)
    echo "[*] detecting USB devices on $DEVICE_PORT*"
    devices=(`ls $DEVICE_PORT* 2>/dev/null`)
    device_arg=""
    user_arg=""

    if [ ${#devices[@]} -gt 0 ]; then
      device_group=`stat -c %g ${devices[0]}`
      echo "[*] found ${#devices[@]} device(s), gid = $device_group"

      for device in ${devices[@]}; do
        device_arg="$device_arg --device=$device"
      done

      user_arg="--user $UID:$device_group"
    else
      echo_warn "no usb devices found!"
    fi

    shift
    echo "[*] running '$@' in the container"
    exec docker run \
      --rm \
      -it \
      -v `pwd`:`pwd` \
      -w `pwd` \
      $user_arg \
      $device_arg \
      $IMAGE_NAME \
      $@
    ;;

  *)
    echo "usage: ./esp-idf-image.sh [assert|build|clean|run COMMAND]"
    ;;
esac

LICENSE

MIT License

Copyright (c) 2020 Michael Neu

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.