add huggingface mirrors

README.md

@@ -14,6 +14,7 @@ Automatically setup package manager mirrors, including ubuntu, pypi and apk etc.
             "ubuntu_mirror": "<your-ubuntu-mirror-domain>",  // only applicable to Ubuntu based images
             "apk_mirror": "<your-alpine-apk-mirror-domain>", // only applicable to Alpine based images
             "pypi_mirror": "https://<your-pypi-mirror-domain>/pypi/web/simple/",
+            "huggingface_mirror": "https://dummy-hf-mirror.com"
         }
     }
 }

src/magicmirror/devcontainer-feature.json

@@ -1,7 +1,7 @@
 {
     "name": "MagicMirror",
     "id": "magicmirror",
-    "version": "1.0.1",
+    "version": "1.0.2",
     "description": "Automatic mirror setup for package managers like apt, pypi, apk etc.",
     "options": {
         "pypi_mirror": {
@@ -27,6 +27,14 @@
             ],
             "default": "",
             "description": "Alpine apk mirror"
+        },
+        "huggingface_mirror": {
+            "type": "string",
+            "proposals": [
+                "https://hf-mirror.com"
+            ],
+            "default": "",
+            "description": "Huggingface mirror"
         }
     },
     "installsAfter": [

src/magicmirror/install.sh

@@ -11,7 +11,6 @@ echo "Activating feature 'magicmirror'"
 # For more details, see https://containers.dev/implementors/features#user-env-var
 echo "The effective dev container remoteUser is '$_REMOTE_USER'"
 echo "The effective dev container remoteUser's home directory is '$_REMOTE_USER_HOME'"
-
 echo "The effective dev container containerUser is '$_CONTAINER_USER'"
 echo "The effective dev container containerUser's home directory is '$_CONTAINER_USER_HOME'"
 
@@ -23,18 +22,19 @@ UBUNTU_MIRROR=${UBUNTU_MIRROR:-""}
 echo "UBUNTU_MIRROR: $UBUNTU_MIRROR"
 if [ "${OS}" = '"Ubuntu"' ] && [ -n "${UBUNTU_MIRROR}" ]; then
     echo "Creating /etc/apt/sources.list with mirror = ${UBUNTU_MIRROR}"
-    cp /etc/apt/sources.list /etc/apt/sources.list.bak
-    sed -i s/archive.ubuntu.com/$UBUNTU_MIRROR/g /etc/apt/sources.list
-    sed -i s/security.ubuntu.com/$UBUNTU_MIRROR/g /etc/apt/sources.list
-    sed -i s/ports.ubuntu.com/$UBUNTU_MIRROR/g /etc/apt/sources.list
+    cp /etc/apt/sources.list /etc/apt/sources.list.mm.bak
+    sed -i "s/archive.ubuntu.com/${UBUNTU_MIRROR}/g" /etc/apt/sources.list
+    sed -i "s/security.ubuntu.com/${UBUNTU_MIRROR}/g" /etc/apt/sources.list
+    sed -i "s/ports.ubuntu.com/${UBUNTU_MIRROR}/g" /etc/apt/sources.list
 fi
 
 # Pypi mirror. TODO[sidecus]: Check Python installation
 PYPI_MIRROR=${PYPI_MIRROR:-""}
 echo "PYPI_MIRROR: $PYPI_MIRROR"
 if [ -n "${PYPI_MIRROR}" ]; then
-    echo "Creating /etc/pip.conf with index-url = ${PYPI_MIRROR}"
-    echo "[global]" > /etc/pip.conf
+    echo "Seting up pypi mirror via /etc/pip.conf: index-url = ${PYPI_MIRROR}"
+    touch /etc/pip.conf && cp /etc/pip.conf /etc/pip.conf.mm.bak
+    echo "[global]" >> /etc/pip.conf
     echo "index-url = ${PYPI_MIRROR}" >> /etc/pip.conf
 fi
 
@@ -43,5 +43,16 @@ APK_MIRROR=${APK_MIRROR:-""}
 echo "APK_MIRROR: $APK_MIRROR"
 if [ "${OS}" = '"Alpine Linux"' ] && [ -n "${APK_MIRROR}" ]; then
     echo "Creating /etc/apk/repositories with mirror = ${APK_MIRROR}"
+    cp /etc/apk/repositories /etc/apk/repositories.mm.bak
     sed -i "s/dl-cdn.alpinelinux.org/${APK_MIRROR}/g" /etc/apk/repositories
-fi
+fi
+
+# Set Huggingface mirror if it's provided
+HUGGINGFACE_MIRROR=${HUGGINGFACE_MIRROR:-""}
+echo "HUGGINGFACE_MIRROR: $HUGGINGFACE_MIRROR"
+if [ -n "${HUGGINGFACE_MIRROR}" ]; then
+    echo "Enabling Huggingface mirror: ${HUGGINGFACE_MIRROR}"
+    touch /etc/environment && cp /etc/environment /etc/environment.mm.bak
+    echo "HF_ENDPOINT=${HF_ENDPOINT}" >> /etc/environment
+    set -a; . /etc/environment; set +a;
+fi

test/magicmirror/hf.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+# This test file will be executed against one of the scenarios devcontainer.json test that
+# includes the 'magicmirror' feature with "huggingface_mirror" option.
+
+set -e
+
+# Optional: Import test library bundled with the devcontainer CLI
+source dev-container-features-test-lib
+
+# Feature-specific tests
+# The 'check' command comes from the dev-container-features-test-lib.
+check "test HF mirror" bash -c '[ "${HF_ENDPOINT}"="https://dummy-hf-mirror.com" ];'
+
+# Report results
+# If any of the checks above exited with a non-zero exit code, the test will fail.
+reportResults

test/magicmirror/pypi.sh

@@ -10,7 +10,7 @@ source dev-container-features-test-lib
 
 # Feature-specific tests
 # The 'check' command comes from the dev-container-features-test-lib.
-check "test pypi mirror" bash -c "cat /etc/pip.conf | grep 'index-url = dummy-pypi-mirror'"
+check "test pypi mirror" bash -c "cat /etc/pip.conf | grep 'index-url = https://dummy-pypi-mirror.com/pypi/web/simple/'"
 
 # Report results
 # If any of the checks above exited with a non-zero exit code, the test will fail.

test/magicmirror/scenarios.json

@@ -3,23 +3,31 @@
         "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
         "features": {
             "magicmirror": {
-                "ubuntu_mirror": "dummy-ubuntu-mirror"
+                "ubuntu_mirror": "dummy-ubuntu-mirror.com"
             }
         }
     },
     "pypi": {
         "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
         "features": {
             "magicmirror": {
-                "pypi_mirror": "dummy-pypi-mirror"
+                "pypi_mirror": "https://dummy-pypi-mirror.com/pypi/web/simple/"
             }
         }
     },
     "apk": {
         "image": "mcr.microsoft.com/devcontainers/base:alpine",
         "features": {
             "magicmirror": {
-                "apk_mirror": "dummy-apk-repo"
+                "apk_mirror": "dummy-apk-repo.com"
+            }
+        }
+    },
+    "hf": {
+        "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
+        "features": {
+            "magicmirror": {
+                "huggingface_mirror": "https://dummy-hf-mirror.com"
             }
         }
     }