fix(testing): Handles opcache config better

Previously it was assumed that the Zend OPCache module was NOT loaded in the
environment which integration and mutliverse tests were run.  Now the PHP Docker
images have Zend OPCache loaded by default, causing errors when the
integration_runner also tried to load this module.  These changes identify if the module
is loaded by default and handles setting the opcache.enable and opcache.enable_cli
INI value based on the value of the "-opcache_off" command line option.

Author: mfulb

daemon/internal/newrelic/integration/test.go

@@ -214,7 +214,28 @@ func (t *Test) MakeRun(ctx *Context) (Tx, error) {
 		}
 	}
 
-	settings = merge(settings, t.PhpModules)
+	// Make a copy of t.PhpModules and remove any entries containing "opcache.so"
+	// if opcache.so is loaded by default
+	// 
+	// three cases:
+	// 1. C test - no opcache.so needed as PHP is not going to be run
+	// 2. Web test and php-cgi has opcache.so loaded by default - remove any PHPMODULE spec for opcache.so
+	// 3. PHP test and php has opcache.so loaded by default - remove any PHPMODULE spec for opcache.so
+	phpModulesCopy := make(map[string]string)
+	if (!t.IsC()) {
+		if (t.IsWeb() && ctx.OPCacheModuleLoaded[ctx.CGI]) ||
+			(ctx.OPCacheModuleLoaded[ctx.PHP]) {
+			for k, v := range t.PhpModules {
+				if !strings.Contains(v, "opcache.so") {
+					phpModulesCopy[k] = v
+				}
+			}
+		}
+	} else {
+		fmt.Printf("ERROR - UNEXPECTED - Running C test: %s\n", t.Path)
+		os.Exit(1)
+	}
+	settings = merge(settings, phpModulesCopy)
 
 	if t.IsC() {
 		return CTx(ScriptFile(t.Path), t.Env, settings, headers, ctx)

daemon/internal/newrelic/integration/transaction.go

@@ -48,15 +48,36 @@ func PhpTx(src Script, env, settings map[string]string, ctx *Context) (Tx, error
 
 	// Make a copy of settings to avoid mutating the original map
 	phpSettings := make(map[string]string, len(settings))
+	setOPCacheEnable := true
+	setOPCacheEnableCLI := true
 	for k, v := range settings {
 		phpSettings[k] = v
+
+		// see if settings affect opcache config
+		// if so then we will not set config below
+		if k == "opcache.enable" {
+			setOPCacheEnable = false
+		} else if k == "opcache.enable_cli" {
+			setOPCacheEnableCLI = false
+		}
 	}
 	if ctx.UseOPCache {
-		if !ctx.OPCacheModuleLoaded[ctx.PHP] {
+		if !ctx.OPCacheModuleLoaded[ctx.CGI] {
 			phpSettings["zend_extension"] = "opcache.so"
 		}
-		phpSettings["opcache.enable"] = "1"
-		phpSettings["opcache.enable_cli"] = "1"
+		if setOPCacheEnable {
+			phpSettings["opcache.enable"] = "1"
+		}
+		if setOPCacheEnableCLI {
+			phpSettings["opcache.enable_cli"] = "1"
+		}
+	} else {
+		if setOPCacheEnable {
+			phpSettings["opcache.enable"] = "0"
+		}
+		if setOPCacheEnableCLI {
+			phpSettings["opcache.enable_cli"] = "0"
+		}	
 	}
 
 	args := phpArgs(nil, filepath.Base(src.Name()), false, phpSettings)
@@ -121,15 +142,36 @@ func CgiTx(src Script, env, settings map[string]string, headers http.Header, ctx
 
 	// Make a copy of settings to avoid mutating the original map
 	cgiSettings := make(map[string]string, len(settings))
+	setOPCacheEnable := true
+	setOPCacheEnableCLI := true
 	for k, v := range settings {
 		cgiSettings[k] = v
+
+		// see if settings affect opcache config
+		// if so then we will not set config below
+		if k == "opcache.enable" {
+			setOPCacheEnable = false
+		} else if k == "opcache.enable_cli" {
+			setOPCacheEnableCLI = false
+		}
 	}
 	if ctx.UseOPCache {
 		if !ctx.OPCacheModuleLoaded[ctx.CGI] {
 			cgiSettings["zend_extension"] = "opcache.so"
 		}
-		cgiSettings["opcache.enable"] = "1"
-		cgiSettings["opcache.enable_cli"] = "1"
+		if setOPCacheEnable {
+			cgiSettings["opcache.enable"] = "1"
+		}
+		if setOPCacheEnableCLI {
+			cgiSettings["opcache.enable_cli"] = "1"
+		}
+	} else {
+		if setOPCacheEnable {
+			cgiSettings["opcache.enable"] = "0"
+		}
+		if setOPCacheEnableCLI {
+			cgiSettings["opcache.enable_cli"] = "0"
+		}	
 	}
 
 	if ctx.Valgrind != "" {

daemon/internal/newrelic/integration/util.go

@@ -55,7 +55,7 @@ func GetOPCacheModuleLoaded(php, cgi string) map[string]bool {
 	result[php] = IsOPcacheLoaded(php)
 	result[cgi] = IsOPcacheLoaded(cgi)	
 
-	fmt.Printf("OPcache loaded status: %+v\n", result)
+	fmt.Printf("OPcache default loading status: %+v\n", result)
 
 	return result
 }