deno.land / std@0.173.0 / dotenv / mod_test.ts
نووسراو ببینە
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
import { assertEquals, assertRejects, assertStringIncludes, assertThrows,} from "../testing/asserts.ts";import type { DotenvConfig } from "./mod.ts";import { load, loadSync, MissingEnvVarsError, parse, stringify,} from "./mod.ts";import * as path from "../path/mod.ts";import type { IsExact } from "../testing/types.ts";import { assertType } from "../testing/types.ts";
const moduleDir = path.dirname(path.fromFileUrl(import.meta.url));const testdataDir = path.resolve(moduleDir, "testdata");
const testOptions = { envPath: path.join(testdataDir, "./.env"), defaultsPath: path.join(testdataDir, "./.env.defaults"),};
Deno.test("parser", () => { const testDotenv = Deno.readTextFileSync( path.join(testdataDir, "./.env.test"), );
const load = parse(testDotenv); assertEquals(load.BASIC, "basic", "parses a basic variable"); assertEquals(load.AFTER_EMPTY, "empty", "skips empty lines"); assertEquals(load["#COMMENT"], undefined, "skips lines with comments"); assertEquals(load.EMPTY_VALUE, "", "empty values are empty strings");
assertEquals( load.QUOTED_SINGLE, "single quoted", "single quotes are escaped", );
assertEquals( load.QUOTED_DOUBLE, "double quoted", "double quotes are escaped", );
assertEquals( load.EMPTY_SINGLE, "", "handles empty single quotes", );
assertEquals( load.EMPTY_DOUBLE, "", "handles empty double quotes", );
assertEquals( load.MULTILINE, "hello\nworld", "new lines are expanded in double quotes", );
assertEquals( JSON.parse(load.JSON).foo, "bar", "inner quotes are maintained", );
assertEquals( load.WHITESPACE, " whitespace ", "whitespace in single-quoted values is preserved", );
assertEquals( load.WHITESPACE_DOUBLE, " whitespace ", "whitespace in double-quoted values is preserved", );
assertEquals( load.MULTILINE_SINGLE_QUOTE, "hello\\nworld", "new lines are escaped in single quotes", );
assertEquals(load.EQUALS, "equ==als", "handles equals inside string");
assertEquals( load.VAR_WITH_SPACE, "var with space", "variables defined with spaces are parsed", );
assertEquals( load.VAR_WITH_ENDING_WHITESPACE, "value", "variables defined with ending whitespace are trimmed", );
assertEquals( load.V4R_W1TH_NUM8ER5, "var with numbers", "accepts variables containing number", );
assertEquals( load["1INVALID"], undefined, "variables beginning with a number are not parsed", );
assertEquals( load.INDENTED_VAR, "indented var", "accepts variables that are indented with space", );
assertEquals( load.INDENTED_VALUE, "indented value", "accepts values that are indented with space", );
assertEquals( load.TAB_INDENTED_VAR, "indented var", "accepts variables that are indented with tabs", );
assertEquals( load.TAB_INDENTED_VALUE, "indented value", "accepts values that are indented with tabs", );
assertEquals( load.PRIVATE_KEY_SINGLE_QUOTED, "-----BEGIN RSA PRIVATE KEY-----\n...\nHkVN9...\n...\n-----END DSA PRIVATE KEY-----", "Private Key Single Quoted", );
assertEquals( load.PRIVATE_KEY_DOUBLE_QUOTED, "-----BEGIN RSA PRIVATE KEY-----\n...\nHkVN9...\n...\n-----END DSA PRIVATE KEY-----", "Private Key Double Quoted", );
assertEquals( load.EXPORT_IS_IGNORED, "export is ignored", "export at the start of the key is ignored", );});
Deno.test("with comments", () => { const testDotenv = Deno.readTextFileSync( path.join(testdataDir, "./.env.comments"), );
const load = parse(testDotenv); assertEquals(load.FOO, "bar", "unquoted value with a simple comment"); assertEquals( load.GREETING, "hello world", "double quoted value with a simple comment", ); assertEquals( load.SPECIAL_CHARACTERS_UNQUOTED, "123", "unquoted value with special characters in comment", ); assertEquals( load.SPECIAL_CHARACTERS_UNQUOTED_NO_SPACES, "123", "unquoted value with special characters in comment which is right after value", );});
Deno.test("loadure", () => { let conf = loadSync(testOptions);
assertEquals(conf.GREETING, "hello world", "fetches .env");
assertEquals(conf.DEFAULT1, "Some Default", "default value loaded");
conf = loadSync({ ...testOptions, export: true }); assertEquals( Deno.env.get("GREETING"), "hello world", "exports variables to env when requested", );
Deno.env.set("DO_NOT_OVERRIDE", "Hello there"); conf = loadSync({ ...testOptions, export: true }); assertEquals( Deno.env.get("DO_NOT_OVERRIDE"), "Hello there", "does not export .env value if environment variable is already set", );
assertEquals( loadSync( { envPath: "./.some.non.existent.env", defaultsPath: "./.some.non.existent.env", }, ), {}, "returns empty object if file doesn't exist", );
assertEquals( loadSync({ envPath: "./.some.non.existent.env", defaultsPath: testOptions.defaultsPath, }), { DEFAULT1: "Some Default" }, "returns with defaults if file doesn't exist", );});
Deno.test("loadureSafe", () => { // Default let conf = loadSync({ ...testOptions, }); assertEquals(conf.GREETING, "hello world", "fetches .env");
// Custom .env.example conf = loadSync({ ...testOptions, examplePath: path.join(testdataDir, "./.env.example.test"), });
assertEquals( conf.GREETING, "hello world", "accepts a path to fetch env example from", );
// Custom .env and .env.example conf = loadSync({ envPath: path.join(testdataDir, "./.env.safe.test"),
examplePath: path.join(testdataDir, "./.env.example.test"), });
assertEquals( conf.GREETING, "hello world", "accepts paths to fetch env and env example from", );
let error: MissingEnvVarsError;
// Throws if not all required vars are there error = assertThrows(() => { loadSync({ envPath: path.join(testdataDir, "./.env.safe.test"),
examplePath: path.join(testdataDir, "./.env.example2.test"), }); }, MissingEnvVarsError);
assertEquals(error.missing, ["ANOTHER"]);
// Throws if any of the required vars is empty error = assertThrows(() => { loadSync({ envPath: path.join(testdataDir, "./.env.safe.empty.test"),
examplePath: path.join(testdataDir, "./.env.example2.test"), }); }, MissingEnvVarsError);
assertEquals(error.missing, ["ANOTHER"]);
// Does not throw if required vars are provided by example loadSync({ envPath: path.join(testdataDir, "./.env.safe.empty.test"),
examplePath: path.join(testdataDir, "./.env.example3.test"), defaultsPath: path.join(moduleDir, "./.env.defaults"), });
// Does not throw if any of the required vars is empty, *and* allowEmptyValues is present loadSync({ envPath: path.join(testdataDir, "./.env.safe.empty.test"),
examplePath: path.join(testdataDir, "./.env.example2.test"), allowEmptyValues: true, });
// Does not throw if any of the required vars passed externally Deno.env.set("ANOTHER", "VAR"); loadSync({ envPath: path.join(testdataDir, "./.env.safe.test"),
examplePath: path.join(testdataDir, "./.env.example2.test"), });
// Throws if any of the required vars passed externally is empty Deno.env.set("ANOTHER", ""); assertThrows(() => { loadSync({ envPath: path.join(testdataDir, "./.env.safe.test"),
examplePath: path.join(testdataDir, "./.env.example2.test"), }); });
// Does not throw if any of the required vars passed externally is empty, *and* allowEmptyValues is present Deno.env.set("ANOTHER", ""); loadSync({ envPath: path.join(testdataDir, "./.env.safe.test"),
examplePath: path.join(testdataDir, "./.env.example2.test"), allowEmptyValues: true, });});
Deno.test("loadure async", async () => { let conf = await load(testOptions); assertEquals(conf.GREETING, "hello world", "fetches .env");
assertEquals(conf.DEFAULT1, "Some Default", "default value loaded");
conf = await load({ envPath: path.join(testdataDir, "./.env.test") }); assertEquals(conf.BASIC, "basic", "accepts a path to fetch env from");
conf = await load({ ...testOptions, 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 load({ ...testOptions, export: true }); assertEquals( Deno.env.get("DO_NOT_OVERRIDE"), "Hello there", "does not export .env value if environment variable is already set", );
assertEquals( await load( { envPath: "./.some.non.existent.env", defaultsPath: "./.some.non.existent.env", }, ), {}, "returns empty object if file doesn't exist", );
assertEquals( await load({ ...testOptions, envPath: "./.some.non.existent.env" }), { DEFAULT1: "Some Default" }, "returns with defaults if file doesn't exist", );});
Deno.test("loadureSafe async", async () => { // Default let conf = await load({ ...testOptions, }); assertEquals(conf.GREETING, "hello world", "fetches .env");
// Custom .env.example conf = await load({ ...testOptions, examplePath: path.join(testdataDir, "./.env.example.test"), });
assertEquals( conf.GREETING, "hello world", "accepts a path to fetch env example from", );
// Custom .env and .env.example conf = await load({ envPath: path.join(testdataDir, "./.env.safe.test"),
examplePath: path.join(testdataDir, "./.env.example.test"), });
assertEquals( conf.GREETING, "hello world", "accepts paths to fetch env and env example from", );
let error: MissingEnvVarsError;
// Throws if not all required vars are there error = await assertRejects(async () => { await load({ envPath: path.join(testdataDir, "./.env.safe.test"),
examplePath: path.join(testdataDir, "./.env.example2.test"), }); }, MissingEnvVarsError);
assertEquals(error.missing, ["ANOTHER"]);
// Throws if any of the required vars is empty error = await assertRejects(async () => { await load({ envPath: path.join(testdataDir, "./.env.safe.empty.test"),
examplePath: path.join(testdataDir, "./.env.example2.test"), }); }, MissingEnvVarsError);
assertEquals(error.missing, ["ANOTHER"]);
// Does not throw if required vars are provided by example await load({ envPath: path.join(testdataDir, "./.env.safe.empty.test"),
examplePath: path.join(testdataDir, "./.env.example3.test"), defaultsPath: path.join(moduleDir, "./.env.defaults"), });
// Does not throw if any of the required vars is empty, *and* allowEmptyValues is present await load({ envPath: path.join(testdataDir, "./.env.safe.empty.test"),
examplePath: path.join(testdataDir, "./.env.example2.test"), allowEmptyValues: true, });
// Does not throw if any of the required vars passed externally Deno.env.set("ANOTHER", "VAR"); await load({ envPath: path.join(testdataDir, "./.env.safe.test"),
examplePath: path.join(testdataDir, "./.env.example2.test"), });
// Throws if any of the required vars passed externally is empty Deno.env.set("ANOTHER", ""); assertRejects(async () => { await load({ envPath: path.join(testdataDir, "./.env.safe.test"),
examplePath: path.join(testdataDir, "./.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 load({ envPath: path.join(testdataDir, "./.env.safe.test"),
examplePath: path.join(testdataDir, "./.env.example2.test"), allowEmptyValues: true, });});
Deno.test("load defaults", async () => { const command = new Deno.Command(Deno.execPath(), { args: [ "run", "--allow-read", "--allow-env", path.join(testdataDir, "./app_defaults.ts"), ], cwd: testdataDir, }); const { stdout } = await command.output();
const decoder = new TextDecoder(); const conf = JSON.parse(decoder.decode(stdout).trim());
assertEquals(conf.GREETING, "hello world", "fetches .env by default");
assertEquals(conf.DEFAULT1, "Some Default", "default value loaded");});
Deno.test("expand variables", () => { const testDotenv = Deno.readTextFileSync( path.join(testdataDir, "./.env.expand.test"), );
const load = parse(testDotenv); assertEquals( load.EXPAND_ESCAPED, "\\$THE_ANSWER", "variable is escaped not expanded", ); assertEquals(load.EXPAND_VAR, "42", "variable is expanded"); assertEquals( load.EXPAND_TWO_VARS, "single quoted!==double quoted", "two variables are expanded", ); assertEquals( load.EXPAND_RECURSIVE, "single quoted!==double quoted", "recursive variables expanded", ); assertEquals(load.EXPAND_DEFAULT_TRUE, "default", "default expanded"); assertEquals(load.EXPAND_DEFAULT_FALSE, "42", "default not expanded"); assertEquals(load.EXPAND_DEFAULT_VAR, "42", "default var expanded"); assertEquals( load.EXPAND_DEFAULT_VAR_RECURSIVE, "single quoted!==double quoted", "default recursive var expanded", ); assertEquals( load.EXPAND_DEFAULT_VAR_DEFAULT, "default", "default variable's default value is used", ); assertEquals( load.EXPAND_DEFAULT_WITH_SPECIAL_CHARACTERS, "/default/path", "default with special characters expanded", ); assertEquals( load.EXPAND_VAR_IN_BRACKETS, "42", "variable in brackets is expanded", ); assertEquals( load.EXPAND_TWO_VARS_IN_BRACKETS, "single quoted!==double quoted", "two variables in brackets are expanded", ); assertEquals( load.EXPAND_RECURSIVE_VAR_IN_BRACKETS, "single quoted!==double quoted", "recursive variables in brackets expanded", ); assertEquals( load.EXPAND_DEFAULT_IN_BRACKETS_TRUE, "default", "default in brackets expanded", ); assertEquals( load.EXPAND_DEFAULT_IN_BRACKETS_FALSE, "42", "default in brackets not expanded", ); assertEquals( load.EXPAND_DEFAULT_VAR_IN_BRACKETS, "42", "default var in brackets expanded", ); assertEquals( load.EXPAND_DEFAULT_VAR_IN_BRACKETS_RECURSIVE, "single quoted!==double quoted", "default recursive var in brackets expanded", ); assertEquals( load.EXPAND_DEFAULT_VAR_IN_BRACKETS_DEFAULT, "default", "default variable's default value in brackets is used", ); assertEquals( load.EXPAND_DEFAULT_IN_BRACKETS_WITH_SPECIAL_CHARACTERS, "/default/path", "default in brackets with special characters expanded", ); assertEquals( load.EXPAND_WITH_DIFFERENT_STYLES, "single quoted!==double quoted", "variables within and without brackets expanded", );});Deno.test("stringify", async (t) => { await t.step( "basic", () => assertEquals( stringify({ "BASIC": "basic" }), `BASIC=basic`, ), ); await t.step( "comment", () => assertEquals( stringify({ "#COMMENT": "comment" }), ``, ), ); await t.step( "single quote", () => assertEquals( stringify({ "QUOTED_SINGLE": "single quoted" }), `QUOTED_SINGLE='single quoted'`, ), ); await t.step( "multiline", () => assertEquals( stringify({ "MULTILINE": "hello\nworld" }), `MULTILINE="hello\\nworld"`, ), ); await t.step( "whitespace", () => assertEquals( stringify({ "WHITESPACE": " whitespace " }), `WHITESPACE=' whitespace '`, ), ); await t.step( "equals", () => assertEquals( stringify({ "EQUALS": "equ==als" }), `EQUALS='equ==als'`, ), ); await t.step( "number", () => assertEquals( stringify({ "THE_ANSWER": "42" }), `THE_ANSWER=42`, ), ); await t.step( "undefined", () => assertEquals( stringify( { "UNDEFINED": undefined } as unknown as Record<string, string>, ), `UNDEFINED=`, ), ); await t.step( "null", () => assertEquals( stringify({ "NULL": null } as unknown as Record<string, string>), `NULL=`, ), );});
Deno.test("use restrictEnvAccessTo to restrict lookup of Env variables to certain vars. Those vars can be granted read permissions now separately.", async () => { const command = new Deno.Command(Deno.execPath(), { args: [ "run", "--allow-read", "--allow-env=GREETING", path.join(testdataDir, "./app_with_restricted_env_access.ts"), ], cwd: testdataDir, }); const { stdout } = await command.output();
const decoder = new TextDecoder(); const conf = JSON.parse(decoder.decode(stdout).trim());
assertEquals(conf.GREETING, "hello world", "fetches .env by default"); assertEquals(conf.DEFAULT1, "Some Default", "default value loaded");});
Deno.test("use restrictEnvAccessTo via loadSync to restrict lookup of Env variables to certain vars.", async () => { const command = new Deno.Command(Deno.execPath(), { args: [ "run", "--allow-read", "--allow-env=GREETING", path.join(testdataDir, "./app_with_restricted_env_access_sync.ts"), ], cwd: testdataDir, }); const { stdout } = await command.output();
const decoder = new TextDecoder(); const conf = JSON.parse(decoder.decode(stdout).trim());
assertEquals(conf.GREETING, "hello world", "fetches .env by default"); assertEquals(conf.DEFAULT1, "Some Default", "default value loaded");});
Deno.test("use of restrictEnvAccessTo for an Env var, without granting env permissions still fails", async () => { const command = new Deno.Command(Deno.execPath(), { args: [ "run", "--allow-read", path.join(testdataDir, "./app_with_restricted_env_access.ts"), ], cwd: testdataDir, }); const { stdout } = await command.output();
const decoder = new TextDecoder(); const error = decoder.decode(stdout).trim();
assertStringIncludes(error, 'Requires env access to "GREETING"');});
Deno.test("type inference based on restrictEnvAccessTo", async (t) => { await t.step("return type is inferred", async () => { const conf = await load({ ...testOptions, restrictEnvAccessTo: ["GREETING"], });
assertType< IsExact<typeof conf, { GREETING: string }> >(true);
assertType< IsExact<typeof conf, { NO_SUCH_KEY: string }> >(false);
assertType< IsExact<typeof conf, DotenvConfig> >(false);
assertEquals(conf.DEFAULT1, "Some Default"); });
await t.step("readonly array is also supported", () => { const conf = loadSync({ ...testOptions, restrictEnvAccessTo: ["GREETING", "DEFAULT1"] as const, });
assertType< IsExact<typeof conf, { GREETING: string; DEFAULT1: string }> >(true); });
await t.step("without restrictEnvAccessTo", async () => { const conf = await load(testOptions);
assertType< IsExact<typeof conf, { GREETING: string }> >(false);
assertType<IsExact<typeof conf, DotenvConfig>>(true); });});
std
Version Info
a year ago
