Files
codex-security/github-action/scripts/check-metadata.ts
T
Michael D'Angelo 009228d09c feat(action): support scan CLI inference providers (#1677)
* feat(action): support native Amazon Bedrock scans

* feat(action): align provider inputs with scan CLI

* fix(cli): allow credential-free provider previews
2026-10-17 11:14:34 +09:00

41 lines
2.5 KiB
TypeScript

import { readFile } from 'node:fs/promises';
import assert from 'node:assert/strict';
import { parse } from 'yaml';
import { INPUT_NAMES, parseInputs } from '../src/inputs.js';
import { OUTPUT_NAMES } from '../src/main.js';
const metadata = parse(await readFile(new URL('../../action.yml', import.meta.url), 'utf8'));
assert.deepEqual(Object.keys(metadata.inputs).sort(), [...INPUT_NAMES].sort(), 'action.yml inputs must match the parser');
assert.deepEqual(Object.keys(metadata.outputs).sort(), [...OUTPUT_NAMES].sort(), 'action.yml outputs must match implementation');
assert.equal(metadata.runs.using, 'node24');
assert.equal(metadata.runs.main, 'github-action/dist/index.cjs');
assert.equal(metadata.runs.post, 'github-action/dist/post.cjs');
assert.equal(metadata.runs['post-if'], 'always()');
const defaults = parseInputs(name => String(metadata.inputs[name]?.default ?? '').replace('${{ github.workspace }}', '/checkout'), '/checkout');
assert.equal(defaults.failOnSeverity, 'none');
assert.equal(defaults.scope, 'repository');
assert.equal(defaults.uploadArtifacts, false);
assert.equal(defaults.verbose, true);
assert.equal(defaults.provider, 'openai');
assert.equal(defaults.model, 'gpt-5.6-sol');
for (const provider of ['amazon-bedrock', 'openrouter', 'fireworks']) {
const inputs = parseInputs(name => name === 'provider' ? provider : String(metadata.inputs[name]?.default ?? ''), '/checkout');
assert.equal(inputs.model, '', 'Non-OpenAI providers must not inherit an OpenAI model default');
}
for (const group of [metadata.inputs, metadata.outputs]) for (const value of Object.values(group) as {description: string}[]) assert.ok(value.description);
const examples = await readFile(new URL('../README.md', import.meta.url), 'utf8');
let workflowCount = 0;
for (const match of examples.matchAll(/```yaml\n([\s\S]*?)\n```/g)) {
const example = parse(match[1]);
if (!example?.jobs) continue;
workflowCount++;
for (const job of Object.values(example.jobs) as {steps: {uses?: string; with?: Record<string,unknown>}[]}[]) {
for (const step of job.steps) {
if (step.uses?.startsWith('openai/codex-security@')) {
for (const key of Object.keys(step.with ?? {})) assert.ok(INPUT_NAMES.includes(key as typeof INPUT_NAMES[number]), `Workflow example uses unknown input ${key}`);
} else if (step.uses) assert.match(step.uses, /@[a-f0-9]{40}$/, 'Example dependency must use a full commit SHA');
}
}
}
assert.equal(workflowCount, 3, 'README must include complete PR, repository, and Bedrock workflows');
console.log('Action metadata and implementation contract agree.');