mountenv/test/test.coffee

mount/load .env files with support for .env.prod/.env.dev files

fs = require 'fs-jetpack'
mountenv = require '../'
{expect} = require 'chai'
SAMPLE = './test/sample'


suite "mountenv", ()->
	suiteTeardown ()->
		fs.remove SAMPLE
		fs.remove '.env'
	
	setup ()->
		delete process.env.ABC
		delete process.env.DEF
		delete process.env.GHI
		fs.dir SAMPLE, empty:true
		fs.write "#{SAMPLE}/.env", """
			ABC=111
			DEF=222
			GHI=333
		"""


	suite ".get()", ()->
		test "loads .env file and returns js object", ()->
			expect(process.env.ABC).to.equal undefined
			expect(mountenv.get(SAMPLE)).to.eql {ABC:'111', DEF:'222', GHI:'333'}

		test "will not extend process env", ()->
			expect(process.env.ABC).to.equal undefined
			result = mountenv.get(SAMPLE)
			expect(process.env.ABC).to.equal undefined

		test "will return an empty object if provided dir doesn't exist or .env files don't exist", ()->
			expect(mountenv.get('./nonexistent')).to.eql {}
		
		test "will default path to cwd", ()->
			expect(mountenv.get()).to.eql {}
			fs.write ".env", "ABC=123"
			expect(mountenv.get()).to.eql {ABC:'123'}

		test "auto loads .env.dev when NODE_ENV === 'development'", ()->
			fs.write "#{SAMPLE}/.env.dev", "ABC=444"
			process.env.NODE_ENV = 'development'
			expect(mountenv.get(SAMPLE)).to.eql {ABC:'444', DEF:'222', GHI:'333'}

		test "auto loads .env.prod when NODE_ENV === 'production'", ()->
			fs.write "#{SAMPLE}/.env.prod", "DEF=555"
			process.env.NODE_ENV = 'production'
			expect(mountenv.get(SAMPLE)).to.eql {ABC:'111', DEF:'555', GHI:'333'}

		test "auto loads .env.test when NODE_ENV === 'test'", ()->
			fs.write "#{SAMPLE}/.env.test", "GHI=666"
			process.env.NODE_ENV = 'test'
			expect(mountenv.get(SAMPLE)).to.eql {ABC:'111', DEF:'222', GHI:'666'}

		test "accepts env file basename as an option in second argument", ()->
			writeMyEnv()
			process.env.NODE_ENV = 'test'
			expect(mountenv.get(SAMPLE)).to.eql {}
			expect(mountenv.get(SAMPLE, basename:'myEnv')).to.eql {LMN:'777', OPQ:'888'}


	suite ".getAll()", ()->
		test "loads .env file and returns js object including current process env", ()->
			process.env.GHI = '444'
			expect(process.env.ABC).to.equal undefined
			expect(process.env.DEF).to.equal undefined
			expect(process.env.GHI).to.equal '444'
			result = mountenv.getAll(SAMPLE)
			expect(result).not.to.equal process.env
			expect(process.env.ABC).to.equal undefined
			expect(process.env.DEF).to.equal undefined
			expect(process.env.GHI).to.equal '444'
			expect(result.ABC).to.equal '111'
			expect(result.DEF).to.equal '222'
			expect(result.GHI).to.equal '444'


	suite ".load()", ()->
		test "loads .env file from given path and extends process env", ()->
			process.env.GHI = '444'
			expect(process.env.ABC).to.equal undefined
			expect(process.env.DEF).to.equal undefined
			expect(process.env.GHI).to.equal '444'
			expect(mountenv.load(SAMPLE)).to.equal process.env
			expect(process.env.ABC).to.equal '111'
			expect(process.env.DEF).to.equal '222'
			expect(process.env.GHI).to.equal '444'

		test "accepts env file basename as an option in second argument", ()->
			writeMyEnv()
			process.env.NODE_ENV = 'test'
			mountenv.load(SAMPLE)
			expect(process.env.LMN).to.equal undefined
			mountenv.load(SAMPLE, basename:'myEnv')
			expect(process.env.LMN).to.equal '777'
			expect(process.env.OPQ).to.equal '888'

	
	suite ".parse()", ()->
		test "parses provided string as env file and returns object", ()->
			contents = fs.read "#{SAMPLE}/.env"
			expect(mountenv.parse(contents)).to.eql {ABC:'111', DEF:'222', GHI:'333'}


	suite "expansion", ()->
		setup ()->
			process.env.EXTERNAL = 456
			writeMyEnv """
				AAA=123
				BBB=$AAA
				CCC=${AAA} $BBB 456
				DDD=$EEE \\${EEE}
				EEE=\\$ESCAPE $NADA 123
				FFF=$EXTERNAL for \\$EXTERNAL
			""", ' '

			@withoutExpansion = 
				AAA: '123'
				BBB: '$AAA'
				CCC: '${AAA} $BBB 456'
				DDD: '$EEE \\${EEE}'
				EEE: '\\$ESCAPE $NADA 123'
				FFF: '$EXTERNAL for \\$EXTERNAL'

			@withExpansion = 
				AAA: '123'
				BBB: '123'
				CCC: '123 123 456'
				DDD: '$ESCAPE  123 ${EEE}'
				EEE: '$ESCAPE  123'
				FFF: '456 for $EXTERNAL'
		
		test "can be toggled on via options {expand:true}", ()->
			expect(mountenv.get(SAMPLE, basename:'myenv', expand:false)).to.eql @withoutExpansion
			expect(mountenv.get(SAMPLE, basename:'myenv', expand:true)).to.eql @withExpansion

		test "is toggled on by default", ()->
			expect(mountenv.get(SAMPLE, basename:'myenv')).to.eql @withExpansion



writeMyEnv = (mainContent, testContent)->
	fs.dir SAMPLE, empty:true
	fs.write "#{SAMPLE}/myEnv", mainContent or "LMN=777"
	fs.write "#{SAMPLE}/myEnv.test", testContent or "OPQ=888"