chore: add Issue management runtime
This commit is contained in:
Tianyi Cui
240
.github/issue-management/policy.test.mjs
vendored
Normal file
240
.github/issue-management/policy.test.mjs
vendored
Normal file
@@ -0,0 +1,240 @@
|
||||
import assert from 'node:assert/strict'
|
||||
import test from 'node:test'
|
||||
|
||||
import {
|
||||
countVisibleUnits,
|
||||
parseReferences,
|
||||
requiresPullRequestPolicy,
|
||||
validateBody,
|
||||
validateIssue,
|
||||
validatePullRequest,
|
||||
} from './policy.mjs'
|
||||
|
||||
const withDetails = (summary) =>
|
||||
`${summary}\n\n<details><summary>验收与细节</summary>待补充。</details>`
|
||||
|
||||
const legalIssue = {
|
||||
title: '完成议题管理校验',
|
||||
body: withDetails('完成议题管理校验。'),
|
||||
assignees: [],
|
||||
labels: [],
|
||||
type: 'Idea',
|
||||
priority: null,
|
||||
status: 'In review',
|
||||
state: 'open',
|
||||
stateReason: null,
|
||||
}
|
||||
|
||||
test('counts only text outside details', () => {
|
||||
assert.deepEqual(countVisibleUnits('支持 GitHub Project。<details>隐藏文字</details>'), {
|
||||
units: 4,
|
||||
balanced: true,
|
||||
detailsCount: 1,
|
||||
allCollapsed: true,
|
||||
})
|
||||
})
|
||||
|
||||
test('requires a balanced default-collapsed details region', () => {
|
||||
assert.deepEqual(validateBody({ body: '完成工作。', assignees: [] }), [
|
||||
'正文必须包含默认收起的 <details> 区域',
|
||||
])
|
||||
assert.deepEqual(
|
||||
validateBody({
|
||||
body: '完成工作。\n\n<details open><summary>细节</summary>待补充。</details>',
|
||||
assignees: [],
|
||||
}),
|
||||
['details 必须默认收起，不得设置 open'],
|
||||
)
|
||||
assert.deepEqual(
|
||||
validateBody({ body: '完成工作。\n\n<details><summary>细节</summary>', assignees: [] }),
|
||||
['details 标签必须成对闭合'],
|
||||
)
|
||||
})
|
||||
|
||||
test('requires Owner for multiple assignees', () => {
|
||||
assert.deepEqual(
|
||||
validateBody({
|
||||
body: withDetails('完成工作。'),
|
||||
assignees: ['tianyicui', 'tianyicui-bot'],
|
||||
}),
|
||||
['多个 Assignees 时首个非空行必须是 Owner: @login'],
|
||||
)
|
||||
})
|
||||
|
||||
test('accepts an intended Owner while assignment permission is pending', () => {
|
||||
assert.deepEqual(
|
||||
validateBody({
|
||||
body: withDetails('Owner: @octocat\n\n完成工作。'),
|
||||
assignees: [],
|
||||
}),
|
||||
[],
|
||||
)
|
||||
assert.deepEqual(
|
||||
validateBody({
|
||||
body: withDetails('Owner: @octocat\n\n完成工作。'),
|
||||
assignees: ['hubot'],
|
||||
}),
|
||||
['零或一个 Assignee 时不得写 Owner 行'],
|
||||
)
|
||||
})
|
||||
|
||||
test('allows optional metadata in every open Status', () => {
|
||||
assert.deepEqual(validateIssue(legalIssue), [])
|
||||
for (const status of ['Inbox', 'Backlog', 'Ready', 'In progress', 'In review']) {
|
||||
assert.deepEqual(validateIssue({ ...legalIssue, status }), [])
|
||||
}
|
||||
})
|
||||
|
||||
test('rejects metadata prefixes in an Issue title', () => {
|
||||
const errors = validateIssue({ ...legalIssue, title: '[Bug] 修复恢复错误' })
|
||||
assert.ok(errors.includes('Issue 标题不得带 Type、Priority、Status、area 或 Owner 前缀'))
|
||||
})
|
||||
|
||||
test('keeps terminal Status aligned with the native close reason', () => {
|
||||
assert.deepEqual(
|
||||
validateIssue({ ...legalIssue, status: 'Done', state: 'closed', stateReason: 'completed' }),
|
||||
[],
|
||||
)
|
||||
assert.deepEqual(
|
||||
validateIssue({
|
||||
...legalIssue,
|
||||
status: 'No action',
|
||||
state: 'closed',
|
||||
stateReason: 'not_planned',
|
||||
}),
|
||||
[],
|
||||
)
|
||||
assert.ok(validateIssue({ ...legalIssue, status: 'Done' }).includes('Done 必须对应 Completed 关闭原因'))
|
||||
})
|
||||
|
||||
test('separates resolving and informational references', () => {
|
||||
assert.deepEqual(
|
||||
parseReferences({
|
||||
body: 'Fixes #12\nRelated to #4\nRefs deepseekharness/dsh-test#7',
|
||||
repository: 'deepseekharness/dsh-test',
|
||||
}),
|
||||
{ all: [4, 7, 12], resolving: [12], related: [4, 7] },
|
||||
)
|
||||
})
|
||||
|
||||
test('allows informational references without cross-object constraints', () => {
|
||||
const errors = validatePullRequest({
|
||||
isDraft: false,
|
||||
authorType: 'User',
|
||||
reviewRequestCount: 1,
|
||||
reviewCount: 0,
|
||||
labels: ['kind/cleanup', 'area/infra'],
|
||||
references: { all: [4], resolving: [], related: [4] },
|
||||
issues: new Map([[4, { type: 'Bug', priority: 'P0', labels: ['area/web'] }]]),
|
||||
})
|
||||
assert.deepEqual(errors, [])
|
||||
})
|
||||
|
||||
test('enforces highest resolving Priority without Type or area synchronization', () => {
|
||||
const pull = {
|
||||
isDraft: false,
|
||||
authorType: 'User',
|
||||
reviewRequestCount: 0,
|
||||
reviewCount: 1,
|
||||
labels: ['kind/cleanup', 'p0', 'area/web'],
|
||||
references: { all: [2, 3], resolving: [2, 3], related: [] },
|
||||
issues: new Map([
|
||||
[2, { type: 'Feature', priority: 'P2', labels: ['area/web'] }],
|
||||
[3, { type: 'Bug', priority: 'P0', labels: ['area/session'] }],
|
||||
]),
|
||||
}
|
||||
assert.deepEqual(validatePullRequest(pull), [])
|
||||
assert.ok(
|
||||
validatePullRequest({ ...pull, labels: ['kind/cleanup', 'p2', 'area/web'] }).includes(
|
||||
'PR Priority 应为 p0',
|
||||
),
|
||||
)
|
||||
})
|
||||
|
||||
test('requires policy only after a human PR enters review', () => {
|
||||
assert.equal(
|
||||
requiresPullRequestPolicy({
|
||||
isDraft: false,
|
||||
authorType: 'User',
|
||||
reviewRequestCount: 1,
|
||||
reviewCount: 0,
|
||||
}),
|
||||
true,
|
||||
)
|
||||
assert.equal(
|
||||
requiresPullRequestPolicy({
|
||||
isDraft: false,
|
||||
authorType: 'User',
|
||||
reviewRequestCount: 0,
|
||||
reviewCount: 0,
|
||||
}),
|
||||
false,
|
||||
)
|
||||
})
|
||||
|
||||
test('exempts Draft, Bot, and App PRs', () => {
|
||||
const invalid = {
|
||||
isDraft: false,
|
||||
labels: [],
|
||||
references: { all: [], resolving: [], related: [] },
|
||||
issues: new Map(),
|
||||
reviewRequestCount: 1,
|
||||
reviewCount: 0,
|
||||
}
|
||||
assert.deepEqual(validatePullRequest({ ...invalid, authorType: 'Bot' }), [])
|
||||
assert.deepEqual(validatePullRequest({ ...invalid, authorType: 'App' }), [])
|
||||
assert.deepEqual(validatePullRequest({ ...invalid, authorType: 'User', isDraft: true }), [])
|
||||
assert.ok(validatePullRequest({ ...invalid, authorType: 'User' }).length > 0)
|
||||
})
|
||||
|
||||
test('requires repository PR labels in the enforcement scope', () => {
|
||||
const errors = validatePullRequest({
|
||||
isDraft: false,
|
||||
authorType: 'User',
|
||||
reviewRequestCount: 1,
|
||||
reviewCount: 0,
|
||||
labels: [],
|
||||
references: { all: [2], resolving: [], related: [2] },
|
||||
issues: new Map([[2, { priority: null }]]),
|
||||
})
|
||||
assert.ok(errors.includes('PR 必须恰好有一个 kind/*，当前为 0'))
|
||||
assert.ok(errors.includes('PR 必须至少有一个 area/*'))
|
||||
})
|
||||
|
||||
test('accepts repository-extensible kind labels', () => {
|
||||
assert.deepEqual(
|
||||
validatePullRequest({
|
||||
isDraft: false,
|
||||
authorType: 'User',
|
||||
reviewRequestCount: 1,
|
||||
reviewCount: 0,
|
||||
labels: ['kind/dependency', 'area/infra'],
|
||||
references: { all: [2], resolving: [], related: [2] },
|
||||
issues: new Map([[2, { priority: null }]]),
|
||||
}),
|
||||
[],
|
||||
)
|
||||
})
|
||||
|
||||
test('allows missing Priority only when resolving Issues are also unprioritized', () => {
|
||||
const pull = {
|
||||
isDraft: false,
|
||||
authorType: 'User',
|
||||
reviewRequestCount: 1,
|
||||
reviewCount: 0,
|
||||
labels: ['kind/feature', 'area/web'],
|
||||
references: { all: [2], resolving: [2], related: [] },
|
||||
issues: new Map([[2, { priority: null }]]),
|
||||
}
|
||||
assert.deepEqual(validatePullRequest(pull), [])
|
||||
assert.ok(
|
||||
validatePullRequest({ ...pull, issues: new Map([[2, { priority: 'P2' }]]) }).includes(
|
||||
'PR Priority 应为 p2',
|
||||
),
|
||||
)
|
||||
assert.ok(
|
||||
validatePullRequest({ ...pull, labels: [...pull.labels, 'p2'] }).includes(
|
||||
'有 Priority 的解决型 PR 要求每个被解决 Issue 都设置 Priority',
|
||||
),
|
||||
)
|
||||
})
|
||||
Reference in New Issue
Block a user