Skip to content

fix(testlist): validate non-empty and non-whitespace IDs across testlist commands #382

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

Closed
naufalfx805-source wants to merge 3 commits into from
Closed

fix(testlist): validate non-empty and non-whitespace IDs across testlist commands #382

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eb1d0ce
fix(testlist): validate non-empty and non-whitespace IDs across testl…
naufalfx805-source Oct 12, 2026
0ab0ae9
fix(testlist): use unknown type in testlist.spec.ts catch blocks
naufalfx805-source Oct 12, 2026
2aa7cd8
style(testlist): format testlist.spec.ts with prettier
naufalfx805-source Oct 12, 2026
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
106 changes: 106 additions & 0 deletions src/commands/testlist.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1053,6 +1053,112 @@ describe('testlist run — insufficient credits → exit 12 + telemetry facts',
await runTestlistRun({ ...runBase, listId: 'list-1' }, { env, fetchImpl, stdout: () => {} });
expect(takeTelemetryExtras()).toEqual({ accepted: 1, conflicts: 0, deferred: 0, skipped: 0 });
});

describe('testlist input validation (empty and whitespace arguments)', () => {
it('get: rejects empty and whitespace list-id', async () => {
for (const invalidId of ['', ' ', '\t\n']) {
await expect(runTestlistGet({ ...base, listId: invalidId })).rejects.toThrow(ApiError);
await expect(runTestlistGet({ ...base, listId: invalidId, dryRun: true })).rejects.toThrow(
ApiError,
);
try {
await runTestlistGet({ ...base, listId: invalidId });
} catch (e: unknown) {
const err = e as ApiError;
expect(err.exitCode).toBe(5);
expect(err.code).toBe('VALIDATION_ERROR');
}
}
});

it('delete: rejects empty and whitespace list-id', async () => {
for (const invalidId of ['', ' ', '\t\n']) {
await expect(
runTestlistDelete({ ...base, listId: invalidId, confirm: true }),
).rejects.toThrow(ApiError);
await expect(
runTestlistDelete({ ...base, listId: invalidId, dryRun: true }),
).rejects.toThrow(ApiError);
try {
await runTestlistDelete({ ...base, listId: invalidId, confirm: true });
} catch (e: unknown) {
const err = e as ApiError;
expect(err.exitCode).toBe(5);
expect(err.code).toBe('VALIDATION_ERROR');
}
}
});

it('update: rejects empty and whitespace list-id', async () => {
for (const invalidId of ['', ' ', '\t\n']) {
await expect(
runTestlistUpdate({ ...base, listId: invalidId, name: 'Renamed' }),
).rejects.toThrow(ApiError);
await expect(
runTestlistUpdate({ ...base, listId: invalidId, name: 'Renamed', dryRun: true }),
).rejects.toThrow(ApiError);
try {
await runTestlistUpdate({ ...base, listId: invalidId, name: 'Renamed' });
} catch (e: unknown) {
const err = e as ApiError;
expect(err.exitCode).toBe(5);
expect(err.code).toBe('VALIDATION_ERROR');
}
}
});

it('add: rejects empty and whitespace list-id and test-ids', async () => {
await expect(runTestlistAdd({ ...base, listId: ' ', testIds: ['test-1'] })).rejects.toThrow(
ApiError,
);
await expect(runTestlistAdd({ ...base, listId: 'list-1', testIds: [' '] })).rejects.toThrow(
ApiError,
);
await expect(
runTestlistAdd({ ...base, listId: 'list-1', testIds: ['test-1', ''] }),
).rejects.toThrow(ApiError);
await expect(
runTestlistAdd({ ...base, listId: ' ', testIds: ['test-1'], dryRun: true }),
).rejects.toThrow(ApiError);
await expect(
runTestlistAdd({ ...base, listId: 'list-1', testIds: [' '], dryRun: true }),
).rejects.toThrow(ApiError);
});

it('remove: rejects empty and whitespace list-id and test-ids', async () => {
await expect(
runTestlistRemove({ ...base, listId: ' ', testIds: ['test-1'] }),
).rejects.toThrow(ApiError);
await expect(
runTestlistRemove({ ...base, listId: 'list-1', testIds: [' '] }),
).rejects.toThrow(ApiError);
await expect(
runTestlistRemove({ ...base, listId: 'list-1', testIds: ['test-1', ''] }),
).rejects.toThrow(ApiError);
await expect(
runTestlistRemove({ ...base, listId: ' ', testIds: ['test-1'], dryRun: true }),
).rejects.toThrow(ApiError);
await expect(
runTestlistRemove({ ...base, listId: 'list-1', testIds: [' '], dryRun: true }),
).rejects.toThrow(ApiError);
});

it('run: rejects empty and whitespace list-id and cases', async () => {
await expect(runTestlistRun({ ...runBase, listId: ' ' })).rejects.toThrow(ApiError);
await expect(runTestlistRun({ ...runBase, listId: ' ', dryRun: true })).rejects.toThrow(
ApiError,
);
await expect(
runTestlistRun({ ...runBase, listId: 'list-1', cases: [' '] }),
).rejects.toThrow(ApiError);
await expect(
runTestlistRun({ ...runBase, listId: 'list-1', cases: ['valid-case', ''] }),
).rejects.toThrow(ApiError);
await expect(
runTestlistRun({ ...runBase, listId: 'list-1', cases: [' '], dryRun: true }),
).rejects.toThrow(ApiError);
});
});
});

it.each([null, '2026-08-01T00:00:05.000Z'])(
Expand Down
38 changes: 38 additions & 0 deletions src/commands/testlist.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,17 @@ function dryRunStderr(deps: TestListDeps): (line: string) => void {
return deps.stderr ?? (line => process.stderr.write(`${line}\n`));
}

function assertValidListId(listId: string | undefined): void {
if (listId === undefined || listId.trim() === '') {
throw localValidationError(
'list-id',
'is required and must not be empty or whitespace-only',
undefined,
'field',
);
}
}

// Canned `--dry-run` samples (offline, no network) — the global `--dry-run`
// contract promises a shape-accurate sample for every command.
const DRY_RUN_LIST: CliTestList = {
Expand Down Expand Up @@ -192,6 +203,7 @@ export async function runTestlistGet(
opts: CommonOptions & { listId: string },
deps: TestListDeps = {},
): Promise<CliTestListDetail> {
assertValidListId(opts.listId);
const out = makeOutput(opts.output, deps);
if (opts.dryRun) {
emitDryRunBanner(dryRunStderr(deps));
Expand Down Expand Up @@ -250,6 +262,7 @@ export async function runTestlistUpdate(
},
deps: TestListDeps = {},
): Promise<CliTestListDetail> {
assertValidListId(opts.listId);
const out = makeOutput(opts.output, deps);
const hasProjectEnv = opts.projectEnv !== undefined && opts.projectEnv.length > 0;
if (opts.clearProjectEnv && hasProjectEnv) {
Expand Down Expand Up @@ -292,6 +305,7 @@ export async function runTestlistDelete(
opts: CommonOptions & { listId: string; confirm?: boolean; idempotencyKey?: string },
deps: TestListDeps = {},
): Promise<CliDeleteTestListResponse> {
assertValidListId(opts.listId);
const out = makeOutput(opts.output, deps);
// Destructive: deleting a list also deletes its schedules (and reaps their
// EventBridge triggers). Require explicit --confirm — matches the CLI's
Expand Down Expand Up @@ -330,10 +344,21 @@ async function mutateCases(
opts: CommonOptions & { listId: string; testIds: string[]; idempotencyKey?: string },
deps: TestListDeps,
): Promise<CliTestListDetail> {
assertValidListId(opts.listId);
const out = makeOutput(opts.output, deps);
if (opts.testIds.length === 0) {
throw localValidationError('test-id', 'at least one test id is required', undefined, 'field');
}
for (const testId of opts.testIds) {
if (!testId || testId.trim() === '') {
throw localValidationError(
'test-id',
'test id must not be empty or whitespace-only',
undefined,
'field',
);
}
}
if (opts.idempotencyKey !== undefined) assertIdempotencyKey(opts.idempotencyKey);
const idempotencyKey = opts.idempotencyKey ?? `cli-testlist-${verb}-${randomUUID()}`;
emitIdempotencyKey(opts, deps, idempotencyKey, opts.idempotencyKey);
Expand Down Expand Up @@ -487,6 +512,19 @@ function assertNoNotFound(resp: CliTestListRunResponse): void {
* JUnit XML report (`--report junit`). testlist run is V3-only.
*/
function validateTestlistRunOptions(opts: RunTestlistRunOptions): void {
assertValidListId(opts.listId);
if (opts.cases !== undefined) {
for (const caseId of opts.cases) {
if (!caseId || caseId.trim() === '') {
throw localValidationError(
'case',
'case id must not be empty or whitespace-only',
undefined,
'flag',
);
}
}
}
if (opts.idempotencyKey !== undefined) assertIdempotencyKey(opts.idempotencyKey);
if (
!Number.isInteger(opts.maxConcurrency) ||
Expand Down
Loading