PHP Extension Testing CI/CD Workflow

Overview

This document describes the automated PHP extension validation workflow that runs on every pull request to the main branch. The workflow is designed to ensure that new PHP versions and their extensions are properly configured and functional across multiple Windows environments.

Workflow Location

File: .github/workflows/php-extension-test.yml

Trigger: Automatically runs when a PR is opened, synchronized, or reopened against the main branch.

Current Status

✅ What is Currently Working

The workflow infrastructure is fully operational and includes:

Automated PR Detection
- Triggers on PR creation, updates, and reopening
- Monitors changes to releases.properties file
Version Detection
- Automatically detects new PHP versions added to releases.properties
- Extracts version numbers from git diff
- Parses version entries for testing
Multi-Platform Testing Matrix
- Tests across 4 Windows configurations:
  - Windows 10 AMD
  - Windows 10 Intel
  - Windows 11 AMD
  - Windows 11 Intel
- Parallel execution with fail-fast: false to test all platforms
Result Aggregation
- Collects results from all platform tests
- Generates visual status badges for each platform
- Posts consolidated results as a single PR comment
Artifact Management
- Uploads test results as artifacts
- Preserves results for debugging and analysis

✅ Complete Implementation Status

ALL PHASES COMPLETED! The workflow now includes:

Phase 1: Basic PHP Validation ✅

Task 1.1: Download and Extract PHP
- ✅ Parses releases.properties to get download URL
- ✅ Downloads PHP 7z archive
- ✅ Extracts to temporary directory
- ✅ Verifies php.exe exists and is accessible
Task 1.2: Verify PHP Executable
- ✅ Runs php -v to verify version
- ✅ Checks version output matches expected version
- ✅ Detects startup errors or warnings
- ✅ Tests basic PHP code execution
- ✅ Displays PHP configuration (Thread Safety, Architecture, Compiler)

Phase 2: Extension Validation ✅

Task 2.1: Download Extensions
- ✅ Parses exts.properties for extension URLs
- ✅ Downloads all extensions (imagick, memcache, xdebug)
- ✅ Extracts ZIP archives automatically
- ✅ Verifies download integrity
Task 2.2: Validate DLL Architecture
- ✅ Reads PE headers from DLL files
- ✅ Validates x64 (AMD64) architecture
- ✅ Reports architecture mismatches
- ✅ Saves validation results
Task 2.3: Test Extension Loading
- ✅ Tests loading with php -m
- ✅ Handles both regular and Zend extensions
- ✅ Verifies extensions appear in module list
- ✅ Captures loading errors

Phase 3: Dependency Validation ✅

Task 3.1: Download Dependencies
- ✅ Parses deps.properties for dependencies
- ✅ Downloads ImageMagick and other dependencies
- ✅ Extracts 7z and ZIP archives
- ✅ Handles missing dependencies gracefully
Task 3.2: Test Extensions with Dependencies
- ✅ Adds dependency paths to system PATH
- ✅ Tests imagick with ImageMagick present
- ✅ Verifies extension classes are available
- ✅ Tests memcache and xdebug functionality

Phase 4: Functional Testing ✅

Task 4.1: Basic Functionality Tests
- ✅ Tests imagick image creation
- ✅ Tests memcache function availability
- ✅ Tests xdebug extension loading
- ✅ Captures functional test results

Phase 5: Enhanced Error Reporting ✅

Comprehensive PR Comments
- ✅ Shows results for all phases
- ✅ Lists all tested extensions with status
- ✅ Displays platform-specific results
- ✅ Includes error messages and warnings
- ✅ Updates existing comments instead of creating duplicates
Detailed Artifacts
- ✅ JSON results for each phase
- ✅ Architecture validation data
- ✅ Extension loading results
- ✅ Dependency test results
- ✅ Functional test outcomes

What Needs to Be Tested

Based on the repository structure (bin/php{version}/ directories), each PHP version includes:

1. PHP Extensions (`exts.properties`)

Each PHP version defines external extensions that must be validated:

imagick - ImageMagick image processing extension
memcache - Memcache caching extension
xdebug - Xdebug debugging extension

2. Dependencies (`deps.properties`)

External dependencies required by extensions:

ImageMagick - Binary dependency for imagick extension

3. Configuration Files

php.ini - PHP configuration with extension paths
bearsampp.conf - Bearsampp-specific configuration
pear.properties - PEAR package manager configuration

Required Implementation Tasks

Phase 1: Basic PHP Validation

Task 1.1: Download and Extract PHP

# Parse releases.properties to get download URL
# Download the PHP 7z archive
# Extract to temporary directory
# Verify php.exe exists and is executable

Validation Points:

Archive downloads successfully
Extraction completes without errors
PHP executable is present
PHP version matches expected version

Task 1.2: Verify PHP Executable

# Run: php -v
# Verify version output matches expected
# Check for any startup errors or warnings

Validation Points:

PHP starts without errors
Version string is correct
No missing DLL errors

Phase 2: Extension Validation

Task 2.1: Download Extensions

# Parse bin/php{version}/exts.properties
# Download each extension from specified URL
# Verify download integrity
# Extract if archived (e.g., imagick comes as .zip)

Validation Points:

All extension URLs are accessible
Downloads complete successfully
Archives extract properly
DLL files are present

Task 2.2: Validate DLL Architecture

# Use PowerShell to check DLL architecture
# Example:
$dllPath = "path/to/php_imagick.dll"
$peHeader = [System.Reflection.PortableExecutable.PEHeaders]::new(
    [System.IO.FileStream]::new($dllPath, [System.IO.FileMode]::Open)
)
$architecture = $peHeader.CoffHeader.Machine
# Verify: AMD64 for x64, I386 for x86

Validation Points:

Extension DLL architecture matches PHP architecture (x64)
Thread-safe (TS) vs non-thread-safe (NTS) compatibility
Visual Studio version compatibility (VS16, VS17, etc.)

Task 2.3: Test Extension Loading

# For each extension, test loading:
php -d extension=php_imagick.dll -m | Select-String "imagick"
php -d extension=php_memcache.dll -m | Select-String "memcache"
php -d zend_extension=php_xdebug.dll -m | Select-String "xdebug"

Validation Points:

Extension appears in php -m output
No error messages during loading
No missing dependency errors

Phase 3: Dependency Validation

Task 3.1: Download Dependencies

# Parse bin/php{version}/deps.properties
# Download ImageMagick portable package
# Extract to appropriate location

Validation Points:

Dependency downloads successfully
Extraction completes
Required DLLs are present

Task 3.2: Test Extension with Dependencies

# Set PATH to include dependency DLLs
$env:PATH = "path/to/imagemagick;$env:PATH"
# Test imagick extension loads with ImageMagick present
php -d extension=php_imagick.dll -r "echo class_exists('Imagick') ? 'OK' : 'FAIL';"

Validation Points:

Extension loads with dependencies
Extension classes/functions are available
No runtime errors

Phase 4: Functional Testing (Optional)

Task 4.1: Basic Functionality Tests

# Test imagick can create an image
php -d extension=php_imagick.dll -r "
  $img = new Imagick();
  $img->newImage(100, 100, new ImagickPixel('red'));
  echo 'imagick: OK';
"

# Test memcache extension functions exist
php -d extension=php_memcache.dll -r "
  echo function_exists('memcache_connect') ? 'memcache: OK' : 'FAIL';
"

# Test xdebug is loaded
php -d zend_extension=php_xdebug.dll -r "
  echo extension_loaded('xdebug') ? 'xdebug: OK' : 'FAIL';
"

Validation Points:

Extensions provide expected functionality
No runtime errors during basic operations
Classes and functions are accessible

Phase 5: Error Handling and Reporting

Task 5.1: Capture Detailed Errors

# Capture stderr and stdout
# Log all PHP warnings and errors
# Save failed DLL information

Task 5.2: Enhanced PR Comments

# Include in PR comment:
# - PHP version tested
# - Extension test results (pass/fail per extension)
# - Specific error messages
# - Download URLs that failed
# - Architecture mismatches
# - Missing dependencies

Example Enhanced Comment:

### ✅ PHP Extension Tests - Partial Success

#### PHP 8.3.27
- ✅ win10-amd: All tests passed
- ❌ win10-intel: imagick failed to load
  - Error: Missing CORE_RL_MagickCore_.dll
  - ImageMagick dependency not found
- ✅ win11-amd: All tests passed
- ✅ win11-intel: All tests passed

#### PHP 8.4.14
- ✅ All platforms: All tests passed

**Extensions Tested:**
- ✅ imagick (3.7.0)
- ✅ memcache (8.3.x)
- ✅ xdebug (3.5.0alpha2)

Implementation Priority

High Priority (Must Have)

✅ COMPLETED - Download and extract PHP version
✅ COMPLETED - Verify PHP executable runs
✅ COMPLETED - Download extensions from exts.properties
✅ COMPLETED - Validate DLL architecture
✅ COMPLETED - Test extension loading with php -m

Medium Priority (Should Have)

✅ COMPLETED - Download and validate dependencies
✅ COMPLETED - Test extensions with dependencies present
✅ COMPLETED - Enhanced error reporting in PR comments
✅ COMPLETED - Upload failed artifacts for debugging

Low Priority (Nice to Have)

✅ COMPLETED - Basic functionality tests per extension
⭕ Performance benchmarks (future enhancement)
⭕ Memory leak detection (future enhancement)
⭕ Compatibility matrix documentation (future enhancement)

Testing Workflow Locally

To test the validation logic locally before committing:

# 1. Navigate to module-php directory
cd E:\Bearsampp-development\module-php

# 2. Get a PHP version from releases.properties
$version = "8.3.27"
$url = (Get-Content releases.properties | Select-String "^$version =").Line.Split('=')[1].Trim()

# 3. Download and extract
Invoke-WebRequest -Uri $url -OutFile "php-$version.7z"
7z x "php-$version.7z" -o"test-php-$version"

# 4. Test PHP
& "test-php-$version\php.exe" -v

# 5. Download and test extensions
$exts = Get-Content "bin\php$version\exts.properties"
# ... continue with extension testing

Architecture Validation Script

Here's a PowerShell script to validate DLL architecture (to be integrated into workflow):

function Test-DllArchitecture {
    param(
        [string]$DllPath,
        [string]$ExpectedArch = "AMD64"  # or "I386" for x86
    )
    
    try {
        $fs = [System.IO.FileStream]::new($DllPath, [System.IO.FileMode]::Open, [System.IO.FileAccess]::Read)
        $br = [System.IO.BinaryReader]::new($fs)
        
        # Read DOS header
        $dosHeader = $br.ReadBytes(64)
        $peOffset = [BitConverter]::ToInt32($dosHeader, 60)
        
        # Seek to PE header
        $fs.Seek($peOffset, [System.IO.SeekOrigin]::Begin) | Out-Null
        $peSignature = $br.ReadBytes(4)
        
        # Read COFF header
        $machine = $br.ReadUInt16()
        
        $fs.Close()
        
        $arch = switch ($machine) {
            0x014c { "I386" }   # x86
            0x8664 { "AMD64" }  # x64
            default { "UNKNOWN" }
        }
        
        return @{
            Success = ($arch -eq $ExpectedArch)
            Detected = $arch
            Expected = $ExpectedArch
        }
    }
    catch {
        return @{
            Success = $false
            Error = $_.Exception.Message
        }
    }
}

# Usage:
$result = Test-DllArchitecture -DllPath "php_imagick.dll" -ExpectedArch "AMD64"
if ($result.Success) {
    Write-Host "✅ DLL architecture is correct: $($result.Detected)"
} else {
    Write-Host "❌ DLL architecture mismatch: Expected $($result.Expected), got $($result.Detected)"
}

File Structure Reference

Each PHP version in the repository follows this structure:

bin/
└── php{version}/
    ├── bearsampp.conf      # Bearsampp configuration
    ├── deps.properties     # External dependencies (ImageMagick, etc.)
    ├── exts.properties     # PHP extensions (imagick, memcache, xdebug)
    ���── pear.properties     # PEAR configuration
    ├── php.ini             # PHP configuration
    └── deps/
        └── README.txt      # Dependency documentation

Example for PHP 8.3.27:

bin/php8.3.27/exts.properties - Lists 3 extensions
bin/php8.3.27/deps.properties - Lists ImageMagick dependency
bin/php8.3.27/php.ini - Contains extension configuration

Contributing

To contribute to the extension testing workflow:

Review this document to understand current status
Implement one or more tasks from the priority list
Test locally using the provided scripts
Submit a PR with your changes
The workflow will run on your PR (though validation is incomplete)

Questions or Issues?

Workflow Issues: Check .github/workflows/php-extension-test.yml
Extension Issues: Check bin/php{version}/exts.properties
Dependency Issues: Check bin/php{version}/deps.properties
General Issues: Report on Bearsampp repository

Last Updated: 2025-02-18
Status: 🎉 ALL PHASES COMPLETE - Full CI/CD testing workflow operational!

Navigation Menu

Uh oh!

Uh oh!

PHP Extension Testing CI/CD Workflow

Overview

Workflow Location

Current Status

✅ What is Currently Working

✅ Complete Implementation Status

What Needs to Be Tested

1. PHP Extensions (`exts.properties`)

2. Dependencies (`deps.properties`)

3. Configuration Files

Required Implementation Tasks

Phase 1: Basic PHP Validation

Task 1.1: Download and Extract PHP

Task 1.2: Verify PHP Executable

Phase 2: Extension Validation

Task 2.1: Download Extensions

Task 2.2: Validate DLL Architecture

Task 2.3: Test Extension Loading

Phase 3: Dependency Validation

Task 3.1: Download Dependencies

Task 3.2: Test Extension with Dependencies

Phase 4: Functional Testing (Optional)

Task 4.1: Basic Functionality Tests

Phase 5: Error Handling and Reporting

Task 5.1: Capture Detailed Errors

Task 5.2: Enhanced PR Comments

Implementation Priority

High Priority (Must Have)

Medium Priority (Should Have)

Low Priority (Nice to Have)

Testing Workflow Locally

Architecture Validation Script

File Structure Reference

Related Documentation

Contributing

Questions or Issues?

Uh oh!

Uh oh!

FilesExpand file tree

PHP-EXTENSION-TESTING.md

Latest commit

History

PHP-EXTENSION-TESTING.md

File metadata and controls

PHP Extension Testing CI/CD Workflow

Overview

Workflow Location

Current Status

✅ What is Currently Working

✅ Complete Implementation Status

What Needs to Be Tested

1. PHP Extensions (exts.properties)

2. Dependencies (deps.properties)

3. Configuration Files

Required Implementation Tasks

Phase 1: Basic PHP Validation

Task 1.1: Download and Extract PHP

Task 1.2: Verify PHP Executable

Phase 2: Extension Validation

Task 2.1: Download Extensions

Task 2.2: Validate DLL Architecture

Task 2.3: Test Extension Loading

Phase 3: Dependency Validation

Task 3.1: Download Dependencies

Task 3.2: Test Extension with Dependencies

Phase 4: Functional Testing (Optional)

Task 4.1: Basic Functionality Tests

Phase 5: Error Handling and Reporting

Task 5.1: Capture Detailed Errors

Task 5.2: Enhanced PR Comments

Implementation Priority

High Priority (Must Have)

Medium Priority (Should Have)

Low Priority (Nice to Have)

Testing Workflow Locally

Architecture Validation Script

File Structure Reference

Related Documentation

Contributing

Questions or Issues?

1. PHP Extensions (`exts.properties`)

2. Dependencies (`deps.properties`)