Add php-src repo/ref overrides for libs workflow tests

shivammathur · shivammathur · commit 77373f015613 · 2026-03-26T12:44:44.000+05:30
diff --git a/php/BuildPhp/private/Add-TestRequirements.ps1 b/php/BuildPhp/private/Add-TestRequirements.ps1
@@ -12,6 +12,10 @@ function Add-TestRequirements {
         VS Version
     .PARAMETER TestsDirectory
         Tests Directory
+    .PARAMETER SourceRepository
+        php-src repository to source tests from when SourceRef is provided.
+    .PARAMETER SourceRef
+        Optional branch, tag, or SHA in the custom php-src repository.
     #>
     [OutputType()]
     param (
@@ -35,7 +39,11 @@ function Add-TestRequirements {
         [string] $TestsDirectory,
         [Parameter(Mandatory = $true, Position=5, HelpMessage='Artifacts Directory')]
         [ValidateNotNull()]
-        [string] $ArtifactsDirectory
+        [string] $ArtifactsDirectory,
+        [Parameter(Mandatory = $false, Position=6, HelpMessage='php-src repository to source tests from when SourceRef is provided')]
+        [string] $SourceRepository = 'php/php-src',
+        [Parameter(Mandatory = $false, Position=7, HelpMessage='Optional branch, tag, or SHA in the custom php-src repository')]
+        [string] $SourceRef = ''
     )
     begin {
     }
@@ -55,6 +63,7 @@ function Add-TestRequirements {
 
         $testZipFilePath = Join-Path $ArtifactsDirectory $testZipFile
         $testsDirectoryPath = Join-Path $currentDirectory $TestsDirectory
+        $useCustomSource = -not [string]::IsNullOrWhiteSpace($SourceRef)
 
         if(-not(Test-Path $binZipFilePath)) {
             Write-Host "Downloading PHP build $binZipFile..."
@@ -67,9 +76,16 @@ function Add-TestRequirements {
             }
         }
 
-        if(-not(Test-Path $testZipFilePath)) {
-            Write-Host "Downloading PHP test pack $testZipFile..."
-            Get-PhpTestPack -PhpVersion $PhpVersion -TestsDirectory $TestsDirectory
+        if($useCustomSource -or -not(Test-Path $testZipFilePath)) {
+            if($useCustomSource) {
+                Write-Host "Downloading PHP tests from custom php-src source..."
+            } else {
+                Write-Host "Downloading PHP test pack $testZipFile..."
+            }
+            Get-PhpTestPack -PhpVersion $PhpVersion `
+                            -TestsDirectory $TestsDirectory `
+                            -SourceRepository $SourceRepository `
+                            -SourceRef $SourceRef
         } else {
             try {
                 [System.IO.Compression.ZipFile]::ExtractToDirectory($testZipFilePath, $testsDirectoryPath)
diff --git a/php/BuildPhp/private/Get-PhpTestPack.ps1 b/php/BuildPhp/private/Get-PhpTestPack.ps1
@@ -6,6 +6,10 @@ function Get-PhpTestPack {
         PHP Version
     .PARAMETER TestsDirectory
         Tests Directory
+    .PARAMETER SourceRepository
+        php-src repository to source tests from when SourceRef is provided.
+    .PARAMETER SourceRef
+        Optional branch, tag, or SHA in the custom php-src repository.
     #>
     [OutputType()]
     param (
@@ -15,14 +19,70 @@ function Get-PhpTestPack {
         [string] $PhpVersion,
         [Parameter(Mandatory = $false, Position=1, HelpMessage='Tests Directory')]
         [ValidateLength(1, [int]::MaxValue)]
-        [string] $TestsDirectory
+        [string] $TestsDirectory,
+        [Parameter(Mandatory = $false, Position=2, HelpMessage='php-src repository to source tests from when SourceRef is provided')]
+        [string] $SourceRepository = 'php/php-src',
+        [Parameter(Mandatory = $false, Position=3, HelpMessage='Optional branch, tag, or SHA in the custom php-src repository')]
+        [string] $SourceRef = ''
     )
     begin {
     }
     process {
         Add-Type -Assembly "System.IO.Compression.Filesystem"
 
         $versionInUrl = $PhpVersion
+        $currentDirectory = (Get-Location).Path
+        $testsDirectoryPath = Join-Path $currentDirectory $TestsDirectory
+        $useCustomSource = -not [string]::IsNullOrWhiteSpace($SourceRef)
+
+        if($useCustomSource) {
+            if([string]::IsNullOrWhiteSpace($SourceRepository)) {
+                throw "SourceRepository must be provided to source tests from a custom php-src archive."
+            }
+
+            $sourceZipFile = ("php-src-tests-{0}-{1}.zip" -f `
+                ($SourceRepository -replace '[\\/]', '-'), `
+                ($SourceRef -replace '[^0-9A-Za-z._-]', '-'))
+            $sourceZipPath = Join-Path $currentDirectory $sourceZipFile
+            $extractRoot = Join-Path $currentDirectory ("php-src-tests-" + [System.Guid]::NewGuid().ToString())
+            $sourceUrl = "https://api.github.com/repos/$SourceRepository/zipball/$([System.Uri]::EscapeDataString($SourceRef))"
+            $headers = @{
+                'User-Agent' = 'php-windows-builder'
+                'X-GitHub-Api-Version' = '2022-11-28'
+            }
+
+            if($env:GITHUB_TOKEN) {
+                $headers['Authorization'] = 'Bearer ' + $env:GITHUB_TOKEN
+            } else {
+                Write-Warning 'GITHUB_TOKEN not set. API rate limits may apply when downloading custom php-src tests.'
+            }
+
+            Write-Host "Downloading PHP tests from $SourceRepository@$SourceRef..."
+            Invoke-WebRequest -Uri $sourceUrl -Headers $headers -OutFile $sourceZipPath -UseBasicParsing
+
+            New-Item -Path $extractRoot -ItemType "directory" -Force > $null 2>&1
+            try {
+                try {
+                    [System.IO.Compression.ZipFile]::ExtractToDirectory($sourceZipPath, $extractRoot)
+                } catch {
+                    7z x $sourceZipPath "-o$extractRoot" -y | Out-Null
+                }
+
+                $sourceRoots = @(
+                    Get-ChildItem -Path $extractRoot -Directory
+                )
+                if($sourceRoots.Count -ne 1) {
+                    throw "Expected a single root directory in custom php-src archive, found $($sourceRoots.Count)."
+                }
+
+                Move-Item -Path $sourceRoots[0].FullName -Destination $testsDirectoryPath
+            } finally {
+                Remove-Item -Path $extractRoot -Recurse -Force -ErrorAction Ignore
+            }
+
+            return
+        }
+
         if($PhpVersion -eq 'master') {
             $fallbackBaseUrl = $baseUrl = "https://github.com/shivammathur/php-builder-windows/releases/download/master"
             $versionInUrl = "master"
@@ -45,9 +105,7 @@ function Get-PhpTestPack {
             }
         }
 
-        $currentDirectory = (Get-Location).Path
         $testZipFilePath = Join-Path $currentDirectory $testZipFile
-        $testsDirectoryPath = Join-Path $currentDirectory $TestsDirectory
 
         try {
             [System.IO.Compression.ZipFile]::ExtractToDirectory($testZipFilePath, $testsDirectoryPath)
@@ -57,4 +115,4 @@ function Get-PhpTestPack {
     }
     end {
     }
-}
+}
diff --git a/php/BuildPhp/public/Invoke-PhpTests.ps1 b/php/BuildPhp/public/Invoke-PhpTests.ps1
@@ -12,6 +12,10 @@ function Invoke-PhpTests {
         Specify Cache
     .PARAMETER TestType
         Test Type
+    .PARAMETER SourceRepository
+        php-src repository to source tests from when SourceRef is provided.
+    .PARAMETER SourceRef
+        Optional branch, tag, or SHA in the custom php-src repository.
     #>
     [OutputType()]
     param (
@@ -32,7 +36,11 @@ function Invoke-PhpTests {
         [string] $Opcache,
         [Parameter(Mandatory = $true, Position=4, HelpMessage='Test Type')]
         [ValidateSet('ext', 'php')]
-        [string] $TestType
+        [string] $TestType,
+        [Parameter(Mandatory = $false, Position=5, HelpMessage='php-src repository to source tests from when SourceRef is provided')]
+        [string] $SourceRepository = 'php/php-src',
+        [Parameter(Mandatory = $false, Position=6, HelpMessage='Optional branch, tag, or SHA in the custom php-src repository')]
+        [string] $SourceRef = ''
     )
     begin {
     }
@@ -57,7 +65,14 @@ function Invoke-PhpTests {
 
         Set-Location "$buildDirectory"
 
-        Add-TestRequirements -PhpVersion $PhpVersion -Arch $Arch -Ts $Ts -VsVersion $VsData.vs -TestsDirectory $testsDirectory -ArtifactsDirectory $currentDirectory
+        Add-TestRequirements -PhpVersion $PhpVersion `
+                             -Arch $Arch `
+                             -Ts $Ts `
+                             -VsVersion $VsData.vs `
+                             -TestsDirectory $testsDirectory `
+                             -ArtifactsDirectory $currentDirectory `
+                             -SourceRepository $SourceRepository `
+                             -SourceRef $SourceRef
 
         Set-PhpIniForTests -BuildDirectory $buildDirectory -Opcache $Opcache
 
