feat: add support for python 3.10 (#101)

Author: briandealwis

python/helper-image/Dockerfile

@@ -14,9 +14,9 @@
 
 # This Dockerfile creates a debug helper base image for Python.
 # It provides installations of debugpy, ptvsd, pydevd, and pydevd-pycharm
-# for Python 2.7, 3.5, 3.6, 3.7, 3.8, and 3.9.
+# for Python 2.7, 3.5, 3.6, 3.7, 3.8, 3.9, and 3.10.
 #   - Apache Beam is based around Python 3.5
-#   - Many ML/NLP images are based on Python 3.6
+#   - Many ML/NLP images are based on Python 3.5 and 3.6
 #
 # debugpy and ptvsd are well-structured packages installed in separate
 # directories under # /dbg/python/lib/pythonX.Y/site-packages and
@@ -69,15 +69,26 @@ COPY pydevd.patch .
 RUN patch -p0 -d /dbgpy/pydevd/python3.9/lib/python3.9/site-packages < pydevd.patch
 RUN PYTHONUSERBASE=/dbgpy/pydevd-pycharm/python3.9 pip install --user pydevd-pycharm --no-warn-script-location
 
-FROM golang:1.17 as build
+FROM python:3.10 as python3_10
+RUN PYTHONUSERBASE=/dbgpy pip install --user ptvsd debugpy
+RUN PYTHONUSERBASE=/dbgpy/pydevd/python3.10 pip install --user pydevd --no-warn-script-location
+COPY pydevd.patch .
+RUN patch -p0 -d /dbgpy/pydevd/python3.10/lib/python3.10/site-packages < pydevd.patch
+RUN PYTHONUSERBASE=/dbgpy/pydevd-pycharm/python3.10 pip install --user pydevd-pycharm --no-warn-script-location
+
+FROM --platform=$BUILDPLATFORM golang:1.17 as build
+ARG BUILDPLATFORM
+ARG TARGETOS
+ARG TARGETARCH
 COPY launcher/ .
 # Produce an as-static-as-possible wrapper binary to work on musl and glibc
-RUN GOPATH="" CGO_ENABLED=0 go build -o launcher -ldflags '-s -w -extldflags "-static"' .
+RUN GOPATH="" CGO_ENABLED=0 GOOS=$TARGETOS GOARCH=$TARGETARCH \
+  go build -o launcher -ldflags '-s -w -extldflags "-static"' .
 
 # Now populate the duct-tape image with the language runtime debugging support files
 # The debian image is about 95MB bigger
-FROM busybox
-ARG BUILDPLATFORM
+FROM --platform=$TARGETPLATFORM busybox
+ARG TARGETPLATFORM
 
 # The install script copies all files in /duct-tape to /dbg
 COPY install.sh /
@@ -89,4 +100,5 @@ COPY --from=python36 /dbgpy/ python/
 COPY --from=python37 /dbgpy/ python/
 COPY --from=python38 /dbgpy/ python/
 COPY --from=python39 /dbgpy/ python/
+COPY --from=python3_10 /dbgpy/ python/
 COPY --from=build /go/launcher python/

python/skaffold.yaml

@@ -52,6 +52,14 @@ profiles:
           docker:
             buildArgs:
               PYTHONVERSION: "3.9"
+      - op: add
+        path: /build/artifacts/-
+        value:
+          image: python310app
+          context: test/pythonapp
+          docker:
+            buildArgs:
+              PYTHONVERSION: "3.10"
       - op: add
         path: /build/artifacts/-
         value:
@@ -61,6 +69,7 @@ profiles:
       kubectl:
         manifests:
           - test/k8s-test-pydevd-python39.yaml
+          - test/k8s-test-pydevd-python310.yaml
 
   # release: pushes images to production with :latest
   - name: release

python/structure-tests-python.yaml

@@ -55,6 +55,15 @@ fileExistenceTests:
   - name: 'pydevd-pycharm for python 3.9'
     path: '/duct-tape/python/pydevd-pycharm/python3.9/lib/python3.9/site-packages/pydevd.py'
 
+  - name: 'ptvsd for python 3.10'
+    path: '/duct-tape/python/lib/python3.10/site-packages/ptvsd/__init__.py'
+  - name: 'debugpy for python 3.10'
+    path: '/duct-tape/python/lib/python3.10/site-packages/debugpy/__init__.py'
+  - name: 'pydevd for python 3.10'
+    path: '/duct-tape/python/pydevd/python3.10/lib/python3.10/site-packages/pydevd.py'
+  - name: 'pydevd-pycharm for python 3.10'
+    path: '/duct-tape/python/pydevd-pycharm/python3.10/lib/python3.10/site-packages/pydevd.py'
+
   - name: 'python launcher'
     path: '/duct-tape/python/launcher'
     isExecutableBy: any

python/test/k8s-test-pydevd-python310.yaml

@@ -0,0 +1,77 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: python310pod
+  labels:
+    app: hello
+    protocol: pydevd
+    runtime: python310
+spec:
+  containers:
+  - name: python310app
+    image: python310app
+    command: ["/dbg/python/launcher", "--mode", "pydevd", "--port", "12345", "--"]
+    args: ["python", "-m", "flask", "run", "--host=0.0.0.0"]
+    ports:
+    - containerPort: 5000
+    - containerPort: 12345
+      name: pydevd
+    env:
+    - name: WRAPPER_VERBOSE
+      value: debug
+    readinessProbe:
+      httpGet:
+        path: /
+        port: 5000
+    volumeMounts:
+    - mountPath: /dbg
+      name: python-debugging-support
+  initContainers:
+  - image: skaffold-debug-python
+    name: install-python-support
+    resources: {}
+    volumeMounts:
+    - mountPath: /dbg
+      name: python-debugging-support
+  volumes:
+  - emptyDir: {}
+    name: python-debugging-support
+
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: hello-pydevd-python310
+spec:
+  ports:
+  - name: http
+    port: 5000
+    protocol: TCP
+  - name: pydevd
+    port: 12345
+    protocol: TCP
+  selector:
+    app: hello
+    protocol: pydevd
+    runtime: python310
+
+---
+apiVersion: batch/v1
+kind: Job
+metadata:
+  name: connect-to-python310
+  labels:
+    project: container-debug-support
+    type: integration-test
+spec:
+  ttlSecondsAfterFinished: 10
+  backoffLimit: 1
+  template:
+    spec:
+      restartPolicy: Never
+      containers:
+      - name: verify-python310
+        image: pydevconnect
+        args: ["hello-pydevd-python310:12345"]
+
+

run-its.sh

@@ -33,5 +33,5 @@ while [ $jobcount -eq 0 -o $jobcount -ne $(countTestJobs) ]; do
 done
 
 echo ">> Monitoring for test job completion [$(date)]"
-kubectl wait --for=condition=complete job.batch \
+kubectl wait --for=condition=complete job.batch --timeout=120s \
     -l project=container-debug-support,type=integration-test