Add CONTRAST_INSTALLATION_TOOL to all agent injectors, remove CONTRAST_INSTALL_SOURCE for agents that did not use it

gamingrobot · gamingrobot · commit 4a3ea0a2b7e0 · 2025-02-19T14:41:56.000-06:00
diff --git a/src/Contrast.K8s.AgentOperator/Core/Reactions/Injecting/Patching/Agents/DotNetPatcher.cs b/src/Contrast.K8s.AgentOperator/Core/Reactions/Injecting/Patching/Agents/DotNetPatcher.cs
@@ -34,8 +34,8 @@ public IEnumerable<V1EnvVar> GenerateEnvVars(PatchingContext context)
             yield return new V1EnvVar("CORECLR_ENABLE_PROFILING", "1");
         }
 
-        yield return new V1EnvVar("CONTRAST_SOURCE", "kubernetes-operator"); //TODO: remove later after dotnet agent has migrated to CONTRAST_INSTALL_SOURCE
-        yield return new V1EnvVar("CONTRAST_INSTALL_SOURCE", "kubernetes-operator");
+        yield return new V1EnvVar("CONTRAST_INSTALL_SOURCE", "kubernetes-operator"); //For backwards compatibility
+        yield return new V1EnvVar("CONTRAST_INSTALLATION_TOOL", "KUBERNETES_OPERATOR");
         yield return new V1EnvVar("CONTRAST_CORECLR_INSTALL_DIRECTORY", context.AgentMountPath);
         yield return new V1EnvVar("CONTRAST_CORECLR_DATA_DIRECTORY", context.WritableMountPath);
         yield return new V1EnvVar("CONTRAST_CORECLR_LOGS_DIRECTORY", $"{context.WritableMountPath}/logs");
diff --git a/src/Contrast.K8s.AgentOperator/Core/Reactions/Injecting/Patching/Agents/JavaAgentPatcher.cs b/src/Contrast.K8s.AgentOperator/Core/Reactions/Injecting/Patching/Agents/JavaAgentPatcher.cs
@@ -22,7 +22,7 @@ public IEnumerable<V1EnvVar> GenerateEnvVars(PatchingContext context)
         yield return new V1EnvVar("JAVA_TOOL_OPTIONS", GetContrastAgentArgument(context));
         yield return new V1EnvVar("CONTRAST__AGENT__CONTRAST_WORKING_DIR", context.WritableMountPath);
         yield return new V1EnvVar("CONTRAST__AGENT__LOGGER__PATH", $"{context.WritableMountPath}/logs/contrast_agent.log");
-        yield return new V1EnvVar("CONTRAST_INSTALL_SOURCE", "kubernetes-operator");
+        yield return new V1EnvVar("CONTRAST_INSTALLATION_TOOL", "KUBERNETES_OPERATOR");
 
         //Disable hierarchy cache since we are in containers
         yield return new V1EnvVar("CONTRAST__ASSESS__CACHE__HIERARCHY_ENABLE", "false");
diff --git a/src/Contrast.K8s.AgentOperator/Core/Reactions/Injecting/Patching/Agents/NodeJsAgentPatcher.cs b/src/Contrast.K8s.AgentOperator/Core/Reactions/Injecting/Patching/Agents/NodeJsAgentPatcher.cs
@@ -17,6 +17,6 @@ public IEnumerable<V1EnvVar> GenerateEnvVars(PatchingContext context)
         yield return new V1EnvVar("NODE_OPTIONS", $"--require {context.AgentMountPath}/node_modules/@contrast/agent");
         yield return new V1EnvVar("CONTRAST__AGENT__LOGGER__PATH", $"{context.WritableMountPath}/logs/contrast_agent.log");
         yield return new V1EnvVar("CONTRAST__AGENT__SECURITY_LOGGER__PATH", $"{context.WritableMountPath}/logs/contrast_agent_cef.log");
-        yield return new V1EnvVar("CONTRAST_INSTALL_SOURCE", "kubernetes-operator");
+        yield return new V1EnvVar("CONTRAST_INSTALLATION_TOOL", "KUBERNETES_OPERATOR");
     }
 }
diff --git a/src/Contrast.K8s.AgentOperator/Core/Reactions/Injecting/Patching/Agents/NodeJsEsmAgentPatcher.cs b/src/Contrast.K8s.AgentOperator/Core/Reactions/Injecting/Patching/Agents/NodeJsEsmAgentPatcher.cs
@@ -17,6 +17,6 @@ public IEnumerable<V1EnvVar> GenerateEnvVars(PatchingContext context)
         yield return new V1EnvVar("NODE_OPTIONS", $"--import {context.AgentMountPath}/node_modules/@contrast/agent/lib/esm-loader.mjs");
         yield return new V1EnvVar("CONTRAST__AGENT__LOGGER__PATH", $"{context.WritableMountPath}/logs/contrast_agent.log");
         yield return new V1EnvVar("CONTRAST__AGENT__SECURITY_LOGGER__PATH", $"{context.WritableMountPath}/logs/contrast_agent_cef.log");
-        yield return new V1EnvVar("CONTRAST_INSTALL_SOURCE", "kubernetes-operator");
+        yield return new V1EnvVar("CONTRAST_INSTALLATION_TOOL", "KUBERNETES_OPERATOR");
     }
 }
diff --git a/src/Contrast.K8s.AgentOperator/Core/Reactions/Injecting/Patching/Agents/PhpAgentPatcher.cs b/src/Contrast.K8s.AgentOperator/Core/Reactions/Injecting/Patching/Agents/PhpAgentPatcher.cs
@@ -15,7 +15,7 @@ public IEnumerable<V1EnvVar> GenerateEnvVars(PatchingContext context)
     {
         yield return new V1EnvVar("PHP_INI_SCAN_DIR", $":{context.AgentMountPath}/ini/");
         yield return new V1EnvVar("CONTRAST__AGENT__LOGGER__PATH", $"{context.WritableMountPath}/logs/contrast_agent.log");
-        yield return new V1EnvVar("CONTRAST_INSTALL_SOURCE", "kubernetes-operator");
+        yield return new V1EnvVar("CONTRAST_INSTALLATION_TOOL", "KUBERNETES_OPERATOR");
     }
 
     public string GetOverrideAgentMountPath() => "/usr/local/lib/contrast/php";
diff --git a/src/Contrast.K8s.AgentOperator/Core/Reactions/Injecting/Patching/Agents/PythonAgentPatcher.cs b/src/Contrast.K8s.AgentOperator/Core/Reactions/Injecting/Patching/Agents/PythonAgentPatcher.cs
@@ -27,6 +27,6 @@ public IEnumerable<V1EnvVar> GenerateEnvVars(PatchingContext context)
         }
         yield return new V1EnvVar("__CONTRAST_USING_RUNNER", "true");
         yield return new V1EnvVar("CONTRAST__AGENT__LOGGER__PATH", $"{context.WritableMountPath}/logs/contrast_agent.log");
-        yield return new V1EnvVar("CONTRAST_INSTALL_SOURCE", "kubernetes-operator");
+        yield return new V1EnvVar("CONTRAST_INSTALLATION_TOOL", "KUBERNETES_OPERATOR");
     }
 }
diff --git a/tests/Contrast.K8s.AgentOperator.FunctionalTests/Scenarios/Injection/Agents/DotnetInjectionTests.cs b/tests/Contrast.K8s.AgentOperator.FunctionalTests/Scenarios/Injection/Agents/DotnetInjectionTests.cs
@@ -41,8 +41,10 @@ public async Task When_injected_then_pod_should_have_agent_injection_environment
                      .Which.Value.Should().Be("/contrast/agent/runtimes/linux-x64/native/ContrastProfiler.so");
             container.Env.Should().Contain(x => x.Name == "CORECLR_ENABLE_PROFILING")
                      .Which.Value.Should().Be("1");
-            container.Env.Should().Contain(x => x.Name == "CONTRAST_SOURCE")
+            container.Env.Should().Contain(x => x.Name == "CONTRAST_INSTALL_SOURCE")
                      .Which.Value.Should().Be("kubernetes-operator");
+            container.Env.Should().Contain(x => x.Name == "CONTRAST_INSTALLATION_TOOL")
+                     .Which.Value.Should().Be("KUBERNETES_OPERATOR");
             container.Env.Should().Contain(x => x.Name == "CONTRAST_CORECLR_INSTALL_DIRECTORY")
                      .Which.Value.Should().Be("/contrast/agent");
             container.Env.Should().Contain(x => x.Name == "CONTRAST_CORECLR_DATA_DIRECTORY")
diff --git a/tests/Contrast.K8s.AgentOperator.FunctionalTests/Scenarios/Injection/Agents/JavaInjectionTests.cs b/tests/Contrast.K8s.AgentOperator.FunctionalTests/Scenarios/Injection/Agents/JavaInjectionTests.cs
@@ -41,6 +41,8 @@ public async Task When_injected_then_pod_should_have_agent_injection_environment
                      .Which.Value.Should().Be("/contrast/data");
             container.Env.Should().Contain(x => x.Name == "CONTRAST__AGENT__LOGGER__PATH")
                      .Which.Value.Should().Be("/contrast/data/logs/contrast_agent.log");
+            container.Env.Should().Contain(x => x.Name == "CONTRAST_INSTALLATION_TOOL")
+                     .Which.Value.Should().Be("KUBERNETES_OPERATOR");
         }
     }
 
diff --git a/tests/Contrast.K8s.AgentOperator.FunctionalTests/Scenarios/Injection/Agents/NodeJsEsmInjectionTests.cs b/tests/Contrast.K8s.AgentOperator.FunctionalTests/Scenarios/Injection/Agents/NodeJsEsmInjectionTests.cs
@@ -38,6 +38,8 @@ public async Task When_injected_then_pod_should_have_agent_injection_environment
                      .Which.Value.Should().Be("--import /contrast/agent/node_modules/@contrast/agent/lib/esm-loader.mjs");
             container.Env.Should().Contain(x => x.Name == "CONTRAST__AGENT__LOGGER__PATH")
                      .Which.Value.Should().Be("/contrast/data/logs/contrast_agent.log");
+            container.Env.Should().Contain(x => x.Name == "CONTRAST_INSTALLATION_TOOL")
+                     .Which.Value.Should().Be("KUBERNETES_OPERATOR");
         }
     }
 
diff --git a/tests/Contrast.K8s.AgentOperator.FunctionalTests/Scenarios/Injection/Agents/NodeJsInjectionTests.cs b/tests/Contrast.K8s.AgentOperator.FunctionalTests/Scenarios/Injection/Agents/NodeJsInjectionTests.cs
@@ -38,6 +38,8 @@ public async Task When_injected_then_pod_should_have_agent_injection_environment
                      .Which.Value.Should().Be("--require /contrast/agent/node_modules/@contrast/agent");
             container.Env.Should().Contain(x => x.Name == "CONTRAST__AGENT__LOGGER__PATH")
                      .Which.Value.Should().Be("/contrast/data/logs/contrast_agent.log");
+            container.Env.Should().Contain(x => x.Name == "CONTRAST_INSTALLATION_TOOL")
+                     .Which.Value.Should().Be("KUBERNETES_OPERATOR");
         }
     }
 
diff --git a/tests/Contrast.K8s.AgentOperator.FunctionalTests/Scenarios/Injection/Agents/PhpInjectionTests.cs b/tests/Contrast.K8s.AgentOperator.FunctionalTests/Scenarios/Injection/Agents/PhpInjectionTests.cs
@@ -39,6 +39,8 @@ public async Task When_injected_then_pod_should_have_agent_injection_environment
                      .Which.Value.Should().Be(":/usr/local/lib/contrast/php/ini/");
             container.Env.Should().Contain(x => x.Name == "CONTRAST__AGENT__LOGGER__PATH")
                      .Which.Value.Should().Be("/contrast/data/logs/contrast_agent.log");
+            container.Env.Should().Contain(x => x.Name == "CONTRAST_INSTALLATION_TOOL")
+                     .Which.Value.Should().Be("KUBERNETES_OPERATOR");
         }
     }
 
diff --git a/tests/Contrast.K8s.AgentOperator.FunctionalTests/Scenarios/Injection/Agents/PythhonInjectionTests.cs b/tests/Contrast.K8s.AgentOperator.FunctionalTests/Scenarios/Injection/Agents/PythhonInjectionTests.cs
@@ -42,6 +42,8 @@ public async Task When_injected_then_pod_should_have_agent_injection_environment
                 .Which.Value.Should().Be("true");
             container.Env.Should().Contain(x => x.Name == "CONTRAST__AGENT__LOGGER__PATH")
                 .Which.Value.Should().Be("/contrast/data/logs/contrast_agent.log");
+            container.Env.Should().Contain(x => x.Name == "CONTRAST_INSTALLATION_TOOL")
+                .Which.Value.Should().Be("KUBERNETES_OPERATOR");
         }
     }
 
diff --git a/tests/Contrast.K8s.AgentOperator.Tests/Core/Reactions/Injecting/Patching/Agents/DotNetPatcherTests.cs b/tests/Contrast.K8s.AgentOperator.Tests/Core/Reactions/Injecting/Patching/Agents/DotNetPatcherTests.cs
@@ -28,8 +28,8 @@ public void GenerateEnvVars_should_return_profiling_vars()
                 "CORECLR_PROFILER",
                 "CORECLR_PROFILER_PATH",
                 "CORECLR_ENABLE_PROFILING",
-                "CONTRAST_SOURCE",
                 "CONTRAST_INSTALL_SOURCE",
+                "CONTRAST_INSTALLATION_TOOL",
                 "CONTRAST_CORECLR_INSTALL_DIRECTORY",
                 "CONTRAST_CORECLR_DATA_DIRECTORY",
                 "CONTRAST_CORECLR_LOGS_DIRECTORY",
@@ -52,8 +52,8 @@ public void GenerateEnvVars_should_return_ldpreload_if_early_chaining()
             var expectedEnvVars = new List<string>
             {
                 "LD_PRELOAD",
-                "CONTRAST_SOURCE",
                 "CONTRAST_INSTALL_SOURCE",
+                "CONTRAST_INSTALLATION_TOOL",
                 "CONTRAST_CORECLR_INSTALL_DIRECTORY",
                 "CONTRAST_CORECLR_DATA_DIRECTORY",
                 "CONTRAST_CORECLR_LOGS_DIRECTORY",
diff --git a/tests/Contrast.K8s.AgentOperator.Tests/Core/Reactions/Injecting/Patching/Agents/JavaAgentPatcherTests.cs b/tests/Contrast.K8s.AgentOperator.Tests/Core/Reactions/Injecting/Patching/Agents/JavaAgentPatcherTests.cs
@@ -56,7 +56,7 @@ public void GenerateEnvVars_should_return_correct_env_vars()
                 new("JAVA_TOOL_OPTIONS", $"-javaagent:{contextFake.AgentMountPath}/contrast-agent.jar"),
                 new("CONTRAST__AGENT__CONTRAST_WORKING_DIR", contextFake.WritableMountPath),
                 new("CONTRAST__AGENT__LOGGER__PATH", $"{contextFake.WritableMountPath}/logs/contrast_agent.log"),
-                new("CONTRAST_INSTALL_SOURCE", "kubernetes-operator"),
+                new("CONTRAST_INSTALLATION_TOOL", "KUBERNETES_OPERATOR"),
                 new("CONTRAST__ASSESS__CACHE__HIERARCHY_ENABLE", "false"),
             });
         }
diff --git a/tests/Contrast.K8s.AgentOperator.Tests/Core/Reactions/Injecting/Patching/Agents/PythonPatcherTests.cs b/tests/Contrast.K8s.AgentOperator.Tests/Core/Reactions/Injecting/Patching/Agents/PythonPatcherTests.cs
@@ -26,7 +26,7 @@ public void GenerateEnvVars_should_not_return_rewrite_if_not_rewriting()
                 "PYTHONPATH",
                 "__CONTRAST_USING_RUNNER",
                 "CONTRAST__AGENT__LOGGER__PATH",
-                "CONTRAST_INSTALL_SOURCE",
+                "CONTRAST_INSTALLATION_TOOL",
             };
 
             // Act
@@ -48,7 +48,7 @@ public void GenerateEnvVars_should_return_rewrite_if_rewriting()
                 "CONTRAST__AGENT__PYTHON__REWRITE",
                 "__CONTRAST_USING_RUNNER",
                 "CONTRAST__AGENT__LOGGER__PATH",
-                "CONTRAST_INSTALL_SOURCE",
+                "CONTRAST_INSTALLATION_TOOL",
             };
 
             // Act

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,6 @@ public IEnumerable<V1EnvVar> GenerateEnvVars(PatchingContext context)`
`17`	`17`	`yield return new V1EnvVar("NODE_OPTIONS", $"--require {context.AgentMountPath}/node_modules/@contrast/agent");`
`18`	`18`	`yield return new V1EnvVar("CONTRAST__AGENT__LOGGER__PATH", $"{context.WritableMountPath}/logs/contrast_agent.log");`
`19`	`19`	`yield return new V1EnvVar("CONTRAST__AGENT__SECURITY_LOGGER__PATH", $"{context.WritableMountPath}/logs/contrast_agent_cef.log");`
`20`		`- yield return new V1EnvVar("CONTRAST_INSTALL_SOURCE", "kubernetes-operator");`
	`20`	`+ yield return new V1EnvVar("CONTRAST_INSTALLATION_TOOL", "KUBERNETES_OPERATOR");`
`21`	`21`	`}`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public IEnumerable<V1EnvVar> GenerateEnvVars(PatchingContext context)`
`15`	`15`	`{`
`16`	`16`	`yield return new V1EnvVar("PHP_INI_SCAN_DIR", $":{context.AgentMountPath}/ini/");`
`17`	`17`	`yield return new V1EnvVar("CONTRAST__AGENT__LOGGER__PATH", $"{context.WritableMountPath}/logs/contrast_agent.log");`
`18`		`- yield return new V1EnvVar("CONTRAST_INSTALL_SOURCE", "kubernetes-operator");`
	`18`	`+ yield return new V1EnvVar("CONTRAST_INSTALLATION_TOOL", "KUBERNETES_OPERATOR");`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`public string GetOverrideAgentMountPath() => "/usr/local/lib/contrast/php";`
Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,6 @@ public IEnumerable<V1EnvVar> GenerateEnvVars(PatchingContext context)`
`27`	`27`	`}`
`28`	`28`	`yield return new V1EnvVar("__CONTRAST_USING_RUNNER", "true");`
`29`	`29`	`yield return new V1EnvVar("CONTRAST__AGENT__LOGGER__PATH", $"{context.WritableMountPath}/logs/contrast_agent.log");`
`30`		`- yield return new V1EnvVar("CONTRAST_INSTALL_SOURCE", "kubernetes-operator");`
	`30`	`+ yield return new V1EnvVar("CONTRAST_INSTALLATION_TOOL", "KUBERNETES_OPERATOR");`
`31`	`31`	`}`
`32`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,8 @@ public async Task When_injected_then_pod_should_have_agent_injection_environment`
`41`	`41`	`.Which.Value.Should().Be("/contrast/data");`
`42`	`42`	`container.Env.Should().Contain(x => x.Name == "CONTRAST__AGENT__LOGGER__PATH")`
`43`	`43`	`.Which.Value.Should().Be("/contrast/data/logs/contrast_agent.log");`
	`44`	`+ container.Env.Should().Contain(x => x.Name == "CONTRAST_INSTALLATION_TOOL")`
	`45`	`+ .Which.Value.Should().Be("KUBERNETES_OPERATOR");`
`44`	`46`	`}`
`45`	`47`	`}`
`46`	`48`
Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,8 @@ public async Task When_injected_then_pod_should_have_agent_injection_environment`
`38`	`38`	`.Which.Value.Should().Be("--import /contrast/agent/node_modules/@contrast/agent/lib/esm-loader.mjs");`
`39`	`39`	`container.Env.Should().Contain(x => x.Name == "CONTRAST__AGENT__LOGGER__PATH")`
`40`	`40`	`.Which.Value.Should().Be("/contrast/data/logs/contrast_agent.log");`
	`41`	`+ container.Env.Should().Contain(x => x.Name == "CONTRAST_INSTALLATION_TOOL")`
	`42`	`+ .Which.Value.Should().Be("KUBERNETES_OPERATOR");`
`41`	`43`	`}`
`42`	`44`	`}`
`43`	`45`