Add Code Pulse instance name and trace port config

- Uses the CODE_PULSE_INSTANCE_NAME environment variable to support
running multiple copies of Code Pulse. An instance name can consist of
alphanumeric characters, dashes, and underscores. Names can be no longer
than 50 characters.
- Enables a tracing port override by using the CODE_PULSE_TRACE_PORT
environment variable.
- Fixes an issue that can block the configuration to override the symbol
service port using the SYMBOL_SERVICE_PORT environment variable.

Author: Steve Salas

codepulse/src/main/resources/application.conf

@@ -2,6 +2,7 @@ cp {
 	userSettings {
 		# The port used to listen for agent connections
 		tracePort = 8765,
+		tracePort=${?CODE_PULSE_TRACE_PORT}
 		symbolService {
 			port = "49582"
 			port = ${?SYMBOL_SERVICE_PORT}

codepulse/src/main/scala/com/secdec/codepulse/package.scala

@@ -62,9 +62,14 @@ package object codepulse {
 		lazy val dateRaw = versionInfo.releaseDate
 	}
 
+	val maxInstanceNameEnvLength = 50
+	val instanceNameEnvVar = "CODE_PULSE_INSTANCE_NAME"
+	val instanceName: String = sys.env.get(instanceNameEnvVar).getOrElse("").replaceAll("[^A-Za-z0-9_-]", "_").take(maxInstanceNameEnvLength)
+
 	object paths {
-		val appData = ApplicationData.getApplicationDataFolder("Code Dx", "Code Pulse", "codepulse")
-		val localAppData = ApplicationData.getLocalApplicationDataFolder("Code Dx", "Code Pulse", "codepulse")
+
+		val appData = ApplicationData.getApplicationDataFolder("Code Dx", "Code Pulse", "codepulse", codepulse.instanceName)
+		val localAppData = ApplicationData.getLocalApplicationDataFolder("Code Dx", "Code Pulse", "codepulse", codepulse.instanceName)
 		val logFiles = appData / "log-files"
 
 		logFiles.mkdirs
@@ -75,6 +80,7 @@ package object codepulse {
 		private var config =
 			ConfigFactory
 				.parseFile(configFile)
+  		  .resolve()
 				.withFallback(ConfigFactory.load())
 				.withOnlyPath("cp.userSettings") // do not return systemSettings, which could get persisted to disk later on
 
@@ -135,8 +141,16 @@ package object codepulse {
 			val renderOptions = ConfigRenderOptions.defaults.setJson(false).setOriginComments(false)
 			val output = config.root.render(renderOptions)
 
+			// preserve option to override tracePort via an environment variable
+			val tracePortPattern = """(tracePort="?\d+"?)""".r
+			val outputWithTracePort = tracePortPattern.replaceFirstIn(output, "$1\n" + " " * 12 + "tracePort=\\${?CODE_PULSE_TRACE_PORT}")
+
+			// preserve option to override port for symbol service via an environment variable
+			val symbolServicePortPattern = """(port="?\d+"?)""".r
+			val outputWithServicePortPattern = symbolServicePortPattern.replaceFirstIn(outputWithTracePort, "$1\n" + " " * 16 + "port=\\${?SYMBOL_SERVICE_PORT}")
+
 			val writer = new FileWriter(configFile)
-			writer.write(output)
+			writer.write(outputWithServicePortPattern)
 			writer.close()
 		}
 	}

codepulse/src/main/scala/com/secdec/codepulse/util/ApplicationData.scala

@@ -27,34 +27,43 @@ import java.io.File
 object ApplicationData {
 	import Implicits._
 
-	private def getAppData(companyName: String, appName: String, appShortName: String, local: Boolean) = OperatingSystem.current match {
-		case OperatingSystem.Windows =>
-			val appData = if (local) WindowsHelper.localAppDataFolder else WindowsHelper.appDataFolder
-			if (appData == null)
-				throw new IllegalStateException("Could not find application data folder")
+	private def getAppData(companyName: String, appName: String, appShortName: String, local: Boolean, instanceName: String) = {
 
-			new File(appData) / companyName / appName
+		val appDataFolder = OperatingSystem.current match {
+			case OperatingSystem.Windows =>
+				val appData = if (local) WindowsHelper.localAppDataFolder else WindowsHelper.appDataFolder
+				if (appData == null)
+					throw new IllegalStateException("Could not find application data folder")
 
-		case OperatingSystem.OSX =>
-			val home = System.getProperty("user.home")
-			if (home == null)
-				throw new IllegalStateException("Could not find user home folder")
+				new File(appData) / companyName / appName
 
-			new File(home) / "Library" / "Application Support" / appName
+			case OperatingSystem.OSX =>
+				val home = System.getProperty("user.home")
+				if (home == null)
+					throw new IllegalStateException("Could not find user home folder")
 
-		case OperatingSystem.Linux | OperatingSystem.Unix =>
-			val home = System.getProperty("user.home")
-			if (home == null)
-				throw new IllegalStateException("Could not find user home folder")
+				new File(home) / "Library" / "Application Support" / appName
 
-			new File(home) / s".$appShortName"
+			case OperatingSystem.Linux | OperatingSystem.Unix =>
+				val home = System.getProperty("user.home")
+				if (home == null)
+					throw new IllegalStateException("Could not find user home folder")
 
-		case _ =>
-			throw new NotImplementedError
+				new File(home) / s".$appShortName"
+
+			case _ =>
+				throw new NotImplementedError
+		}
+
+		if (instanceName.isEmpty()) {
+			appDataFolder
+		} else {
+			new File(appDataFolder.getPath, instanceName)
+		}
 	}
 
-	def getApplicationDataFolder(companyName: String, appName: String, appShortName: String) = getAppData(companyName, appName, appShortName, false)
-	def getLocalApplicationDataFolder(companyName: String, appName: String, appShortName: String) = getAppData(companyName, appName, appShortName, true)
+	def getApplicationDataFolder(companyName: String, appName: String, appShortName: String, instanceName: String) = getAppData(companyName, appName, appShortName, false, instanceName)
+	def getLocalApplicationDataFolder(companyName: String, appName: String, appShortName: String, instanceName: String) = getAppData(companyName, appName, appShortName, true, instanceName)
 
 	/** Internal helper for Windows to query for appdata folder the proper way */
 	private object WindowsHelper {