Files
PaperClipAI/tests/runner-e2e/prepare-report-lock.test.ts
T
Devin FoleyandPaperclip 6d117998c8 fix(ci): skip reviewed-lock checks for a pending Dependabot lock in the Runner support suite (#21942)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work
> - Dependabot pull requests that change `pnpm-lock.yaml` are the only
way, other than the lockfile refresh, that lock content changes
> - #19356 let a verified Dependabot lockfile pass CI. The server's
reporting-lock policy test skips when `PAPERCLIP_CI_PR_AUTHOR` is
`dependabot[bot]`, and the lockfile refresh renews the proof after the
merge
> - #19537 then made the Runner support suite a required check. That job
does not set `PAPERCLIP_CI_PR_AUTHOR`, and the suite's own reviewed-lock
checks have no Dependabot skip
> - So every Dependabot lockfile pull request fails `ci / Runner support
suite` and `ci / verify`. The last one that merged, #17364, merged
before #19537
> - This pull request gives the support suite the same Dependabot skip
as the server test
> - The benefit is that Dependabot dependency updates can merge again,
with the same lock trust rules as before

## Linked Issues or Issue Description

Refs #19356, #19537, #19614, #17172, #19575. Rebased onto `master` after
#21943, which fixed the unrelated `qualify_test_selection` failure that
a CI file change triggers.

**What happened?**

Dependabot pull request #17172 changes `pnpm-lock.yaml`. `ci / Runner
support suite` fails in four test files, and `ci / verify` fails because
of it:

- `prepare-report-lock.test.ts` > installs only the reviewed dependency
correction (4 cases): the committed lock hash is not in
`report-lock.json`.
- `source-sdk-public-type.test.ts`: the shared setup throws "Committed
SDK reference lock is not reviewed".
- `source-sdk-evidence.test.ts` > seals a normal producer-certified
reviewed-reference SDK: the same error.
- `source-sdk-public-inputs.test.mjs` > the committed SDK public source
pins match this checkout's committed tree: `pnpm-lock.yaml` is stale in
`source-sdk-public-inputs.json`.

A Dependabot pull request may not change `report-lock.json`,
`report-lock.patch` or the SDK pins. `lockfile-trust.mjs` rejects that
change, and `refresh-lockfile.yml` renews those files after the merge.
So the pull request can never pass.

**Expected behavior**

A verified Dependabot lockfile passes the Runner support suite, as it
already passes the server's reporting-lock policy test. Other authors
keep every check.

**Steps to reproduce**

1. Open a Dependabot pull request that changes `pnpm-lock.yaml`, such as
#17172.
2. Let CI run. `ci / Runner support suite` fails in the four files
above.

## What Changed

- `.github/workflows/pr-trusted.yml`: the `verify_runner_e2e_support`
job sets `PAPERCLIP_CI_PR_AUTHOR` from the pull request author, like the
general test job.
- `tests/runner-e2e/prepare-report-lock.test.ts`,
`source-sdk-evidence.test.ts`, `source-sdk-public-inputs.test.mjs`: the
test cases that need a reviewed committed lock skip when
`PAPERCLIP_CI_PR_AUTHOR` is `dependabot[bot]`. This uses the same check
as `server/scripts/reporting-lock-policy.test.mjs`. The other cases in
these files still run.
- `tests/runner-e2e/vitest.config.ts`: on a Dependabot pull request, the
suite excludes `source-sdk-public-type.test.ts`. Its shared `beforeAll`
prepares the reviewed SDK reference, so every case in the file needs a
reviewed lock.
- `tests/runner-e2e/source-sdk-public-type.ts`: the installed
TypeScript, Babel parser and Zod package hash checks move into an
exported `verifySdkProofPackages`, which `verifySdkPublicSource` calls.
The lockfile refresh renews the lock and source pins after a merge, but
keeps these package hashes.
- `tests/runner-e2e/source-sdk-proof-packages.test.ts` (new): runs
`verifySdkProofPackages` against the installed packages on every pull
request, including Dependabot ones, and checks that a changed package
pin is rejected. So a Dependabot update of one of those packages still
fails until its pins are reviewed.

## Verification

- Red, then green, with a real Dependabot lock: I committed the
`pnpm-lock.yaml` and `package.json` changes of #17172 on top of this
branch in a local commit (not pushed). Then I ran `node
node_modules/vitest/vitest.mjs run --config
tests/runner-e2e/vitest.config.ts` on the four files:
- Without `PAPERCLIP_CI_PR_AUTHOR`: 4 files failed and the same 6 tests
failed as in CI.
- With `PAPERCLIP_CI_PR_AUTHOR=dependabot[bot]`: 3 files passed, 33
tests passed and 6 skipped. `source-sdk-public-type.test.ts` was
excluded.
- On this branch with master's lock: `pnpm test:e2e:runner:unit` passed
(Vitest: 687 files, 11640 tests; node tests passed).
- `node --test .github/scripts/tests/*.test.mjs`: 808 passed.
- After the package check change: the five affected files
(`source-sdk-proof-packages`, `source-sdk-public-type`,
`source-sdk-evidence`, `source-sdk-public-inputs`,
`prepare-report-lock`) pass, 71 tests. `tsc --noEmit -p
tests/runner-e2e/tsconfig.json` passes.
- `pr.yml` calls `pr-trusted.yml@master`, so this pull request's own CI
does not use the new job variable. The first Dependabot pull request
after the merge checks it.

## Risks

- A Dependabot update of TypeScript, the Babel parser or Zod still fails
the suite until a maintainer reviews the new package pins. That is
deliberate.
- On a Dependabot pull request, the suite no longer checks the committed
lock against the reviewed proof. The policy job still requires that the
lock comes from a verified Dependabot commit (`lockfile-trust.mjs pr`),
and the lockfile refresh still admits the lock and renews the proof and
the SDK pins after the merge. That is the same trust as #19356.
- `PAPERCLIP_CI_PR_AUTHOR` is the pull request author from the GitHub
event. A contributor cannot set it to `dependabot[bot]`. Other commits
pushed to a Dependabot branch are still checked by the policy job.
- No runtime code changes.

## Model Used

- Claude Opus 5.5 (`claude-opus-5-5`), Anthropic, used through Claude
Code with tool use and code execution.

## Checklist

- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have searched GitHub for duplicate or related PRs and linked
them above
- [x] I have either (a) linked existing issues with `Fixes: #` / `Closes
#` / `Refs #` OR (b) described the issue in-PR following the relevant
issue template
- [x] I have not referenced internal/instance-local Paperclip issues or
links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip`
URLs)
- [x] My branch name describes the change (e.g. `docs/...`, `fix/...`)
and contains no internal Paperclip ticket id or instance-derived details
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [ ] All Paperclip CI gates are green
- [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge

---------

Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-11-16 18:03:41 -08:00

162 lines
11 KiB
TypeScript

import { mkdtemp, mkdir, readFile, writeFile, copyFile, realpath, rm } from 'node:fs/promises';
import { createHash } from 'node:crypto';
import { execFileSync } from 'node:child_process';
import { tmpdir } from 'node:os';
import path from 'node:path';
import { expect, it } from 'vitest';
import { parse } from 'yaml';
import { prepareReportLock, refreshReportLock } from './prepare-report-lock.mjs';
const pendingDependabotLock = process.env.PAPERCLIP_CI_PR_AUTHOR === 'dependabot[bot]';
it.skipIf(pendingDependabotLock).each(['valid', 'unknown-lock', 'changed-patch', 'wrong-output'])(
'installs only the reviewed dependency correction: %s', async variant => {
const root = await mkdtemp(path.join(tmpdir(), 'eval-report-lock-test-'));
const here = import.meta.dirname, relative = path.join(root, 'tests/runner-e2e');
try {
await mkdir(relative, { recursive: true });
for (const file of ['report-lock.json', 'report-lock.patch']) await copyFile(path.join(here, file), path.join(relative, file));
const committed = execFileSync('git', ['show', 'HEAD:pnpm-lock.yaml'], { cwd: path.resolve(here, '../..') });
const policy = JSON.parse(await readFile(path.join(relative, 'report-lock.json'), 'utf8'));
const committedHash = createHash('sha256').update(committed).digest('hex');
expect([policy.inputSha256, policy.outputSha256]).toContain(committedHash);
const lock = path.join(root, 'pnpm-lock.yaml');
await writeFile(lock, committed);
if (variant === 'valid') {
expect(await prepareReportLock(root)).toBe(committedHash === policy.outputSha256 ? 'already-reviewed' : 'reviewed-correction');
expect(createHash('sha256').update(await readFile(lock)).digest('hex')).toBe(policy.outputSha256);
await writeFile(lock, committed);
}
if (committedHash === policy.outputSha256) {
execFileSync('git', ['apply', '--reverse', path.join(relative, 'report-lock.patch')], { cwd: root });
}
const input = await readFile(lock);
expect(createHash('sha256').update(input).digest('hex')).toBe(policy.inputSha256);
await writeFile(lock, variant === 'unknown-lock' ? 'unknown\n' : input);
if (variant === 'changed-patch') await writeFile(path.join(relative, 'report-lock.patch'), 'changed');
if (variant === 'wrong-output') { policy.outputSha256 = '0'.repeat(64); await writeFile(path.join(relative, 'report-lock.json'), JSON.stringify(policy)); }
if (variant === 'valid') {
expect(await prepareReportLock(root)).toBe('reviewed-correction');
expect(createHash('sha256').update(await readFile(lock)).digest('hex')).toBe(policy.outputSha256);
expect(await prepareReportLock(root)).toBe('already-reviewed');
const reviewed = parse(await readFile(lock, 'utf8'));
const ui = JSON.parse(await readFile(path.resolve(here, '../../ui/package.json'), 'utf8'));
for (const [name, specifier] of Object.entries(ui.dependencies)) {
const entry = reviewed.importers.ui.dependencies[name];
expect(entry.specifier).toBe(specifier);
if (entry.version.startsWith('link:')) continue;
expect(reviewed.packages, name).toHaveProperty(`${name}@${entry.version.split('(')[0]}`);
expect(reviewed.snapshots, name).toHaveProperty(`${name}@${entry.version}`);
}
} else {
await expect(prepareReportLock(root)).rejects.toThrow();
expect(await readFile(lock)).toEqual(variant === 'unknown-lock' ? Buffer.from('unknown\n') : input);
}
} finally { await rm(root, { recursive: true, force: true }); }
},
);
it.each(['input', 'output', 'unknown'])('refreshes dependency proof only from a %s committed lock', async variant => {
const root = await realpath(await mkdtemp(path.join(tmpdir(), 'eval-report-lock-refresh-')));
const relative = path.join(root, 'tests/runner-e2e');
const original = "lockfileVersion: '9.0'\nimporters: {}\npackages:\n old@1.0.0: {resolution: {integrity: fixture-old}}\n";
const resolved = "lockfileVersion: '9.0'\nimporters:\n ui: {}\npackages:\n added@2.0.0: {resolution: {integrity: fixture-new}}\n";
const hash = (value: string) => createHash('sha256').update(value).digest('hex');
try {
await mkdir(relative, { recursive: true });
await writeFile(path.join(root, 'pnpm-lock.yaml'), original);
const initial = { inputSha256: variant === 'input' ? hash(original) : '0'.repeat(64),
outputSha256: variant === 'output' ? hash(original) : '1'.repeat(64), patchSha256: hash('historical') };
await writeFile(path.join(relative, 'report-lock.json'), JSON.stringify(initial));
await writeFile(path.join(relative, 'report-lock.patch'), 'historical');
execFileSync('git', ['init', '-q'], { cwd: root });
execFileSync('git', ['add', '.'], { cwd: root });
execFileSync('git', ['-c', 'user.name=Fixture', '-c', 'user.email=fixture@example.invalid', 'commit', '-qm', 'fixture'], { cwd: root });
await writeFile(path.join(root, 'pnpm-lock.yaml'), resolved);
if (variant === 'unknown') {
await expect(refreshReportLock(root)).rejects.toThrow('not reviewed');
expect(await readFile(path.join(relative, 'report-lock.patch'), 'utf8')).toBe('historical');
expect(JSON.parse(await readFile(path.join(relative, 'report-lock.json'), 'utf8'))).toEqual(initial);
expect(await readFile(path.join(root, 'pnpm-lock.yaml'), 'utf8')).toBe(resolved);
return;
}
if (variant === 'output') {
const cli = path.join(relative, 'prepare-report-lock.mjs');
await copyFile(path.join(import.meta.dirname, 'prepare-report-lock.mjs'), cli);
expect(execFileSync(process.execPath, [cli, '--refresh'], { cwd: root, encoding: 'utf8' }).trim()).toBe('refreshed');
} else {
expect(await refreshReportLock(root)).toBe('refreshed');
}
const policy = JSON.parse(await readFile(path.join(relative, 'report-lock.json'), 'utf8'));
const patch = await readFile(path.join(relative, 'report-lock.patch'), 'utf8');
expect(policy).toMatchObject({ inputSha256: hash(original), outputSha256: hash(resolved), patchSha256: hash(patch) });
await writeFile(path.join(root, 'pnpm-lock.yaml'), original);
expect(await prepareReportLock(root)).toBe('reviewed-correction');
expect(await readFile(path.join(root, 'pnpm-lock.yaml'), 'utf8')).toBe(resolved);
expect(parse(await readFile(path.join(root, 'pnpm-lock.yaml'), 'utf8')).packages).toEqual(parse(resolved).packages);
expect(await prepareReportLock(root)).toBe('already-reviewed');
execFileSync('git', ['add', '.'], { cwd: root });
execFileSync('git', ['-c', 'user.name=Fixture', '-c', 'user.email=fixture@example.invalid', 'commit', '-qm', 'refresh'], { cwd: root });
expect(await refreshReportLock(root)).toBe('unchanged');
expect(await readFile(path.join(relative, 'report-lock.patch'), 'utf8')).toBe(patch);
} finally { await rm(root, { recursive: true, force: true }); }
});
async function trustedLockFixture(variant: string, callback: (root: string, relative: string, hash: (value: string) => string,
original: string, resolved: string, initial: object) => Promise<void>) {
const root = await realpath(await mkdtemp(path.join(tmpdir(), `eval-report-lock-${variant}-`)));
const relative = path.join(root, 'tests/runner-e2e');
const original = "lockfileVersion: '9.0'\nimporters: {}\npackages:\n dependabot@2.0.0: {resolution: {integrity: fixture-bot}}\n";
const resolved = "lockfileVersion: '9.0'\nimporters:\n ui: {}\npackages:\n dependabot@2.0.0: {resolution: {integrity: fixture-bot}}\n";
const hash = (value: string) => createHash('sha256').update(value).digest('hex');
const initial = { inputSha256: '0'.repeat(64), outputSha256: '1'.repeat(64), patchSha256: hash('historical') };
try {
await mkdir(relative, { recursive: true });
await writeFile(path.join(root, 'pnpm-lock.yaml'), original);
await writeFile(path.join(relative, 'report-lock.json'), JSON.stringify(initial));
await writeFile(path.join(relative, 'report-lock.patch'), 'historical');
execFileSync('git', ['init', '-q'], { cwd: root });
execFileSync('git', ['add', '.'], { cwd: root });
execFileSync('git', ['-c', 'user.name=Fixture', '-c', 'user.email=fixture@example.invalid', 'commit', '-qm', 'fixture'], { cwd: root });
await callback(root, relative, hash, original, resolved, initial);
} finally { await rm(root, { recursive: true, force: true }); }
}
it('admits a verified trusted lock that already resolves without a correction', async () => {
await trustedLockFixture('trusted-resolved', async (root, relative, hash, original) => {
expect(await refreshReportLock(root, { trustedLockSha256: hash(original) })).toBe('refreshed');
const policy = JSON.parse(await readFile(path.join(relative, 'report-lock.json'), 'utf8'));
expect(policy).toMatchObject({ inputSha256: hash(original), outputSha256: hash(original), patchSha256: hash('') });
expect(await readFile(path.join(relative, 'report-lock.patch'), 'utf8')).toBe('');
expect(await prepareReportLock(root)).toBe('already-reviewed');
});
});
it('records the correction for a verified trusted lock that resolves differently', async () => {
await trustedLockFixture('trusted-corrected', async (root, relative, hash, original, resolved) => {
await writeFile(path.join(root, 'pnpm-lock.yaml'), resolved);
const cli = path.join(relative, 'prepare-report-lock.mjs');
await copyFile(path.join(import.meta.dirname, 'prepare-report-lock.mjs'), cli);
expect(execFileSync(process.execPath, [cli, '--refresh', '--trusted-lock-sha256', hash(original)], { cwd: root, encoding: 'utf8' }).trim())
.toBe('refreshed');
const policy = JSON.parse(await readFile(path.join(relative, 'report-lock.json'), 'utf8'));
expect(policy).toMatchObject({ inputSha256: hash(original), outputSha256: hash(resolved) });
await writeFile(path.join(root, 'pnpm-lock.yaml'), original);
expect(await prepareReportLock(root)).toBe('reviewed-correction');
expect(await readFile(path.join(root, 'pnpm-lock.yaml'), 'utf8')).toBe(resolved);
});
});
it('refuses a trusted hash that does not name the committed lock', async () => {
await trustedLockFixture('trusted-mismatch', async (root, relative, hash, original, resolved, initial) => {
await expect(refreshReportLock(root, { trustedLockSha256: hash(resolved) })).rejects.toThrow('not reviewed');
expect(JSON.parse(await readFile(path.join(relative, 'report-lock.json'), 'utf8'))).toEqual(initial);
expect(await readFile(path.join(relative, 'report-lock.patch'), 'utf8')).toBe('historical');
const cli = path.join(relative, 'prepare-report-lock.mjs');
await copyFile(path.join(import.meta.dirname, 'prepare-report-lock.mjs'), cli);
expect(() => execFileSync(process.execPath, [cli, '--refresh', '--trusted-lock-sha256', 'not-a-hash'], { cwd: root, stdio: 'pipe' }))
.toThrow();
});
});