Unify the Dockerfiles by fleshing out build.sh

Script is written to handle it's own dependencies so it can be used within Docker or on the host system
2020-12-17 13:12:06 +00:00
parent 276c8aa308
commit a7df0a0279
7 changed files with 171 additions and 139 deletions
--- a/docker/Dockerfile
+++ b/docker/Dockerfile
@@ -0,0 +1,37 @@
+FROM ubuntu:18.04
+
+RUN \
+    apt-get update -qq && \
+    apt-get install -y \
+# x86_64 / generic packages
+      bash git gosu \
+      cmake make build-essential \
+      wget unzip \
+      python3 python3-pip \ 
+# aarch64 packages
+      libffi-dev libssl-dev python3-dev \ 
+    && rm -rf /var/lib/apt/lists/*;
+
+RUN pip3 install adafruit-nrfutil
+
+# build.sh knows how to compile
+COPY build.sh /opt/
+
+# Lets get each in a separate docker layer for better downloads
+# GCC
+RUN bash -c "source /opt/build.sh; GetGcc;"
+# NrfSdk
+RUN bash -c "source /opt/build.sh; GetNrfSdk;"
+# McuBoot
+RUN bash -c "source /opt/build.sh; GetMcuBoot;"
+
+# Set and arg and use it in the env for power to override at build AND runtime
+ARG USER_ID=33333
+ARG GROUP_ID=33333
+ENV USER_ID $USER_ID
+ENV GROUP_ID $GROUP_ID
+
+ENV SOURCES_DIR /sources
+COPY entrypoint.sh /opt/
+ENTRYPOINT ["/opt/entrypoint.sh"]
+CMD ["/opt/build.sh"]
--- a/docker/amd64/Dockerfile
+++ b/docker/amd64/Dockerfile
@@ -1,34 +0,0 @@
-FROM amd64/ubuntu:18.04
-
-ARG DEBIAN_FRONTEND=noninteractive
-RUN apt-get update -qq \
-    && apt-get install -y \ 
-        build-essential \
-        cmake \
-        git \
-        make \
-        python3 \
-        python3-pip \
-        tar \
-        unzip \
-        wget \
-    && rm -rf /var/cache/apt/* /var/lib/apt/lists/*
-
-RUN wget -q https://developer.arm.com/-/media/Files/downloads/gnu-rm/9-2020q2/gcc-arm-none-eabi-9-2020-q2-update-x86_64-linux.tar.bz \
-  && tar -xjf gcc-arm-none-eabi-9-2020-q2-update-x86_64-linux.tar.bz -C /opt \
-  && rm gcc-arm-none-eabi-9-2020-q2-update-x86_64-linux.tar.bz
-
-RUN wget -q https://developer.nordicsemi.com/nRF5_SDK/nRF5_SDK_v15.x.x/nRF5_SDK_15.3.0_59ac345.zip  \
-  && unzip -q nRF5_SDK_15.3.0_59ac345.zip -d /opt/ && rm nRF5_SDK_15.3.0_59ac345.zip
-
-RUN git clone https://github.com/JuulLabs-OSS/mcuboot.git /opt/mcuboot \
-  && pip3 install -r /opt/mcuboot/scripts/requirements.txt
-
-RUN pip3 install adafruit-nrfutil
-
-ARG PUID=1000
-ARG PGID=1000
-RUN groupadd --system --gid $PGID infinitime && useradd --system --uid $PUID --gid $PGID infinitime
-
-USER infinitime:infinitime
-CMD ["/sources/docker/build.sh"]
--- a/docker/arm64v8/Dockerfile
+++ b/docker/arm64v8/Dockerfile
@@ -1,37 +0,0 @@
-FROM arm64v8/ubuntu:18.04
-
-ENV DEBIAN_FRONTEND=noninteractive
-RUN apt-get update -qq \
-    && apt-get install -y \ 
-        build-essential \
-        cmake \
-        git \
-        libffi-dev \
-        libssl-dev \
-        make \
-        python3 \
-        python3-dev \
-        python3-pip \
-        tar \
-        unzip \
-        wget \
-    && rm -rf /var/cache/apt/* /var/lib/apt/lists/*
-
-RUN wget -q https://developer.arm.com/-/media/Files/downloads/gnu-rm/9-2020q2/gcc-arm-none-eabi-9-2020-q2-update-aarch64-linux.tar.bz2 \
-  && tar -xjf gcc-arm-none-eabi-9-2020-q2-update-aarch64-linux.tar.bz2 -C /opt \
-  && rm gcc-arm-none-eabi-9-2020-q2-update-aarch64-linux.tar.bz2
-
-RUN wget -q https://developer.nordicsemi.com/nRF5_SDK/nRF5_SDK_v15.x.x/nRF5_SDK_15.3.0_59ac345.zip \
-  && unzip -q nRF5_SDK_15.3.0_59ac345.zip -d /opt/ \
-  && rm nRF5_SDK_15.3.0_59ac345.zip
-
-RUN git clone https://github.com/JuulLabs-OSS/mcuboot.git /opt/mcuboot && pip3 install -r /opt/mcuboot/scripts/requirements.txt
-
-RUN pip3 install adafruit-nrfutil
-
-ARG PUID=1000
-ARG PGID=1000
-RUN groupadd --system --gid $PGID infinitime && useradd --system --uid $PUID --gid $PGID infinitime
-
-USER infinitime:infinitime
-CMD ["/sources/docker/build.sh"]
--- a/docker/build.sh
+++ b/docker/build.sh
@@ -1,12 +1,73 @@
-#!/bin/sh
+#!/bin/bash
+(return 0 2>/dev/null) && SOURCED="true" || SOURCED="false"
 export LC_ALL=C.UTF-8
 export LANG=C.UTF-8
 set -x
+set -e

-mkdir /sources/build
-cd /sources/build
+# Default locations if the var isn't already set
+export TOOLS_DIR="${TOOLS_DIR:=/opt}"
+export SOURCES_DIR="${SOURCES_DIR:=/sources}"
+export BUILD_DIR="${BUILD_DIR:=$SOURCES_DIR/build}"
+export OUTPUT_DIR="${OUTPUT_DIR:=$BUILD_DIR/output}"

-cmake -DARM_NONE_EABI_TOOLCHAIN_PATH=/opt/gcc-arm-none-eabi-9-2020-q2-update -DNRF5_SDK_PATH=/opt/nRF5_SDK_15.3.0_59ac345 -DUSE_OPENOCD=1 ../
-make -j$(nproc)
+export BUILD_TYPE=${BUILD_TYPE:=Release}
+export GCC_ARM_VER=${GCC_ARM_VER:="gcc-arm-none-eabi-9-2020-q2-update"}
+export NRF_SDK_VER=${NRF_SDK_VER:="nRF5_SDK_15.3.0_59ac345"}

-sh /sources/docker/post_build.sh
+MACHINE="$(uname -m)"
+[[ "$MACHINE" == "arm64" ]] && MACHINE="aarch64"
+
+main() {
+  local target="$1"
+  [[ ! -d "$TOOLS_DIR/$GCC_ARM_VER" ]] && GetGcc
+  [[ ! -d "$TOOLS_DIR/$NRF_SDK_VER" ]] && GetNrfSdk
+  [[ ! -d "$TOOLS_DIR/mcuboot" ]] && GetMcuBoot
+
+  mkdir -p "$BUILD_DIR"
+
+  CmakeGenerate
+  CmakeBuild "$target"
+
+  if [[ "$DISABLE_POSTBUILD" != "true" ]]; then
+    source "$BUILD_DIR/post_build.sh"
+  fi
+}
+
+GetGcc() {
+  GCC_SRC="$GCC_ARM_VER-$MACHINE-linux.tar.bz"
+  wget -q https://developer.arm.com/-/media/Files/downloads/gnu-rm/9-2020q2/$GCC_SRC -O - | tar -xj -C $TOOLS_DIR/
+}
+
+GetMcuBoot() {
+  git clone https://github.com/JuulLabs-OSS/mcuboot.git "$TOOLS_DIR/mcuboot"
+  pip3 install -r "$TOOLS_DIR/mcuboot/scripts/requirements.txt"
+}
+
+GetNrfSdk() {
+  wget -q "https://developer.nordicsemi.com/nRF5_SDK/nRF5_SDK_v15.x.x/$NRF_SDK_VER.zip" -O /tmp/$NRF_SDK_VER
+  unzip -q /tmp/$NRF_SDK_VER -d "$TOOLS_DIR/"
+  rm /tmp/$NRF_SDK_VER
+}
+
+CmakeGenerate() {
+  # We can swap the CD and trailing SOURCES_DIR for -B and -S respectively
+  # once we go to newer CMake (Ubuntu 18.10 gives us CMake 3.10)
+  cd "$BUILD_DIR"
+
+  cmake -G "Unix Makefiles" \
+    -DCMAKE_BUILD_TYPE=$BUILD_TYPE \
+    -DUSE_OPENOCD=1 \
+    -DARM_NONE_EABI_TOOLCHAIN_PATH="$TOOLS_DIR/$GCC_ARM_VER" \
+    -DNRF5_SDK_PATH="$TOOLS_DIR/$NRF_SDK_VER" \
+    "$SOURCES_DIR"
+  cmake -L -N .
+}
+
+CmakeBuild() {
+  local target="$1"
+  [[ -n "$target" ]] && target="--target $target"
+  cmake --build "$BUILD_DIR" --config $BUILD_TYPE "$target" -- -j$(nproc)
+}
+
+[[ $SOURCED == "false" ]] && main "$@" || echo "Sourced!"
--- a/docker/entrypoint.sh
+++ b/docker/entrypoint.sh
@@ -0,0 +1,7 @@
+#!/bin/bash
+set -e
+## Create a user on-the-fly before running CMD
+## This allows us to override at runtime, allowing use of a pre-built docker image
+addgroup --gid $GROUP_ID user
+adduser --disabled-password --gecos '' --uid $USER_ID --gid $GROUP_ID user
+exec gosu user:user /bin/bash -c "$@"
--- a/docker/post_build.sh.in
+++ b/docker/post_build.sh.in
@@ -2,15 +2,24 @@
 export LC_ALL=C.UTF-8
 export LANG=C.UTF-8
 set -x
+set -e

-mkdir -p /sources/build/output
-/opt/mcuboot/scripts/imgtool.py create --align 4 --version 1.0.0 --header-size 32 --slot-size 475136 --pad-header /sources/build/src/pinetime-mcuboot-app-@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@.@PROJECT_VERSION_PATCH@.bin /sources/build/output/image-@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@.@PROJECT_VERSION_PATCH@.bin
-adafruit-nrfutil dfu genpkg --dev-type 0x0052 --application /sources/build/output/image-@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@.@PROJECT_VERSION_PATCH@.bin /sources/build/output/dfu-@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@.@PROJECT_VERSION_PATCH@.zip
+export PROJECT_VERSION="@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@.@PROJECT_VERSION_PATCH@"

-cp /sources/build/src/*.bin /sources/build/output/
-cp /sources/build/src/*.hex /sources/build/output/
-cp /sources/build/src/*.out /sources/build/output/
-cp /sources/build/src/*.map /sources/build/output/
-cp /sources/bootloader/bootloader-5.0.4.bin /sources/build/output/bootloader.bin
+mkdir -p "$OUTPUT_DIR"

+"$TOOLS_DIR"/mcuboot/scripts/imgtool.py create --version 1.0.0 \
+    --align 4 --header-size 32 --slot-size 475136 --pad-header \
+    "$BUILD_DIR/src/pinetime-mcuboot-app-$PROJECT_VERSION.bin" \
+    "$OUTPUT_DIR/image-$PROJECT_VERSION.bin"

+adafruit-nrfutil dfu genpkg --dev-type 0x0052 \
+    --application "$OUTPUT_DIR/image-$PROJECT_VERSION.bin" \
+    "$OUTPUT_DIR/dfu-$PROJECT_VERSION.zip"
+
+cp  "$BUILD_DIR"/src/*.bin \
+    "$BUILD_DIR"/src/*.hex \
+    "$BUILD_DIR"/src/*.out \
+    "$BUILD_DIR"/src/*.map \
+    $OUTPUT_DIR
+cp "$SOURCES_DIR"/bootloader/bootloader-5.0.4.bin $OUTPUT_DIR/bootloader.bin