Grab bag of updates

- Unique metadata for each image
- Security notice in shell welcome message
- Added gcc-multilib
- Fixed reportgenerator installation shell conditional

Author: mkarlesky

.github/workflows/dev.yml

@@ -10,7 +10,8 @@ on:
       - 'main'
 
 env:
-  IMAGE_BASE_NAME: 'throwtheswitch/madsciencelab'
+  IMAGE_ORG: 'throwtheswitch'
+  IMAGE_BASE_NAME: 'madsciencelab'
 
 
 jobs:
@@ -24,6 +25,10 @@ jobs:
       packages: write
       attestations: write
       id-token: write
+    env:
+      IMAGE_NAME: "${{ env.IMAGE_BASE_NAME }}"
+      # Cannot reference IMAGE_NAME as it does not exist yet
+      IMAGE_URL: "${{ env.IMAGE_ORG }}/${{ env.IMAGE_BASE_NAME }}-plugins"
 
     steps:
       - name: 'Checkout GitHub Action'
@@ -49,8 +54,10 @@ jobs:
         with:
           platforms: linux/amd64,linux/arm64
           file: build/standard/docker/Dockerfile
-          build-args: CONTAINER_VERSION=${{ github.ref_name }}
-          tags: ${{ env.IMAGE_BASE_NAME }}:latest
+          build-args: |
+            CONTAINER_VERSION=${{ github.ref_name }}
+            IMAGE_NAME=${{ env.IMAGE_NAME }}            
+          tags: ${{ env.IMAGE_URL }}:latest
 
   madsciencelab-plugins:
     runs-on: ubuntu-latest
@@ -59,8 +66,12 @@ jobs:
       packages: write
       attestations: write
       id-token: write
-    env: 
-      VARIANT: plugins
+    env:
+      VARIANT: 'plugins'
+      # Cannot reference VARIANT as it does not exist yet
+      IMAGE_NAME: "${{ env.IMAGE_BASE_NAME }}-plugins"
+      # Cannot reference IMAGE_NAME as it does not exist yet
+      IMAGE_URL: "${{ env.IMAGE_ORG }}/${{ env.IMAGE_BASE_NAME }}-plugins"
 
     steps:
       - name: 'Checkout GitHub Action'
@@ -80,13 +91,15 @@ jobs:
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
       # Docker image: madsciencelab-plugins
-      - name: 'Build Docker image ${{ env.IMAGE_BASE_NAME }}-${{ env.VARIANT }}'
+      - name: 'Build Docker image ${{ env.IMAGE_NAME }}'
         uses: docker/build-push-action@v6
         with:
           platforms: linux/amd64,linux/arm64
           file: build/${{ env.VARIANT }}/docker/Dockerfile
-          build-args: CONTAINER_VERSION=${{ github.ref_name }}
-          tags: ${{ env.IMAGE_BASE_NAME }}-${{ env.VARIANT }}:latest
+          build-args: |
+            CONTAINER_VERSION=${{ github.ref_name }}
+            IMAGE_NAME=${{ env.IMAGE_NAME }}
+          tags: ${{ env.IMAGE_URL }}:latest
 
   madsciencelab-arm-none-eabi:
     runs-on: ubuntu-latest
@@ -96,7 +109,11 @@ jobs:
       attestations: write
       id-token: write
     env:
-      VARIANT: arm-none-eabi
+      VARIANT: 'arm-none-eabi'
+      # Cannot reference VARIANT as it does not exist yet
+      IMAGE_NAME: "${{ env.IMAGE_BASE_NAME }}-arm-none-eabi"
+      # Cannot reference IMAGE_NAME as it does not exist yet
+      IMAGE_URL: "${{ env.IMAGE_ORG }}/${{ env.IMAGE_BASE_NAME }}-arm-none-eabi"
 
     steps:
       - name: 'Checkout GitHub Action'
@@ -121,8 +138,10 @@ jobs:
         with:
           platforms: linux/amd64,linux/arm64
           file: build/${{ env.VARIANT }}/docker/Dockerfile
-          build-args: CONTAINER_VERSION=${{ github.ref_name }}
-          tags: ${{ env.IMAGE_BASE_NAME }}-${{ env.VARIANT }}:latest
+          build-args: |
+            CONTAINER_VERSION=${{ github.ref_name }}
+            IMAGE_NAME=${{ env.IMAGE_NAME }}            
+          tags: ${{ env.IMAGE_URL }}:latest
 
   madsciencelab-arm-none-eabi-plugins:
     runs-on: ubuntu-latest
@@ -132,7 +151,11 @@ jobs:
       attestations: write
       id-token: write
     env:
-      VARIANT: arm-none-eabi-plugins
+      VARIANT: 'arm-none-eabi-plugins'
+      # Cannot reference VARIANT as it does not exist yet
+      IMAGE_NAME: "${{ env.IMAGE_BASE_NAME }}-arm-none-eabi-plugins"
+      # Cannot reference IMAGE_NAME as it does not exist yet
+      IMAGE_URL: "${{ env.IMAGE_ORG }}/${{ env.IMAGE_BASE_NAME }}-arm-none-eabi-plugins"
 
     steps:
       - name: 'Checkout GitHub Action'
@@ -157,6 +180,8 @@ jobs:
         with:
           platforms: linux/amd64,linux/arm64
           file: build/${{ env.VARIANT }}/docker/Dockerfile
-          build-args: CONTAINER_VERSION=${{ github.ref_name }}
-          tags: ${{ env.IMAGE_BASE_NAME }}-${{ env.VARIANT }}:latest
+          build-args: |
+            CONTAINER_VERSION=${{ github.ref_name }}
+            IMAGE_NAME=${{ env.IMAGE_NAME }}            
+          tags: ${{ env.IMAGE_URL }}:latest
 

.github/workflows/release.yml

@@ -7,7 +7,8 @@ on:
       - '*'
 
 env:
-  IMAGE_BASE_NAME: 'throwtheswitch/madsciencelab'
+  IMAGE_ORG: 'throwtheswitch'
+  IMAGE_BASE_NAME: 'madsciencelab'
 
 
 jobs:
@@ -21,6 +22,10 @@ jobs:
       packages: write
       attestations: write
       id-token: write
+    env:
+      IMAGE_NAME: "${{ env.IMAGE_BASE_NAME }}"
+      # Cannot reference IMAGE_NAME as it does not exist yet
+      IMAGE_URL: "${{ env.IMAGE_ORG }}/${{ env.IMAGE_BASE_NAME }}-plugins"
 
     steps:
       - name: 'Checkout GitHub Action'
@@ -46,9 +51,11 @@ jobs:
         with:
           platforms: linux/amd64,linux/arm64
           file: build/standard/docker/Dockerfile
-          build-args: CONTAINER_VERSION=${{ github.ref_name }}
+          build-args: |
+            CONTAINER_VERSION=${{ github.ref_name }}
+            IMAGE_NAME=${{ env.IMAGE_NAME }}            
           push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ env.IMAGE_BASE_NAME }}:${{ github.ref_name }}, ${{ env.IMAGE_BASE_NAME }}:latest
+          tags: ${{ env.IMAGE_URL }}:${{ github.ref_name }}, ${{ env.IMAGE_URL }}:latest
 
   madsciencelab-plugins:
     runs-on: ubuntu-latest
@@ -58,7 +65,11 @@ jobs:
       attestations: write
       id-token: write
     env: 
-      VARIANT: plugins
+      VARIANT: 'plugins'
+      # Cannot reference VARIANT as it does not exist yet
+      IMAGE_NAME: "${{ env.IMAGE_BASE_NAME }}-plugins"
+      # Cannot reference IMAGE_NAME as it does not exist yet
+      IMAGE_URL: "${{ env.IMAGE_ORG }}/${{ env.IMAGE_BASE_NAME }}-plugins"
 
     steps:
       - name: 'Checkout GitHub Action'
@@ -83,9 +94,11 @@ jobs:
         with:
           platforms: linux/amd64,linux/arm64
           file: build/${{ env.VARIANT }}/docker/Dockerfile
-          build-args: CONTAINER_VERSION=${{ github.ref_name }}
+          build-args: |
+            CONTAINER_VERSION=${{ github.ref_name }}
+            IMAGE_NAME=${{ env.IMAGE_NAME }}            
           push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ env.IMAGE_BASE_NAME }}-${{ env.VARIANT }}:${{ github.ref_name }}, ${{ env.IMAGE_BASE_NAME }}-${{ env.VARIANT }}:latest
+          tags: ${{ env.IMAGE_URL }}:${{ github.ref_name }}, ${{ env.IMAGE_URL }}:latest
 
   madsciencelab-arm-none-eabi:
     runs-on: ubuntu-latest
@@ -95,7 +108,11 @@ jobs:
       attestations: write
       id-token: write
     env:
-      VARIANT: arm-none-eabi
+      VARIANT: 'arm-none-eabi'
+      # Cannot reference VARIANT as it does not exist yet
+      IMAGE_NAME: "${{ env.IMAGE_BASE_NAME }}-arm-none-eabi"
+      # Cannot reference IMAGE_NAME as it does not exist yet
+      IMAGE_URL: "${{ env.IMAGE_ORG }}/${{ env.IMAGE_BASE_NAME }}-arm-none-eabi"
 
     steps:
       - name: 'Checkout GitHub Action'
@@ -120,9 +137,11 @@ jobs:
         with:
           platforms: linux/amd64,linux/arm64
           file: build/${{ env.VARIANT }}/docker/Dockerfile
-          build-args: CONTAINER_VERSION=${{ github.ref_name }}
+          build-args: |
+            CONTAINER_VERSION=${{ github.ref_name }}
+            IMAGE_NAME=${{ env.IMAGE_NAME }}            
           push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ env.IMAGE_BASE_NAME }}-${{ env.VARIANT }}:${{ github.ref_name }}, ${{ env.IMAGE_BASE_NAME }}-${{ env.VARIANT }}:latest
+          tags: ${{ env.IMAGE_URL }}:${{ github.ref_name }}, ${{ env.IMAGE_URL }}:latest
 
   madsciencelab-arm-none-eabi-plugins:
     runs-on: ubuntu-latest
@@ -132,7 +151,11 @@ jobs:
       attestations: write
       id-token: write
     env:
-      VARIANT: arm-none-eabi-plugins
+      VARIANT: 'arm-none-eabi-plugins'
+      # Cannot reference VARIANT as it does not exist yet
+      IMAGE_NAME: "${{ env.IMAGE_BASE_NAME }}-arm-none-eabi-plugins"
+      # Cannot reference IMAGE_NAME as it does not exist yet
+      IMAGE_URL: "${{ env.IMAGE_ORG }}/${{ env.IMAGE_BASE_NAME }}-arm-none-eabi-plugins"
 
     steps:
       - name: 'Checkout GitHub Action'
@@ -157,7 +180,9 @@ jobs:
         with:
           platforms: linux/amd64,linux/arm64
           file: build/${{ env.VARIANT }}/docker/Dockerfile
-          build-args: CONTAINER_VERSION=${{ github.ref_name }}
+          build-args: |
+            CONTAINER_VERSION=${{ github.ref_name }}
+            IMAGE_NAME=${{ env.IMAGE_NAME }}            
           push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ env.IMAGE_BASE_NAME }}-${{ env.VARIANT }}:${{ github.ref_name }}, ${{ env.IMAGE_BASE_NAME }}-${{ env.VARIANT }}:latest
+          tags: ${{ env.IMAGE_URL }}:${{ github.ref_name }}, ${{ env.IMAGE_URL }}:latest
 

README.md

@@ -22,13 +22,13 @@ image is to create an easy-to-install portable system for running unit tests wit
 
 ### Generating Dockerfiles
 
-`./build.sh --dir build/standard --variant "" --version 1.0.0-prerelease`
+`./build.sh --dir build/standard --variant "" --version 1.0.0`
 
-`./build.sh --dir build/standard --dir build/plugins --version 1.0.0-prerelease`
+`./build.sh --dir build/standard --dir build/plugins --version 1.0.0`
 
-`./build.sh --dir build/arm-none-eabi --version 1.0.0-prerelease`
+`./build.sh --dir build/arm-none-eabi --version 1.0.0`
 
-`./build.sh --dir build/arm-none-eabi --dir build/plugins --dir build/arm-none-eabi-plugins --version 1.0.0-prerelease`
+`./build.sh --dir build/arm-none-eabi --dir build/plugins --dir build/arm-none-eabi-plugins --version 1.0.0`
 
 
 ## Basic Articles Discussing Unit Testing

build.sh

@@ -298,7 +298,7 @@ if [ "$BUILD" = true ]; then
 
   # Perform multi-platform build with output as an image or optionally a direct push to the repository
   # Always echo this command to the command line
-  (set -x; docker $BUILD_ACTION $LOG_ARGS -t "$IMAGE":"$IMAGE_TAG" $PLATFORM_ARGS --build-arg CONTAINER_VERSION="$CONTAINER_VERSION" -f "$VARIANT_DIR_PATH"/docker/Dockerfile .)
+  (set -x; docker $BUILD_ACTION $LOG_ARGS -t "$IMAGE":"$IMAGE_TAG" $PLATFORM_ARGS --build-arg CONTAINER_VERSION="$CONTAINER_VERSION" --build_arg IMAGE_NAME="$IMAGE" -f "$VARIANT_DIR_PATH"/docker/Dockerfile .)
 
   # Capture exit code from attempted Docker image build
   success=$?

build/arm-none-eabi-plugins/assets/shell/welcome

@@ -1,6 +1,6 @@
 echo ""
-echo "\u001b[35mWelcome to the Mad Science Lab $MADSCIENCELAB_VERSION \u001b[0m"
-echo "\u001b[37m"
+echo "\e[35mWelcome to the Mad Science Lab $MADSCIENCELAB_VERSION \e[0m"
+echo "\e[37m"
 echo "  This container includes:"
 if [[ "$CONTAINER_PLATFORM" == * ]]; then echo "   * Ceedling, Unity, CMock & CException"; fi
 if [[ "$CONTAINER_PLATFORM" == * ]]; then echo "   * Ruby 3"; fi
@@ -15,6 +15,9 @@ if [[ "$CONTAINER_PLATFORM" == * ]]; then echo "   * unzip, git & svn for use by
 if [[ "$CONTAINER_PLATFORM" == * ]]; then echo "   * tput for use by Beep plugin"; fi
 if [[ "$CONTAINER_PLATFORM" == * ]]; then echo "   * Python 3, needed by gcovr"; fi
 if [[ "$CONTAINER_PLATFORM" == linux/amd64 ]]; then echo "   * Dotnet 8, needed by reportgenerator"; fi
-echo ""
-echo "  To get started, enter \`ceedling help\` at the command line."
-echo "\u001b[0m"
+echo "\e[0m"
+echo "  NOTICE: Container user \`$(whoami)\` lacks root priveleges as a security best practice."
+echo "  This limits installing software and more. See Docker Hub page for container security docs and options."
+echo "\e[33m"
+echo "  To get started, enter \`ceedling help\` at the command line..."
+echo "\e[0m"

build/arm-none-eabi-plugins/docker/Dockerfile

@@ -19,6 +19,10 @@ ARG CONTAINER_VERSION
 # Capture TARGETPLATFORM as an environment variable in the image
 ENV CONTAINER_PLATFORM=$TARGETPLATFORM
 
+# Docker image name used for Metadata, set via Docker build argument
+# The command line must include `--build-arg IMAGE_NAME=<name>`
+ENV MADSCIENCELAB_IMAGE_NAME=$IMAGE_NAME
+
 # Docker image tag for internal container use, set via Docker build argument
 ENV MADSCIENCELAB_VERSION=$CONTAINER_VERSION
 
@@ -28,8 +32,8 @@ ENV MADSCIENCELAB_VERSION=$CONTAINER_VERSION
 ##
 
 ## Metadata
-LABEL org.opencontainers.image.source=https://github.com/ThrowTheSwitch/MadScienceLabDocker
-LABEL org.opencontainers.image.url=https://github.com/ThrowTheSwitch/MadScienceLabDocker/blob/master/README.md
+LABEL org.opencontainers.image.source=https://github.com/ThrowTheSwitch/MadScienceLabDocker/releases
+LABEL org.opencontainers.image.url=https://hub.docker.com/r/throwtheswitch/$MADSCIENCELAB_IMAGE_NAME
 LABEL org.opencontainers.image.base.name=docker.io/bitnami/minideb
 LABEL org.opencontainers.image.title="Mad Science Lab"
 LABEL org.opencontainers.image.description="Contains Ceedling, supporting frameworks, and GNU C toolchain to provide a unit testing and build system environment for C projects"
@@ -115,7 +119,7 @@ RUN set -ex \
 
 # Microsoft Dotnet installation to support `reportgenerator` for `gcov` plugin
 # Only available on AMD64 image builds
-RUN if [[ $TARGETPLATFORM == "linux/amd64" ]] ; then set -ex \
+RUN if [ "$TARGETPLATFORM" = "linux/amd64" ]; then set -ex \
    && dpkg -i /assets/plugins/dotnet/packages-microsoft-prod.deb \
    && apt update \
    && apt install -y \
@@ -159,7 +163,7 @@ USER dev
 
 # Install `reportgenerator` (for `gcov` plugin)
 # Only available in AMD64 containers
-RUN if [[ $TARGETPLATFORM == "linux/amd64" ]] ; then set -ex \
+RUN if [ "$TARGETPLATFORM" == "linux/amd64" ]; then set -ex \
   # Install the dotnet tool as global (which means global for the current user vs. a local directory)
   && dotnet tool install --global dotnet-reportgenerator-globaltool \
   # Modify the PATH so the new tool is findable

build/arm-none-eabi/assets/shell/welcome

@@ -1,6 +1,6 @@
 echo ""
-echo "\u001b[35mWelcome to the Mad Science Lab $MADSCIENCELAB_VERSION \u001b[0m"
-echo "\u001b[37m"
+echo "\e[35mWelcome to the Mad Science Lab $MADSCIENCELAB_VERSION \e[0m"
+echo "\e[37m"
 echo "  This container includes:"
 if [[ "$CONTAINER_PLATFORM" == * ]]; then echo "   * Ceedling, Unity, CMock & CException"; fi
 if [[ "$CONTAINER_PLATFORM" == * ]]; then echo "   * Ruby 3"; fi
@@ -9,6 +9,9 @@ if [[ "$CONTAINER_PLATFORM" == * ]]; then echo "   * Essential build tools (make
 if [[ "$CONTAINER_PLATFORM" == * ]]; then echo "   * nano for simple text editing"; fi
 if [[ "$CONTAINER_PLATFORM" == * ]]; then echo "   * GNU Compiler Collection (gcc, etc.) for ARM"; fi
 if [[ "$CONTAINER_PLATFORM" == * ]]; then echo "   * Standard C libraries (ARM)"; fi
-echo ""
-echo "  To get started, enter \`ceedling help\` at the command line."
-echo "\u001b[0m"
+echo "\e[0m"
+echo "  NOTICE: Container user \`$(whoami)\` lacks root priveleges as a security best practice."
+echo "  This limits installing software and more. See Docker Hub page for container security docs and options."
+echo "\e[33m"
+echo "  To get started, enter \`ceedling help\` at the command line..."
+echo "\e[0m"

build/arm-none-eabi/docker/Dockerfile

@@ -19,6 +19,10 @@ ARG CONTAINER_VERSION
 # Capture TARGETPLATFORM as an environment variable in the image
 ENV CONTAINER_PLATFORM=$TARGETPLATFORM
 
+# Docker image name used for Metadata, set via Docker build argument
+# The command line must include `--build-arg IMAGE_NAME=<name>`
+ENV MADSCIENCELAB_IMAGE_NAME=$IMAGE_NAME
+
 # Docker image tag for internal container use, set via Docker build argument
 ENV MADSCIENCELAB_VERSION=$CONTAINER_VERSION
 
@@ -28,8 +32,8 @@ ENV MADSCIENCELAB_VERSION=$CONTAINER_VERSION
 ##
 
 ## Metadata
-LABEL org.opencontainers.image.source=https://github.com/ThrowTheSwitch/MadScienceLabDocker
-LABEL org.opencontainers.image.url=https://github.com/ThrowTheSwitch/MadScienceLabDocker/blob/master/README.md
+LABEL org.opencontainers.image.source=https://github.com/ThrowTheSwitch/MadScienceLabDocker/releases
+LABEL org.opencontainers.image.url=https://hub.docker.com/r/throwtheswitch/$MADSCIENCELAB_IMAGE_NAME
 LABEL org.opencontainers.image.base.name=docker.io/bitnami/minideb
 LABEL org.opencontainers.image.title="Mad Science Lab"
 LABEL org.opencontainers.image.description="Contains Ceedling, supporting frameworks, and GNU C toolchain to provide a unit testing and build system environment for C projects"

build/base/templates/Dockerfile.erb

@@ -19,6 +19,10 @@ ARG CONTAINER_VERSION
 # Capture TARGETPLATFORM as an environment variable in the image
 ENV CONTAINER_PLATFORM=$TARGETPLATFORM
 
+# Docker image name used for Metadata, set via Docker build argument
+# The command line must include `--build-arg IMAGE_NAME=<name>`
+ENV MADSCIENCELAB_IMAGE_NAME=$IMAGE_NAME
+
 # Docker image tag for internal container use, set via Docker build argument
 ENV MADSCIENCELAB_VERSION=$CONTAINER_VERSION
 
@@ -28,8 +32,8 @@ ENV MADSCIENCELAB_VERSION=$CONTAINER_VERSION
 ##
 
 ## Metadata
-LABEL org.opencontainers.image.source=https://github.com/ThrowTheSwitch/MadScienceLabDocker
-LABEL org.opencontainers.image.url=https://github.com/ThrowTheSwitch/MadScienceLabDocker/blob/master/README.md
+LABEL org.opencontainers.image.source=https://github.com/ThrowTheSwitch/MadScienceLabDocker/releases
+LABEL org.opencontainers.image.url=https://hub.docker.com/r/throwtheswitch/$MADSCIENCELAB_IMAGE_NAME
 LABEL org.opencontainers.image.base.name=docker.io/bitnami/minideb
 LABEL org.opencontainers.image.title="Mad Science Lab"
 LABEL org.opencontainers.image.description="Contains Ceedling, supporting frameworks, and GNU C toolchain to provide a unit testing and build system environment for C projects"