-
-
Notifications
You must be signed in to change notification settings - Fork 143
feat: load secret from files #337
8000New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
e35b52e
feat: load secret from files
sweatybridge 675618d
Merge branch 'master' into get-secret
sweatybridge ab926fa
Merge branch 'master' into get-secret
sweatybridge dc32569
Merge branch 'master' into get-secret
sweatybridge 881c0d8
chore: fix tests by using dynamic imports
sweatybridge 4ba9e26
chore: add reference comment
sweatybridge File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
// Use dynamic import to support module mock | ||
const fs = await import('fs/promises') | ||
|
||
export const getSecret = async (key: string) => { | ||
if (!key) { | ||
return '' | ||
} | ||
|
||
const env = process.env[key] | ||
if (env) { | ||
return env | ||
} | ||
|
||
const file = process.env[key + '_FILE'] | ||
if (!file) { | ||
return '' | ||
} | ||
|
||
return await fs.readFile(file, { encoding: 'utf8' }).catch((e) => { | ||
if (e.code == 'ENOENT') { | ||
return '' | ||
} | ||
throw e | ||
}) | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
import { jest } from '@jest/globals' | ||
|
||
// Ref: https://jestjs.io/docs/ecmascript-modules | ||
jest.unstable_mockModule('fs/promises', () => ({ | ||
readFile: jest.fn(), | ||
})) | ||
const { readFile } = await import('fs/promises') | ||
const { getSecret } = await import('../../src/lib/secrets') | ||
|
||
describe('getSecret', () => { | ||
const value = 'dummy' | ||
|
||
beforeEach(() => { | ||
// Clears env var | ||
jest.resetModules() | ||
}) | ||
|
||
afterEach(() => { | ||
delete process.env.SECRET | ||
delete process.env.SECRET_FILE | ||
}) | ||
|
||
it('loads from env', async () => { | ||
process.env.SECRET = value | ||
const res = await getSecret('SECRET') | ||
expect(res).toBe(value) | ||
}) | ||
|
||
it('loads from file', async () => { | ||
process.env.SECRET_FILE = '/run/secrets/db_password' | ||
jest.mocked(readFile).mockResolvedValueOnce(value) | ||
const res = await getSecret('SECRET') | ||
expect(res).toBe(value) | ||
}) | ||
|
||
it('defaults to empty string', async () => { | ||
expect(await getSecret('')).toBe('') | ||
expect(await getSecret('SECRET')).toBe('') | ||
}) | ||
|
||
it('default on file not found', async () => { | ||
process.env.SECRET_FILE = '/run/secrets/db_password' | ||
const e: NodeJS.ErrnoException = new Error('no such file or directory') | ||
e.code = 'ENOENT' | ||
jest.mocked(readFile).mockRejectedValueOnce(e) | ||
const res = await getSecret('SECRET') | ||
expect(res).toBe('') | ||
}) | ||
|
||
it('throws on permission denied', async () => { | ||
process.env.SECRET_FILE = '/run/secrets/db_password' | ||
const e: NodeJS.ErrnoException = new Error('permission denied') | ||
e.code = 'EACCES' | ||
jest.mocked(readFile).mockRejectedValueOnce(e) | ||
expect(getSecret('SECRET')).rejects.toThrow() | ||
}) | ||
}) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.