585158425

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/neverendingqs/serverless-dotenv-plugin/commit/<a class=hub.com/neverendingqs/serverless-dotenv-plugin/commit/<a class="double-link" href="https://git"><a class=hub.com/neverendingqs/serverless-dotenv-plugin/commit/<a class="double-link" href="https://git"><a class=hub.com/neverendingqs/serverless-dotenv-plugin/commit/e7d7516dc155672447f396763a04dc60d2fd42dc">e7d7516dc<a href="https://github.com/neverendingqs/serverless-dotenv-plugin/commit/e7d7516dc155672447f396763a04dc60d2fd42dc">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/neverendingqs/serverless-dotenv-plugin/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/neverendingqs/serverless-dotenv-plugin/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/neverendingqs/serverless-dotenv-plugin/commit/e7d7516dc155672447f396763a04dc60d2fd42dc&quot;&gt;e7d7516dc&lt;/a&gt;&lt;a href=&quot;https://github.com/neverendingqs/serverless-dotenv-plugin/commit/e7d7516dc155672447f396763a04dc60d2fd42dc&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/neverendingqs/serverless-dotenv-plugin/commit/e7d7516dc155672447f396763a04dc60&lt;/a&gt;d2fd42dc&quot;&gt;&amp;quot;&gt;Merge &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/neverendingqs/serverless-dotenv-plugin/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/neverendingqs/serverless-dotenv-plugin/commit/<a class="double-link" href="https://github.com/neverendingqs/serverless-dotenv-plugin/commit/eaa3bb27e54622bd5bf05b23f5d037f0bca5582d">eaa3bb27e</a><a href="https://github.com/neverendingqs/serverless-dotenv-plugin/commit/e7d7516dc155672447f396763a04dc60d2fd42dc">&amp;quot;&amp;gt;eaa3bb27e&amp;lt;/a&amp;gt;&amp;quot;&amp;gt;eaa3bb27e&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/neverendingqs/serverless-dotenv-plugin/commit/e7d7516dc155672447f396763a04dc60d2fd4&lt;/a&gt;2dc&quot;&gt; into &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/neverendingqs/serverless-dotenv-plugin/commit/<a class="double-link" href="https://github.com/neverendingqs/serverless-dotenv-plugin/commit/b72b503ab">b72b503ab">b72b503ab</a>

Pull Request Pull Request #127: feat: adding support for custom dotenv parser.

Run Details

62 of 66 branches covered (93.94%)

Branch coverage included in aggregate %.

9 of 9 new or added lines in 1 file covered. (100.0%)

68 of 73 relevant lines covered (93.15%)

18.95 hits per line

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

93.53

/index.js

'use strict'

const dotenv = require('dotenv')
const dotenvExpand = require('dotenv-expand')
const chalk = require('chalk')
const fs = require('fs')
const path = require('path')

const errorTypes = {
  HALT: 'HALT',
}

class ServerlessPlugin {
  constructor(serverless, options) {
    this.serverless = serverless
    this.serverless.service.provider.environment =
      this.serverless.service.provider.environment || {}
    this.config =
      this.serverless.service.custom && this.serverless.service.custom['dotenv']
    this.logging =
      this.config && typeof this.config.logging !== 'undefined'
        ? this.config.logging
        : true
    this.required = (this.config && this.config.required) || {}
    this.variableExpansion = !(
      (this.config && this.config.variableExpansion) === false
    )

    if (this.config && this.config.dotenvParser) {
      this.dotenvParserPath = path.join(
        serverless.config.servicePath,
        this.config.dotenvParser,
      )
    }

    this.loadEnv(this.getEnvironment(options))
  }

  log(...args) {
    if (this.logging) {
      this.serverless.cli.log(...args)
    }
  }

  /**
   * @param {Object} options
   * @returns {string}
   */
  getEnvironment(options) {
    return process.env.NODE_ENV || options.env || options.stage || 'development'
  }

  /**
   * @param {string} env
   * @returns {string[]}
   */
  resolveEnvFileNames(env) {
    const basePath = (this.config && this.config.basePath) || ''

    if (this.config && this.config.path) {
      if (basePath) {
        this.log('DOTENV (WARNING): if "path" is set, "basePath" is ignored.')
      }

      if (Array.isArray(this.config.path)) {
        return this.config.path
      }
      return [this.config.path]
    }

    // https://github.com/bkeepers/dotenv#what-other-env-files-can-i-use
    const dotenvFiles = [
      `.env.${env}.local`,
      `.env.${env}`,
      // Don't include `.env.local` for `test` environment
      // since normally you expect tests to produce the same
      // results for everyone
      env !== 'test' && `.env.local`,
      `.env`,
    ]

    const filesNames = dotenvFiles.map((file) => basePath + file)

    return filesNames.filter((fileName) => fs.existsSync(fileName))
  }

  /**
   * @param {string[]} envFileNames
   * @returns {Object}
   */
  callDotenvParser(envFileNames) {
    try {
      return require(this.dotenvParserPath)({ dotenv, paths: envFileNames })
    } catch (err) {
      throw Object.assign(err, { type: errorTypes.HALT })
    }
  }

  /**
   * @param {string[]} envFileNames
   * @returns {Object}
   */
  parseEnvFiles(envFileNames) {
    const envVarsArray = envFileNames.map((fileName) => {
      const parsed = dotenv.config({ path: fileName })
      return this.variableExpansion
        ? dotenvExpand(parsed).parsed
        : parsed.parsed
    })

    return envVarsArray.reduce((acc, curr) => ({ ...acc, ...curr }), {})
  }

  /**
   * @param {Object} envVars
   */
  setProviderEnv(envVars) {
    const include = (this.config && this.config.include) || []
    const exclude = (this.config && this.config.exclude) || []

    if (include.length > 0) {
      if (exclude) {
        this.log('DOTENV (WARNING): if "include" is set, "exclude" is ignored.')
      }

      Object.keys(envVars)
        .filter((key) => !include.includes(key))
        .forEach((key) => {
          delete envVars[key]
        })
    } else if (exclude.length > 0) {
      Object.keys(envVars)
        .filter((key) => exclude.includes(key))
        .forEach((key) => {
          delete envVars[key]
        })
    }

    Object.keys(envVars).forEach((key) => {
      this.log('\t - ' + key)
      this.serverless.service.provider.environment[key] = envVars[key]
    })
  }

  /**
   * @param {string[]} envFileNames
   */
  validateEnvFileNames(envFileNames) {
    if (envFileNames.length > 0) {
      this.log(
        'DOTENV: Loading environment variables from ' +
          [...envFileNames].reverse().join(', ') +
          ':',
      )
    } else {
      const errorMsg = 'DOTENV: Could not find .env file.'
      this.log(errorMsg)

      if (this.required.file === true) {
        throw Object.assign(new Error(errorMsg), { type: errorTypes.HALT })
      }
    }
  }

  /**
   * @param {string[]} envFileNames
   */
  validateEnvVars(envVars) {
    if (!envVars) {
      throw Object.assign(
        new Error(
          'Unexpected env var object (expected an object but is falsy). Did you forget to return an object in your dotenv parser?',
        ),
        { type: errorTypes.HALT },
      )
    }

    const missingRequiredEnvVars = (this.required.env || []).filter(
      (envVarName) => !envVars[envVarName] && !process.env[envVarName],
    )

    if (missingRequiredEnvVars.length > 0) {
      throw Object.assign(
        new Error(
          `Missing the following required environment variables: ${missingRequiredEnvVars.join(
            ',',
          )}`,
        ),
        { type: errorTypes.HALT },
      )
    }
  }

  /**
   * @param {string} env
   */
  loadEnv(env) {
    const envFileNames = this.resolveEnvFileNames(env)
    try {
      this.validateEnvFileNames(envFileNames)

      const envVars = this.dotenvParserPath
        ? this.callDotenvParser(envFileNames)
        : this.parseEnvFiles(envFileNames)

      this.validateEnvVars(envVars)
      this.setProviderEnv(envVars)
    } catch (e) {
      if (e.type === errorTypes.HALT) {
        throw e
      }

      console.error(
        chalk.red(
          '\n Serverless Plugin Error --------------------------------------\n',
        ),
      )
      console.error(chalk.red('  ' + e.message))
    }
  }
}

module.exports = ServerlessPlugin

1	'use strict'
2
3	const dotenv = require('dotenv')	31✔
4	const dotenvExpand = require('dotenv-expand')	31✔
5	const chalk = require('chalk')	31✔
6	const fs = require('fs')	31✔
7	const path = require('path')	31✔
8
9	const errorTypes = {	31✔
10	HALT: 'HALT',
11	}
12
13	class ServerlessPlugin {
14	constructor(serverless, options) {
15	this.serverless = serverless	31✔
16	this.serverless.service.provider.environment =	31✔
17	this.serverless.service.provider.environment \|\| {}	62✔
18	this.config =	31✔
19	this.serverless.service.custom && this.serverless.service.custom['dotenv']	43✔
20	this.logging =	31✔
21	this.config && typeof this.config.logging !== 'undefined'	74✔
22	? this.config.logging
23	: true
24	this.required = (this.config && this.config.required) \|\| {}	31✔
25	this.variableExpansion = !(	31✔
26	(this.config && this.config.variableExpansion) === false	43✔
27	)
28
29	if (this.config && this.config.dotenvParser) {	31!
30	this.dotenvParserPath = path.join(	×
31	serverless.config.servicePath,
32	this.config.dotenvParser,
33	)
34	}
35
36	this.loadEnv(this.getEnvironment(options))	31✔
37	}
38
39	log(...args) {
40	if (this.logging) {	48✔
41	this.serverless.cli.log(...args)	46✔
42	}
43	}
44
45	/**
46	* @param {Object} options
47	* @returns {string}
48	*/
49	getEnvironment(options) {
50	return process.env.NODE_ENV \|\| options.env \|\| options.stage \|\| 'development'	22✔
51	}
52
53	/**
54	* @param {string} env
55	* @returns {string[]}
56	*/
57	resolveEnvFileNames(env) {
58	const basePath = (this.config && this.config.basePath) \|\| ''	29✔
59
60	if (this.config && this.config.path) {	29✔
61	if (basePath) {	6✔
62	this.log('DOTENV (WARNING): if "path" is set, "basePath" is ignored.')	2✔
63	}
64
65	if (Array.isArray(this.config.path)) {	6✔
66	return this.config.path	2✔
67	}
68	return [this.config.path]	4✔
69	}
70
71	// https://github.com/bkeepers/dotenv#what-other-env-files-can-i-use
72	const dotenvFiles = [	23✔
73	`.env.${env}.local`,
74	`.env.${env}`,
75	// Don't include `.env.local` for `test` environment
76	// since normally you expect tests to produce the same
77	// results for everyone
78	env !== 'test' && `.env.local`,	45✔
79	`.env`,
80	]
81
82	const filesNames = dotenvFiles.map((file) => basePath + file)	92✔
83
84	return filesNames.filter((fileName) => fs.existsSync(fileName))	92✔
85	}
86
87	/**
88	* @param {string[]} envFileNames
89	* @returns {Object}
90	*/
91	callDotenvParser(envFileNames) {
92	try {	×
93	return require(this.dotenvParserPath)({ dotenv, paths: envFileNames })	×
94	} catch (err) {
95	throw Object.assign(err, { type: errorTypes.HALT })	×
96	}
97	}
98
99	/**
100	* @param {string[]} envFileNames
101	* @returns {Object}
102	*/
103	parseEnvFiles(envFileNames) {
104	const envVarsArray = envFileNames.map((fileName) => {	28✔
105	const parsed = dotenv.config({ path: fileName })	22✔
106	return this.variableExpansion	21✔
107	? dotenvExpand(parsed).parsed
108	: parsed.parsed
109	})
110
111	return envVarsArray.reduce((acc, curr) => ({ ...acc, ...curr }), {})	15✔
112	}
113
114	/**
115	* @param {Object} envVars
116	*/
117	setProviderEnv(envVars) {
118	const include = (this.config && this.config.include) \|\| []	14✔
119	const exclude = (this.config && this.config.exclude) \|\| []	14✔
120
121	if (include.length > 0) {	14✔
122	if (exclude) {	2!
123	this.log('DOTENV (WARNING): if "include" is set, "exclude" is ignored.')	2✔
124	}
125
126	Object.keys(envVars)	2✔
127	.filter((key) => !include.includes(key))	6✔
128	.forEach((key) => {
129	delete envVars[key]	3✔
130	})
131	} else if (exclude.length > 0) {	12✔
132	Object.keys(envVars)	1✔
133	.filter((key) => exclude.includes(key))	3✔
134	.forEach((key) => {
135	delete envVars[key]	1✔
136	})
137	}
138
139	Object.keys(envVars).forEach((key) => {	14✔
140	this.log('\t - ' + key)	14✔
141	this.serverless.service.provider.environment[key] = envVars[key]	14✔
142	})
143	}
144
145	/**
146	* @param {string[]} envFileNames
147	*/
148	validateEnvFileNames(envFileNames) {
149	if (envFileNames.length > 0) {	29✔
150	this.log(	20✔
151	'DOTENV: Loading environment variables from ' +
152	[...envFileNames].reverse().join(', ') +
153	':',
154	)
155	} else {
156	const errorMsg = 'DOTENV: Could not find .env file.'	9✔
157	this.log(errorMsg)	9✔
158
159	if (this.required.file === true) {	9✔
160	throw Object.assign(new Error(errorMsg), { type: errorTypes.HALT })	1✔
161	}
162	}
163	}
164
165	/**
166	* @param {string[]} envFileNames
167	*/
168	validateEnvVars(envVars) {
169	if (!envVars) {	15!
170	throw Object.assign(	×
171	new Error(
172	'Unexpected env var object (expected an object but is falsy). Did you forget to return an object in your dotenv parser?',
173	),
174	{ type: errorTypes.HALT },
175	)
176	}
177
178	const missingRequiredEnvVars = (this.required.env \|\| []).filter(	15✔
179	(envVarName) => !envVars[envVarName] && !process.env[envVarName],	4✔
180	)
181
182	if (missingRequiredEnvVars.length > 0) {	15✔
183	throw Object.assign(	1✔
184	new Error(
185	`Missing the following required environment variables: ${missingRequiredEnvVars.join(
186	',',
187	)}`,
188	),
189	{ type: errorTypes.HALT },
190	)
191	}
192	}
193
194	/**
195	* @param {string} env
196	*/
197	loadEnv(env) {
198	const envFileNames = this.resolveEnvFileNames(env)	30✔
199	try {	29✔
200	this.validateEnvFileNames(envFileNames)	29✔
201
202	const envVars = this.dotenvParserPath	28!
203	? this.callDotenvParser(envFileNames)
204	: this.parseEnvFiles(envFileNames)
205
206	this.validateEnvVars(envVars)	15✔
207	this.setProviderEnv(envVars)	14✔
208	} catch (e) {
209	if (e.type === errorTypes.HALT) {	15✔
210	throw e	2✔
211	}
212
213	console.error(	13✔
214	chalk.red(
215	'\n Serverless Plugin Error --------------------------------------\n',
216	),
217	)
218	console.error(chalk.red(' ' + e.message))	13✔
219	}
220	}
221	}
222
223	module.exports = ServerlessPlugin	31✔

neverendingqs / serverless-dotenv-plugin / 585158425

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