@nsshunt/stsconfig 1.9.1 → 1.12.0

package/.env-test-file-2

@@ -0,0 +1,167 @@
+#.env
+# ==================================================================================================
+# Development Settings
+# ==================================================================================================
+# Database username
+DB_USER=postgres
+# Database password
+#DB_PASSWORD=somepassword
+# Database password file. To create, use 'echo -n [password] > /home/marcusbettens/projects/dbpassword'
+# This will set the database password to the contents of the dbpassword file without the trailing /cr character.
+DB_PASSWORD_FILE=/home/marcusbettens/projects/dbpassword
+# Database host
+DB_HOST=localhost
+# Database port
+DB_PORT=5432
+# Database name
+DB_DATABASE=testdb17
+# Maximum pool size for database connections (per thread)
+POOL_SIZE=200
+# Database Script Folder
+DB_SCRIPT_FOLDER=/var/lib/sts/stsglobalresources/db-scripts
+# sudo mkdir /var/run/sts
+# sudo chown marcusbettens /var/run/sts 
+#PORT=/var/run/sts/stsrest01.sock
+
+PUBLISH_DEBUG=false
+PUBLISH_TIMEOUT=750
+PUBLISH_INTERVAL=1000
+
+# STSRest01 service host and connection details
+REST01_ENDPOINT=http://localhost
+REST01_HOST_PORT=3003
+REST01_PORT=3003
+REST01_APIROOT=/stsrest01/v1
+REST01_EMAIL=K6TestUser@sts
+#REST01_PASSWORD=somepassword
+REST01_PASSWORD_FILE=/home/marcusbettens/projects/rest01passwordfile
+REST01_SERVICE_NAME=STSRest01
+REST01_SERVICE_VERSION=1.0.0
+REST01_PROM_SUPPORT=true
+REST01_PROM_CLUSTER_PORT=3013
+
+# STSInstrumentManager service host and connection details
+IM_ENDPOINT=http://localhost
+IM_HOST_PORT=3001
+IM_PORT=3001
+IM_APIROOT=/stsinstrumentmanager/v1
+IM_EMAIL=K6TestUser@sts
+#IM_PASSWORD=K6TestUserPassword
+IM_PASSWORD_FILE=/home/marcusbettens/projects/impasswordfile
+IM_SERVICE_NAME=STSInstrumentManager
+IM_SERVICE_VERSION=1.0.0
+IM_PROM_SUPPORT=true
+IM_PROM_CLUSTER_PORT=3011
+
+# STSAuth service host and connection details
+AS_ENDPOINT=http://localhost
+AS_HOST_PORT=3002
+AS_PORT=3002
+AS_APIROOT=/stsauth/v1
+AS_EMAIL=K6TestUser@sts
+#AS_PASSWORD=K6TestUserPassword
+AS_PASSWORD_FILE=/home/marcusbettens/projects/aspasswordfile
+AS_SERVICE_NAME=STSAuth
+AS_SERVICE_VERSION=1.0.0
+AS_PROM_SUPPORT=true
+AS_PROM_CLUSTER_PORT=3012
+
+# STS Test Orchestrator service host and connection details
+TO_ENDPOINT=http://localhost
+TO_HOST_PORT=3004
+TO_PORT=3004
+TO_APIROOT=/ststestorchestrator/v1
+TO_EMAIL=K6TestUser@sts
+#TO_PASSWORD=somepassword
+TO_PASSWORD_FILE=/home/marcusbettens/projects/topasswordfile
+TO_SERVICE_NAME=STSTestOrchestrator
+TO_SERVICE_VERSION=1.0.0
+TO_PROM_SUPPORT=true
+TO_PROM_CLUSTER_PORT=3014
+
+# STS Test Runner service host and connection details
+TR_EMAIL=K6TestUser@sts
+#TR_PASSWORD=somepassword
+TR_PASSWORD_FILE=/home/marcusbettens/projects/trpasswordfile
+TR_SERVICE_NAME=STSRestRunner
+TR_SERVICE_VERSION=1.0.0
+TR_PROM_SUPPORT=true
+TR_PROM_CLUSTER_PORT=3015
+
+# Auth Server public and private key paths
+AS_PRIVATE_KEY_PATH=/var/lib/sts/stsglobalresources/keys/private.key
+AS_PUBLIC_KEY_PATH=/var/lib/sts/stsglobalresources/keys/public.key
+
+# Node runtime environment
+NODE_ENV=debug
+# Default K6 test script path
+K6SCRIPTPATH=.
+# Redis server end point
+REDIS_SERVER=localhost
+# Redis server port
+REDIS_PORT=6379
+# Use redis for Microservice
+USE_REDIS=false
+# Use redis as a layer 1 cache
+USE_L1_REDIS=false
+# Automatically flush the redis cache when terminating the Microservice
+REDIS_END_FLUSH=false
+# Log error messages to the console within the microservice
+CONSOLE_LOG_ERRORS=false
+# Maximum number of CPUs (incl. logical processors) to use within the Microservice. 
+# Use -1 to use all available within the runtime container. Each CPU will spawn a node work thread.
+MAX_CPU=2
+# Automatically re-spawn a worker thread if one dies.
+RESPAWN=false
+# Default number of entries to create for a fresh database
+DEFAULT_DB_ENTRIES=10000
+# Default flag to automatically copy from the source RESFK_ records to the working set RESCP_ records
+# during initial fresh database creation.
+DEFAULT_DB_POPULATE=true
+# Default flag to automatically populate the redis cache (if enabled) with the current RESCP_ records
+# as they are being created. Only valid when DEFAULT_DB_POPULATE = true AND USE_REDIS = true.
+DEFAULT_REDIS_POPULATE=true
+# Default number of entries K6 should test against.
+DEFAULT_K6_ENTRIES=10000
+# Default microservice end-point for K6 tests.
+DEFAULT_K6_MS_HOST=localhost
+# Default microservice port for K6 tests.
+DEFAULT_K6_MS_PORT=3000
+# Default ratio (%) that each test should be an update rather than just a read.
+DEFAULT_K6_UPDATE_RATIO=2
+# Default ratio (%) that for an update, this update will actually be a delete. Only valid when
+# DEFAULT_K6_UPDATE_RATIO is > 0
+DEFAULT_K6_DELETE_RATIO=0
+# Default flag to always create a new record for each interation during K6 test runs. The new
+# record will contain a UUID for the ID to ensure uniqueness.
+DEFAULT_K6_ALWAYS_ADD=false
+# Default number of virtual CPUs to use on each testing node.
+DEFAULT_K6_VCPU=20
+# Default duration each test node should run the K6 test.
+DEFAULT_K6_DURATION=30s
+# ==================================================================================================
+# Production Settings
+# ==================================================================================================
+#PORT=3000
+#NODE_ENV=production
+#DATABASE_URL=postgresql://postgres:02740274@192.168.0.160:5432/testdb
+#REDIS_SERVER=192.168.0.160
+#REDIS_PORT=6379
+#USE_REDIS=true
+#REDIS_END_FLUSH=false
+#CONSOLE_LOG_ERRORS=false
+#
+# Only use for self signed certificates, otherwise remove from .env file
+#NODE_TLS_REJECT_UNAUTHORIZED=0
+#
+# To run PROD from command line
+# PORT=3000 NODE_ENV=production DATABASE_URL='postgresql://postgres:02740274@192.168.0.27:5432/testdb' node app
+#
+# To run DEV from command line
+# PORT=3000 NODE_ENV=debug DB_USER=postgres DB_PASSWORD=02740274 DB_HOST=192.168.0.27 DB_PORT=5432 DB_DATABASE=testdb node app
+
+MONITOR = false
+TRANSPORT = RESTAPI
+
+#MONITOR = true
+#TRANSPORT = RESTAPI

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "@nsshunt/stsconfig",
-  "version": "1.9.1",
+  "version": "1.12.0",
   "description": "",
   "main": "stsconfig.js",
   "dependencies": {
     "colors": "^1.4.0",
     "debug": "^4.3.3",
-    "dotenv": "^16.0.0",
-    "yaml": "^1.10.2"
+    "dotenv": "^16.0.0"
   },
   "standard": {
     "parser": "@babel/eslint-parser"
@@ -17,7 +16,7 @@
     "@babel/eslint-parser": "^7.17.0",
     "@babel/plugin-proposal-class-properties": "^7.16.7",
     "@babel/plugin-proposal-private-methods": "^7.16.11",
-    "eslint": "^8.9.0",
+    "eslint": "^8.10.0",
     "jest": "^27.5.1"
   },
   "scripts": {

package/stsconfig.js

@@ -1,59 +1,50 @@
-const YAML = require('yaml');
 const { accessSync, constants, readFileSync } = require('fs');
 const debug = require('debug')(`proc:${process.pid}`);
 require('colors');
 
+// Order for config settings
+// -------------------------
+// Passwords;
+//   Use password specified within a database password file (if present)
+//   Fall back to use a password from an environment variable
+
 // Add tthe STSENVFILE to script run commands in order to use the require .env file for configuration
-let envfile = (process.env.STSENVFILE === undefined ? '../stsglobalresources/.env' : process.env.STSENVFILE);
-let yamlfile = (process.env.STSYAMLFILE === undefined ? '../stsglobalresources/config.yml' : process.env.STSYAMLFILE);
+let envfile = (process.env.STSENVFILE === undefined ? '/.env' : process.env.STSENVFILE);
 
 require('dotenv').config({ path: envfile });
 
-let deffileconfig = { };
-try {
-	accessSync(yamlfile, constants.R_OK);
-	const file = readFileSync(yamlfile, 'utf8');
-	deffileconfig = YAML.parse(file);
-} catch (err) {
-	debug(`Problem loading YAML file: [${yamlfile}], Error: [${err}]`.yellow);
-}
-
 const defconfig = 
 {
 	// Node runtime environment
-	isProduction: process.env.NODE_ENV === 'production'
+	isProduction: (process.env.NODE_ENV === undefined ? false : process.env.NODE_ENV === 'production')
 	// Log error messages to the console within the microservice
 	,consoleLogErrors: (process.env.CONSOLE_LOG_ERRORS === undefined ? false : (process.env.CONSOLE_LOG_ERRORS === "true" ? true : false ))
 	// Database username.
-	,dbuser: process.env.DB_USER
+	,dbuser: (process.env.DB_USER === undefined ? 'postgres' : process.env.DB_USER)
 	// Database password.
-	,dbpassword: process.env.DB_PASSWORD
-	// Database host.
-	,dbhost: process.env.DB_HOST
-	// Database port.
-	,dbport: process.env.DB_PORT
+	,dbpassword: (process.env.DB_PASSWORD === undefined ? 'password' : process.env.DB_PASSWORD)
+	// Database password file
+	,dbpasswordfile: process.env.DB_PASSWORD_FILE
+	// Database host
+	,dbhost: (process.env.DB_HOST === undefined ? 'localhost' : process.env.DB_HOST)
+	// Database port
+	,dbport: (process.env.DB_PORT === undefined ? '5432' : process.env.DB_PORT)
 	// Database name.
-	,database: process.env.DB_DATABASE
-	// Database connection string to be used in production mode.
+	,database: (process.env.DB_DATABASE === undefined ? 'stsrestmsdb01' : process.env.DB_DATABASE) // STS REST MicroService Database 01
+	// Database connection string to be used in production mode
 	,databaseUrl: process.env.DATABASE_URL
-	// Computed connection string to be used in development mode.
-	,connectionString: `postgresql://${process.env.DB_USER}:${process.env.DB_PASSWORD}@${process.env.DB_HOST}:${process.env.DB_PORT}/${process.env.DB_DATABASE}`
-	// Default computed connection string for postgres. Database name = postgres.
-	,defaultDatabaseConnectionString: `postgresql://${process.env.DB_USER}:${process.env.DB_PASSWORD}@${process.env.DB_HOST}:${process.env.DB_PORT}/postgres`
 	// Database script(s) folder
 	,databasescriptfolder: (process.env.DB_SCRIPT_FOLDER === undefined ? "/var/lib/sts/stsglobalresources/db-scripts" : process.env.DB_SCRIPT_FOLDER)
 
-	// Use the on-screen UI for the server. Set to false for head-less mode (i.e. inside cluster etc.)
-	,useui: (process.env.USEUI === undefined ? true : (process.env.USEUI === "true" ? true : false ))
 	// The maximum pool size for pg. There will be one pool per thread.
-	,poolSize: (process.env.POOL_SIZE === undefined ? 20 : parseInt(process.env.POOL_SIZE))
+	,poolSize: (process.env.POOL_SIZE === undefined ? 500 : parseInt(process.env.POOL_SIZE))
 	// Maximum number of CPUs (incl. logical processors) to use within the Microservice. 
 	// Use -1 to use all available within the runtime container. Each CPU will spawn a node work thread.
 	,useCPUs: (process.env.MAX_CPU === undefined ? -1 : parseFloat(process.env.MAX_CPU))
 	// Automatically re-spawn a worker thread if one dies.
 	,respawnOnFail: (process.env.RESPAWN === undefined ? false : (process.env.RESPAWN === "true" ? true : false ))
 	// Default number of entries to create for a fresh database.
-	,defaultDatabaseEntries: process.env.DEFAULT_DB_ENTRIES
+	,defaultDatabaseEntries: (process.env.DEFAULT_DB_ENTRIES === undefined ? 10000 : process.env.DEFAULT_DB_ENTRIES)
 	// Microservice listen port.
 	,useRedis: (process.env.USE_REDIS === undefined ? false : (process.env.USE_REDIS === "true" ? true : false ))
 	// Use redis for Microservice.
@@ -61,65 +52,28 @@ const defconfig =
 	// Automatically flush the redis cache when terminating the Microservice.
 	,endFlush: (process.env.REDIS_END_FLUSH === undefined ? false : (process.env.REDIS_END_FLUSH === "true" ? true : false ))
 	// Redis server port.
-	,redisPort: process.env.REDIS_PORT
+	,redisPort: (process.env.REDIS_PORT === undefined ? '6379' : process.env.REDIS_PORT)
 	// Redis server endpoint.
-	,redisServer: process.env.REDIS_SERVER
+	,redisServer: (process.env.REDIS_SERVER === undefined ? 'localhost' : process.env.REDIS_SERVER)
 	// Default K6 test script path
 	,k6ScriptPath: (process.env.K6SCRIPTPATH === undefined ? "." : process.env.K6SCRIPTPATH)
-	// Default flag to automatically copy from the source RESFK_ records to the working set RESCP_ records
-	// during initial fresh database creation.
-	,defaultDatabasePopulate: (process.env.DEFAULT_DB_POPULATE === undefined ? true : (process.env.DEFAULT_DB_POPULATE === "true" ? true : false ))
-	// Default flag to automatically populate the redis cache (if enabled) with the current RESCP_ records
-	// as they are being created. Only valid when DEFAULT_DB_POPULATE = true AND USE_REDIS = true.
-	,defaultRedisPopulate: (process.env.DEFAULT_REDIS_POPULATE === undefined ? true : (process.env.DEFAULT_REDIS_POPULATE === "true" ? true : false))
-	// Default number of entries K6 should test against.
-	,defaultK6Entries: (process.env.DEFAULT_K6_ENTRIES === undefined ? 100000 : parseInt(process.env.DEFAULT_K6_ENTRIES))
-	// Default microservice end-point for K6 tests.
-	,defaultK6MicroServiceHost: (process.env.DEFAULT_K6_MS_HOST === undefined ? 'localhost' : process.env.DEFAULT_K6_MS_HOST)
-	// Default microservice port for K6 tests.
-	,defaultK6MicroServicePort: (process.env.DEFAULT_K6_MS_PORT === undefined ? 3000 : parseInt(process.env.DEFAULT_K6_MS_PORT))
-	// Default ratio (%) that each test should be an update rather than just a read.
-	,defaultK6MicroServiceUpdateRatio: (process.env.DEFAULT_K6_UPDATE_RATIO === undefined ? 2 : parseInt(process.env.DEFAULT_K6_UPDATE_RATIO))
-	// Default ratio (%) that for an update, this update will actually be a delete. Only valid when
-	// DEFAULT_K6_UPDATE_RATIO is > 0
-	,defaultK6MicroServiceDeleteRatio: (process.env.DEFAULT_K6_DELETE_RATIO === undefined ? 0 : parseInt(process.env.DEFAULT_K6_DELETE_RATIO))
-	// Default flag to always create a new record for each interation during K6 test runs. The new
-	// record will contain a UUID for the ID to ensure uniqueness.
-	,defaultK6MicroServiceAlwaysAdd: (process.env.DEFAULT_K6_ALWAYS_ADD === undefined ? false : (process.env.DEFAULT_K6_ALWAYS_ADD === "true" ? true : false))
-	// Default number of virtual CPUs to use on each testing node.
-	,defaultK6MicroServiceVCPUs: (process.env.DEFAULT_K6_VCPU === undefined ? 20 : parseInt(process.env.DEFAULT_K6_VCPU))
-	// Default duration each test node should run the K6 test.
-	,defaultK6MicroServiceDuration: (process.env.DEFAULT_K6_DURATION === undefined ? "30s" : process.env.DEFAULT_K6_DURATION)
-	// Default token refresh modulas.
-	,defaulttokenrefreshmod: (process.env.DEFAULT_K6_TOKEN_REFRESH_MOD === undefined ? 5000 : parseInt(process.env.DEFAULT_K6_TOKEN_REFRESH_MOD))
-	// Default sleep duration (ms) between iterations - random number between 0 and this number.
-	,defaultitersleep: (process.env.DEFAULT_K6_ITER_SLEEP === undefined ? 0 : parseInt(process.env.DEFAULT_K6_ITER_SLEEP))
 	// Default number of entries to create for a fresh database.
 	,defaultDatabaseMinExtraDataSize: (process.env.DEFAULT_DATABASE_MIN_EXTRA_DATA_SIZE === undefined ? 0 : parseInt(process.env.DEFAULT_DATABASE_MIN_EXTRA_DATA_SIZE))
 	// Default number of entries to create for a fresh database.
 	,defaultDatabaseMaxExtraDataSize: (process.env.DEFAULT_DATABASE_MAX_EXTRA_DATA_SIZE === undefined ? 2000 : parseInt(process.env.DEFAULT_DATABASE_MAX_EXTRA_DATA_SIZE))
 
-	/* To be developed in future ...
-	// Config Server (CS) endpoint
-	,csendpoint: (process.env.CS_ENDPOINT === undefined ? "http://localhost" : process.env.CS_ENDPOINT)
-	// Config Server (CS) port
-	,csport: (process.env.CS_PORT === undefined ? "3000" : process.env.CS_PORT)
-	// Config Server (CS) endpoint
-	,csapiroot: (process.env.CS_APIROOT === undefined ? "/api/v1/k6testing" : process.env.CS_APIROOT)
-	// Config Server (CS) username email
-	,csemail: (process.env.CS_EMAIL === undefined ? "K6TestUser@sts" : process.env.CS_EMAIL)
-	// Config Server (CS) username password
-	,cspassword: (process.env.CS_PASSWORD === undefined ? "K6TestUserPassword" : process.env.CS_PASSWORD)
-	*/
-
 	// STSREST01 Server endpoint
 	,rest01endpoint: (process.env.REST01_ENDPOINT === undefined ? "http://localhost" : process.env.REST01_ENDPOINT)
 	// STSREST01 Server port (listen port for the service)
-	,rest01hostport: (process.env.REST01_HOST_PORT === undefined ? "3000" : process.env.REST01_HOST_PORT)
+	,rest01hostport: (process.env.REST01_HOST_PORT === undefined ? "3003" : process.env.REST01_HOST_PORT)
 	// STSREST01 Server port (client port to access the service)
-	,rest01port: (process.env.REST01_PORT === undefined ? "3000" : process.env.REST01_PORT)
+	,rest01port: (process.env.REST01_PORT === undefined ? "3003" : process.env.REST01_PORT)
 	// STSREST01 Server endpoint
-	,rest01apiroot: (process.env.REST01_APIROOT === undefined ? "/stsrest01/v1/im" : process.env.REST01_APIROOT)
+	,rest01apiroot: (process.env.REST01_APIROOT === undefined ? "/stsrest01/v1" : process.env.REST01_APIROOT)
+	// STSREST01 Prometheus metric support
+	,rest01prometheussupport: (process.env.REST01_PROM_SUPPORT === undefined ? true : (process.env.REST01_PROM_SUPPORT === "true" ? true : false))
+	// STSREST01 Cluster Server port (port used for cluster prometheus scrapes). Service will listen on this port at mount point /metrics
+	,rest01prometheusclusterport: (process.env.REST01_PROM_CLUSTER_PORT === undefined ? "3013" : process.env.REST01_PROM_CLUSTER_PORT)
 	// STSREST01 Service Name
 	,rest01servicename: (process.env.REST01_SERVICE_NAME === undefined ? "STSRest01" : process.env.REST01_SERVICE_NAME)
 	// STSREST01 Service Version
@@ -130,7 +84,8 @@ const defconfig =
 	,rest01email: (process.env.REST01_EMAIL === undefined ? "K6TestUser@sts" : process.env.REST01_EMAIL)
 	// STSREST01 Server username password
 	,rest01password: (process.env.REST01_PASSWORD === undefined ? "K6TestUserPassword" : process.env.REST01_PASSWORD)
-	
+	// STSREST01 Server username password file
+	,rest01passwordfile: process.env.REST01_PASSWORD_FILE
 	
 	// STS Instrument Manager Service endpoint
 	,imendpoint: (process.env.IM_ENDPOINT === undefined ? "http://localhost" : process.env.IM_ENDPOINT)
@@ -140,6 +95,10 @@ const defconfig =
 	,import: (process.env.IM_PORT === undefined ? "3001" : process.env.IM_PORT)
 	// STS Instrument Manager Service endpoint
 	,imapiroot: (process.env.IM_APIROOT === undefined ? "/stsinstrumentmanager/v1" : process.env.IM_APIROOT)
+	// STS Instrument Manager Prometheus metric support
+	,imprometheussupport: (process.env.IM_PROM_SUPPORT === undefined ? true : (process.env.IM_PROM_SUPPORT === "true" ? true : false ))
+	// STS Instrument Manager Cluster Server port (port used for cluster prometheus scrapes)
+	,imprometheusclusterport: (process.env.IM_PROM_CLUSTER_PORT === undefined ? "3011" : process.env.IM_PROM_CLUSTER_PORT)
 	// STS Instrument Manager Service Name
 	,imservicename: (process.env.IM_SERVICE_NAME === undefined ? "STSInstrumentManager" : process.env.IM_SERVICE_NAME)
 	// STS Instrument Manager Service Version
@@ -150,6 +109,8 @@ const defconfig =
 	,imemail: (process.env.IM_EMAIL === undefined ? "K6TestUser@sts" : process.env.IM_EMAIL)
 	// STS Instrument Manager Service username password
 	,impassword: (process.env.IM_PASSWORD === undefined ? "K6TestUserPassword" : process.env.IM_PASSWORD)
+	// STS Instrument Manager Service username password file
+	,impasswordfile: process.env.IM_PASSWORD_FILE
 
 	// STS Test Orchestrator Service endpoint
 	,toendpoint: (process.env.TO_ENDPOINT === undefined ? "http://localhost" : process.env.TO_ENDPOINT)
@@ -159,6 +120,10 @@ const defconfig =
 	,toport: (process.env.TO_PORT === undefined ? "3004" : process.env.TO_PORT)
 	// STS Test Orchestrator Service endpoint
 	,toapiroot: (process.env.TO_APIROOT === undefined ? "/ststestorchestrator/v1" : process.env.TO_APIROOT)
+	// STS Test Orchestrator Prometheus metric support
+	,toprometheussupport: (process.env.TO_PROM_SUPPORT === undefined ? true : (process.env.TO_PROM_SUPPORT === "true" ? true : false ))
+	// STS Test Orchestrator Cluster Server port (port used for cluster prometheus scrapes)
+	,toprometheusclusterport: (process.env.TO_PROM_CLUSTER_PORT === undefined ? "3014" : process.env.TO_PROM_CLUSTER_PORT)
 	// STS Test Orchestrator Service Name
 	,toservicename: (process.env.TO_SERVICE_NAME === undefined ? "STSTestOrchestrator" : process.env.TO_SERVICE_NAME)
 	// STS Test Orchestrator Service Version
@@ -169,6 +134,8 @@ const defconfig =
 	,toemail: (process.env.TO_EMAIL === undefined ? "K6TestUser@sts" : process.env.TO_EMAIL)
 	// STS Test Orchestrator Service username password
 	,topassword: (process.env.TO_PASSWORD === undefined ? "K6TestUserPassword" : process.env.TO_PASSWORD)
+	// STS Test Orchestrator Service username password file
+	,topasswordfile: process.env.TO_PASSWORD_FILE
 	
 	// Auth Server endpoint
 	,asendpoint: (process.env.AS_ENDPOINT === undefined ? "http://localhost" : process.env.AS_ENDPOINT)
@@ -178,6 +145,10 @@ const defconfig =
 	,asport: (process.env.AS_PORT === undefined ? "3002" : process.env.AS_PORT)
 	// Auth Server endpoint
 	,asapiroot: (process.env.AS_APIROOT === undefined ? "/stsauth/v1" : process.env.AS_APIROOT)
+	// Auth Server Prometheus metric support
+	,asprometheussupport: (process.env.AS_PROM_SUPPORT === undefined ? true : (process.env.AS_PROM_SUPPORT === "true" ? true : false ))
+	// Auth Prometheus Cluster Server port (port used for cluster prometheus scrapes)
+	,asprometheusclusterport: (process.env.AS_PROM_CLUSTER_PORT === undefined ? "3012" : process.env.AS_PROM_CLUSTER_PORT)
 	// STSAuth Service Name
 	,asservicename: (process.env.AS_SERVICE_NAME === undefined ? "STSAuth" : process.env.AS_SERVICE_NAME)
 	// STSAuth Service Version
@@ -188,7 +159,17 @@ const defconfig =
 	,asemail: (process.env.AS_EMAIL === undefined ? "K6TestUser@sts" : process.env.AS_EMAIL)
 	// Auth Server username password
 	,aspassword: (process.env.AS_PASSWORD === undefined ? "K6TestUserPassword" : process.env.AS_PASSWORD)
+	// Auth Server username password file
+	,aspasswordfile: process.env.AS_PASSWORD_FILE
+	// Auth Server - Private Key (when using JWT)
+	,asprivatekeypath: (process.env.AS_PRIVATE_KEY_PATH === undefined ? "/var/lib/sts/stsglobalresources/keys/private.key" : process.env.AS_PRIVATE_KEY_PATH)
+	// Auth Server - Public Key (when using JWT)
+	,aspublickeypath: (process.env.AS_PUBLIC_KEY_PATH === undefined ? "/var/lib/sts/stsglobalresources/keys/public.key" : process.env.AS_PUBLIC_KEY_PATH)
 
+	// STS Test Runner Prometheus metric support
+	,trprometheussupport: (process.env.TR_PROM_SUPPORT === undefined ? true : (process.env.TR_PROM_SUPPORT === "true" ? true : false ))
+	// STS Test Runner Cluster Server port (port used for cluster prometheus scrapes)
+	,trprometheusclusterport: (process.env.TR_PROM_CLUSTER_PORT === undefined ? "3015" : process.env.TR_PROM_CLUSTER_PORT)
 	// STS Test Runner Service Name
 	,trservicename: (process.env.TR_SERVICE_NAME === undefined ? "STSRestRunner" : process.env.TR_SERVICE_NAME)
 	// STS Test Runner Service Version
@@ -199,14 +180,8 @@ const defconfig =
 	,tremail: (process.env.TR_EMAIL === undefined ? "K6TestUser@sts" : process.env.TR_EMAIL)
 	// STS Test Runner password
 	,trpassword: (process.env.TR_PASSWORD === undefined ? "K6TestUserPassword" : process.env.TR_PASSWORD)
-	
-	// Auth Server - Private Key
-	,asprivatekeypath: (process.env.AS_PRIVATE_KEY_PATH === undefined ? "/var/lib/sts/stsglobalresources/keys/private.key" : process.env.AS_PRIVATE_KEY_PATH)
-	// Auth Server - Public Key
-	,aspublickeypath: (process.env.AS_PUBLIC_KEY_PATH === undefined ? "/var/lib/sts/stsglobalresources/keys/public.key" : process.env.AS_PUBLIC_KEY_PATH)
-	
-	// Special flags
-	,monitor: (process.env.MONITOR === undefined ? false : (process.env.MONITOR === "true" ? true : false ))
+	// STS Test Runner password file
+	,trpasswordfile: process.env.TR_PASSWORD_FILE
 
 	// Duration (in ms) between each publish event.
 	,publishinterval: (process.env.PUBLISH_INTERVAL === undefined ? 1000 : parseInt(process.env.PUBLISH_INTERVAL))
@@ -221,6 +196,7 @@ const defconfig =
 	// Transport(s) to use for sending instrumentation data to the instrumentation server
 	,transport: (process.env.TRANSPORT === undefined ? 0 : process.env.TRANSPORT)
 
+	/*
 	// Instrument Defaults
 	// Logger lines (sliding window size)
 	,instrumentLoggerSize: (process.env.INSTRUMENT_LOGGER_SIZE === undefined ? 200 : parseInt(process.env.INSTRUMENT_LOGGER_SIZE))
@@ -233,6 +209,7 @@ const defconfig =
 
 	// Sample size (number of readings to use for P(x) calculations. Time approx. (Sample Interval / 1000) * Sample Size, i.e. Caluclate P(x) on the observed data for the last 6 minutes.
 	,instrumentSampleSize: (process.env.INSTRUMENT_SAMPLE_SIZE === undefined ? 600 : parseInt(process.env.INSTRUMENT_SAMPLE_SIZE))
+	*/
 
 	// Use secure cookies option when passing back cookies from STS services (such as STSAuth service).
 	// This setting will be ignore for production mode. In production mode services will always use secure cookies.
@@ -263,9 +240,103 @@ const defconfig =
 	,timeout: (process.env.TIMEOUT === undefined ? 10000 : parseInt(process.env.TIMEOUT))
 	// Reference: https://nodejs.org/api/http.html#class-httpagent
 	// timeout <number> Socket timeout in milliseconds. This will set the timeout when the socket is created.
+
+	// Maximum payload size allowed for express server calls
+	,maxPayloadSize: (process.env.MAX_PAYLOAD_SIZE === undefined ? '50mb' : process.env.MAX_PAYLOAD_SIZE)
+
+	// Instrumentation Config Settings
+	// -------------------------------
+	// Generic interval (ms) to make on observation for instrumentation objects.
+	,instrumentationObservationInterval: (process.env.INSTRUMENTATION_OBSERVATION_INTERVAL === undefined ? 1000 : parseInt(process.env.INSTRUMENTATION_OBSERVATION_INTERVAL))
+
+	// Generic sliding time window (seconds) for instrumentation objects that process telemetry over time (e.g. P(x) instruments).
+	,instrumentationTimeWindow: (process.env.INSTRUMENTATION_TIME_WINDOW === undefined ? 600 : parseInt(process.env.INSTRUMENTATION_TIME_WINDOW))
+
+	// Service Specific Config Settings
+	// --------------------------------
+	// STSAuth
+	// -------
+	// Define the valid age for a JWT access token (in ms). Default 10 minutes.
+	,authJWTAccessTokenTimeout: (process.env.AUTH_JWT_ACCESS_TOKEN_TIMEOUT === undefined ? 600 : parseInt(process.env.AUTH_JWT_ACCESS_TOKEN_TIMEOUT))
+
+	// Define the valid age for a JWT refresh token (in ms). Default 24 hours.
+	,authJWTRefreshTokenTimeout: (process.env.AUTH_JWT_REFRESH_TOKEN_TIMEOUT === undefined ? (3600 * 24) : parseInt(process.env.AUTH_JWT_REFRESH_TOKEN_TIMEOUT))
+
+	// Define the valid age for an authentication/session cookie. Default 24 hours.
+	,authCookieTimeout: (process.env.AUTH_COOKIE_TIMEOUT === undefined ? (3600 * 24) : parseInt(process.env.AUTH_COOKIE_TIMEOUT))
+
+	// STSAppFramework (library)
+	// -------------------------
+	// Define the time (ms) to wait prior to exiting the application (using process.exit(0))
+	,masterProcessExitTime: (process.env.MASTER_PROCESS_EXIT_TIME === undefined ? 500 : parseInt(process.env.MASTER_PROCESS_EXIT_TIME))
+
+	// Define the time (ms) to wait prior to exiting the application (using process.exit(0))
+	,childProcessExitTime: (process.env.CHILD_PROCESS_EXIT_TIME === undefined ? 500 : parseInt(process.env.CHILD_PROCESS_EXIT_TIME))
+
+	// Define the interval (ms) to collect system information for instrumentation purposes
+	,systemInformationInterval: (process.env.SYSTEM_INFORMATION_INTERVAL === undefined ? 1000 : parseInt(process.env.SYSTEM_INFORMATION_INTERVAL))
+
+	// Ignore socket.io REST api calls and/or WebSocket calls when collecting telemetry for instrumentation purposes.
+	,ignoresocketio: (process.env.IGNORE_SOCKETIO === undefined ? true : (process.env.IGNORE_SOCKETIO === "true" ? true : false ))
+
+	/*
+	// STSModels (library)
+	// -------------------
+	// Define the interval for checking instrumentation updates on a instrumentation model. Entries in the model will be removed after this timeout value (ms) if no
+	// activity has been detected. Default 5 seconds.
+	,modelPurgeUpdateTimeout: (process.env.MODEL_PURGE_UPDATE_TIMEOUT === undefined ? 5000 : parseInt(process.env.MODEL_PURGE_UPDATE_TIMEOUT))
+	*/
+}
+
+const ReadPasswordFile = (passwordFile) => {
+	try {
+		accessSync(passwordFile, constants.R_OK);
+		const data = readFileSync(passwordFile, 'utf8');
+		debug(`Successfully loaded password file: [${passwordFile}]`.green);
+		return data;
+	} catch (err) {
+		debug(`Problem loading password file: [${passwordFile}], Error: [${err}]`.red);
+		return "";
+	}
+}
+
+// Database password file
+if (defconfig.dbpasswordfile !== undefined) {
+	defconfig.dbpassword = ReadPasswordFile(defconfig.dbpasswordfile);
+}
+
+// Auth Server username password file
+if (defconfig.aspasswordfile !== undefined) {
+	defconfig.aspassword = ReadPasswordFile(defconfig.aspasswordfile);
+}
+
+// STSREST01 Server username password file
+if (defconfig.rest01passwordfile !== undefined) {
+	defconfig.rest01password = ReadPasswordFile(defconfig.rest01passwordfile);
+}
+
+// STS Test Runner password file
+if (defconfig.trpasswordfile !== undefined) {
+	defconfig.trpassword = ReadPasswordFile(defconfig.trpasswordfile);
+}
+
+// STS Test Orchestrator Service username password file
+if (defconfig.topasswordfile !== undefined) {
+	defconfig.topassword = ReadPasswordFile(defconfig.topasswordfile);
+}
+
+// STS Instrument Manager Service username password file
+if (defconfig.impasswordfile !== undefined) {
+	defconfig.impassword = ReadPasswordFile(defconfig.impasswordfile);
 }
 
 // Preference order is YAML file then .env file
-const $options = {...deffileconfig, ...defconfig};
+const $options = {
+	...defconfig
+	// Computed connection string to be used in development mode.
+	,connectionString: `postgresql://${defconfig.dbuser}:${defconfig.dbpassword}@${defconfig.dbhost}:${defconfig.dbport}/${defconfig.database}`
+	// Default computed connection string for postgres. Database name = postgres. Used by utilites that create and/or update the STS database(s).
+	,defaultDatabaseConnectionString: `postgresql://${defconfig.dbuser}:${defconfig.dbpassword}@${defconfig.dbhost}:${defconfig.dbport}/postgres`
+}
 
 module.exports = { $options }

package/stsconfig.test.js

@@ -11,10 +11,75 @@ describe("Test", () =>
 
 	});
 
-	test('Testing Module', async () => 
+	test('Checking default config items', async () => 
 	{
-		expect.assertions(1);
-		expect(1).toEqual(1);
+		expect.assertions(21);
+
+		process.env.STSENVFILE = './.env-test-file-1'; // Empty environment file
+		let goptions = require('./stsconfig.js').$options;
+
+		expect(goptions.isProduction).toEqual(false);
+		expect(goptions.consoleLogErrors).toEqual(false);
+		expect(goptions.dbuser).toEqual('postgres');
+		expect(goptions.dbpassword).toEqual('password');
+		expect(goptions.dbpasswordfile).toEqual(undefined);
+		expect(goptions.dbhost).toEqual('localhost');
+		expect(goptions.dbport).toEqual('5432');
+		expect(goptions.database).toEqual('stsrestmsdb01');
+		expect(goptions.databaseUrl).toEqual(undefined);
+		expect(goptions.databasescriptfolder).toEqual('/var/lib/sts/stsglobalresources/db-scripts');
+
+		expect(goptions.poolSize).toEqual(500);
+		expect(goptions.useCPUs).toEqual(-1);
+		expect(goptions.respawnOnFail).toEqual(false);
+		expect(goptions.defaultDatabaseEntries).toEqual(10000);
+		expect(goptions.useRedis).toEqual(false);
+		expect(goptions.endFlush).toEqual(false);
+		expect(goptions.redisPort).toEqual('6379');
+		expect(goptions.redisServer).toEqual('localhost');
+		expect(goptions.k6ScriptPath).toEqual('.');
+		expect(goptions.defaultDatabaseMinExtraDataSize).toEqual(0);
+		expect(goptions.defaultDatabaseMaxExtraDataSize).toEqual(2000);
+	});
+
+	test('Checking default rest01 service config', async () => 
+	{
+		expect.assertions(11);
+
+		process.env.STSENVFILE = './.env-test-file-1'; // Empty environment file
+		let goptions = require('./stsconfig.js').$options;
+
+		expect(goptions.rest01endpoint).toEqual('http://localhost');
+		expect(goptions.rest01hostport).toEqual('3003');
+		expect(goptions.rest01port).toEqual('3003');
+		expect(goptions.rest01apiroot).toEqual('/stsrest01/v1');
+		expect(goptions.rest01prometheussupport).toEqual(true);
+		expect(goptions.rest01prometheusclusterport).toEqual('3013');
+		expect(goptions.rest01servicename).toEqual('STSRest01');
+		expect(goptions.rest01serviceversion).toEqual('1.0.0');
+		expect(goptions.rest01email).toEqual('K6TestUser@sts');
+		expect(goptions.rest01password).toEqual('K6TestUserPassword');
+		expect(goptions.rest01passwordfile).toEqual(undefined);
+	});
+
+	test('Checking default instrument manager service config', async () => 
+	{
+		expect.assertions(11);
+
+		process.env.STSENVFILE = './.env-test-file-1'; // Empty environment file
+		let goptions = require('./stsconfig.js').$options;
+
+		expect(goptions.imendpoint).toEqual('http://localhost');
+		expect(goptions.imhostport).toEqual('3001');
+		expect(goptions.import).toEqual('3001');
+		expect(goptions.imapiroot).toEqual('/stsinstrumentmanager/v1');
+		expect(goptions.imprometheussupport).toEqual(true);
+		expect(goptions.imprometheusclusterport).toEqual('3011');
+		expect(goptions.imservicename).toEqual('STSInstrumentManager');
+		expect(goptions.imserviceversion).toEqual('1.0.0');
+		expect(goptions.imemail).toEqual('K6TestUser@sts');
+		expect(goptions.impassword).toEqual('K6TestUserPassword');
+		expect(goptions.impasswordfile).toEqual(undefined);
 	});
 });