make the strauss version a configurable option during both testing and packing

paulgoodchild · paulgoodchild · commit 355beca24e56 · 2025-12-23T14:49:09.000Z
diff --git a/.github/config/packager.conf b/.github/config/packager.conf
@@ -0,0 +1,3 @@
+# Strauss version for packaging and tests
+STRAUSS_VERSION="0.19.4"
+
diff --git a/.github/scripts/read-packager-config.sh b/.github/scripts/read-packager-config.sh
@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+# Load Strauss version for packaging/tests.
+# Usage: source .github/scripts/read-packager-config.sh
+
+set -euo pipefail
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+PROJECT_ROOT="$(cd "${SCRIPT_DIR}/../.." && pwd)"
+CONFIG_FILE="${PROJECT_ROOT}/.github/config/packager.conf"
+
+if [ ! -f "${CONFIG_FILE}" ]; then
+  echo "❌ packager config not found: ${CONFIG_FILE}" >&2
+  exit 1
+fi
+
+# shellcheck source=/dev/null
+source "${CONFIG_FILE}"
+
+if [ -z "${STRAUSS_VERSION:-}" ]; then
+  echo "❌ STRAUSS_VERSION is not set in ${CONFIG_FILE}" >&2
+  exit 1
+fi
+
+# Strip leading "v" if present
+STRAUSS_VERSION="${STRAUSS_VERSION#v}"
+
+export STRAUSS_VERSION
+export SHIELD_STRAUSS_VERSION="${SHIELD_STRAUSS_VERSION:-${STRAUSS_VERSION}}"
+
+echo "Using STRAUSS_VERSION=${STRAUSS_VERSION}"
+
diff --git a/.github/workflows/docker-tests.yml b/.github/workflows/docker-tests.yml
@@ -192,6 +192,12 @@ jobs:
           npm run build
         fi
         
+    - name: Load Strauss version
+      run: |
+        source .github/scripts/read-packager-config.sh
+        echo "SHIELD_STRAUSS_VERSION=${SHIELD_STRAUSS_VERSION}" >> $GITHUB_ENV
+        echo "STRAUSS_VERSION=${STRAUSS_VERSION}" >> $GITHUB_ENV
+        
     - name: Build plugin package
       run: |
         PACKAGE_DIR="${{ github.workspace }}/shield-package"
@@ -222,6 +228,7 @@ jobs:
           echo "WP_VERSION_PREVIOUS=${{ needs.detect-wp-versions.outputs.previous }}"
           echo "PLUGIN_SOURCE=${{ env.SHIELD_PACKAGE_PATH }}"
           echo "SHIELD_PACKAGE_PATH=${{ env.SHIELD_PACKAGE_PATH }}"
+          echo "SHIELD_STRAUSS_VERSION=${SHIELD_STRAUSS_VERSION}"
           echo "SHIELD_TEST_IMAGE=shield-test-runner:php${PHP_VERSION}-wp${WP_VERSION}"
           echo "SHIELD_TEST_IMAGE_LATEST=shield-test-runner:php${PHP_VERSION}-wp${WP_VERSION}"
           echo "SHIELD_TEST_IMAGE_PREVIOUS=shield-test-runner:php${PHP_VERSION}-wp${WP_VERSION}"
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -65,6 +65,12 @@ jobs:
     - name: Build assets
       run: npm run build
       
+    - name: Load Strauss version
+      run: |
+        source .github/scripts/read-packager-config.sh
+        echo "SHIELD_STRAUSS_VERSION=${SHIELD_STRAUSS_VERSION}" >> $GITHUB_ENV
+        echo "STRAUSS_VERSION=${STRAUSS_VERSION}" >> $GITHUB_ENV
+        
     - name: Build plugin package
       run: |
         PACKAGE_DIR="${{ github.workspace }}/shield-package"
diff --git a/bin/package-plugin.php b/bin/package-plugin.php
@@ -8,6 +8,7 @@
 
 $options = getopt( '', [
 	'output::',
+	'strauss-version::',
 	'skip-root-composer',
 	'skip-lib-composer',
 	'skip-npm-install',
@@ -21,6 +22,16 @@
 if ( is_string( $outputDir ) ) {
 	$outputDir = trim( $outputDir, " \t\n\r\0\x0B\"'" );
 }
+
+$straussVersion = $options[ 'strauss-version' ] ?? null;
+if ( is_string( $straussVersion ) ) {
+	$straussVersion = trim( $straussVersion );
+}
+$envStrauss = getenv( 'SHIELD_STRAUSS_VERSION' );
+$resolvedStrauss = $straussVersion !== null && $straussVersion !== ''
+	? $straussVersion
+	: ( is_string( $envStrauss ) ? $envStrauss : null );
+
 $packagerOptions = [];
 
 if ( isset( $options[ 'skip-root-composer' ] ) ) {
@@ -47,6 +58,10 @@
 	$packagerOptions[ 'skip_copy' ] = true;
 }
 
+if ( is_string( $resolvedStrauss ) && $resolvedStrauss !== '' ) {
+	$packagerOptions[ 'strauss_version' ] = $resolvedStrauss;
+}
+
 try {
 	$path = ( new PluginPackager() )->package( is_string( $outputDir ) ? $outputDir : null, $packagerOptions );
 	echo '✅ Shield plugin package created at: '.$path.PHP_EOL;
diff --git a/bin/run-docker-tests.sh b/bin/run-docker-tests.sh
@@ -35,6 +35,9 @@ SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 PROJECT_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
 cd "$PROJECT_ROOT"
 
+# Set a predictable Compose project name to avoid generic "docker" container names
+export COMPOSE_PROJECT_NAME="shield-tests"
+
 # Source matrix configuration (single source of truth)
 if [ -f "$PROJECT_ROOT/.github/config/matrix.conf" ]; then
     source "$PROJECT_ROOT/.github/config/matrix.conf"
@@ -43,6 +46,14 @@ else
     DEFAULT_PHP="8.2"
 fi
 
+# Source packager config for Strauss version
+if [ -f "$PROJECT_ROOT/.github/scripts/read-packager-config.sh" ]; then
+    # shellcheck source=/dev/null
+    source "$PROJECT_ROOT/.github/scripts/read-packager-config.sh"
+else
+    echo "⚠️  Warning: Packager config loader not found, STRAUSS_VERSION not set"
+fi
+
 # PHP version to test (can be overridden via environment variable)
 PHP_VERSION=${PHP_VERSION:-"$DEFAULT_PHP"}
 echo "🐘 PHP Version: $PHP_VERSION"
@@ -118,6 +129,13 @@ export PLUGIN_SOURCE="$PACKAGE_DIR"
 # We pass relative path to avoid absolute path issues across host/container
 PACKAGE_DIR_RELATIVE="tmp/shield-package-local"
 
+# Ensure clean environment now that env vars are set
+echo "🧹 Cleaning up any existing test containers/volumes..."
+docker compose -f tests/docker/docker-compose.yml \
+    -f tests/docker/docker-compose.package.yml \
+    down -v --remove-orphans || true
+echo "   ✅ Clean start ensured"
+
 # Start MySQL containers early in background for parallel initialization
 # Based on testing, MySQL takes ~38 seconds to fully initialize
 echo "🗄️ Starting MySQL databases in background for parallel initialization..."
@@ -273,6 +291,7 @@ docker run --rm --name shield-composer-package \
     -v "$PROJECT_ROOT:/app" \
     -w /app \
     -e COMPOSER_PROCESS_TIMEOUT=900 \
+    -e SHIELD_STRAUSS_VERSION="$SHIELD_STRAUSS_VERSION" \
     $COMPOSER_IMAGE \
     composer package-plugin -- --output="$PACKAGE_DIR_RELATIVE" \
         --skip-root-composer --skip-lib-composer \
@@ -338,6 +357,7 @@ run_parallel_tests() {
     
     # Prepare output directories
     mkdir -p /tmp
+    rm -f /tmp/shield-test-latest.log /tmp/shield-test-previous.log /tmp/shield-test-latest.exit /tmp/shield-test-previous.exit
     
     # Set up environment variables for both WordPress versions
     cat > tests/docker/.env << EOF
@@ -347,6 +367,7 @@ WP_VERSION_PREVIOUS=$PREVIOUS_VERSION
 TEST_PHP_VERSION=$PHP_VERSION
 PLUGIN_SOURCE=$PACKAGE_DIR
 SHIELD_PACKAGE_PATH=$PACKAGE_DIR
+SHIELD_STRAUSS_VERSION=$SHIELD_STRAUSS_VERSION
 SHIELD_TEST_IMAGE_LATEST=shield-test-runner:php$PHP_VERSION-wp$LATEST_VERSION
 SHIELD_TEST_IMAGE_PREVIOUS=shield-test-runner:php$PHP_VERSION-wp$PREVIOUS_VERSION
 EOF
diff --git a/infrastructure/src/Tooling/PluginPackager.php b/infrastructure/src/Tooling/PluginPackager.php
@@ -10,6 +10,7 @@
 class PluginPackager {
 
 	private string $projectRoot;
+	private string $straussVersion = '';
 
 	/** @var callable */
 	private $logger;
@@ -30,6 +31,7 @@ public function __construct( ?string $projectRoot = null, ?callable $logger = nu
 	 */
 	public function package( ?string $outputDir = null, array $options = [] ) :string {
 		$options = $this->resolveOptions( $options );
+		$this->straussVersion = $this->resolveStraussVersion( $options );
 		$targetDir = $this->resolveOutputDirectory( $outputDir );
 		$this->log( sprintf( 'Packaging Shield plugin to: %s', $targetDir ) );
 
@@ -46,7 +48,7 @@ public function package( ?string $outputDir = null, array $options = [] ) :strin
 					'install',
 					'--no-interaction',
 					'--prefer-dist',
-					'--optimize-autoloader'
+//					'--optimize-autoloader'
 				] ),
 				$this->projectRoot
 			);
@@ -58,7 +60,7 @@ public function package( ?string $outputDir = null, array $options = [] ) :strin
 					'install',
 					'--no-interaction',
 					'--prefer-dist',
-					'--optimize-autoloader'
+//					'--optimize-autoloader'
 				] ),
 				$this->projectRoot.'/src/lib'
 			);
@@ -245,7 +247,7 @@ private function log( string $message ) :void {
 	}
 
 	/**
-	 * @return array<string,bool>
+	 * @return array<string,mixed>
 	 */
 	private function resolveOptions( array $options ) :array {
 		$defaults = [
@@ -255,11 +257,26 @@ private function resolveOptions( array $options ) :array {
 			'npm_build'       => true,
 			'directory_clean' => true,
 			'skip_copy'       => false,
+			'strauss_version' => null,
 		];
 
 		return array_replace( $defaults, array_intersect_key( $options, $defaults ) );
 	}
 
+	private function resolveStraussVersion( array $options ) :string {
+		$fromOptions = $options[ 'strauss_version' ] ?? null;
+		if ( is_string( $fromOptions ) && $fromOptions !== '' ) {
+			return ltrim( $fromOptions, "v \t\n\r\0\x0B" );
+		}
+
+		$env = getenv( 'SHIELD_STRAUSS_VERSION' );
+		if ( is_string( $env ) && $env !== '' ) {
+			return ltrim( $env, "v \t\n\r\0\x0B" );
+		}
+
+		return self::FALLBACK_STRAUSS_VERSION;
+	}
+
 	/**
 	 * Parse .gitattributes and return list of export-ignore patterns
 	 * This makes .gitattributes the single source of truth for package contents
@@ -548,7 +565,7 @@ private function installComposerDependencies( string $targetDir ) :void {
 				'--no-dev',
 				'--no-interaction',
 				'--prefer-dist',
-				'--optimize-autoloader',
+//				'--optimize-autoloader',
 				'--quiet'
 			] ),
 			$libDir
@@ -558,18 +575,21 @@ private function installComposerDependencies( string $targetDir ) :void {
 		$this->log( '' );
 	}
 
-	private const STRAUSS_VERSION = '0.19.4';
-	private const STRAUSS_DOWNLOAD_URL = 'https://github.com/BrianHenryIE/strauss/releases/download/0.19.4/strauss.phar';
+	private const FALLBACK_STRAUSS_VERSION = '0.19.4';
 
 	/**
 	 * Download Strauss phar file for namespace prefixing
 	 * @throws RuntimeException if download fails with detailed error message
 	 */
 	private function downloadStraussPhar( string $targetDir ) :void {
-		$this->log( sprintf( 'Downloading Strauss v%s...', self::STRAUSS_VERSION ) );
+		$this->log( sprintf( 'Downloading Strauss v%s...', $this->straussVersion ) );
 
 		$libDir = Path::join( $targetDir, 'src/lib' );
 		$targetPath = Path::join( $libDir, 'strauss.phar' );
+		$downloadUrl = sprintf(
+			'https://github.com/BrianHenryIE/strauss/releases/download/%s/strauss.phar',
+			$this->straussVersion
+		);
 
 		// Check if allow_url_fopen is enabled
 		if ( !ini_get( 'allow_url_fopen' ) ) {
@@ -579,7 +599,7 @@ private function downloadStraussPhar( string $targetDir ) :void {
 				'WHY: The PHP setting "allow_url_fopen" is disabled, which prevents PHP from downloading files from URLs. '.
 				'HOW TO FIX: Enable allow_url_fopen in your php.ini file by setting "allow_url_fopen = On", '.
 				'or contact your system administrator to enable this setting. '.
-				'Alternatively, you can manually download strauss.phar from '.self::STRAUSS_DOWNLOAD_URL.' '.
+				'Alternatively, you can manually download strauss.phar from '.$downloadUrl.' '.
 				'and place it in the package src/lib directory.'
 			);
 		}
@@ -602,7 +622,7 @@ private function downloadStraussPhar( string $targetDir ) :void {
 		error_clear_last();
 
 		// Attempt to download the file
-		$content = @file_get_contents( self::STRAUSS_DOWNLOAD_URL, false, $context );
+		$content = @file_get_contents( $downloadUrl, false, $context );
 
 		if ( $content === false ) {
 			$lastError = error_get_last();
@@ -617,7 +637,7 @@ private function downloadStraussPhar( string $targetDir ) :void {
 					'(3) Firewall or proxy blocking the connection, (4) SSL certificate verification failure. '.
 					'HOW TO FIX: Check your internet connection and try again. If the problem persists, '.
 					'you can manually download strauss.phar from the URL above and place it at: %s',
-					self::STRAUSS_DOWNLOAD_URL,
+					$downloadUrl,
 					$errorMessage,
 					$targetPath
 				)
@@ -632,8 +652,8 @@ private function downloadStraussPhar( string $targetDir ) :void {
 					'WHY: This usually indicates a server-side issue or the release file was not found. '.
 					'HOW TO FIX: Verify that Strauss version %s exists at the download URL. '.
 					'You can manually download strauss.phar and place it at: %s',
-					self::STRAUSS_DOWNLOAD_URL,
-					self::STRAUSS_VERSION,
+					$downloadUrl,
+					$this->straussVersion,
 					$targetPath
 				)
 			);
@@ -690,7 +710,7 @@ private function downloadStraussPhar( string $targetDir ) :void {
 					'HOW TO FIX: Delete the empty file and try running the packaging again. '.
 					'If the problem persists, manually download from: %s',
 					$targetPath,
-					self::STRAUSS_DOWNLOAD_URL
+					$downloadUrl
 				)
 			);
 		}
diff --git a/tests/docker/docker-compose.package.yml b/tests/docker/docker-compose.package.yml
@@ -7,10 +7,12 @@ services:
       - ${PLUGIN_SOURCE}:/package
     environment:
       SHIELD_PACKAGE_PATH: /package
+      SHIELD_STRAUSS_VERSION: ${SHIELD_STRAUSS_VERSION}
 
   test-runner-previous:
     volumes:
       - ../../:/app
       - ${PLUGIN_SOURCE}:/package
     environment:
-      SHIELD_PACKAGE_PATH: /package
+      SHIELD_PACKAGE_PATH: /package
+      SHIELD_STRAUSS_VERSION: ${SHIELD_STRAUSS_VERSION}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Strauss version for packaging and tests`
	`2`	`+STRAUSS_VERSION="0.19.4"`
	`3`	`+`