5616

pending completion

Build # 5616

Build Type

push

travis-ci

Committed by

bewest

Commit Message

env: off/on are truthy sometimes

Provide readENVTruthy, and mapTruthy, to explicitly handle
the cases where on/off or similar should result in a
Boolean value.  Here, they should be mapped correctly,
eliminating a problem @miloskozak experienced when setting
AUTH_DEFAULT_ROLES=bad, there is an exception becaue the
value is a literal `true` instead of the string `"bad"`.

Intended to be a no-op, preserving the intended effects
from previous commit
dbe29bd4b from
@jasoncalabrese.

Run Details

11 of 11 new or added lines in 2 files covered. (100.0%)

6783 of 9009 relevant lines covered (75.29%)

9578.86 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

92.52

/env.js

'use strict';

var _ = require('lodash');
var fs = require('fs');
var crypto = require('crypto');
var consts = require('./lib/constants');

var env = {
  settings: require('./lib/settings')()
};

// Module to constrain all config and environment parsing to one spot.
// See the
function config ( ) {
  /*
   * See README.md for info about all the supported ENV VARs
   */
  env.DISPLAY_UNITS = readENV('DISPLAY_UNITS', 'mg/dl');
  env.PORT = readENV('PORT', 1337);
  env.static_files = readENV('NIGHTSCOUT_STATIC_FILES', __dirname + '/static/');

  if (env.err) {
    delete env.err;
  }

  setSSL();
  setAPISecret();
  setVersion();
  setMongo();
  updateSettings();

  return env;
}

function setSSL() {
  env.SSL_KEY = readENV('SSL_KEY');
  env.SSL_CERT = readENV('SSL_CERT');
  env.SSL_CA = readENV('SSL_CA');
  env.ssl = false;
  if (env.SSL_KEY && env.SSL_CERT) {
    env.ssl = {
      key: fs.readFileSync(env.SSL_KEY), cert: fs.readFileSync(env.SSL_CERT)
    };
    if (env.SSL_CA) {
      env.ca = fs.readFileSync(env.SSL_CA);
    }
  }
}

// A little ugly, but we don't want to read the secret into a var
function setAPISecret() {
  var useSecret = (readENV('API_SECRET') && readENV('API_SECRET').length > 0);
  //TODO: should we clear API_SECRET from process env?
  env.api_secret = null;
  // if a passphrase was provided, get the hex digest to mint a single token
  if (useSecret) {
    if (readENV('API_SECRET').length < consts.MIN_PASSPHRASE_LENGTH) {
      var msg = ['API_SECRET should be at least', consts.MIN_PASSPHRASE_LENGTH, 'characters'].join(' ');
      console.error(msg);
      env.err = {desc: msg};
    } else {
      var shasum = crypto.createHash('sha1');
      shasum.update(readENV('API_SECRET'));
      env.api_secret = shasum.digest('hex');

      if (!readENV('TREATMENTS_AUTH', true)) {

      }


    }
  }
}

function setVersion() {
  var software = require('./package.json');
  var git = require('git-rev');

  if (readENV('APPSETTING_ScmType') === readENV('ScmType') && readENV('ScmType') === 'GitHub') {
    env.head = require('./scm-commit-id.json');
    console.log('SCM COMMIT ID', env.head);
  } else {
    git.short(function record_git_head(head) {
      console.log('GIT HEAD', head);
      env.head = head || readENV('SCM_COMMIT_ID') || readENV('COMMIT_HASH', '');
    });
  }
  env.version = software.version;
  env.name = software.name;
}

function setMongo() {
  env.mongo = readENV('MONGO_CONNECTION') || readENV('MONGO') || readENV('MONGOLAB_URI') || readENV('MONGODB_URI');
  env.mongo_collection = readENV('MONGO_COLLECTION', 'entries');
  env.MQTT_MONITOR = readENV('MQTT_MONITOR', null);
  if (env.MQTT_MONITOR) {
    var hostDbCollection = [env.mongo.split('mongodb://').pop().split('@').pop(), env.mongo_collection].join('/');
    var mongoHash = crypto.createHash('sha1');
    mongoHash.update(hostDbCollection);
    //some MQTT servers only allow the client id to be 23 chars
    env.mqtt_client_id = mongoHash.digest('base64').substring(0, 23);
    console.info('Using Mongo host/db/collection to create the default MQTT client_id', hostDbCollection);
    if (env.MQTT_MONITOR.indexOf('?clientId=') === -1) {
      console.info('Set MQTT client_id to: ', env.mqtt_client_id);
    } else {
      console.info('MQTT configured to use a custom client id, it will override the default: ', env.mqtt_client_id);
    }
  }
  env.authentication_collections_prefix = readENV('MONGO_AUTHENTICATION_COLLECTIONS_PREFIX', 'auth_');
  env.treatments_collection = readENV('MONGO_TREATMENTS_COLLECTION', 'treatments');
  env.profile_collection = readENV('MONGO_PROFILE_COLLECTION', 'profile');
  env.devicestatus_collection = readENV('MONGO_DEVICESTATUS_COLLECTION', 'devicestatus');
  env.food_collection = readENV('MONGO_FOOD_COLLECTION', 'food');

  // TODO: clean up a bit
  // Some people prefer to use a json configuration file instead.
  // This allows a provided json config to override environment variables
  var DB = require('./database_configuration.json'),
    DB_URL = DB.url ? DB.url : env.mongo,
    DB_COLLECTION = DB.collection ? DB.collection : env.mongo_collection;
  env.mongo = DB_URL;
  env.mongo_collection = DB_COLLECTION;
}

function updateSettings() {

  var envNameOverrides = {
    UNITS: 'DISPLAY_UNITS'
  };

  env.settings.eachSettingAsEnv(function settingFromEnv (name) {
    var envName = envNameOverrides[name] || name;
    return readENV(envName);
  });

  //should always find extended settings last
  env.extendedSettings = findExtendedSettings(process.env);

  if (!readENVTruthy('TREATMENTS_AUTH', true)) {
    env.settings.authDefaultRoles = env.settings.authDefaultRoles || "";
    env.settings.authDefaultRoles += ' careportal';
  }


}

function readENV(varName, defaultValue) {
  //for some reason Azure uses this prefix, maybe there is a good reason
  var value = process.env['CUSTOMCONNSTR_' + varName]
    || process.env['CUSTOMCONNSTR_' + varName.toLowerCase()]
    || process.env[varName]
    || process.env[varName.toLowerCase()];


  return value != null ? value : defaultValue;
}

function readENVTruthy(varName, defaultValue) {
  var value = readENV(varName, defaultValue);
  if (typeof value === 'string' && (value.toLowerCase() === 'on' || value.toLowerCase() === 'true')) { value = true; }
  if (typeof value === 'string' && (value.toLowerCase() === 'off' || value.toLowerCase() === 'false')) { value = false; }
  return value;
}

function findExtendedSettings (envs) {
  var extended = {};

  function normalizeEnv (key) {
    return key.toUpperCase().replace('CUSTOMCONNSTR_', '');
  }

  _.each(env.settings.enable, function eachEnable(enable) {
    if (_.trim(enable)) {
      _.forIn(envs, function eachEnvPair (value, key) {
        var env = normalizeEnv(key);
        if (_.startsWith(env, enable.toUpperCase() + '_')) {
          var split = env.indexOf('_');
          if (split > -1 && split <= env.length) {
            var exts = extended[enable] || {};
            extended[enable] = exts;
            var ext = _.camelCase(env.substring(split + 1).toLowerCase());
            if (!isNaN(value)) { value = Number(value); }
            if (typeof value === 'string' && (value.toLowerCase() === 'on' || value.toLowerCase() === 'true')) { value = true; }
            if (typeof value === 'string' && (value.toLowerCase() === 'off' || value.toLowerCase() === 'false')) { value = false; }
            exts[ext] = value;
          }
        }
      });
    }
  });
  return extended;
}

module.exports = config;

1	'use strict';
2
3	var _ = require('lodash');	3✔
4	var fs = require('fs');	3✔
5	var crypto = require('crypto');	3✔
6	var consts = require('./lib/constants');	3✔
7
8	var env = {	3✔
9	settings: require('./lib/settings')()
10	};
11
12	// Module to constrain all config and environment parsing to one spot.
13	// See the
14	function config ( ) {	3✔
15	/*
16	* See README.md for info about all the supported ENV VARs
17	*/
18	env.DISPLAY_UNITS = readENV('DISPLAY_UNITS', 'mg/dl');	135✔
19	env.PORT = readENV('PORT', 1337);	135✔
20	env.static_files = readENV('NIGHTSCOUT_STATIC_FILES', __dirname + '/static/');	135✔
21
22	if (env.err) {	135✔
23	delete env.err;	3✔
24	}
25
26	setSSL();	135✔
27	setAPISecret();	135✔
28	setVersion();	135✔
29	setMongo();	135✔
30	updateSettings();	135✔
31
32	return env;	135✔
33	}
34
35	function setSSL() {	3✔
36	env.SSL_KEY = readENV('SSL_KEY');	135✔
37	env.SSL_CERT = readENV('SSL_CERT');	135✔
38	env.SSL_CA = readENV('SSL_CA');	135✔
39	env.ssl = false;	135✔
40	if (env.SSL_KEY && env.SSL_CERT) {	135✔
41	env.ssl = {	×
42	key: fs.readFileSync(env.SSL_KEY), cert: fs.readFileSync(env.SSL_CERT)
43	};
44	if (env.SSL_CA) {	×
45	env.ca = fs.readFileSync(env.SSL_CA);	×
46	}
47	}
48	}
49
50	// A little ugly, but we don't want to read the secret into a var
51	function setAPISecret() {	3✔
52	var useSecret = (readENV('API_SECRET') && readENV('API_SECRET').length > 0);	135✔
53	//TODO: should we clear API_SECRET from process env?
54	env.api_secret = null;	135✔
55	// if a passphrase was provided, get the hex digest to mint a single token
56	if (useSecret) {	135✔
57	if (readENV('API_SECRET').length < consts.MIN_PASSPHRASE_LENGTH) {	90✔
58	var msg = ['API_SECRET should be at least', consts.MIN_PASSPHRASE_LENGTH, 'characters'].join(' ');	3✔
59	console.error(msg);	3✔
60	env.err = {desc: msg};	3✔
61	} else {
62	var shasum = crypto.createHash('sha1');	87✔
63	shasum.update(readENV('API_SECRET'));	87✔
64	env.api_secret = shasum.digest('hex');	87✔
65
66	if (!readENV('TREATMENTS_AUTH', true)) {	87✔
67
68	}
69
70
71	}
72	}
73	}
74
75	function setVersion() {	3✔
76	var software = require('./package.json');	135✔
77	var git = require('git-rev');	135✔
78
79	if (readENV('APPSETTING_ScmType') === readENV('ScmType') && readENV('ScmType') === 'GitHub') {	135✔
80	env.head = require('./scm-commit-id.json');	×
81	console.log('SCM COMMIT ID', env.head);	×
82	} else {
83	git.short(function record_git_head(head) {	135✔
84	console.log('GIT HEAD', head);	135✔
85	env.head = head \|\| readENV('SCM_COMMIT_ID') \|\| readENV('COMMIT_HASH', '');	135✔
86	});
87	}
88	env.version = software.version;	135✔
89	env.name = software.name;	135✔
90	}
91
92	function setMongo() {	3✔
93	env.mongo = readENV('MONGO_CONNECTION') \|\| readENV('MONGO') \|\| readENV('MONGOLAB_URI') \|\| readENV('MONGODB_URI');	135✔
94	env.mongo_collection = readENV('MONGO_COLLECTION', 'entries');	135✔
95	env.MQTT_MONITOR = readENV('MQTT_MONITOR', null);	135✔
96	if (env.MQTT_MONITOR) {	135✔
97	var hostDbCollection = [env.mongo.split('mongodb://').pop().split('@').pop(), env.mongo_collection].join('/');	3✔
98	var mongoHash = crypto.createHash('sha1');	3✔
99	mongoHash.update(hostDbCollection);	3✔
100	//some MQTT servers only allow the client id to be 23 chars
101	env.mqtt_client_id = mongoHash.digest('base64').substring(0, 23);	3✔
102	console.info('Using Mongo host/db/collection to create the default MQTT client_id', hostDbCollection);	3✔
103	if (env.MQTT_MONITOR.indexOf('?clientId=') === -1) {	3✔
104	console.info('Set MQTT client_id to: ', env.mqtt_client_id);	3✔
105	} else {
106	console.info('MQTT configured to use a custom client id, it will override the default: ', env.mqtt_client_id);	×
107	}
108	}
109	env.authentication_collections_prefix = readENV('MONGO_AUTHENTICATION_COLLECTIONS_PREFIX', 'auth_');	135✔
110	env.treatments_collection = readENV('MONGO_TREATMENTS_COLLECTION', 'treatments');	135✔
111	env.profile_collection = readENV('MONGO_PROFILE_COLLECTION', 'profile');	135✔
112	env.devicestatus_collection = readENV('MONGO_DEVICESTATUS_COLLECTION', 'devicestatus');	135✔
113	env.food_collection = readENV('MONGO_FOOD_COLLECTION', 'food');	135✔
114
115	// TODO: clean up a bit
116	// Some people prefer to use a json configuration file instead.
117	// This allows a provided json config to override environment variables
118	var DB = require('./database_configuration.json'),	135✔
119	DB_URL = DB.url ? DB.url : env.mongo,
120	DB_COLLECTION = DB.collection ? DB.collection : env.mongo_collection;
121	env.mongo = DB_URL;	135✔
122	env.mongo_collection = DB_COLLECTION;	135✔
123	}
124
125	function updateSettings() {	3✔
126
127	var envNameOverrides = {	135✔
128	UNITS: 'DISPLAY_UNITS'
129	};
130
131	env.settings.eachSettingAsEnv(function settingFromEnv (name) {	135✔
132	var envName = envNameOverrides[name] \|\| name;	5,394✔
133	return readENV(envName);	5,394✔
134	});
135
136	//should always find extended settings last
137	env.extendedSettings = findExtendedSettings(process.env);	135✔
138
139	if (!readENVTruthy('TREATMENTS_AUTH', true)) {	135✔
140	env.settings.authDefaultRoles = env.settings.authDefaultRoles \|\| "";	×
141	env.settings.authDefaultRoles += ' careportal';	×
142	}
143
144
145	}
146
147	function readENV(varName, defaultValue) {	3✔
148	//for some reason Azure uses this prefix, maybe there is a good reason
149	var value = process.env['CUSTOMCONNSTR_' + varName]	8,313✔
150	\|\| process.env['CUSTOMCONNSTR_' + varName.toLowerCase()]
151	\|\| process.env[varName]
152	\|\| process.env[varName.toLowerCase()];
153
154
155	return value != null ? value : defaultValue;	8,313✔
156	}
157
158	function readENVTruthy(varName, defaultValue) {	3✔
159	var value = readENV(varName, defaultValue);	135✔
160	if (typeof value === 'string' && (value.toLowerCase() === 'on' \|\| value.toLowerCase() === 'true')) { value = true; }	135✔
161	if (typeof value === 'string' && (value.toLowerCase() === 'off' \|\| value.toLowerCase() === 'false')) { value = false; }	135✔
162	return value;	135✔
163	}
164
165	function findExtendedSettings (envs) {	3✔
166	var extended = {};	135✔
167
168	function normalizeEnv (key) {	3✔
169	return key.toUpperCase().replace('CUSTOMCONNSTR_', '');	107,232✔
170	}
171
172	_.each(env.settings.enable, function eachEnable(enable) {	135✔
173	if (_.trim(enable)) {	1,203✔
174	_.forIn(envs, function eachEnvPair (value, key) {	1,203✔
175	var env = normalizeEnv(key);	107,232✔
176	if (_.startsWith(env, enable.toUpperCase() + '_')) {	107,232✔
177	var split = env.indexOf('_');	60✔
178	if (split > -1 && split <= env.length) {	60✔
179	var exts = extended[enable] \|\| {};	60✔
180	extended[enable] = exts;	60✔
181	var ext = _.camelCase(env.substring(split + 1).toLowerCase());	60✔
182	if (!isNaN(value)) { value = Number(value); }	60✔
183	if (typeof value === 'string' && (value.toLowerCase() === 'on' \|\| value.toLowerCase() === 'true')) { value = true; }	60✔
184	if (typeof value === 'string' && (value.toLowerCase() === 'off' \|\| value.toLowerCase() === 'false')) { value = false; }	60✔
185	exts[ext] = value;	60✔
186	}
187	}
188	});
189	}
190	});
191	return extended;	135✔
192	}
193
194	module.exports = config;	3✔

nightscout / cgm-remote-monitor / 5616

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous