Skip to content

test: add tests for password prompt #274

New 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.

Sign up for GitHub

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
43081j merged 1 commit into from
Apr 6, 2025
Merged

test: add tests for password prompt #274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
280 changes: 280 additions & 0 deletions packages/prompts/src/__snapshots__/index.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -708,6 +708,146 @@ exports[`prompts (isCI = false) > multiselect > sliding window loops upwards 1`]
]
`;

exports[`prompts (isCI = false) > password > renders and clears validation errors 1`] = `
[
"[?25l",
"│
◆ foo
│ _
└
",
"",
"",
"",
"│ ▪_",
"",
"",
"",
"",
"▲ foo
│ ▪
└ Password must be at least 2 characters
",
"",
"",
"",
"◆ foo
│ ▪▪_
└
",
"",
"",
"",
"◇ foo
│ ▪▪",
"
",
"[?25h",
]
`;

exports[`prompts (isCI = false) > password > renders cancelled value 1`] = `
[
"[?25l",
"│
◆ foo
│ _
└
",
"",
"",
"",
"│ ▪_",
"",
"",
"",
"",
"■ foo
│ ▪
│",
"
",
"[?25h",
]
`;

exports[`prompts (isCI = false) > password > renders custom mask 1`] = `
[
"[?25l",
"│
◆ foo
│ _
└
",
"",
"",
"",
"│ *_",
"",
"",
"",
"",
"│ **_",
"",
"",
"",
"",
"◇ foo
│ **",
"
",
"[?25h",
]
`;

exports[`prompts (isCI = false) > password > renders masked value 1`] = `
[
"[?25l",
"│
◆ foo
│ _
└
",
"",
"",
"",
"│ ▪_",
"",
"",
"",
"",
"│ ▪▪_",
"",
"",
"",
"",
"◇ foo
│ ▪▪",
"
",
"[?25h",
]
`;

exports[`prompts (isCI = false) > password > renders message 1`] = `
[
"[?25l",
"│
◆ foo
│ _
└
",
"",
"",
"",
"◇ foo
│",
"
",
"[?25h",
]
`;

exports[`prompts (isCI = false) > select > can cancel 1`] = `
[
"[?25l",
Expand Down Expand Up @@ -1873,6 +2013,146 @@ exports[`prompts (isCI = true) > multiselect > sliding window loops upwards 1`]
]
`;

exports[`prompts (isCI = true) > password > renders and clears validation errors 1`] = `
[
"[?25l",
"│
◆ foo
│ _
└
",
"",
"",
"",
"│ ▪_",
"",
"",
"",
"",
"▲ foo
│ ▪
└ Password must be at least 2 characters
",
"",
"",
"",
"◆ foo
│ ▪▪_
└
",
"",
"",
"",
"◇ foo
│ ▪▪",
"
",
"[?25h",
]
`;

exports[`prompts (isCI = true) > password > renders cancelled value 1`] = `
[
"[?25l",
"│
◆ foo
│ _
└
",
"",
"",
"",
"│ ▪_",
"",
"",
"",
"",
"■ foo
│ ▪
│",
"
",
"[?25h",
]
`;

exports[`prompts (isCI = true) > password > renders custom mask 1`] = `
[
"[?25l",
"│
◆ foo
│ _
└
",
"",
"",
"",
"│ *_",
"",
"",
"",
"",
"│ **_",
"",
"",
"",
"",
"◇ foo
│ **",
"
",
"[?25h",
]
`;

exports[`prompts (isCI = true) > password > renders masked value 1`] = `
[
"[?25l",
"│
◆ foo
│ _
└
",
"",
"",
"",
"│ ▪_",
"",
"",
"",
"",
"│ ▪▪_",
"",
"",
"",
"",
"◇ foo
│ ▪▪",
"
",
"[?25h",
]
`;

exports[`prompts (isCI = true) > password > renders message 1`] = `
[
"[?25l",
"│
◆ foo
│ _
└
",
"",
"",
"",
"◇ foo
│",
"
",
"[?25h",
]
`;

exports[`prompts (isCI = true) > select > can cancel 1`] = `
[
"[?25l",
Expand Down
90 changes: 90 additions & 0 deletions packages/prompts/src/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -809,4 +809,94 @@ describe.each(['true', 'false'])('prompts (isCI = %s)', (isCI) => {
expect(output.buffer).toMatchSnapshot();
});
});

describe('password', () => {
test('renders message', async () => {
const result = prompts.password({
message: 'foo',
input,
output,
});

input.emit('keypress', '', { name: 'return' });

await result;

expect(output.buffer).toMatchSnapshot();
});

test('renders masked value', async () => {
const result = prompts.password({
message: 'foo',
input,
output,
});

input.emit('keypress', 'x', { name: 'x' });
input.emit('keypress', 'y', { name: 'y' });
input.emit('keypress', '', { name: 'return' });

const value = await result;

expect(value).toBe('xy');
expect(output.buffer).toMatchSnapshot();
});

test('renders custom mask', async () => {
const result = prompts.password({
message: 'foo',
mask: '*',
input,
output,
});

input.emit('keypress', 'x', { name: 'x' });
input.emit('keypress', 'y', { name: 'y' });
input.emit('keypress', '', { name: 'return' });

await result;

expect(output.buffer).toMatchSnapshot();
});

test('renders and clears validation errors', async () => {
const result = prompts.password({
message: 'foo',
validate: (value) => {
if (value.length < 2) {
return 'Password must be at least 2 characters';
}

return undefined;
},
input,
output,
});

input.emit('keypress', 'x', { name: 'x' });
input.emit('keypress', '', { name: 'return' });
input.emit('keypress', 'y', { name: 'y' });
input.emit('keypress', '', { name: 'return' });

await result;

expect(output.buffer).toMatchSnapshot();
});

test('renders cancelled value', async () => {
const result = prompts.password({
message: 'foo',
input,
output,
});

input.emit('keypress', 'x', { name: 'x' });
input.emit('keypress', '', { name: 'escape' });

const value = await result;

expect(prompts.isCancel(value)).toBe(true);
expect(output.buffer).toMatchSnapshot();
});
});
});