Isolate tools into individual environments with pipx

Author: TimPansino

.devcontainer/Dockerfile

@@ -4,17 +4,18 @@ FROM ghcr.io/newrelic/newrelic-python-agent-ci:${IMAGE_TAG}
 
 # Setup non-root user
 USER root
-ARG UID=1000
+ARG UID=1001
 ARG GID=${UID}
-ENV HOME /home/vscode
+ENV HOME=/home/vscode
 RUN mkdir -p ${HOME} && \
     groupadd --gid ${GID} vscode && \
     useradd --uid ${UID} --gid ${GID} --home ${HOME} vscode && \
     chown -R ${UID}:${GID} /home/vscode
 
 # Fix pyenv installation
 RUN echo 'eval "$(pyenv init -)"' >>${HOME}/.bashrc && \
-    chown -R vscode:vscode ${PYENV_ROOT}
+    chown -R vscode:vscode "${PYENV_ROOT}" && \
+    chown -R vscode:vscode "${PIPX_HOME}"
 
 # Set user
 USER ${UID}:${GID}

.github/containers/Dockerfile

@@ -84,7 +84,7 @@ RUN ln -fs "/usr/share/zoneinfo/${TZ}" /etc/localtime && \
     dpkg-reconfigure -f noninteractive tzdata
 
 # Use root user
-ENV HOME /root
+ENV HOME=/root
 WORKDIR "${HOME}"
 
 # Install pyenv
@@ -96,11 +96,22 @@ RUN echo 'eval "$(pyenv init -)"' >>${HOME}/.bashrc && \
 
 # Install Python
 ARG PYTHON_VERSIONS="3.12 3.11 3.10 3.9 3.8 3.7 3.13 pypy3.10-7.3.17"
-COPY --chown=1000:1000 --chmod=755 ./install-python.sh /tmp/install-python.sh
+COPY --chown=0:0 --chmod=755 ./install-python.sh /tmp/install-python.sh
 RUN /tmp/install-python.sh && \
     rm /tmp/install-python.sh
 
 # Install dependencies for main python installation
 COPY ./requirements.txt /tmp/requirements.txt
 RUN pyenv exec pip install --upgrade -r /tmp/requirements.txt && \
-    rm /tmp/requirements.txt
+    rm /tmp/requirements.txt
+
+# Install tools with pipx in isolated environments
+COPY ./requirements-tools.txt /tmp/requirements-tools.txt
+ENV PIPX_HOME="/opt/pipx"
+ENV PIPX_BIN_DIR="${PIPX_HOME}/bin"
+ENV PATH="${PIPX_BIN_DIR}:${PATH}"
+RUN mkdir -p "${PIPX_BIN_DIR}" && \
+    while IFS="" read -r line || [ -n "$line" ]; do \
+        pyenv exec pipx install --global "${line}"; \
+    done </tmp/requirements-tools.txt && \
+    rm /tmp/requirements-tools.txt

.github/containers/requirements-tools.txt

@@ -0,0 +1,6 @@
+bandit
+black
+flake8
+flynt
+isort
+tox

.github/containers/requirements.txt

@@ -1,9 +1,5 @@
-bandit
-black
-flake8
-isort
 pip
+pipx
 setuptools
-tox
 virtualenv
 wheel