restore use of Dockerfile for devcontainer

Author: gilesknap

.devcontainer.json

@@ -1,7 +1,14 @@
 // For format details, see https://aka.ms/devcontainer.json
 {
     "name": "Python 3 Developer Container",
-    "image": "python:3.11",
+    "build": {
+        "dockerfile": "Dockerfile",
+        "target": "build",
+        "context": ".",
+        "args": {
+            "PIP_OPTIONS": "-e .[dev]"
+        }
+    },
     "remoteEnv": {
         "DISPLAY": "${localEnv:DISPLAY}"
     },
@@ -19,6 +26,7 @@
     "initializeCommand": "bash -c 'for i in $HOME/.inputrc; do [ -f $i ] || touch $i; done'",
     "runArgs": [
         "--net=host",
+        "--security-opt=label=type:container_runtime_t",
         "-v=${localEnv:HOME}/.ssh:/root/.ssh",
         "-v=${localEnv:HOME}/.inputrc:/root/.inputrc"
     ],
@@ -28,7 +36,5 @@
     ],
     // make the workspace folder the same inside and outside of the container
     "workspaceMount": "source=${localWorkspaceFolder},target=${localWorkspaceFolder},type=bind",
-    "workspaceFolder": "${localWorkspaceFolder}",
-    // After the container is created, install the python project in editable form
-    "postCreateCommand": "pip install -e .[dev]"
+    "workspaceFolder": "${localWorkspaceFolder}"
 }

.github/workflows/code.yml

@@ -104,9 +104,8 @@ jobs:
           install_options: dist/*.whl
 
       - name: Test module --version works using the installed wheel
-        run: |
-          # If more than one module in src/ replace with module name to test
-          python -m $(ls src | head -1) --version
+        # If more than one module in src/ replace with module name to test
+        run: python -m $(ls src | head -1) --version
 
   container:
     needs: [lint, dist, test]
@@ -151,6 +150,8 @@ jobs:
       - name: Build runtime image
         uses: docker/build-push-action@v3
         with:
+          build-args: |
+            PIP_OPTIONS=-r lockfiles/requirements.txt dist/*.whl
           push: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags') }}
           load: ${{ ! (github.event_name == 'push' && startsWith(github.ref, 'refs/tags')) }}
           tags: ${{ steps.meta.outputs.tags }}

Dockerfile

@@ -1,8 +1,13 @@
-# This file is for use as a runtime container only, it depends on dist/
-# and lockfiles being made outside the container
-FROM python:3.11-slim as base
+# This file is for use as a devcontainer and a runtime container
+#
+# The devcontainer should use the build target and run as root with podman
+# or docker with user namespaces.
+#
+FROM python:3.11 as base
 FROM base as build
 
+ARG PIP_OPTIONS
+
 # Add any system dependencies for the developer/build environment here e.g.
 # RUN apt-get update && apt-get upgrade -y && \
 #     apt-get install -y --no-install-recommends \
@@ -17,10 +22,10 @@ ENV PATH=/venv/bin:$PATH
 COPY . /project
 WORKDIR /project
 
-# install the wheel
-RUN pip install -r lockfiles/requirements.txt dist/*.whl
+# install python package into /venv
+RUN pip install ${PIP_OPTIONS}
 
-FROM base as runtime
+FROM python:3.11-slim as runtime
 
 # Add apt-get system dependecies for runtime here if needed