Install swiftly into vscode-swift devcontainer (#1922)

- Pull from nightly image to always have latest deps
- Install swiftly and add to bashrc to use swiftly toolchain
- Add "vscode" user and password in docker file
- Force always prompting for sudo password for "vscode" user to help testing askpass

Author: award999

.devcontainer/Dockerfile

@@ -1,5 +1,6 @@
-FROM swiftlang/swift:nightly-6.2-jammy
+FROM swiftlang/swift:nightly-jammy
 
+#  python3-lldb-13 is only needed for swiftly and a great dep to remove to test post-install script ;)
 RUN export DEBIAN_FRONTEND=noninteractive DEBCONF_NONINTERACTIVE_SEEN=true \
     && apt-get -q update \
     && apt-get -q dist-upgrade -y \
@@ -9,8 +10,11 @@ RUN export DEBIAN_FRONTEND=noninteractive DEBCONF_NONINTERACTIVE_SEEN=true \
       libsqlite3-dev \
       libncurses5-dev \
       python3 \
-      build-essential
+      python3-lldb-13 \
+      build-essential \
+      sudo
 
+# Install nvm / Node.js
 RUN mkdir -p /usr/local/nvm
 ENV NVM_DIR /usr/local/nvm
 ENV NODE_VERSION v20.19.0
@@ -21,3 +25,24 @@ ENV PATH $NODE_PATH:$PATH
 RUN npm -v
 RUN node -v
 
+# Create a "vscode" user that is a sudoer
+RUN useradd -ms /bin/bash vscode
+RUN echo "vscode:vscode" | chpasswd
+RUN adduser vscode sudo
+
+# Install swiftly
+USER vscode
+ENV SWIFTLY_HOME_DIR /home/vscode/.swiftly
+ENV SWIFTLY_BIN_DIR /home/vscode/.swiftly/bin
+ENV SWIFTLY_TOOLCHAINS_DIR /home/vscode/.swiftly/bin
+RUN mkdir -p $SWIFTLY_HOME_DIR
+RUN cd ~ && curl -O https://download.swift.org/swiftly/linux/swiftly-$(uname -m).tar.gz && \
+    tar zxf swiftly-$(uname -m).tar.gz && \
+    ./swiftly init --quiet-shell-followup && \
+    . "${SWIFTLY_HOME_DIR}/env.sh" && \
+    hash -r
+
+# Use swiftly toolchain by default
+RUN echo "export SWIFTLY_HOME_DIR=$SWIFTLY_HOME_DIR" >> ~/.bashrc
+RUN echo "export SWIFTLY_BIN_DIR=$SWIFTLY_BIN_DIR" >> ~/.bashrc
+RUN echo '. "${SWIFTLY_HOME_DIR}/env.sh"' >> ~/.bashrc

.devcontainer/devcontainer.json

@@ -4,9 +4,6 @@
     "features": {
         "ghcr.io/devcontainers/features/common-utils:2": {
             "installZsh": "false",
-            "username": "vscode",
-            "userUid": "1000",
-            "userGid": "1000",
             "upgradePackages": "false"
         },
         "ghcr.io/devcontainers/features/git:1": {
@@ -35,7 +32,8 @@
         "source=node_modules,target=${containerWorkspaceFolder}/node_modules,type=volume"
     ],
     // Use 'postCreateCommand' to run commands after the container is created.
-    "postCreateCommand": "sudo chown vscode node_modules && npm install",
+    // Modify /etc/sudoers.d/vscode to make sure we're always prompted for root password for testing askpass.
+    "postCreateCommand": "sudo chown vscode node_modules && echo 'vscode ALL=(ALL:ALL) ALL' | sudo tee /etc/sudoers.d/vscode && npm install",
     // Set `remoteUser` to `root` to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
     "remoteUser": "vscode"
 }