Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 15 additions & 2 deletions src/config-validation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ function validateRule(value: unknown, path: string): RulesetRule {
const record = expectRecord(value, path);
const type = expectString(record.type, `${path}.type`);

if (type === 'deletion' || type === 'non_fast_forward') {
if (type === 'deletion' || type === 'non_fast_forward' || type === 'required_signatures') {
rejectUnknownKeys(record, path, ['type']);
return { type };
}
Expand Down Expand Up @@ -312,13 +312,19 @@ function validateRule(value: unknown, path: string): RulesetRule {
rejectUnknownKeys(
checkRecord,
`${path}.parameters.required_status_checks[${index}]`,
['context'],
['context', 'integration_id'],
);
return {
context: expectNonEmptyString(
checkRecord.context,
`${path}.parameters.required_status_checks[${index}].context`,
),
...('integration_id' in checkRecord ? {
integration_id: expectNonNegativeInteger(
checkRecord.integration_id,
`${path}.parameters.required_status_checks[${index}].integration_id`,
),
} : {}),
};
});

Expand Down Expand Up @@ -395,6 +401,13 @@ function expectBoolean(value: unknown, path: string): boolean {
return value;
}

function expectNonNegativeInteger(value: unknown, path: string): number {
if (typeof value !== 'number' || !Number.isSafeInteger(value) || value < 0) {
fail(path, 'must be a non-negative safe integer');
}
return value;
}

function expectNumber(value: unknown, path: string): number {
if (typeof value !== 'number' || !Number.isFinite(value)) {
fail(path, 'must be a finite number');
Expand Down
8 changes: 6 additions & 2 deletions src/github-client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -392,7 +392,7 @@ function parseRule(value: unknown): RulesetRule {
throw new Error('Invalid ruleset rule from GitHub');
}

if (value.type === 'deletion' || value.type === 'non_fast_forward') {
if (value.type === 'deletion' || value.type === 'non_fast_forward' || value.type === 'required_signatures') {
return { type: value.type };
}

Expand Down Expand Up @@ -444,7 +444,11 @@ function parseRule(value: unknown): RulesetRule {
if (!isRecord(check) || typeof check.context !== 'string') {
throw new Error('Invalid required status check from GitHub');
}
return { context: check.context };
const integrationId = check.integration_id;
if (integrationId !== undefined && (typeof integrationId !== 'number' || !Number.isSafeInteger(integrationId) || integrationId < 0)) {
throw new Error('Invalid required status check integration from GitHub');
}
return { context: check.context, ...(integrationId !== undefined ? { integration_id: integrationId } : {}) };
})
: [];

Expand Down
13 changes: 12 additions & 1 deletion src/ruleset-normalizer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -72,5 +72,16 @@ export function rulesetsEqual(
left: RepositoryRuleset,
right: RepositoryRuleset,
): boolean {
return JSON.stringify(normalizeRuleset(left)) === JSON.stringify(normalizeRuleset(right));
const current = normalizeRuleset(left);
const desired = normalizeRuleset(right);
for (const rule of current.rules) {
if (rule.type !== 'required_status_checks') continue;
const expected = desired.rules.find((candidate) => candidate.type === 'required_status_checks');
if (expected?.type !== 'required_status_checks') continue;
rule.parameters.required_status_checks = rule.parameters.required_status_checks.map((check) => {
const wanted = expected.parameters.required_status_checks.find((candidate) => candidate.context === check.context);
return wanted?.integration_id === undefined ? { context: check.context } : check;
});
}
return JSON.stringify(current) === JSON.stringify(desired);
}
4 changes: 2 additions & 2 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ export type PullRequestRule = {
export type RequiredStatusChecksRule = {
type: 'required_status_checks';
parameters: {
required_status_checks: Array<{ context: string }>;
required_status_checks: Array<{ context: string; integration_id?: number }>;
strict_required_status_checks_policy: boolean;
do_not_enforce_on_create: boolean;
};
};

export type SimpleRule = {
type: 'deletion' | 'non_fast_forward';
type: 'deletion' | 'non_fast_forward' | 'required_signatures';
};

export type RulesetRule = PullRequestRule | RequiredStatusChecksRule | SimpleRule;
Expand Down
43 changes: 43 additions & 0 deletions tests/config-validation.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,47 @@ describe('validateGovernanceConfig', () => {
);
});

it('accepts signed commits and bound required CI checks', () => {
const config = structuredClone(validConfig) as any;
config.policies.protected.rules.push({ type: 'required_signatures' });
config.policies.protected.rules.push({
type: 'required_status_checks',
parameters: {
required_status_checks: [{ context: 'PHPUnit', integration_id: 15368 }],
strict_required_status_checks_policy: true,
do_not_enforce_on_create: false,
},
});
expect(validateGovernanceConfig(config)).toEqual(config);
});

it('rejects invalid CI integration identifiers', () => {
const config = structuredClone(validConfig) as any;
config.policies.protected.rules.push({
type: 'required_status_checks',
parameters: {
required_status_checks: [{ context: 'PHPUnit', integration_id: 'invalid' }],
strict_required_status_checks_policy: true,
do_not_enforce_on_create: false,
},
});
expect(() => validateGovernanceConfig(config)).toThrow('integration_id');
});

it.each([-1, 1.5, Number.MAX_SAFE_INTEGER + 1])(
'rejects invalid numerical integration ID %s',
(integrationId) => {
const config = structuredClone(validConfig) as any;
config.policies.protected.rules.push({
type: 'required_status_checks',
parameters: {
required_status_checks: [{ context: 'PHPUnit', integration_id: integrationId }],
strict_required_status_checks_policy: true,
do_not_enforce_on_create: false,
},
});
expect(() => validateGovernanceConfig(config)).toThrow('integration_id');
},
);

});
23 changes: 23 additions & 0 deletions tests/ruleset-normalizer.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,29 @@ describe('normalizeRuleset', () => {
expect(rulesetsEqual(current, protectedBranchesFixture)).toBe(true);
});

it('compares integration-bound checks without drifting unbound configurations', () => {
const current = structuredClone(requiredCiFixture);
const desired = structuredClone(requiredCiFixture);
const currentRule = current.rules.find((rule) => rule.type === 'required_status_checks');
const desiredRule = desired.rules.find((rule) => rule.type === 'required_status_checks');
if (currentRule?.type !== 'required_status_checks' || desiredRule?.type !== 'required_status_checks') {
throw new Error('missing fixture checks');
}
currentRule.parameters.required_status_checks[0]!.integration_id = 15368;
expect(rulesetsEqual(current, desired)).toBe(true);
desiredRule.parameters.required_status_checks[0]!.integration_id = 15368;
expect(rulesetsEqual(current, desired)).toBe(true);
currentRule.parameters.required_status_checks[0]!.integration_id = 999;
expect(rulesetsEqual(current, desired)).toBe(false);
});

it('preserves required signatures as a managed rule', () => {
const ruleset = structuredClone(protectedBranchesFixture);
ruleset.rules.push({ type: 'required_signatures' });
expect(normalizeRuleset(ruleset).rules.some((rule) => rule.type === 'required_signatures')).toBe(true);
expect(rulesetsEqual(ruleset, protectedBranchesFixture)).toBe(false);
});

it('preserves required status checks as managed policy', () => {
const normalized = normalizeRuleset(requiredCiFixture);
const rule = normalized.rules.find(
Expand Down
Loading