Add tests for dev containers

.devcontainer/Dockerfile

@@ -0,0 +1,37 @@
+FROM rocker/rstudio:4.0.5
+
+LABEL org.opencontainers.image.source https://github.com/opensafely/research-template
+
+# we are going to use an apt cache on the host, so disable the default debian
+# docker clean up that deletes that cache on every apt install
+RUN rm -f /etc/apt/apt.conf.d/docker-clean
+
+# Install python 3.10. This is the version used by the python-docker 
+# image, used for analyses using the OpenSAFELY pipeline.
+RUN --mount=type=cache,target=/var/cache/apt \
+    echo "deb http://ppa.launchpadcontent.net/deadsnakes/ppa/ubuntu focal main" > /etc/apt/sources.list.d/deadsnakes-ppa.list &&\
+    /usr/lib/apt/apt-helper download-file 'https://keyserver.ubuntu.com/pks/lookup?op=get&search=0xf23c5a6cf475977595c89f51ba6932366a755776' /etc/apt/trusted.gpg.d/deadsnakes.asc &&\
+    apt update &&\
+    apt install -y curl python3.10 python3.10-distutils python3.10-venv &&\
+    # Pip for Python 3.10 isn't included in deadsnakes, so install separately
+    curl https://bootstrap.pypa.io/get-pip.py | python3.10 &&\
+    # Set default python, so that the Python virtualenv works as expected
+    rm /usr/bin/python3 && ln -s /usr/bin/python3.10 /usr/bin/python3
+
+# install renv
+RUN --mount=type=cache,target=/cache,id=/cache-2004 R -e 'install.packages("renv", destdir="/cache"); renv::init(bare = TRUE)'
+
+# copy the renv directory from the OpenSAFELY R action image
+COPY --from=ghcr.io/opensafely-core/r /renv/ /renv/
+
+# Copy the Python virtualenv from OpenSAFELY Python action image
+COPY --from=ghcr.io/opensafely-core/python:v2 /opt/venv /opt/venv
+
+# Create a local user and give it sudo (aka root) permissions
+RUN usermod -aG sudo rstudio
+RUN echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers
+
+# Required for installing opensafely cli
+ENV PATH="/home/rstudio/.local/bin:${PATH}"
+
+USER rstudio

.devcontainer/devcontainer.json

@@ -1,12 +1,8 @@
 // For format details, see https://aka.ms/devcontainer.json. For config options, see the
 // README at: https://github.com/devcontainers/templates/tree/main/src/python
 {
-    "name": "Python 3",
-    // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
-    // 2023-06-29: Use bullseye image instead of bookworm.
-    // At time of writing, bookworm is new and may have issues with dev containers:
-    // https://github.com/devcontainers/features/issues/576
-    "image": "mcr.microsoft.com/devcontainers/python:3.11-bullseye",
+    "name": "OpenSAFELY",
+    "image": "ghcr.io/opensafely/research-template:latest",
     // Features to add to the dev container. More info: https://containers.dev/features.
     "features": {
         "ghcr.io/devcontainers/features/docker-in-docker:2": {
@@ -17,18 +13,36 @@
             "dockerDashComposeVersion": "v2"
         }
     },
-    // Use 'forwardPorts' to make a list of ports inside the container available locally.
-    // "forwardPorts": [],
-    // Use 'postCreateCommand' to run commands after the container is created.
-    "postCreateCommand": "pip3 install --user -r .devcontainer/requirements.in",
+    "postCreateCommand": "/bin/bash .devcontainer/postCreate.sh",
+    "postAttachCommand": {
+        "rstudio-start": "sudo rstudio-server start"
+    },
+    "forwardPorts": [
+        8787
+    ],
+    "portsAttributes": {
+        "8787": {
+            "label": "RStudio IDE"
+        }
+    },
     // Configure tool-specific properties.
     "customizations": {
         "vscode": {
             "extensions": [
                 "ms-python.python",
                 "ms-toolsai.jupyter",
                 "ms-toolsai.jupyter-renderers"
-            ]
+            ],
+            "settings": {
+                "extensions.ignoreRecommendations": true,
+                "files.autoSave": "afterDelay",
+                "files.autoSaveDelay": 1000,
+                "git.autofetch": true,
+                "python.analysis.extraPaths": [".devcontainer/ehrql-main/"],
+                "python.defaultInterpreterPath": "/opt/venv/bin/python3.10",
+                "python.terminal.activateEnvironment": true,
+                "window.autoDetectColorScheme": true
+            }
         }
     },
     // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.

.devcontainer/postCreate.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+set -euo pipefail 
+
+pip3 install --user -r .devcontainer/requirements.in
+
+#set R working directory
+! grep -q `pwd` $R_HOME/etc/Rprofile.site && sudo tee -a $R_HOME/etc/Rprofile.site <<< "setwd(\"`pwd`\")"
+#set RStudio working directory
+! grep -q `pwd` ~/.config/rstudio/rstudio-prefs.json && cat ~/.config/rstudio/rstudio-prefs.json | jq ". + {\"initial_working_directory\":\"`pwd`\"}" >  ~/.config/rstudio/rstudio-prefs.json 
+
+#download and extract latest ehrql source
+wget https://github.com/opensafely-core/ehrql/archive/main.zip -P .devcontainer
+unzip -o .devcontainer/main.zip -d .devcontainer/
+rm .devcontainer/main.zip

.devcontainer/requirements.in

@@ -1,2 +1 @@
 opensafely
-https://github.com/opensafely-core/ehrql/archive/main.zip

.github/workflows/test_devcontainers.yaml

@@ -0,0 +1,31 @@
+name: 'Test devcontainers'
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-13]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout (GitHub)
+        uses: actions/checkout@v4
+
+      - name: Setup macOS Docker
+        if: runner.os == 'macos'
+        run: |
+          brew install colima docker
+          brew services start colima
+
+      - name: Setup macOS Docker Buildx
+        if: runner.os == 'macos'
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build and run dev container task
+        uses: devcontainers/[email protected]
+        with:
+          runCmd: opensafely run run_all

.gitignore

@@ -9,3 +9,5 @@ venv/
 .DS_Store
 .Rhistory
 .Rproj.user/
+
+.devcontainer/ehrql-main