[Bug]: Codespaces creation fails when pre-commit feature is enabled (#514)

Author: danielbraun89

src/pipx-package/devcontainer-feature.json

@@ -1,7 +1,7 @@
 {
     "name": "Pipx package",
     "id": "pipx-package",
-    "version": "1.1.6",
+    "version": "1.1.7",
     "description": "Installs a pipx package.",
     "documentationURL": "http://github.com/devcontainers-contrib/features/tree/main/src/pipx-package",
     "installsAfter": [
@@ -42,8 +42,8 @@
             "proposals": [
                 "python3"
             ],
-            "default": "python3",
-            "description": "Select the python interpreter to use"
+            "default": "",
+            "description": "Force python interpreter to be use (must already exists on the container). If none selected (the default) then python3 will be used (and will be installed in case it does not exists)"
         }
     }
 }

src/pipx-package/install.sh

@@ -5,7 +5,7 @@ PACKAGE=${PACKAGE:-""}
 VERSION=${VERSION:-"latest"}
 INJECTIONS=${INJECTIONS:-""}
 INCLUDEDEPS=${INCLUDEDEPS:-"false"}
-INTERPRETER=${INTERPRETER:-"python3"}
+INTERPRETER=${INTERPRETER:-""}
 
 #  PEP 668  compatibility 
 export PIP_BREAK_SYSTEM_PACKAGES=1
@@ -45,32 +45,41 @@ install_via_pipx() {
 	local VERSION=$3
 	local INJECTIONS=$4
 	local INCLUDEDEPS=$5
-	if [ "$INTERPRETER" = "python3" ]; then
 
-		# if no python - install it
-		if ! type python3 >/dev/null 2>&1; then
-			echo "installing python3-minimal libffi-dev"
-			apt-get update -y
-			apt-get -y install python3-minimal
-		fi
-
-		# if no pip - install it
-		if ! type pip3 >/dev/null 2>&1; then
-			echo "installing python3-pip"
-			apt-get update -y
-			apt-get -y install libffi-dev python3-pip
-		fi
-
-		if ! python3 -Im ensurepip --version >/dev/null 2>&1; then
-			echo "installing python3-venv"
-			apt-get update -y
-			apt-get -y install python3-venv
+	if [ -n "$INTERPRETER" ]; then
+		if ! type $INTERPRETER >/dev/null 2>&1; then
+			echo "interpreter given is invalid: $INTERPRETER"
+			exit 1
 		fi
+		local _interpreter=$INTERPRETER
+	else
+		local _interpreter="python3"
 	fi
-
-	if ! type "$INTERPRETER"; then
-		echo "interpreter given is invalid: $INTERPRETER"
-		exit 1
+	
+	if [ -z "$INTERPRETER" ]; then # if interpreter selected manually - it should exists (validated above)
+
+		if [ "$_interpreter" = "python3" ]; then
+
+			# if no python - install it
+			if ! type python3 >/dev/null 2>&1; then
+				echo "installing python3-minimal libffi-dev"
+				apt-get update -y
+				apt-get -y install python3-minimal
+			fi
+
+			# if no pip - install it
+			if ! type pip3 >/dev/null 2>&1; then
+				echo "installing python3-pip"
+				apt-get update -y
+				apt-get -y install libffi-dev python3-pip
+			fi
+
+			if ! python3 -Im ensurepip --version >/dev/null 2>&1; then
+				echo "installing python3-venv"
+				apt-get update -y
+				apt-get -y install python3-venv
+			fi
+		fi
 	fi
 
 	export PYTHONUSERBASE=/tmp/pip-tmp
@@ -80,9 +89,7 @@ install_via_pipx() {
 	export PIPX_BIN_DIR="${PIPX_HOME}/bin"
 	mkdir -p "${PIPX_HOME}"
 
-	# if pipx not exists - install it
-	if ! $INTERPRETER -m pip list | grep pipx >/dev/null 2>&1; then
-
+	_install_pipx() {
 		PATH="${PATH}:${PIPX_BIN_DIR}"
 
 		# Create pipx group, dir, and set sticky bit
@@ -96,18 +103,34 @@ install_via_pipx() {
 		chmod -R g+r+w "${PIPX_HOME}"
 		find "${PIPX_HOME}" -type d -print0 | xargs -0 -n 1 chmod g+s
 
-		$INTERPRETER -m pip install --disable-pip-version-check --no-cache-dir --user pipx 2>&1
-		/tmp/pip-tmp/bin/pipx install --pip-args=--no-cache-dir pipx
-		pipx_bin=/tmp/pip-tmp/bin/pipx
+		$_interpreter -m pip install --disable-pip-version-check --no-cache-dir --user pipx 2>&1
+		$PYTHONUSERBASE/bin/pipx install --pip-args=--no-cache-dir --force pipx
+		pipx_bin=$PYTHONUSERBASE/bin/pipx
 
 		updaterc "export PIPX_HOME=\"${PIPX_HOME}\""
 		updaterc "export PIPX_BIN_DIR=\"${PIPX_BIN_DIR}\""
 		updaterc "if [[ \"\${PATH}\" != *\"\${PIPX_BIN_DIR}\"* ]]; then export PATH=\"\${PATH}:\${PIPX_BIN_DIR}\"; fi"
-
+	}
+
+	
+	if  $_interpreter -m pip list | grep pipx >/dev/null 2>&1; then
+		# if pipx exists in the selected interpreter - use it
+		pipx_bin="$_interpreter -m pipx"
+	elif [ -n "$INTERPRETER" ]; then
+		# if interpreter was *explicitely* selected, 
+		# and pipx is not installed with it - install it
+		_install_pipx
+		pipx_bin="$_interpreter -m pipx"
+	elif type pipx >/dev/null 2>&1; then
+		# if a global pipx is install - use it
+		pipx_bin="pipx"
 	else
-		pipx_bin="$INTERPRETER -m pipx"
+		# if no pipx installed what so ever - install it
+		_install_pipx
+		pipx_bin=$PYTHONUSERBASE/bin/pipx
 	fi
 
+
 	if [ "$(${pipx_bin} list --short | grep "$PACKAGE")" != "" ]; then
 		echo "$PACKAGE  already exists - skipping installation"
 	else
@@ -130,7 +153,7 @@ install_via_pipx() {
 		done
 
 		# cleaning pipx to save disk space
-		rm -rf /tmp/pip-tmp
+		rm -rf $PYTHONUSERBASE
 	fi
 }
 

src/pre-commit/install.sh

@@ -16,7 +16,7 @@ $nanolayer_location \
     install \
     devcontainer-feature \
     "ghcr.io/devcontainers-contrib/features/pipx-package:1.1.6" \
-    --option package='pre-commit' --option version="$VERSION"
+    --option package='pre-commit' --option version="$VERSION" --verbose
 
 
 

test/pipx-package/install_precommit.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+set -e
+
+source dev-container-features-test-lib
+
+check "pipx list --short | grep pre-commit" pipx list --short | grep "pre-commit"
+
+check "type pre-commit"  type pre-commit
+
+reportResults

test/pipx-package/scenarios.json

@@ -19,6 +19,15 @@
             }
         }
     },
+    "install_precommit": {
+        "image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
+        "features": {
+            "pipx-package": {
+                "version": "latest",
+                "package": "pre-commit"
+            }
+        }
+    },
     "install_black_custom_interpreter": {
         "image": "debian:bullseye",
         "features": {

test/pre-commit/scenarios.json

@@ -1,6 +1,6 @@
 {
     "test": {
-        "image": "mcr.microsoft.com/devcontainers/base:debian",
+        "image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
         "features": {
             "pre-commit": {}
         }