Adds new version of help50

.github/workflows/main.yml

@@ -1,16 +1,14 @@
 on: push
+
 jobs:
-  build:
+  build-amd64:
     runs-on: ubuntu-latest-64-cores
     steps:
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
-
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
 
       - name: Log into Docker Hub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
@@ -21,14 +19,16 @@ jobs:
           python-version: '3.11'
 
       - name: Build for linux/amd64
-        uses: docker/build-push-action@v3
+        uses: docker/build-push-action@v5
         with:
           build-args: |
             VCS_REF=${{ github.sha }}
             BUILDARCH=amd64
           load: true
           platforms: linux/amd64
-          tags: cs50/cli:amd64
+          tags: |
+            cs50/cli:amd64
+            cs50/cli:canary-amd64
           cache-from: type=registry,ref=cs50/cli:amd64-buildcache
           cache-to: type=registry,ref=cs50/cli:amd64-buildcache,mode=max
 
@@ -37,15 +37,55 @@ jobs:
         run: |
           docker push cs50/cli:amd64
 
+      - name: Push linux/amd64 build to Docker Hub (canary)
+        run: |
+          docker push cs50/cli:canary-amd64
+
+  build-arm64:
+    runs-on: ubuntu-latest-64-cores-arm
+    steps:
+      - name: Install Docker (remove once Docker is pre-installed on arm64 runners)
+        run: |
+          export DEBIAN_FRONTEND=noninteractive
+          sudo apt update
+          sudo apt install -y ca-certificates curl
+          sudo install -m 0755 -d /etc/apt/keyrings
+          sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
+          sudo chmod a+r /etc/apt/keyrings/docker.asc
+          echo \
+          "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
+          $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
+          sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
+          sudo apt update
+          sudo apt install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
+          sudo usermod -aG docker $USER
+          sudo apt install -y acl
+          sudo setfacl --modify user:$USER:rw /var/run/docker.sock
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log into Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Install Python (replace with setup-python once available on arm64 runners)
+        run: |
+          sudo apt install -y python3
+
       - name: Build for linux/arm64
-        uses: docker/build-push-action@v3
+        uses: docker/build-push-action@v5
         with:
           build-args: |
             VCS_REF=${{ github.sha }}
             BUILDARCH=arm64
           load: true
           platforms: linux/arm64
-          tags: cs50/cli:arm64
+          tags: |
+            cs50/cli:arm64
+            cs50/cli:canary-arm64
           cache-from: type=registry,ref=cs50/cli:arm64-buildcache
           cache-to: type=registry,ref=cs50/cli:arm64-buildcache,mode=max
 
@@ -54,6 +94,20 @@ jobs:
         run: |
           docker push cs50/cli:arm64
 
+      - name: Push linux/arm64 build to Docker Hub (canary)
+        run: |
+          docker push cs50/cli:canary-arm64
+
+  finalize:
+    needs: [build-amd64, build-arm64]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Log into Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
       - name: Create multi-arch manifest and push to Docker Hub
         if: ${{ github.ref == 'refs/heads/main' }}
         run: |
@@ -62,9 +116,16 @@ jobs:
           --amend cs50/cli:arm64
           docker manifest push cs50/cli:latest
 
+      - name: Create multi-arch manifest and push to Docker Hub (canary)
+        run: |
+          docker manifest create cs50/cli:canary \
+          --amend cs50/cli:canary-amd64 \
+          --amend cs50/cli:canary-arm64
+          docker manifest push cs50/cli:canary
+
       - name: Re-deploy depdendents
         if: ${{ github.ref == 'refs/heads/main' }}
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         with:
           github-token: ${{ secrets.DEPLOY50_PAT }}
           script: |
@@ -78,4 +139,4 @@ jobs:
                   workflow_id: 'main.yml',
                   ref: 'main'
                 });
-            }
+            }

Dockerfile

@@ -171,11 +171,13 @@ RUN apt update && \
         build-essential `# dpkg-dev, libc, gcc, g++, make, etc.`\
         ca-certificates \
         clang \
+        colorized-logs `# For help50` \
         coreutils `# For fold` \
         cowsay \
         curl \
         dos2unix \
         dnsutils `# For nslookup` \
+        expect `# For help50` \
         fonts-noto-color-emoji `# For render50` \
         gdb \
         git \
@@ -243,7 +245,6 @@ RUN pip3 install --no-cache-dir \
         cs50 \
         Flask \
         Flask-Session \
-        help50 \
         pytest \
         render50 \
         setuptools \

Makefile

@@ -13,7 +13,7 @@ rebuild:
 	docker build --build-arg VCS_REF=$(shell git rev-parse HEAD) --no-cache --tag $(IMAGE) .
 
 run:
-	docker run --env LANG=$(LANG) --env LOCAL_WORKSPACE_FOLDER="$(PWD)" --interactive --publish-all --rm --security-opt seccomp=unconfined --tty --volume "$(PWD)":/mnt --volume /var/run/docker.sock:/var/run/docker-host.sock --workdir /mnt $(IMAGE) bash --login || true
+	docker run --env LANG=$(LANG) --env LOCAL_WORKSPACE_FOLDER="$(PWD)" --env WORKDIR=/mnt --interactive --publish-all --rm --security-opt seccomp=unconfined --tty --volume "$(PWD)":/mnt --volume /var/run/docker.sock:/var/run/docker-host.sock --workdir /mnt cs50/cli bash --login || true
 
 squash: depends
 	docker-squash --tag $(IMAGE) $(IMAGE)

etc/profile.d/cli.sh

@@ -1,5 +1,5 @@
 # If not root
-if [ "$(whoami)" != "root" ]; then
+if [ `id -u` -ne 0 ]; then
 
     # $PATH
     export PATH="/opt/cs50/bin":"/opt/bin":"$PATH"
@@ -60,4 +60,9 @@ if [ "$(whoami)" != "root" ]; then
 
     # Valgrind
     export VALGRIND_OPTS="--memcheck:leak-check=full --memcheck:show-leak-kinds=all --memcheck:track-origins=yes"
+
+    ## TODO: Start help50 if enabled
+    # if help50 is-enabled > /dev/null; then
+    #     help50 start
+    # fi
 fi

etc/profile.d/help50.sh

@@ -0,0 +1,114 @@
+# If not started
+if [[ -z "$HELP50" ]]; then
+    return
+fi
+
+# Directory with helpers
+HELPERS="/opt/cs50/lib/help50"
+
+# Library
+. /opt/cs50/lib/cli
+
+# Ignore duplicates (but not commands that begin with spaces)
+export HISTCONTROL="ignoredups"
+
+function _help50() {
+
+    # Get exit status of last command
+    local status=$?
+
+    # Get last command line, independent of user's actual history
+    histfile=$(mktemp)
+    HISTFILE=$histfile history -a
+    local argv=$(HISTFILE=$histfile history 1 | cut -c 8-) # Could technically contain multiple commands, separated by ; or &&
+    rm --force $histfile
+
+    # Remove aliases
+    for name in n no y yes; do
+        unalias $name 2> /dev/null
+    done
+
+    # If last command erred (and is not ctl-c or ctl-z)
+    # https://tldp.org/LDP/abs/html/exitcodes.html
+    if [[ $status -ne 0 && $status -ne 130 && $status -ne 148 ]]; then
+
+        # Ignore ./* if executable file
+        local argv0=$(echo "$argv" | awk '{print $1}') # Assume for simplicity it's just a single command
+        if [[ "$argv0" =~ ^\./ && -f "$argv0" && -x "$argv0" ]]; then
+            break
+        fi
+
+        # Read typescript from disk
+        local typescript=$(cat $HELP50)
+
+        # Remove script's own output (if this is user's first command)
+        typescript=$(echo "$typescript" | sed '1{/^Script started on .*/d}')
+
+        # Cap typescript at MIN(1K lines, 1M bytes), else `read` is slow
+        typescript=$(echo "$typescript" | head -n 1024 | cut -b 1-1048576)
+
+        # Remove any line continuations from command line
+        local lines=""
+        while IFS= read -r line || [[ -n "$line" ]]; do
+            if [[ -z $done && $line =~ \\$ ]]; then
+                lines+="${line%\\}"
+            else
+                lines+="$line"$'\n'
+                local done=1
+            fi
+        done <<< "$typescript"
+        typescript="$lines"
+
+        # Remove command line from typescript
+        typescript=$(echo "$typescript" | sed '1d')
+
+        # Remove ANSI characters
+        typescript=$(echo "$typescript" | ansi2txt)
+
+        # Remove control characters
+        # https://superuser.com/a/237154
+        typescript=$(echo "$typescript" | col -bp)
+
+        # Try to get help
+        for helper in $HELPERS/*; do
+            if [[ -f $helper && -x $helper ]]; then
+                local help=$($helper <<< "$typescript")
+                if [[ -n "$help" ]]; then
+                    break
+                fi
+            fi
+        done
+        if [[ -n "$help" ]]; then # If helpful
+            _helpful "$help"
+        elif [[ $status -ne 0 ]]; then # If helpless
+            _helpless "$typescript"
+        fi
+    fi
+
+    # Truncate typescript
+    truncate -s 0 $HELP50
+}
+
+function _question() {
+    _alert "That was a rhetorical question. :)"
+}
+
+# Default helpers
+if ! type _helpful >/dev/null 2>&1; then
+    function _helpful() {
+
+        # Intercept accidental invocation of `yes` and `n`, which are actual programs
+        for name in n no y yes; do
+            alias $name=_question
+        done
+
+        # Output help
+        local output=$(_ansi "$1")
+        _alert "$output"
+    }
+fi
+if ! type _helpless >/dev/null 2>&1; then
+    function _helpless() { :; } # Silent
+fi
+
+export PROMPT_COMMAND=_help50