Merge branch 'init' into 'main'

Add first implementation

Closes #1

See merge request divio/incubator/multi-python!1

Author: derlin

.gitlab-ci.yml

@@ -0,0 +1,35 @@
+image: docker:latest
+
+include:
+  - project: divio/infra/gitlab-pipelines
+    ref: master
+    file: docker-project/.gitlab-ci.yml
+
+variables:
+  PUBLIC_REPOSITORY: divio/multi-python
+  PUBLIC_CREDS: ${DOCKER_HUB_USER}:${DOCKER_HUB_TOKEN}
+
+build-docker-image:
+  before_script:
+    - !reference [.buildx, install]
+    # Update the QEMU version, this is required for libc-bin on ARM
+    - docker run --rm --privileged linuxkit/binfmt:af88a591f9cc896a52ce596b9cf7ca26a061ef97
+
+test:
+  stage: qa
+  needs: [build-docker-image]
+  image: ${CI_REGISTRY_IMAGE}/build:${CI_PIPELINE_IID}
+  except:
+    - tags
+  script:
+    - cd test && tox
+
+release-latest-docker-image:
+  variables:
+    DST_REGISTRY_CREDS: ${PUBLIC_CREDS}
+    TARGET_IMAGE_NAME: ${PUBLIC_REPOSITORY}:latest
+
+release-tag-docker-image:
+  variables:
+    DST_REGISTRY_CREDS: ${PUBLIC_CREDS}
+    TARGET_IMAGE_NAME: ${PUBLIC_REPOSITORY}:${CI_COMMIT_TAG}

Dockerfile

@@ -0,0 +1,89 @@
+FROM ubuntu:22.04
+
+## Main python version to install + use for tox
+ARG PYTHON_MAIN_VERSION=3.11
+## Other python versions to install
+# Must be available either in the deadsnakes PPA or in
+# the official Ubuntu repositories
+ARG PYTHON_OTHER_VERSIONS="3.7 3.8 3.9 3.10"
+## PyPy version to install
+# for versions see https://www.pypy.org/download.html
+ARG PYTHON_PYPY_VERSION=3.9-v7.3.12
+## GPG key for the deadsnakes PPA
+# See https://launchpad.net/~deadsnakes/+archive/ubuntu/ppa
+ARG DEADSNAKES_GPG_KEY=F23C5A6CF475977595C89F51BA6932366A755776
+
+ARG TARGETARCH
+ENV DEBIAN_FRONTEND=noninteractive
+
+# Install common build dependencies, add deadsnakes PPA and cleanup.
+# (see https://github.com/deadsnakes)
+# hadolint ignore=DL3008,SC2086
+RUN set -eux \
+  ; apt-get update \
+  ; apt-get install -y --no-install-recommends \
+      ca-certificates \
+      g++ \
+      gcc \
+      git \
+      curl \
+      bzip2 \
+      make \
+  ; savedAptMark="$(apt-mark showmanual)" \
+  \
+  ; apt-get install -y --no-install-recommends \
+      dirmngr \
+      gnupg \
+  \
+  ; tmp_home="$(mktemp -d)"; export GNUPGHOME="$tmp_home" \
+  ; gpg --keyserver hkps://keyserver.ubuntu.com --recv-keys "$DEADSNAKES_GPG_KEY" \
+  ; gpg -o /usr/share/keyrings/deadsnakes.gpg --export "$DEADSNAKES_GPG_KEY" \
+  ; echo "deb [arch=amd64,arm64 signed-by=/usr/share/keyrings/deadsnakes.gpg] https://ppa.launchpadcontent.net/deadsnakes/ppa/ubuntu jammy main" >> /etc/apt/sources.list \
+  \
+  ; apt-mark auto '.*' > /dev/null \
+  ; apt-mark manual $savedAptMark \
+  ; apt-get purge -y --auto-remove -o APT::AutoRemove::RecommendsImportant=false \
+  ; rm -rf /var/lib/apt/lists/*
+
+# Install pip3, all python versions and tox in the main python version
+# hadolint ignore=DL3008,SC2086
+RUN set -eux \
+  ; apt-get update \
+  ; apt-get install -y --no-install-recommends python3-pip \
+  ; for version in ${PYTHON_OTHER_VERSIONS} ${PYTHON_MAIN_VERSION} \
+    ; do \
+      apt-get install -y --no-install-recommends \
+        python${version} \
+        python${version}-dev \
+        python${version}-venv \
+        python${version}-distutils \
+      ; python${version} -m pip install --upgrade pip \
+    ; done \
+  ; python${PYTHON_MAIN_VERSION} -m pip install --no-cache tox \
+  ; rm -rf /var/lib/apt/lists/*;
+
+# Install PyPy
+RUN set -eux \
+  ; if [ "$TARGETARCH" = "arm64" ] ; then curl -L --show-error --retry 5 -o /pypy.tar.bz2 https://downloads.python.org/pypy/pypy${PYTHON_PYPY_VERSION}-aarch64.tar.bz2 \
+  ; else curl -L --show-error --retry 5 -o /pypy.tar.bz2 https://downloads.python.org/pypy/pypy${PYTHON_PYPY_VERSION}-linux64.tar.bz2 \
+  ; fi \
+  ; mkdir /pypy && tar -xf /pypy.tar.bz2 -C /pypy --strip-components=1
+
+ENV PATH="/pypy/bin:$PATH"
+
+# Create user and app directory
+RUN set -eux \
+  ; groupadd -r tox --gid=1000 \
+  ; useradd --no-log-init -r -g tox -m --uid=1000 tox \
+  ; mkdir /app \
+  ; chown tox:tox /app
+
+WORKDIR /app
+VOLUME /app
+USER tox
+
+# Add safe.directory to git to avoid setuptools_scm "unable to detect version"
+# This can't be limited to /app since gitlab-ci mounts the workspace somewhere else
+# (see https://github.com/pypa/setuptools_scm/issues/797)
+# This needs to run as user tox
+RUN git config --global --add safe.directory '*'

Makefile

@@ -0,0 +1,8 @@
+IMAGE_NAME = registry.gitlab.com/divio/incubator/multi-python
+TARGET ?= amd64
+
+lint:
+	docker run --rm -e LINT_FILE_DOCKER=Dockerfile -v $(CURDIR):/app divio/lint /bin/lint ${ARGS}
+
+build:
+	docker build -t ${IMAGE_NAME} --platform linux/${TARGET} .

README.md

@@ -0,0 +1,28 @@
+# Multi-Python Image
+
+This repository defines a Python image based on Ubuntu with multiple Python versions installed,
+along with the `tox` executable. It is meant to use in CI for test purposes.
+
+It supports both ARM and AMD architectures.
+
+## Python versions
+
+The list of Python versions to install is passed as arguments (see `Dockerfile`).
+One Python version must be selected as "main" - it will be used to install `tox`.
+Along with "regular" Python versions, one pypy version will also be installed.
+
+**IMPORTANT**: Python versions must be available either in the official Ubuntu repositories or in
+the [deadsnakes PPA](https://launchpad.net/~deadsnakes/+archive/ubuntu/ppa). The PyPy version should
+be available at https://www.pypy.org/download.html.
+
+## Usage
+
+Run the following from a terminal at the root of your Python project:
+```bash
+docker run --rm -it -v $(PWD):/app registry.gitlab.com/divio/incubator/multi-Python:latest tox
+```
+
+## Development
+
+After updating the Python versions in the `Dockerfile`, ensure you also update `test/tox.ini` to
+reflect the change.

test/test_foo.py

@@ -0,0 +1 @@
+assert True

test/tox.ini

@@ -0,0 +1,3 @@
+[tox]
+envlist = py37,py38,py39,py3.10,py3.11,pypy3
+skip_missing_interpreters = false