Add support to run tests with and without opcache

Author: shivammathur

README.md

@@ -62,7 +62,7 @@ Build a PHP extension for a specific version.
     php-version: '8.3'
     ts: nts
     arch: x64
-    args: --enable-xdebug
+    args: --with-xdebug
     libs: zlib
 ```
 
@@ -78,6 +78,7 @@ Build a PHP extension for a specific version.
 - `build-directory` (optional) - The directory to build the extension in, defaults to the user's temporary directory.
 - `run-tests` (optional) - Run the extension tests. Defaults to `true`.
 - `test-runner` (optional) - The test runner to use. Defaults to `run-tests.php`.
+- `test-opcache-mode` (optional) - Run tests with opcache `on`, `off` or `both`. Defaults to `on`.
 - `auth-token` (optional) - Authentication token to use in case the extension is hosted on a private repository.
 
 Instead of having to configure all the inputs for the extension action, you can use the `extension-matrix` action to get the matrix of jobs with different input configurations.

extension/BuildPhpExtension/private/Get-BuildDirectory.ps1

@@ -2,22 +2,28 @@ Function Get-BuildDirectory {
     <#
     .SYNOPSIS
         Get the directory to build the extension.
+    .PARAMETER ParentBuildDirectory
+        Parent directory to create the build directory.
     #>
     [OutputType()]
     param(
+        [Parameter(Mandatory = $false, Position=0, HelpMessage='Parent directory to create the build directory.')]
+        [string] $ParentBuildDirectory = ""
     )
     begin {
     }
     process {
-        if ($null -ne $env:BUILD_DIRECTORY -and $env:BUILD_DIRECTORY -ne "") {
-            $parentBuildDirectory = $env:BUILD_DIRECTORY
-        } else {
-            $parentBuildDirectory = [System.IO.Path]::GetTempPath()
+        if($ParentBuildDirectory -eq "") {
+            if ($null -ne $env:BUILD_DIRECTORY -and $env:BUILD_DIRECTORY -ne "") {
+                $ParentBuildDirectory = $env:BUILD_DIRECTORY
+            } else {
+                $ParentBuildDirectory = [System.IO.Path]::GetTempPath()
+            }
         }
 
         $buildDirectory = [System.Guid]::NewGuid().ToString().substring(0, 8)
 
-        $buildDirectoryPath = [System.IO.Path]::Combine($parentBuildDirectory, $buildDirectory)
+        $buildDirectoryPath = [System.IO.Path]::Combine($ParentBuildDirectory, $buildDirectory)
 
         New-Item "$buildDirectoryPath" -ItemType "directory" -Force > $null 2>&1
 

extension/BuildPhpExtension/private/Invoke-Tests.ps1

@@ -13,15 +13,13 @@ Function Invoke-Tests {
     begin {
     }
     process {
-        Add-StepLog "Running tests for $($Config.name) extension"
         try {
             $currentDirectory = (Get-Location).Path
             $php_dir = Join-Path $currentDirectory php-bin
             $env:TEST_PHP_EXECUTABLE = "$php_dir\php.exe"
             $env:REPORT_EXIT_STATUS = 1
             $env:XDEBUG_MODE = ""
-            $env:TEMP=$((Get-Item -LiteralPath $Env:TEMP).FullName)
-            $env:TMP=$((Get-Item -LiteralPath $Env:TMP).FullName)
+            $tempOriginal = $env:TEMP
             $type='extension'
             if ((Select-String -Path 'config.w32' -Pattern 'ZEND_EXTENSION\(' -Quiet) -eq $true) {
                 $type='zend_extension'
@@ -47,22 +45,58 @@ Function Invoke-Tests {
                 '--show-diff',
                 '--show-slow 1000',
                 '--set-timeout 120',
-                '-g FAIL,XFAIL,BORK,WARN,LEAK,SKIP',
-                '--temp-source ' + $env:TEMP,
-                '--temp-target ' + $env:TEMP
+                '-g FAIL,XFAIL,BORK,WARN,LEAK,SKIP'
             )
-            $phpExpression = "php $env:TEST_RUNNER " + ($test_runner_args -join ' ')
-            chcp 65001
-            Write-Output "Running tests... $phpExpression"
-            Write-Output "TEST_PHP_ARGS $env:TEST_PHP_ARGS"
-            Write-Output "TEST_PHP_EXECUTABLE $env:TEST_PHP_EXECUTABLE"
-            Invoke-Expression $phpExpression
-            if ($LASTEXITCODE -ne 0) {
-                exit $LASTEXITCODE
+
+            $opcacheModes = @($env:TEST_OPCACHE_MODE)
+            if($env:TEST_OPCACHE_MODE -eq 'both') {
+                $opcacheModes = @('on', 'off')
             }
-            Add-BuildLog tick $($Config.name) "Tests executed successfully"
+            $success = $True
+            foreach($opcacheMode in $opcacheModes) {
+                $suffix = ""
+                if($env:TEST_OPCACHE_MODE -eq 'both') {
+                    $suffix = " (opcache=$opcacheMode)"
+                }
+                Add-StepLog "Running tests for $($Config.name) extension$suffix"
+                Set-GAGroup start
+                $tempDirectory = Get-BuildDirectory $currentDirectory
+                $env:TEMP=$tempDirectory
+                $env:TMP=$tempDirectory
+                $env:OPCACHE = $opcacheMode
+                $test_runner_args += '--temp-source ' + $tempDirectory;
+                $test_runner_args += '--temp-target ' + $tempDirectory;
+                $opcache_args = @()
+                if($opcacheMode -eq 'on') {
+                    $opcache_args += "-d zend_extension=$php_dir\ext\php_opcache.dll"
+                    $opcache_args += "-d opcache.enable=1"
+                    $opcache_args += "-d opcache.enable_cli=1"
+                    $opcache_args += "-d opcache.optimization_level=1"
+                }
+                $phpExpression = @(
+                    'php',
+                    $env:TEST_RUNNER,
+                    ($test_runner_args -join ' '),
+                    ($opcache_args -join ' ')
+                ) -join ' '
+                Write-Host "Running tests... $phpExpression"
+                Write-Host "TEST_PHP_ARGS $env:TEST_PHP_ARGS"
+                Write-Host "TEST_PHP_EXECUTABLE $env:TEST_PHP_EXECUTABLE"
+                chcp 65001
+                Invoke-Expression $phpExpression
+                if ($LASTEXITCODE -ne 0) {
+                    $success = $False
+                }
+                Set-GAGroup end
+            }
+            $env:TEMP = $tempOriginal
+            $env:TMP = $tempOriginal
+            if(-not $success) {
+                throw "Failed to run tests successfully"
+            }
+            Add-BuildLog tick $($Config.name) "Tests run successfully"
         } catch {
-            Add-BuildLog cross $($Config.name) "Failed to run tests"
+            Add-BuildLog cross $($Config.name) "Failed to run tests successfully"
             throw
         }
     }

extension/action.yml

@@ -39,6 +39,10 @@ inputs:
     description: Test runner to use
     required: false
     default: 'run-tests.php'
+  test-opcache-mode:
+    description: Test opcache mode
+    required: false
+    default: 'on'
   build-directory:
     description: Directory to build the extension in
     required: false
@@ -58,6 +62,7 @@ runs:
         ARTIFACT_NAMING_SCHEME: ${{env.artifact-naming-scheme}}
         RUN_TESTS: ${{inputs.run-tests}}
         TEST_RUNNER: ${{inputs.test-runner}}
+        TEST_OPCACHE_MODE: ${{inputs.test-opcache-mode}}
         BUILD_DIRECTORY: ${{inputs.build-directory}}
         AUTH_TOKEN: ${{inputs.auth-token}}
       run: |