docker-keil/Dockerfile

ARG USER_NAME=keil
FROM scottyhardy/docker-wine:devel-8.4
ARG USER_NAME
ARG KEIL_URL=https://armkeil.blob.core.windows.net/eval/MDK537.EXE
ARG PACK_URL=https://ennis.zhaw.ch/pack/InES.CTBoard14_DFP.4.0.3.pack
ARG DEBUG=0

RUN \
    apt-get update \
    && apt-get upgrade -y \
    && apt-get install -y \
        dwm \
        clangd \
        gdb-multiarch \
        htop \
        inotify-tools \
        python3 \
        python-is-python3 \
        python3-pip \
        ssh \
        vim \
        xmlstarlet \
    && {  \
            [ "$DEBUG" -eq 1 ] \
            || true; \
    } \
    && rm -rf /var/lib/apt/lists/

RUN pip install pyocd

RUN \
    installerExtension=".exe"; \
    installer="$(mktemp --suffix="$installerExtension")"; \
    installerName="$(basename "$installer" | sed "s/$installerExtension$//")"; \
    rm "$installer"; \
    wget "${KEIL_URL}" --progress=bar:force:noscroll -O "$installer"; \
    [ "$DEBUG" -eq 1 ] && { \
        apt-get update; \
        apt-get install -y \
                build-essential \
                imagemagick; \
        rm -rf /var/lib/apt/lists; \
        TIV="$(mktemp)"; \
        logDir="logs"; \
        screenDir="$logDir/screens"; \
        git clone https://github.com/stefanhaustein/TerminalImageViewer.git && \
        cd TerminalImageViewer/src/main/cpp && \
        make && \
        apt-get remove -y build-essential && \
        apt-get autoremove -y && \
        mv tiv "$TIV" && \
        cd - && \
        rm -rf TerminalImageViewer; \
        mkdir -p "$logDir"; \
        mkdir -p "$screenDir"; \
    } || true; \
    printHeading() { \
        local heading; \
        heading="====================================================="; \
        echo "$heading"; \
        [ -z "$1" ] && cat || echo "$1"; \
        echo "$heading"; \
    }; \
    # Run actual Keil uVision installer
    install_keil() { \
        try="$1"; \
        logFile="$(mktemp)"; \
        printHeading "Starting ARM Keil installation"; \
        # Run installer asynchronously
        { \
            { \
                local exitCode; \
                exitCodeFile="$(mktemp)"; \
                { \
                    2>&1 WINEDEBUG=+all,trace-all,warn-all /usr/bin/entrypoint wine "$installer" --batch-install; \
                    echo "$?" > "$exitCodeFile"; \
                } \
                    # Write output to a log file when debugging
                    | { [ "$DEBUG" -eq 1 ] && tee "$logFile" || cat; } \
                    # Pipe stdout and stderr to `handle_output` function
                    | handle_output; \
                outputHandlerCode="$?"; \
                exitCode="$(cat "$exitCodeFile")"; \
                rm "$exitCodeFile"; \
                bash -c "exit $([ "$outputHandlerCode" -ne 0 ] && echo "$outputHandlerCode" || echo "$exitCode")"; \
            } & \
        }; \
        pid="$!"; \
        # Continuously display screenshots and iteration number
        [ "$DEBUG" -eq 1 ] \
        && { \
            { \
                x=0; \
                maxCount=120; \
                while ps -p "$pid" > /dev/null && [ "$x" -ne "$maxCount" ]; do \
                    # Create screenshot and print it to the console
                    fileName="$screenDir/install-try$try-$x.png"; \
                    import -window root "$fileName"; \
                    "$TIV" -w 10000 -h 10000 "$fileName"; \
                    x="$(expr "$x" + 1)"; \
                    echo "Frame #$x"; \
                    sleep 1; \
                done; \
                # Kill installer after timeout indicated by `maxCount`
                [ "$x" -eq "$maxCount" ] && { kill_installer; mv "$logFile" "$logDir/timeout-try$try.log"; }; \
            } & \
        }; \
        wait "$pid"; \
        exitCode="$?"; \
        # Rename log file according to the state of the installer
        [ "$DEBUG" -eq 1 ] \
        && [ -f "$logFile" ] \
        && { \
            # Move logs to location based on exit code
            [ "$exitCode" -eq 0 ] && mv "$logFile" "$logDir/success-try$try.log"; \
            [ "$exitCode" -eq 42 ] && mv "$logFile" "$logDir/timeout-handled-try$try.log"; \
            [ "$exitCode" -ne 0 ] && mv "$logFile" "$logDir/fail-try$try.log"; \
        }; \
        { \
            [ "$exitCode" -ne 0 ] && { \
                [ "$exitCode" -eq 42 ] && echo "The installation Got Stuck" || \
                echo "The Installation Failed"; \
            } || \
            echo "The Installation Was Successful"; \
            echo "Installation Process Exited With Code $exitCode"; \
        } | printHeading; \
        return "$exitCode"; \
    }; \
    # Handle console output of Keil uVision installer
    handle_output() { \
        # A pattern that is supposed to indicates that wine got stuck
        pattern="fixme:win:NtUserLockWindowUpdate ((nil))"; \
        # The amount of times the pattern should occur for the process to be considered stuck
        patternCount=2; \
        sed \
            -u \
            # Handle multiple occurrences of $pattern
            -e "/$pattern/{ x; s/^x\{$(expr $patternCount - 1)\}$/\0/; x; t stuck; x; s/^\(x*\)$/\1x/; x; };" \
            # Return to start
            -e "b;" \
            # Branch "stuck": delete output and exit with code 42
            -e ":stuck q42;" \
            # Branch "end": exit with code 0
            -e ":end q;"; \
        exitCode="$?"; \
        # Kill installer if it got stuck (according to console output)
        [ "$exitCode" -eq 42 ] && kill_installer; \
        # Use `sed`s exit code if non-zero
        [ "$exitCode" -ne 0 ] && exit "$exitCode" || \
        # Return true otherwise
        true; \
    }; \
    kill_installer() { \
        pkill -9 "$installerName" > /dev/null 2>&1; \
    }; \
    display=:90; \
    export DISPLAY="$display"; \
    mkdir -p --mode=777 /tmp/.X11-unix; \
    # Create job for waiting for Xvfb to start
    watchStarting="$(mktemp)"; \
    { 2>&1 inotifywait -e create /tmp/.X11-unix/; } | { sed -u -e "/^Watches established.\$/e rm \"$watchStarting\""; } & \
    resolver="$!"; \
    while [ -f "$watchStarting" ]; do true; done; \
    { \
        # Improve arguments for screenshots
        ARGS="$([ $DEBUG -eq 1 ] && echo "-screen 0 640x480x24 -dpi 192" || echo "")"; \
        Xvfb "${DISPLAY}" ${ARGS} & \
    }; \
    displayPID="$!"; \
    # Wait for Xvfb to start
    wait "$resolver"; \
    y=0; \
    while ! \
        install_keil \
            "$y" \
        ; \
    do \
        printHeading "Restarting Installation"; \
        # Increase counter
        y="$(expr "$y" + 1)"; \
    done && \
    kill -9 "$displayPID" > /dev/null 2>&1; \
    # Cleanup Unnecessary Files
    rm -f "$TIV"; \
    rm -rf "$(/usr/bin/entrypoint winepath 'C:\Keil_v5')/Backup."*; \
    rm "$installer"; \
    rm -f /tmp/.X*-lock; \
    [ "$DEBUG" -eq 1 ] && { \
        apt-get remove -y imagemagick; \
        apt-get autoremove -y; \
    } || true

RUN \
    keilConfig="$(/usr/bin/entrypoint winepath 'C:\Keil_v5\TOOLS.INI')" && \
    winAppData="$(/usr/bin/entrypoint wine cmd.exe /c 'echo %LOCALAPPDATA%' | tr -d '\r' | sed 's/\\/\\\\/g')" && \
    packDir="$winAppData"'\Arm\Packs' && \
    sed -i '/^RTEPATH=/d' "$keilConfig" && \
    echo 'RTEPATH="'"$packDir"'"' | sed -i '/\[UV2\]/ r /dev/stdin' "$keilConfig"

RUN \
    wget "${PACK_URL}" --progress=bar:force:noscroll --no-check-certificate -O InES.pack; \
    /usr/bin/entrypoint xvfb-run wine 'C:\Keil_v5\UV4\PackUnzip.exe' --embedded --agree-license InES.pack & \
    pid="$!"; \
    wait "$pid"; \
    rm InES.pack; \
    rm -f /tmp/.X*-lock;

RUN \
    apt-get update && \
    ln -s "$(which true)" /usr/bin/depmod && \
    wget https://github.com/stlink-org/stlink/releases/download/v1.7.0/stlink_1.7.0-1_amd64.deb --progress=bar:force:noscroll -O stlink.deb && \
    dpkg -i stlink.deb; \
    apt-get install --fix-broken -y && \
    rm -rf /var/lib/apt/lists/ && \
    rm stlink.deb

RUN ln -s /usr/bin/gdb-multiarch /usr/bin/arm-none-eabi-gdb
RUN echo "${USER_NAME} ALL=(ALL:ALL) NOPASSWD: ALL" > /etc/sudoers.d/keil

COPY ./compile.sh /bin/st-compile
RUN chmod a+x /bin/st-compile

ENV USER_NAME=${USER_NAME}