update env variable for app insights and adjust tests accordingly (#344)

* update env variable for app insights and adjust tests accordingly * update condition * update tests * update tests
microsoft · Sep 6, 2019 · 7cf32a5 · 7cf32a5
1 parent 2c52ada
commit 7cf32a5
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 60 deletions.
diff --git a/build/constants.yaml b/build/constants.yaml
@@ -4,6 +4,8 @@
     application-insights-instrumentation-key-env-var-name: ORYX_AI_INSTRUMENTATION_KEY
     app-service-app-name-env-var-name: APPSETTING_WEBSITE_SITE_NAME
     scm-commit-id-env-var-name: SCM_COMMIT_ID
+    user-app-insights-key-env: APPINSIGHTS_INSTRUMENTATIONKEY
+    user-app-insights-enable-env: ApplicationInsightsAgent_EXTENSION_VERSION
   outputs:
     - type: csharp
       directory: src/Common

diff --git a/src/Common/ExtVarNames.cs b/src/Common/ExtVarNames.cs
@@ -8,5 +8,7 @@ public static class ExtVarNames
         public const string ApplicationInsightsInstrumentationKeyEnvVarName = "ORYX_AI_INSTRUMENTATION_KEY";
         public const string AppServiceAppNameEnvVarName = "APPSETTING_WEBSITE_SITE_NAME";
         public const string ScmCommitIdEnvVarName = "SCM_COMMIT_ID";
+        public const string UserAppInsightsKeyEnv = "APPINSIGHTS_INSTRUMENTATIONKEY";
+        public const string UserAppInsightsEnableEnv = "ApplicationInsightsAgent_EXTENSION_VERSION";
     }
 }
diff --git a/src/startupscriptgenerator/src/common/consts/ext_var_names.go b/src/startupscriptgenerator/src/common/consts/ext_var_names.go
@@ -6,3 +6,5 @@ const EnvironmentType string = "ORYX_ENV_TYPE"
 const ApplicationInsightsInstrumentationKeyEnvVarName string = "ORYX_AI_INSTRUMENTATION_KEY"
 const AppServiceAppNameEnvVarName string = "APPSETTING_WEBSITE_SITE_NAME"
 const ScmCommitIdEnvVarName string = "SCM_COMMIT_ID"
+const UserAppInsightsKeyEnv string = "APPINSIGHTS_INSTRUMENTATIONKEY"
+const UserAppInsightsEnableEnv string = "ApplicationInsightsAgent_EXTENSION_VERSION"
diff --git a/src/startupscriptgenerator/src/node/scriptgenerator.go b/src/startupscriptgenerator/src/node/scriptgenerator.go
@@ -46,10 +46,10 @@ const inspectParamVariableName = "ORYX_NODE_INSPECT_PARAM"
 
 // Checks if the application insights needs to be enabled for the current runtime
 func shouldApplicationInsightsBeConfigured() bool {
-	nodeAppInsightsKeyEnv := os.Getenv("APPINSIGHTS_INSTRUMENTATIONKEY")
-	nodeAppInsightsEnabledEnv := os.Getenv("APPLICATIONINSIGHTSAGENT_EXTENSION_ENABLED")
+	nodeAppInsightsKeyEnv := os.Getenv(consts.UserAppInsightsKeyEnv)
+	nodeAppInsightsEnabledEnv := os.Getenv(consts.UserAppInsightsEnableEnv)
 
-	if nodeAppInsightsKeyEnv != "" && strings.ToLower(nodeAppInsightsEnabledEnv) == "true" {
+	if nodeAppInsightsKeyEnv != "" && strings.ToLower(nodeAppInsightsEnabledEnv) != "disabled" {
 		fmt.Printf("Environment Variables for Application Insight's Codeless Configuration exists..\n")
 		return true
 	}
@@ -75,7 +75,7 @@ func createApplicationInsightsLoaderFile(appInsightsLoaderFilePath string) {
 
 			return true;
 		}
-		if (process.env.APPINSIGHTS_INSTRUMENTATIONKEY && process.env.APPLICATIONINSIGHTSAGENT_EXTENSION_ENABLED === "true") {
+		if (process.env.` + consts.UserAppInsightsKeyEnv + ` && process.env.` + consts.UserAppInsightsEnableEnv + ` !== "disabled") {
 			appInsights
 				.setup()
 				.setSendLiveMetrics(true)
@@ -130,7 +130,7 @@ func (gen *NodeStartupScriptGenerator) GenerateEntrypointScript() string {
 		scriptBuilder.WriteString("mkdir -p " + targetNodeModulesDir + "\n")
 		scriptBuilder.WriteString("echo Extracting modules...\n")
 		scriptBuilder.WriteString("$extractionCommand\n")
-		
+
 		// Some versions of node, in particular Node 4.8 and 6.2 according to our tests, do not find the node_modules
 		// folder at the root. To handle these versions, we also add /node_modules to the NODE_PATH directory.
 		scriptBuilder.WriteString("export NODE_PATH=\"" + targetNodeModulesDir + "\":$NODE_PATH\n")
@@ -229,7 +229,7 @@ func (gen *NodeStartupScriptGenerator) GenerateEntrypointScript() string {
 		loaderFile := filepath.Join(gen.SourcePath, consts.NodeAppInsightsLoaderFileName)
 
 		if !common.FileExists(loaderFile) {
-			createApplicationInsightsLoaderFile(loaderFile)			
+			createApplicationInsightsLoaderFile(loaderFile)
 		}
 
 		var nodeOptions = "'--require ./" + consts.NodeAppInsightsLoaderFileName + " ' $NODE_OPTIONS"

diff --git a/tests/Oryx.Integration.Tests/Node/NodeTestWithAppInsightsConfigured.cs b/tests/Oryx.Integration.Tests/Node/NodeTestWithAppInsightsConfigured.cs
@@ -31,8 +31,8 @@ public async Task CanBuildAndRun_NodeApp_WithAppInsights_Configured(string nodeV
             var volume = CreateAppVolume(appName);
             var appDir = volume.ContainerDir;
             var spcifyNodeVersionCommand = "--platform nodejs --platform-version=" + nodeVersion;
-            var aIKey = "APPINSIGHTS_INSTRUMENTATIONKEY";
-            var aIEnabled = "APPLICATIONINSIGHTSAGENT_EXTENSION_ENABLED";
+            var aIKey = ExtVarNames.UserAppInsightsKeyEnv;
+            var aIEnabled = ExtVarNames.UserAppInsightsEnableEnv;
             var buildScript = new ShellScriptBuilder()
                 .AddCommand($"oryx build {appDir} -o {appDir} {spcifyNodeVersionCommand} --log-file {appDir}/1.log")
                 .AddDirectoryExistsCheck($"{appDir}/node_modules").ToString();
@@ -81,8 +81,8 @@ public async Task CanBuildAndRun_NodeApp_WithAppInsights_As_Package_Dependency(s
             var volume = CreateAppVolume(appName);
             var appDir = volume.ContainerDir;
             var spcifyNodeVersionCommand = "--platform nodejs --platform-version=" + nodeVersion;
-            var aIKey = "APPINSIGHTS_INSTRUMENTATIONKEY";
-            var aIEnabled = "APPLICATIONINSIGHTSAGENT_EXTENSION_ENABLED";
+            var aIKey = ExtVarNames.UserAppInsightsKeyEnv;
+            var aIEnabled = ExtVarNames.UserAppInsightsEnableEnv;
             var buildScript = new ShellScriptBuilder()
                 .AddCommand($"oryx build {appDir} -o {appDir} {spcifyNodeVersionCommand} --log-file {appDir}/1.log")
                 .AddDirectoryExistsCheck($"{appDir}/node_modules").ToString();

diff --git a/tests/Oryx.RuntimeImage.Tests/Node/NodeRuntimeImageCanRunWhenAppInsightsModuleNotFound.cs b/tests/Oryx.RuntimeImage.Tests/Node/NodeRuntimeImageCanRunWhenAppInsightsModuleNotFound.cs
@@ -37,8 +37,8 @@ public async Task GeneratesScript_CanRun_AppInsightsModule_NotFound(string nodeV
             var volume = DockerVolume.CreateMirror(hostDir);
             var appDir = volume.ContainerDir;
             var imageName = string.Concat("oryxdevmcr.azurecr.io/public/oryx/node-", nodeVersion);
-            var aIKey = "APPINSIGHTS_INSTRUMENTATIONKEY";
-            var aIEnabled = "APPLICATIONINSIGHTSAGENT_EXTENSION_ENABLED";
+            var aIKey = ExtVarNames.UserAppInsightsKeyEnv;
+            var aIEnabled = ExtVarNames.UserAppInsightsEnableEnv;
             int containerDebugPort = 8080;
 
             var script = new ShellScriptBuilder()
@@ -86,11 +86,11 @@ public async Task GeneratesScript_CanRun_AppInsights_NotConfigured(string nodeVe
             var volume = DockerVolume.CreateMirror(hostDir);
             var appDir = volume.ContainerDir;
             var imageName = string.Concat("oryxdevmcr.azurecr.io/public/oryx/node-", nodeVersion);
-            var aIEnabled = "APPLICATIONINSIGHTSAGENT_EXTENSION_ENABLED";
+            var aIEnabled = ExtVarNames.UserAppInsightsEnableEnv;
             int containerDebugPort = 8080;
 
             var script = new ShellScriptBuilder()
-                .AddCommand($"export {aIEnabled}=TRUE")
+                .AddCommand($"export {aIEnabled}=disabled")
                 .AddCommand($"cd {appDir}")
                 .AddCommand("npm install")
                 .AddCommand($"oryx -appPath {appDir}")

diff --git a/tests/Oryx.RuntimeImage.Tests/Node/NodeRuntimeImageOtherTests.cs b/tests/Oryx.RuntimeImage.Tests/Node/NodeRuntimeImageOtherTests.cs
@@ -125,50 +125,6 @@ public void GeneratedScript_CanRunStartupScriptsFromAppRoot()
             RunAsserts(() => Assert.Equal(result.ExitCode, exitCodeSentinel), result.GetDebugInfo());
         }
 
-        [Fact]
-        public void GeneratedScript_CanRunStartupScripts_WithAppInsightsConfigured()
-        {
-            // Arrange
-            const int exitCodeSentinel = 222;
-            var appPath = "/tmp/app";
-            var aiNodesdkLoaderContent = @"var appInsights = require('applicationinsights');  
-                if (process.env.APPINSIGHTS_INSTRUMENTATIONKEY)
-                { 
-                    try 
-                    { 
-                       appInsights.setup().start();
-                    } catch (e) { 
-                       console.error(e); 
-                    } 
-                }";
-            var manifestFileContent = $"'{NodeConstants.InjectedAppInsights}=\"True\"'";
-
-            var script = new ShellScriptBuilder()
-                .CreateDirectory(appPath)
-                .CreateFile($"{appPath}/entry.sh", $"exit {exitCodeSentinel}")
-                .CreateFile($"{appPath}/{FilePaths.BuildManifestFileName}", manifestFileContent)
-                .CreateFile($"{appPath}/oryx-appinsightsloader.js", $"\"{aiNodesdkLoaderContent}\"")
-                .AddCommand("oryx -userStartupCommand entry.sh -appPath " + appPath)
-                .AddCommand(". ./run.sh") // Source the default output path
-                .AddStringExistsInFileCheck("export NODE_OPTIONS='--require ./oryx-appinsightsloader.js'", "./run.sh")
-                .ToString();
-
-            // Act
-            var result = _dockerCli.Run(new DockerRunArguments
-            {
-                ImageId = "oryxdevmcr.azurecr.io/public/oryx/node-10.14",
-                EnvironmentVariables = new List<EnvironmentVariable>
-                {
-                    new EnvironmentVariable("APPINSIGHTS_INSTRUMENTATIONKEY", "asdas")
-                },
-                CommandToExecuteOnRun = "/bin/sh",
-                CommandArguments = new[] { "-c", script }
-            });
-
-            // Assert
-            RunAsserts(() => Assert.Equal(result.ExitCode, exitCodeSentinel), result.GetDebugInfo());
-        }
-
         [Theory(Skip = "Investigating debugging using pm2")]
         [MemberData(
             nameof(TestValueGenerator.GetNodeVersions_SupportDebugging),

diff --git a/tests/SampleApps/nodejs/linxnodeexpress-appinsights/server.js b/tests/SampleApps/nodejs/linxnodeexpress-appinsights/server.js
@@ -5,9 +5,9 @@ var appInsights = require('applicationinsights');
 var responseString = "";
 
 console.log(process.env.APPINSIGHTS_INSTRUMENTATIONKEY)
-console.log(process.env.APPLICATIONINSIGHTSAGENT_EXTENSION_ENABLED)
+console.log(process.env.ApplicationInsightsAgent_EXTENSION_VERSION)
 
-if (process.env.APPINSIGHTS_INSTRUMENTATIONKEY && process.env.APPLICATIONINSIGHTSAGENT_EXTENSION_ENABLED === "true") {
+if (process.env.APPINSIGHTS_INSTRUMENTATIONKEY && process.env.ApplicationInsightsAgent_EXTENSION_VERSION !== "disabled") {
 	console.log("hello world here")
 	appInsights
 		.setup(process.env.APPINSIGHTS_INSTRUMENTATIONKEY)