Accept IPE_SAVE_...DEPS_TO to store required apt/apk dependencies (#1229)

Author: mlocati

.github/workflows/test-extensions.yml

@@ -316,3 +316,76 @@ jobs:
         uses: actions/checkout@v4
       -
         run: docker run --rm --volume "$(pwd):/app" --workdir /app php:8.2-cli-alpine ./scripts/test-icu-data-en-upgradable
+
+  test_persisting_deps:
+    name: Test that IPE_SAVE_...DEPS_TO works
+    needs:
+      - check_syntax_data
+      - check_syntax_shell
+      - check_syntax_php
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v6
+      -
+        name: Install extensions
+        run: >
+          docker run --rm
+          --volume "$(pwd):/app"
+          --workdir /app
+          --env CI=true
+          --env IPE_SAVE_PERMDEPS_TO=perm-deps.txt
+          --env IPE_SAVE_VOLDEPS_TO=vol-deps.txt
+          php:8.2-cli-alpine
+          ./install-php-extensions zip
+      -
+        name: List permanent deps
+        run: cat perm-deps.txt
+      -
+        name: Check permanent deps
+        run: |
+          search=libzip
+          found=0
+          while read -r line; do
+            set -f
+            set -- $line
+            set +f
+            for dep; do
+              if [ "$dep" = "$search" ]; then
+                found=1
+                break 2
+              fi
+            done
+          done < perm-deps.txt
+          if [ $found -eq 1 ]; then
+            echo 'OK'
+          else
+            echo "$search not found in permanent deps"
+            exit 1
+          fi
+      -
+        name: List volatile deps
+        run: cat vol-deps.txt
+      -
+        name: Check volatile deps
+        run: |
+          search=libzip-dev
+          found=0
+          while read -r line; do
+            set -f
+            set -- $line
+            set +f
+            for dep; do
+              if [ "$dep" = "$search" ]; then
+                found=1
+                break 2
+              fi
+            done
+          done < vol-deps.txt
+          if [ $found -eq 1 ]; then
+            echo 'OK'
+          else
+            echo "$search not found in volatile deps"
+            exit 1
+          fi

README.md

@@ -471,6 +471,7 @@ Here's the list of all the supported environment variables:
 |---|---|---|
 | | `IPE_DEBUG=1` | By setting this environment variable, the script will print all the commands it executes (it will be very verbose, useful only for debug purposes) |
 | | `IPE_INSECURE=1` | By setting this environment variable, HTTPS certificate validation is disabled for network operations performed by the program |
+| | `IPE_SAVE_PERMDEPS_TO=path`<br />`IPE_SAVE_VOLDEPS_TO=path` | By setting this environment variable, the script will store in the path specified the list of APT/APK packages required by the installed PHP extensions (`IPE_SAVE_PERMDEPS_TO`) and/or the packages required to build the PHP extensions (`IPE_SAVE_VOLDEPS_TO`).<br />Please remark that `install-php-extension` may configure the system in other ways ([example](https://github.com/mlocati/docker-php-extension-installer/blob/2.9.28/install-php-extensions#L2234-L2286)) |
 | | `IPE_PROCESSOR_COUNT` | By default all available processors. Set this environment variable to override the number of processors detected by the script (used for parallel compilation) |
 | | `IPE_DONT_ENABLE=1` | By default the script will install and enable the extensions.<br />If you want to only install them (without enabling them) you can set this environment variable.<br />To enable the extensions at a later time you can execute the command `docker-php-ext-enable-<extension>` (for example: `docker-php-ext-enable-xdebug`).<br />**Beware**: installing some PHP extensions requires that other PHP extensions are already enabled, so use this feature wisely. |
 | | `IPE_SKIP_CHECK=1` | By default the script will check if the extensions can be enabled: if you want to skip this check, you can use this flag.<br />**Beware**: extensions may be enabled even if they break PHP: use this function wisely. |

install-php-extensions

@@ -2075,7 +2075,13 @@ markPreinstalledPackagesAsUsed() {
 installRequiredPackages() {
 	printf '### INSTALLING REQUIRED PACKAGES ###\n'
 	printf '# Packages to be kept after installation: %s\n' "$PACKAGES_PERSISTENT_NEW"
+	if test -n "${IPE_SAVE_PERMDEPS_TO:-}"; then
+		printf '%s\n' "$PACKAGES_PERSISTENT_NEW" >"$IPE_SAVE_PERMDEPS_TO"
+	fi
 	printf '# Packages to be used only for installation: %s\n' "$PACKAGES_VOLATILE"
+	if test -n "${IPE_SAVE_VOLDEPS_TO:-}"; then
+		printf '%s\n' "$PACKAGES_VOLATILE" >"$IPE_SAVE_VOLDEPS_TO"
+	fi
 	case "$DISTRO" in
 		alpine)
 			apk add $IPE_APK_FLAGS $PACKAGES_PERSISTENT_NEW $PACKAGES_VOLATILE