|
|
@@ -42,29 +42,29 @@ function updates(ctx: Context): CredentialRef[] {
|
|
|
}
|
|
|
|
|
|
describe('resolveSpec', () => {
|
|
|
- it('defaults to .env under the harness home with watching on', () => {
|
|
|
+ it('defaults to .credentials.yaml under the harness home with watching on', () => {
|
|
|
const spec = resolveSpec({ dshHome: '/custom/home' })
|
|
|
- expect(spec).toEqual({ filename: resolve('/custom/home/.env'), watch: true, debounceMs: 100 })
|
|
|
+ expect(spec).toEqual({ filename: resolve('/custom/home/.credentials.yaml'), watch: true, debounceMs: 100 })
|
|
|
})
|
|
|
|
|
|
it('lets an explicit path win over the home', () => {
|
|
|
- const spec = resolveSpec({ path: '/etc/dsh/creds.env', dshHome: '/ignored', watch: false, debounceMs: 5 })
|
|
|
- expect(spec).toEqual({ filename: resolve('/etc/dsh/creds.env'), watch: false, debounceMs: 5 })
|
|
|
+ const spec = resolveSpec({ path: '/etc/dsh/creds.yaml', dshHome: '/ignored', watch: false, debounceMs: 5 })
|
|
|
+ expect(spec).toEqual({ filename: resolve('/etc/dsh/creds.yaml'), watch: false, debounceMs: 5 })
|
|
|
})
|
|
|
})
|
|
|
|
|
|
describe('layering and reads', () => {
|
|
|
it('treats an absent file as an empty writable store', async () => {
|
|
|
const dir = await tempDir()
|
|
|
- const ctx = await boot({ path: join(dir, '.env'), watch: false })
|
|
|
+ const ctx = await boot({ path: join(dir, '.credentials.yaml'), watch: false })
|
|
|
expect(await ctx.credentials.resolve(KEY)).toBeUndefined()
|
|
|
expect(await ctx.credentials.describe(KEY)).toEqual({ configured: false, writable: true })
|
|
|
})
|
|
|
|
|
|
- it('serves file entries, including export-prefixed and quoted values', async () => {
|
|
|
+ it('serves file entries alongside comments and quoted values', async () => {
|
|
|
const dir = await tempDir()
|
|
|
- const path = join(dir, '.env')
|
|
|
- await writeFile(path, '# notes\nexport DSH_CRED_TEST=plain\nDSH_CRED_OTHER="with space"\n')
|
|
|
+ const path = join(dir, '.credentials.yaml')
|
|
|
+ await writeFile(path, '# notes\nDSH_CRED_TEST: plain\nDSH_CRED_OTHER: "with space"\n')
|
|
|
const ctx = await boot({ path, watch: false })
|
|
|
expect(await ctx.credentials.resolve(KEY)).toEqual({ value: 'plain', source: 'file' })
|
|
|
expect(await ctx.credentials.resolve(OTHER)).toEqual({ value: 'with space', source: 'file' })
|
|
|
@@ -73,22 +73,22 @@ describe('layering and reads', () => {
|
|
|
|
|
|
it('lets a non-empty process environment win read-only over the file', async () => {
|
|
|
const dir = await tempDir()
|
|
|
- const path = join(dir, '.env')
|
|
|
- await writeFile(path, 'DSH_CRED_TEST=from-file\n')
|
|
|
+ const path = join(dir, '.credentials.yaml')
|
|
|
+ await writeFile(path, 'DSH_CRED_TEST: from-file\n')
|
|
|
const ctx = await boot({ path, watch: false })
|
|
|
vi.stubEnv('DSH_CRED_TEST', 'from-env')
|
|
|
expect(await ctx.credentials.resolve(KEY)).toEqual({ value: 'from-env', source: 'env' })
|
|
|
expect(await ctx.credentials.describe(KEY)).toEqual({ configured: true, source: 'env', writable: false })
|
|
|
})
|
|
|
|
|
|
- it('treats empty values as absent in both layers', async () => {
|
|
|
+ it('treats an empty environment value as absent, falling through to the file', async () => {
|
|
|
const dir = await tempDir()
|
|
|
- const path = join(dir, '.env')
|
|
|
- await writeFile(path, 'DSH_CRED_TEST=\n')
|
|
|
+ const path = join(dir, '.credentials.yaml')
|
|
|
+ await writeFile(path, 'DSH_CRED_TEST: stored\n')
|
|
|
const ctx = await boot({ path, watch: false })
|
|
|
vi.stubEnv('DSH_CRED_TEST', '')
|
|
|
- expect(await ctx.credentials.resolve(KEY)).toBeUndefined()
|
|
|
- expect(await ctx.credentials.describe(KEY)).toEqual({ configured: false, writable: true })
|
|
|
+ expect(await ctx.credentials.resolve(KEY)).toEqual({ value: 'stored', source: 'file' })
|
|
|
+ expect(await ctx.credentials.describe(KEY)).toEqual({ configured: true, source: 'file', writable: true })
|
|
|
})
|
|
|
|
|
|
it('fails boot loud when the document exists but cannot be read', async () => {
|
|
|
@@ -100,110 +100,149 @@ describe('layering and reads', () => {
|
|
|
})
|
|
|
})
|
|
|
|
|
|
-describe('line-editing writes', () => {
|
|
|
- it('appends a missing key to a fresh 0600 document and emits the commit', async () => {
|
|
|
+describe('document validation', () => {
|
|
|
+ // Every rejection below is a boot failure rather than a skipped entry: this
|
|
|
+ // document holds nothing but credentials, so an ignored key would read as
|
|
|
+ // "the secret I stored has no effect".
|
|
|
+ it.each([
|
|
|
+ ['a non-mapping root', 'just a string\n', /must be a mapping/],
|
|
|
+ ['a sequence root', '- DSH_CRED_TEST\n', /must be a mapping/],
|
|
|
+ ['a key that is not a POSIX identifier', 'not-a-ref: value\n', /credential ref/],
|
|
|
+ ['a non-string value', 'DSH_CRED_TEST: 123\n', /must be a string/],
|
|
|
+ ['an empty value', 'DSH_CRED_TEST: ""\n', /is empty/],
|
|
|
+ ['duplicate keys', 'DSH_CRED_TEST: one\nDSH_CRED_TEST: two\n', /invalid document/],
|
|
|
+ ['malformed yaml', 'DSH_CRED_TEST: "unterminated\n', /invalid document/],
|
|
|
+ ])('fails boot on %s', async (_case, text, message) => {
|
|
|
const dir = await tempDir()
|
|
|
- const path = join(dir, '.env')
|
|
|
+ const path = join(dir, '.credentials.yaml')
|
|
|
+ await writeFile(path, text)
|
|
|
+ const ctx = new Context()
|
|
|
+ await expect(ctx.plugin(CredentialsLocal, { path, watch: false })).rejects.toThrow(message)
|
|
|
+ })
|
|
|
+
|
|
|
+ it('reads an empty document as an empty store', async () => {
|
|
|
+ const dir = await tempDir()
|
|
|
+ const path = join(dir, '.credentials.yaml')
|
|
|
+ await writeFile(path, '# nothing stored yet\n')
|
|
|
+ const ctx = await boot({ path, watch: false })
|
|
|
+ expect(await ctx.credentials.resolve(KEY)).toBeUndefined()
|
|
|
+ })
|
|
|
+})
|
|
|
+
|
|
|
+describe('document writes', () => {
|
|
|
+ it('adds a missing key to a fresh 0600 document and emits the commit', async () => {
|
|
|
+ const dir = await tempDir()
|
|
|
+ const path = join(dir, '.credentials.yaml')
|
|
|
const ctx = await boot({ path, watch: false })
|
|
|
const seen = updates(ctx)
|
|
|
await ctx.credentials.set(KEY, 'sk-fresh')
|
|
|
- expect(await readFile(path, 'utf8')).toBe('DSH_CRED_TEST=sk-fresh\n')
|
|
|
+ expect(await readFile(path, 'utf8')).toBe('DSH_CRED_TEST: sk-fresh\n')
|
|
|
expect((await stat(path)).mode & 0o777).toBe(0o600)
|
|
|
expect(await ctx.credentials.resolve(KEY)).toEqual({ value: 'sk-fresh', source: 'file' })
|
|
|
expect(seen).toEqual([KEY])
|
|
|
})
|
|
|
|
|
|
- it('rewrites one line in place, preserving every other byte and dropping duplicates', async () => {
|
|
|
+ it('patches one entry, preserving comments and every untouched entry', async () => {
|
|
|
const dir = await tempDir()
|
|
|
- const path = join(dir, '.env')
|
|
|
- await writeFile(path, '# deployment notes\nFIRST=one\n\nDSH_CRED_TEST=old\nTRAILING=x\nDSH_CRED_TEST=older')
|
|
|
+ const path = join(dir, '.credentials.yaml')
|
|
|
+ await writeFile(path, '# deployment notes\nDSH_CRED_OTHER: keep\n\n# the one under edit\nDSH_CRED_TEST: old\n')
|
|
|
const ctx = await boot({ path, watch: false })
|
|
|
await ctx.credentials.set(KEY, 'new value!')
|
|
|
- expect(await readFile(path, 'utf8')).toBe('# deployment notes\nFIRST=one\n\nDSH_CRED_TEST=\'new value!\'\nTRAILING=x\n')
|
|
|
+ expect(await readFile(path, 'utf8')).toBe(
|
|
|
+ '# deployment notes\nDSH_CRED_OTHER: keep\n\n# the one under edit\nDSH_CRED_TEST: new value!\n',
|
|
|
+ )
|
|
|
})
|
|
|
|
|
|
- it('quotes hostile values so they round-trip through a fresh provider', async () => {
|
|
|
+ it('round-trips values no dotenv line could represent', async () => {
|
|
|
const dir = await tempDir()
|
|
|
- const path = join(dir, '.env')
|
|
|
+ const path = join(dir, '.credentials.yaml')
|
|
|
const ctx = await boot({ path, watch: false })
|
|
|
- const singleQuoted = 'with "quote", back\\slash and space'
|
|
|
- const doubleQuoted = "it's got an apostrophe"
|
|
|
- await ctx.credentials.set(KEY, singleQuoted)
|
|
|
- await ctx.credentials.set(OTHER, doubleQuoted)
|
|
|
+ const multiLine = 'line one\nline two'
|
|
|
+ const mixedQuotes = 'both \' and "'
|
|
|
+ await ctx.credentials.set(KEY, multiLine)
|
|
|
+ await ctx.credentials.set(OTHER, mixedQuotes)
|
|
|
const reread = await boot({ path, watch: false })
|
|
|
- expect(await reread.credentials.resolve(KEY)).toEqual({ value: singleQuoted, source: 'file' })
|
|
|
- expect(await reread.credentials.resolve(OTHER)).toEqual({ value: doubleQuoted, source: 'file' })
|
|
|
- })
|
|
|
-
|
|
|
- it('fails loud on values no .env quoting style reads back verbatim', async () => {
|
|
|
- const dir = await tempDir()
|
|
|
- const ctx = await boot({ path: join(dir, '.env'), watch: false })
|
|
|
- await expect(ctx.credentials.set(KEY, 'line one\nline two')).rejects.toThrow(/control characters/)
|
|
|
- await expect(ctx.credentials.set(KEY, 'both \' and "')).rejects.toThrow(/mixes quoting/)
|
|
|
+ expect(await reread.credentials.resolve(KEY)).toEqual({ value: multiLine, source: 'file' })
|
|
|
+ expect(await reread.credentials.resolve(OTHER)).toEqual({ value: mixedQuotes, source: 'file' })
|
|
|
+ expect(await reread.credentials.describe(KEY)).toEqual({ configured: true, source: 'file', writable: true })
|
|
|
})
|
|
|
|
|
|
- it('unsets only the owning line and keeps an absent unset silent', async () => {
|
|
|
+ it('unsets only the owning entry, with its own annotation, and keeps an absent unset silent', async () => {
|
|
|
const dir = await tempDir()
|
|
|
- const path = join(dir, '.env')
|
|
|
- await writeFile(path, '# keep\nDSH_CRED_TEST=gone\nDSH_CRED_OTHER=stays\n')
|
|
|
+ const path = join(dir, '.credentials.yaml')
|
|
|
+ // Comments above an entry are that entry's annotation and go with it when
|
|
|
+ // it is removed — including anything above the document's first entry.
|
|
|
+ // Every other entry keeps its own comments.
|
|
|
+ await writeFile(path, '# about the doomed one\nDSH_CRED_TEST: gone\n# about the survivor\nDSH_CRED_OTHER: stays\n')
|
|
|
const ctx = await boot({ path, watch: false })
|
|
|
const seen = updates(ctx)
|
|
|
await ctx.credentials.unset(KEY)
|
|
|
- expect(await readFile(path, 'utf8')).toBe('# keep\nDSH_CRED_OTHER=stays\n')
|
|
|
+ expect(await readFile(path, 'utf8')).toBe('# about the survivor\nDSH_CRED_OTHER: stays\n')
|
|
|
await ctx.credentials.unset(KEY)
|
|
|
expect(seen).toEqual([KEY])
|
|
|
})
|
|
|
|
|
|
- it('rejects empty values, shadowed writes, and multi-line entries', async () => {
|
|
|
+ it('rejects empty values and writes the environment would shadow', async () => {
|
|
|
const dir = await tempDir()
|
|
|
- const path = join(dir, '.env')
|
|
|
- await writeFile(path, 'DSH_CRED_TEST="line one\nline two"\n')
|
|
|
+ const path = join(dir, '.credentials.yaml')
|
|
|
+ await writeFile(path, 'DSH_CRED_TEST: stored\n')
|
|
|
const ctx = await boot({ path, watch: false })
|
|
|
|
|
|
await expect(ctx.credentials.set(KEY, '')).rejects.toThrow(/empty value/)
|
|
|
- await expect(ctx.credentials.set(KEY, 'next')).rejects.toThrow(/multi-line/)
|
|
|
- await expect(ctx.credentials.unset(KEY)).rejects.toThrow(/multi-line/)
|
|
|
|
|
|
vi.stubEnv('DSH_CRED_TEST', 'shadowing')
|
|
|
await expect(ctx.credentials.set(KEY, 'next')).rejects.toThrow(/shadowed/)
|
|
|
await expect(ctx.credentials.unset(KEY)).rejects.toThrow(/shadowed/)
|
|
|
})
|
|
|
|
|
|
- it('leaves an empty document after unsetting the only entry', async () => {
|
|
|
+ it('leaves an empty mapping after unsetting the only entry', async () => {
|
|
|
const dir = await tempDir()
|
|
|
- const path = join(dir, '.env')
|
|
|
- await writeFile(path, 'DSH_CRED_TEST=only\n')
|
|
|
+ const path = join(dir, '.credentials.yaml')
|
|
|
+ await writeFile(path, 'DSH_CRED_TEST: only\n')
|
|
|
const ctx = await boot({ path, watch: false })
|
|
|
await ctx.credentials.unset(KEY)
|
|
|
- expect(await readFile(path, 'utf8')).toBe('')
|
|
|
+ expect(await readFile(path, 'utf8')).toBe('{}\n')
|
|
|
+ // The emptied document still reloads as an empty store, not a parse error.
|
|
|
+ const reread = await boot({ path, watch: false })
|
|
|
+ expect(await reread.credentials.resolve(KEY)).toBeUndefined()
|
|
|
+ })
|
|
|
+
|
|
|
+ it('fails a write loud when the on-disk document became invalid', async () => {
|
|
|
+ const dir = await tempDir()
|
|
|
+ const path = join(dir, '.credentials.yaml')
|
|
|
+ const ctx = await boot({ path, watch: false })
|
|
|
+ // An external editor left the document unparsable: the read-modify-write
|
|
|
+ // must refuse rather than overwrite content it cannot understand.
|
|
|
+ await writeFile(path, 'DSH_CRED_TEST: "unterminated\n')
|
|
|
+ await expect(ctx.credentials.set(OTHER, 'lands')).rejects.toThrow(/invalid document/)
|
|
|
})
|
|
|
|
|
|
it('chains past a rejected write so one bad value cannot poison the queue', async () => {
|
|
|
const dir = await tempDir()
|
|
|
- const path = join(dir, '.env')
|
|
|
+ const path = join(dir, '.credentials.yaml')
|
|
|
const ctx = await boot({ path, watch: false })
|
|
|
- const bad = expect(ctx.credentials.set(KEY, 'both \' and "')).rejects.toThrow(/mixes quoting/)
|
|
|
+ const bad = expect(ctx.credentials.set(KEY, '')).rejects.toThrow(/empty value/)
|
|
|
const good = ctx.credentials.set(OTHER, 'lands')
|
|
|
await bad
|
|
|
await good
|
|
|
- expect(await readFile(path, 'utf8')).toBe('DSH_CRED_OTHER=lands\n')
|
|
|
+ expect(await readFile(path, 'utf8')).toBe('DSH_CRED_OTHER: lands\n')
|
|
|
})
|
|
|
|
|
|
it('serializes concurrent writes so both land in the one document', async () => {
|
|
|
const dir = await tempDir()
|
|
|
- const path = join(dir, '.env')
|
|
|
+ const path = join(dir, '.credentials.yaml')
|
|
|
const ctx = await boot({ path, watch: false })
|
|
|
await Promise.all([
|
|
|
ctx.credentials.set(KEY, 'one'),
|
|
|
ctx.credentials.set(OTHER, 'two'),
|
|
|
])
|
|
|
- expect(await readFile(path, 'utf8')).toBe('DSH_CRED_TEST=one\nDSH_CRED_OTHER=two\n')
|
|
|
+ expect(await readFile(path, 'utf8')).toBe('DSH_CRED_TEST: one\nDSH_CRED_OTHER: two\n')
|
|
|
})
|
|
|
|
|
|
it('refuses writes after disposal', async () => {
|
|
|
const dir = await tempDir()
|
|
|
const ctx = new Context()
|
|
|
- const fiber = ctx.plugin(CredentialsLocal, { path: join(dir, '.env'), watch: false })
|
|
|
+ const fiber = ctx.plugin(CredentialsLocal, { path: join(dir, '.credentials.yaml'), watch: false })
|
|
|
await fiber
|
|
|
// Capture the handle first: disposal also removes the ctx.credentials service.
|
|
|
const service = ctx.credentials
|
|
|
@@ -215,20 +254,20 @@ describe('line-editing writes', () => {
|
|
|
describe('real hot reload', () => {
|
|
|
it('publishes external edits, replaces the snapshot wholesale, and suppresses self-writes', async () => {
|
|
|
const dir = await tempDir()
|
|
|
- const path = join(dir, '.env')
|
|
|
+ const path = join(dir, '.credentials.yaml')
|
|
|
// Watching starts on an existing document: creation racing watcher setup
|
|
|
// is a chokidar readiness gap, not the reload contract under test.
|
|
|
- await writeFile(path, 'DSH_CRED_TEST=boot\n')
|
|
|
+ await writeFile(path, 'DSH_CRED_TEST: boot\n')
|
|
|
const ctx = await boot({ path, debounceMs: 10 })
|
|
|
const seen = updates(ctx)
|
|
|
|
|
|
- await writeFile(path, 'DSH_CRED_TEST=live\nDSH_CRED_OTHER=extra\n')
|
|
|
+ await writeFile(path, 'DSH_CRED_TEST: live\nDSH_CRED_OTHER: extra\n')
|
|
|
await vi.waitFor(async () => {
|
|
|
expect(await ctx.credentials.resolve(KEY)).toEqual({ value: 'live', source: 'file' })
|
|
|
})
|
|
|
|
|
|
// Wholesale replacement: an entry deleted on disk never lingers in memory.
|
|
|
- await writeFile(path, 'DSH_CRED_TEST=live\n')
|
|
|
+ await writeFile(path, 'DSH_CRED_TEST: live\n')
|
|
|
await vi.waitFor(async () => {
|
|
|
expect(await ctx.credentials.resolve(OTHER)).toBeUndefined()
|
|
|
})
|