Add lib-builder docker image

tools/docker/Dockerfile

@@ -0,0 +1,88 @@
+FROM ubuntu:22.04
+
+# switch to root, let the entrypoint drop back to host user
+USER root
+
+ARG DEBIAN_FRONTEND=noninteractive
+
+RUN : \
+  && apt-get update \
+  && apt-get install -y --no-install-recommends \
+    bison \
+    ccache \
+    cmake \
+    curl \
+    flex \
+    git \
+    gperf \
+    jq \
+    libncurses-dev \
+    libssl-dev \
+    libusb-1.0 \
+    ninja-build \
+    patch \
+    python3 \
+    python3-click \
+    python3-cryptography \
+    python3-future \
+    python3-pip \
+    python3-pyelftools \
+    python3-pyparsing \
+    python3-serial \
+    python3-setuptools \
+    python3-venv \
+    wget \
+  && pip install --upgrade pip \
+  && apt-get autoremove -y \
+  && rm -rf /var/lib/apt/lists/* \
+  && :
+
+# install gosu for a better su+exec command
+ARG GOSU_VERSION=1.17
+RUN dpkgArch="$(dpkg --print-architecture | awk -F- '{ print $NF }')" \
+ && wget -O /usr/local/bin/gosu "https://github.com/tianon/gosu/releases/download/$GOSU_VERSION/gosu-$dpkgArch" \
+ && chmod +x /usr/local/bin/gosu \
+ && gosu nobody true
+
+# To build the image for a branch or a tag of the lib-builder, pass --build-arg LIBBUILDER_CLONE_BRANCH_OR_TAG=name.
+# To build the image with a specific commit ID of lib-builder, pass --build-arg LIBBUILDER_CHECKOUT_REF=commit-id.
+# It is possibe to combine both, e.g.:
+#   LIBBUILDER_CLONE_BRANCH_OR_TAG=release/vX.Y
+#   LIBBUILDER_CHECKOUT_REF=<some commit on release/vX.Y branch>.
+# Use LIBBUILDER_CLONE_SHALLOW=1 to peform shallow clone (i.e. --depth=1 --shallow-submodules)
+# Use LIBBUILDER_CLONE_SHALLOW_DEPTH=X to define the depth if LIBBUILDER_CLONE_SHALLOW is used (i.e. --depth=X)
+# Use IDF_INSTALL_TARGETS to install tools only for selected chip targets (CSV)
+
+ARG LIBBUILDER_CLONE_URL=https://github.com/espressif/esp32-arduino-lib-builder
+ARG LIBBUILDER_CLONE_BRANCH_OR_TAG=master
+ARG LIBBUILDER_CHECKOUT_REF=
+ARG LIBBUILDER_CLONE_SHALLOW=
+ARG LIBBUILDER_CLONE_SHALLOW_DEPTH=1
+ARG LIBBUILDER_TARGETS=all
+
+ENV LIBBUILDER_PATH=/opt/esp/lib-builder
+ENV ARDUINO_PATH=/opt/esp/lib-builder/arduino-esp32
+
+RUN echo LIBBUILDER_CHECKOUT_REF=$LIBBUILDER_CHECKOUT_REF LIBBUILDER_CLONE_BRANCH_OR_TAG=$LIBBUILDER_CLONE_BRANCH_OR_TAG && \
+    git clone --recursive \
+      ${LIBBUILDER_CLONE_SHALLOW:+--depth=${LIBBUILDER_CLONE_SHALLOW_DEPTH} --shallow-submodules} \
+      ${LIBBUILDER_CLONE_BRANCH_OR_TAG:+-b $LIBBUILDER_CLONE_BRANCH_OR_TAG} \
+      $LIBBUILDER_CLONE_URL $LIBBUILDER_PATH && \
+    git config --system --add safe.directory $LIBBUILDER_PATH && \
+    if [ -n "$LIBBUILDER_CHECKOUT_REF" ]; then \
+      cd $LIBBUILDER_PATH && \
+      if [ -n "$LIBBUILDER_CLONE_SHALLOW" ]; then \
+        git fetch origin --depth=${LIBBUILDER_CLONE_SHALLOW_DEPTH} --recurse-submodules ${LIBBUILDER_CHECKOUT_REF}; \
+      fi && \
+      git checkout $LIBBUILDER_CHECKOUT_REF && \
+      git submodule update --init --recursive; \
+    fi
+
+COPY entrypoint.sh $LIBBUILDER_PATH/entrypoint.sh
+
+# Ccache is installed, enable it by default
+ENV IDF_CCACHE_ENABLE=1
+
+WORKDIR /opt/esp/lib-builder
+ENTRYPOINT [ "/opt/esp/lib-builder/entrypoint.sh" ]
+CMD [ "bash" ]

tools/docker/entrypoint.sh

@@ -0,0 +1,33 @@
+#!/usr/bin/env bash
+set -e
+
+# LIBBUILDER_GIT_SAFE_DIR has the same format as system PATH environment variable.
+# All path specified in LIBBUILDER_GIT_SAFE_DIR will be added to user's
+# global git config as safe.directory paths. For more information
+# see git-config manual page.
+if [ -n "${LIBBUILDER_GIT_SAFE_DIR+x}" ]
+then
+	echo "Adding following directories into git's safe.directory"
+	echo "$LIBBUILDER_GIT_SAFE_DIR" | tr ':' '\n' | while read -r dir
+	do
+		git config --global --add safe.directory "$dir"
+		echo "  $dir"
+	done
+fi
+
+if [ "$(id -u)" = "0" ] && [ -n "${HOST_UID}" ]; then
+	groupadd -g ${HOST_UID} host_user
+	useradd -m -u ${HOST_UID} -g ${HOST_UID} host_user
+
+	if [ -d /arduino-esp32 ]; then
+		chown -R ${HOST_UID}:${HOST_UID} /arduino-esp32
+	fi
+
+	chown -R ${HOST_UID}:${HOST_UID} /opt/esp
+
+	# Add call to gosu to drop from root user to host_user
+	# when running original entrypoint
+	set -- gosu host_user "$@"
+fi
+
+exec "$@"

tools/docker/run.sh

@@ -0,0 +1,46 @@
+#!/usr/bin/env bash
+
+i=0
+NEXT_ARG="false"
+ARDUINO_DIR=""
+DOCKER_ARGS=()
+ORIGINAL_ARGS=("$@")
+TRIMMED_ARGS=()
+
+while [ $i -lt ${#ORIGINAL_ARGS[@]} ]; do
+	arg=${ORIGINAL_ARGS[$i]}
+	if [ $arg == "-c" ]; then
+		NEXT_ARG="true"
+	elif [ $NEXT_ARG == "true" ]; then
+		ARDUINO_DIR=$arg
+		NEXT_ARG="false"
+	else
+		TRIMMED_ARGS+=($arg)
+	fi
+	i=$((i + 1))
+done
+
+if [ -n "$ARDUINO_DIR" ]; then
+	if [ ! -d "$ARDUINO_DIR" ]; then
+		echo "Arduino directory \"$ARDUINO_DIR\" does not exist"
+		exit 1
+	fi
+	ARDUINO_DIR=$(echo $(cd $ARDUINO_DIR; pwd))
+	DOCKER_ARGS+=(-v $ARDUINO_DIR:/arduino-esp32)
+	TRIMMED_ARGS+=(-c /arduino-esp32)
+fi
+
+DOCKER_ARGS+=(-e HOST_UID=$UID)
+
+if [ -n "$LIBBUILDER_GIT_SAFE_DIR" ]; then
+	DOCKER_ARGS+=(-e LIBBUILDER_GIT_SAFE_DIR=$LIBBUILDER_GIT_SAFE_DIR)
+fi
+
+if [ "$VERBOSE_OUTPUT" -eq 1 ]; then
+	echo "Arguments:"
+	echo "DOCKER_ARGS = ${DOCKER_ARGS[@]}"
+	echo "TRIMMED_ARGS = ${TRIMMED_ARGS[@]}"
+	echo "Running: docker run ${DOCKER_ARGS[@]} lucassvaz/esp32-arduino-lib-builder ./build.sh ${TRIMMED_ARGS[@]}"
+fi
+
+docker run ${DOCKER_ARGS[@]} lucassvaz/esp32-arduino-lib-builder ./build.sh ${TRIMMED_ARGS[@]}