Extremely Popular
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492import { assertEquals, assertRejects, assertThrows } from "./test_deps.ts";import { config, configAsync, MissingEnvVarExportsError, MissingEnvVarsError, parse,} from "./mod.ts";
Deno.test("parser", () => { const testDotenv = Deno.readTextFileSync("./.env.test");
const { env: config, exports } = parse(testDotenv); assertEquals(config.BASIC, "basic", "parses a basic variable"); assertEquals(config.AFTER_EMPTY, "empty", "skips empty lines"); assertEquals(config["#COMMENT"], undefined, "skips lines with comments"); assertEquals(config.EMPTY_VALUE, "", "empty values are empty strings");
assertEquals( config.QUOTED_SINGLE, "single quoted", "single quotes are escaped", );
assertEquals( config.QUOTED_DOUBLE, "double quoted", "double quotes are escaped", );
assertEquals( config.MULTILINE, "hello\nworld", "new lines are expanded in double quotes", );
assertEquals( JSON.parse(config.JSON).foo, "bar", "inner quotes are maintained", );
assertEquals( config.WHITESPACE, " whitespace ", "whitespace in single-quoted values is preserved", );
assertEquals( config.WHITESPACE_DOUBLE, " whitespace ", "whitespace in double-quoted values is preserved", );
assertEquals( config.MULTILINE_SINGLE_QUOTE, "hello\\nworld", "new lines are escaped in single quotes", );
assertEquals(config.EQUALS, "equ==als", "handles equals inside string");
assertEquals( config.VAR_WITH_SPACE, "var with space", "variables defined with spaces are parsed", );
assertEquals( config.VAR_WITH_ENDING_WHITESPACE, "value", "variables defined with ending whitespace are trimmed", );
assertEquals( config.V4R_W1TH_NUM8ER5, "var with numbers", "accepts variables containing number", );
assertEquals( config["1INVALID"], undefined, "variables beginning with a number are not parsed", );
assertEquals( config.INDENTED_VAR, "indented var", "accepts variables that are indented with space", );
assertEquals( config.INDENTED_VALUE, "indented value", "accepts values that are indented with space", );
assertEquals( config.TAB_INDENTED_VAR, "indented var", "accepts variables that are indented with tabs", );
assertEquals( config.TAB_INDENTED_VALUE, "indented value", "accepts values that are indented with tabs", );
const expectedExportedAssignments = [ { name: "EXPORTED_VAR", value: "exported value 1", comment: "accepts exported variables", }, { name: "INDENTED_EXPORTED_ASSIGNMENT", value: "exported value 2", comment: "accepts indented exported assignments", }, { name: "TAB_INDENTED_EXPORTED_ASSIGNMENT", value: " exported value 3 ", comment: "accepts tab indented exported assignments", }, { name: "TAB_SPACED_ASSIGNMENT_VAR", value: " exported value 4 ", comment: "accepts tab spaced exported assignments", }, ];
const expectedExportedVariables = expectedExportedAssignments.map(( { name }, ) => name); assertEquals( [...exports].sort(), expectedExportedVariables.sort(), "correctly identifies exports", );
expectedExportedAssignments.forEach(({ name, value, comment }) => assertEquals(config[name], value, comment) );});
Deno.test("configure", () => { let conf = config(); assertEquals(conf.GREETING, "hello world", "fetches .env by default");
assertEquals(conf.DEFAULT1, "Some Default", "default value loaded");
conf = config({ path: "./.env.test" }); assertEquals(conf.BASIC, "basic", "accepts a path to fetch env from");
conf = config({ export: true }); assertEquals( Deno.env.get("GREETING"), "hello world", "exports variables to env when requested", );
Deno.env.set("DO_NOT_OVERRIDE", "Hello there"); conf = config({ export: true }); assertEquals( Deno.env.get("DO_NOT_OVERRIDE"), "Hello there", "does not export .env value if environment variable is already set", );
assertEquals( config( { path: "./.some.non.existent.env", defaults: "./.some.non.existent.env", }, ), {}, "returns empty object if file doesn't exist", );
assertEquals( config({ path: "./.some.non.existent.env" }), { DEFAULT1: "Some Default" }, "returns with defaults if file doesn't exist", );});
Deno.test("configureSafe", () => { // Default let conf = config({ safe: true, }); assertEquals(conf.GREETING, "hello world", "fetches .env by default");
// Custom .env.example conf = config({ safe: true, example: "./.env.example.test", });
assertEquals( conf.GREETING, "hello world", "accepts a path to fetch env example from", );
// Custom .env and .env.example conf = config({ path: "./.env.safe.test", safe: true, example: "./.env.example.test", });
assertEquals( conf.GREETING, "hello world", "accepts paths to fetch env and env example from", );
// Throws if not all required vars are there assertThrows(() => { config({ path: "./.env.safe.test", safe: true, example: "./.env.example2.test", }); }, MissingEnvVarsError);
// Throws if any of the required vars is empty assertThrows(() => { config({ path: "./.env.safe.empty.test", safe: true, example: "./.env.example2.test", }); }, MissingEnvVarsError);
// Does not throw if required vars are provided by example config({ path: "./.env.safe.empty.test", safe: true, example: "./.env.example3.test", defaults: "./.env.defaults", });
// Does not throw if any of the required vars is empty, *and* allowEmptyValues is present config({ path: "./.env.safe.empty.test", safe: true, example: "./.env.example2.test", allowEmptyValues: true, });
// Does not throw if any of the required vars passed externally Deno.env.set("ANOTHER", "VAR"); config({ path: "./.env.safe.test", safe: true, example: "./.env.example2.test", });
// Throws if any of the required vars passed externally is empty Deno.env.set("ANOTHER", ""); assertThrows(() => { config({ path: "./.env.safe.test", safe: true, example: "./.env.example2.test", }); });
// Does not throw if any of the required vars passed externally is empty, *and* allowEmptyValues is present Deno.env.set("ANOTHER", ""); config({ path: "./.env.safe.test", safe: true, example: "./.env.example2.test", allowEmptyValues: true, });});
Deno.test("configure async", async () => { let conf = await configAsync(); assertEquals(conf.GREETING, "hello world", "fetches .env by default");
assertEquals(conf.DEFAULT1, "Some Default", "default value loaded");
conf = await configAsync({ path: "./.env.test" }); assertEquals(conf.BASIC, "basic", "accepts a path to fetch env from");
conf = await configAsync({ export: true }); assertEquals( Deno.env.get("GREETING"), "hello world", "exports variables to env when requested", );
Deno.env.set("DO_NOT_OVERRIDE", "Hello there"); conf = await configAsync({ export: true }); assertEquals( Deno.env.get("DO_NOT_OVERRIDE"), "Hello there", "does not export .env value if environment variable is already set", );
assertEquals( await configAsync( { path: "./.some.non.existent.env", defaults: "./.some.non.existent.env", }, ), {}, "returns empty object if file doesn't exist", );
assertEquals( await configAsync({ path: "./.some.non.existent.env" }), { DEFAULT1: "Some Default" }, "returns with defaults if file doesn't exist", );});
Deno.test("configureSafe async", async () => { // Default let conf = await configAsync({ safe: true, }); assertEquals(conf.GREETING, "hello world", "fetches .env by default");
// Custom .env.example conf = await configAsync({ safe: true, example: "./.env.example.test", });
assertEquals( conf.GREETING, "hello world", "accepts a path to fetch env example from", );
// Custom .env and .env.example conf = await configAsync({ path: "./.env.safe.test", safe: true, example: "./.env.example.test", });
assertEquals( conf.GREETING, "hello world", "accepts paths to fetch env and env example from", );
// Throws if not all required vars are there assertRejects(async () => { await configAsync({ path: "./.env.safe.test", safe: true, example: "./.env.example2.test", }); }, MissingEnvVarsError);
// Throws if any of the required vars is empty assertRejects(async () => { await configAsync({ path: "./.env.safe.empty.test", safe: true, example: "./.env.example2.test", }); }, MissingEnvVarsError);
// Does not throw if required vars are provided by example await configAsync({ path: "./.env.safe.empty.test", safe: true, example: "./.env.example3.test", defaults: "./.env.defaults", });
// Does not throw if any of the required vars is empty, *and* allowEmptyValues is present await configAsync({ path: "./.env.safe.empty.test", safe: true, example: "./.env.example2.test", allowEmptyValues: true, });
// Does not throw if any of the required vars passed externally Deno.env.set("ANOTHER", "VAR"); await configAsync({ path: "./.env.safe.test", safe: true, example: "./.env.example2.test", });
// Throws if any of the required vars passed externally is empty Deno.env.set("ANOTHER", ""); assertRejects(async () => { await configAsync({ path: "./.env.safe.test", safe: true, example: "./.env.example2.test", }); });
// Does not throw if any of the required vars passed externally is empty, *and* allowEmptyValues is present Deno.env.set("ANOTHER", ""); await configAsync({ path: "./.env.safe.test", safe: true, example: "./.env.example2.test", allowEmptyValues: true, });});
Deno.test("configureExports", () => { // exports requested variables cleanseEnv(); config({ path: ".env.exports.test", });
const expectedUnexportedVariables = [ "NON_EXPORTED_VAR_1", "NON_EXPORTED_VAR_2", ]; expectedUnexportedVariables.forEach((name) => assertEquals( Deno.env.get(name), undefined, "does not export variables not marked for export", ) );
const expectedExportedAssignments = [{ name: "EXPORTED_VAR_1", value: "exported value 1", comment: "exports variables correctly", }, { name: "EXPORTED_VAR_2", value: "exported value 2", comment: "exports variables correctly", }]; expectedExportedAssignments.forEach(({ name, value, comment }) => assertEquals(Deno.env.get(name), value, comment) );
// exports anything marked as "export" from defaults cleanseEnv(); config({ path: ".env.exports.defaults.test", defaults: ".env.exports.defaults", }); assertEquals( Deno.env.get("DEFAULT_EXPORTED_VARIABLE"), "default exported value yeaah", "takes an unmentioned variable from default and exports it", ); assertEquals( Deno.env.get("ANOTHER_DEFAULT_EXPORTED_VARIABLE"), "this value should override the default value", "exports a variable if defaults mark it as an export", ); assertEquals( Deno.env.get("DEFAULT_UNEXPORTED_VARIABLE"), undefined, "does not export a variable not marked as an export", );
// example file checks certain variables to be exported cleanseEnv(); Deno.env.set("AWESOME_VAR", "wow it's a value going via the environment!"); assertThrows(() => { config({ path: ".env.exports.example.test", defaults: ".env.exports.example.defaults", example: ".env.exports.example", safe: true, }); }, MissingEnvVarExportsError);});
function cleanseEnv() { for (const key of Object.keys(Deno.env.toObject())) { Deno.env.delete(key); }}