@1aboveio/skills 0.0.0-stage → 1.0.0

package/skills/cicd/mergify/scripts/stack-push.test.mjs

@@ -0,0 +1,233 @@
+// @covers mergify-stack-push
+// @level unit
+import { test } from 'node:test'
+import assert from 'node:assert/strict'
+import { EXIT, MIN_CLI_VERSION, REREAD_ATTEMPTS, parseArgs, pushArgs, pushedPrs, stackPush } from './stack-push-core.mjs'
+
+const HOOKS = '/repo/.git/hooks'
+
+const listJson = (entries) => JSON.stringify({ branch: 'feat/x', trunk: 'origin/main', entries })
+const entry = (sha, pr = null) => ({
+  commit_sha: sha,
+  title: `feat: ${sha}`,
+  change_id: `I${sha}`,
+  status: pr ? 'open' : 'no_pr',
+  pull_number: pr,
+  pull_url: pr ? `https://github.com/o/r/pull/${pr}` : null,
+})
+
+// A fake for the external CLIs (git, mergify, gh). `script` maps a command key to a queue of
+// results, so a test can return a different stack before and after the push.
+function harness(script, { hooks = true, version = { status: 0, stdout: `mergify ${MIN_CLI_VERSION}\n`, stderr: '' } } = {}) {
+  const calls = []
+  const queues = Object.fromEntries(Object.entries(script).map(([k, v]) => [k, [...v]]))
+  const exec = (cmd, args) => {
+    calls.push([cmd, ...args])
+    if (cmd === 'git' && args[0] === 'config') return { status: 1, stdout: '', stderr: '' }
+    if (cmd === 'mergify' && args[0] === '--version') return version
+    if (cmd === 'git' && args.includes('--show-toplevel')) return { status: 0, stdout: '/repo\n', stderr: '' }
+    if (cmd === 'git' && args.includes('--git-common-dir')) return { status: 0, stdout: '/repo/.git\n', stderr: '' }
+    const key = cmd === 'mergify' ? `${args[0]} ${args[1]}` : `${cmd} ${args[0]} ${args[1]}`
+    const queue = queues[key]
+    if (!queue || queue.length === 0) throw new Error(`unexpected call: ${cmd} ${args.join(' ')}`)
+    return queue.length > 1 ? queue.shift() : queue[0]
+  }
+  const out = { text: '', write(s) { this.text += s } }
+  const err = { text: '', write(s) { this.text += s } }
+  const exists = (path) => hooks && path === `${HOOKS}/mergify-hooks`
+  const sleeps = []
+  return { calls, sleeps, deps: { exec, exists, out, err, sleep: (ms) => sleeps.push(ms) }, out, err }
+}
+
+const ok = (stdout = '') => ({ status: 0, stdout, stderr: '' })
+
+test('refuses a repo without Mergify stack hooks and pushes nothing', () => {
+  const h = harness({}, { hooks: false })
+  assert.equal(stackPush([], h.deps), EXIT.NOT_STACK_REPO)
+  assert.match(h.err.text, /git push.*gh pr create/)
+  assert.ok(!h.calls.some((c) => c[0] === 'mergify'))
+})
+
+test('an older mergify CLI stops before reading or pushing the stack and names the upgrade', () => {
+  const h = harness({}, { version: ok('mergify 2026.7.8.1\n') })
+  assert.equal(stackPush([], h.deps), EXIT.OLD_CLI)
+  assert.match(h.err.text, new RegExp(`2026\\.7\\.8\\.1.*${MIN_CLI_VERSION.replaceAll('.', '\\.')}.*brew upgrade mergify-cli`))
+  assert.ok(!h.calls.some((c) => c[0] === 'mergify' && c[1] === 'stack'))
+})
+
+test('an unreadable mergify version warns and still pushes', () => {
+  const h = harness({ 'stack list': [ok(listJson([entry('a1', 11)]))], 'stack push': [ok()] }, { version: { status: 1, stdout: '', stderr: 'boom' } })
+  assert.equal(stackPush([], h.deps), EXIT.OK)
+  assert.match(h.err.text, /could not read the mergify CLI version/)
+  assert.ok(h.calls.some((c) => c[0] === 'mergify' && c[1] === 'stack' && c[2] === 'push'))
+})
+
+test('the minimum CLI version and newer ones push', () => {
+  for (const v of [MIN_CLI_VERSION, '2026.11.1', '2027.1.2.1']) {
+    const h = harness({ 'stack list': [ok(listJson([entry('a1', 11)]))], 'stack push': [ok()] }, { version: ok(`mergify ${v}\n`) })
+    assert.equal(stackPush([], h.deps), EXIT.OK, v)
+  }
+})
+
+test('a push that falls back to Depends-On warns that the stack is not GitHub-native', () => {
+  const h = harness({
+    'stack list': [ok(listJson([entry('a1'), entry('b2')])), ok(listJson([entry('a1', 11), entry('b2', 12)]))],
+    'stack push': [{ status: 0, stdout: 'stack: not registered on GitHub (stacking API unavailable)\n', stderr: '' }],
+  })
+  assert.equal(stackPush([], h.deps), EXIT.OK)
+  assert.match(h.err.text, /not a GitHub-native stack.*Depends-On.*delete_branch_on_merge/)
+})
+
+test('a native stack push prints no Depends-On warning', () => {
+  const h = harness({
+    'stack list': [ok(listJson([entry('a1'), entry('b2')])), ok(listJson([entry('a1', 11), entry('b2', 12)]))],
+    'stack push': [ok()],
+  })
+  assert.equal(stackPush([], h.deps), EXIT.OK)
+  assert.doesNotMatch(h.err.text, /not a GitHub-native stack/)
+})
+
+test('a commit without Change-Id stops before the push and names the amend fix', () => {
+  const h = harness({
+    'stack list': [{ status: 7, stdout: '', stderr: 'mergify: `Change-Id:` line is missing on commit c0f001685487cf95174b01801366a390d20d3bd5\n' }],
+  })
+  assert.equal(stackPush([], h.deps), EXIT.FIX_COMMITS)
+  assert.match(h.err.text, /c0f001685487.*git commit --amend --no-edit/)
+  assert.ok(!h.calls.some((c) => c[1] === 'stack' && c[2] === 'push'))
+})
+
+test('an empty stack asks for a commit instead of pushing', () => {
+  const h = harness({ 'stack list': [ok(listJson([]))] })
+  assert.equal(stackPush([], h.deps), EXIT.FIX_COMMITS)
+  assert.match(h.err.text, /no commits.*origin\/main/)
+})
+
+test('pushes with the trunk and kept PR bodies, never skips hooks, and reports every PR', () => {
+  const h = harness({
+    'stack list': [ok(listJson([entry('aaa'), entry('bbb')])), ok(listJson([entry('aaa', 11), entry('bbb', 12)]))],
+    'stack push': [ok('[created] #11\n[created] #12\n')],
+  })
+  assert.equal(stackPush([], h.deps), EXIT.OK)
+  const push = h.calls.find((c) => c[0] === 'mergify' && c[2] === 'push')
+  assert.deepEqual(push.slice(3), ['--trunk', 'origin/main', '--keep-pull-request-title-and-body'])
+  assert.ok(!h.calls.flat().includes('--no-verify'))
+  assert.deepEqual(JSON.parse(h.out.text).prs.map((p) => p.pr), [11, 12])
+  assert.match(h.err.text.trim().split('\n').at(-1), /2 PR\(s\): #11 #12$/)
+})
+
+test('a push that moves an open PR warns that its queue request is cancelled (fmm-express #1846)', () => {
+  const moved = (pr) => ({ ...entry('new', pr), commit_sha: 'new' })
+  const h = harness({
+    'stack list': [ok(listJson([entry('old', 1846), entry('kept', 1847)])), ok(listJson([moved(1846), entry('kept', 1847)]))],
+    'stack push': [ok()],
+  })
+  assert.equal(stackPush([], h.deps), EXIT.OK)
+  assert.match(h.err.text, /new commits on #1846 cancel any Mergify queue request on them; requeue with --enqueue/)
+  assert.doesNotMatch(h.err.text, /#1847 cancel/, 'an unchanged PR keeps its queue request')
+  const fresh = harness({ 'stack list': [ok(listJson([entry('aaa')])), ok(listJson([entry('aaa', 9)]))], 'stack push': [ok()] })
+  assert.equal(stackPush([], fresh.deps), EXIT.OK)
+  assert.doesNotMatch(fresh.err.text, /cancel/, 'a new PR had no queue request')
+  const requeued = harness({
+    'stack list': [ok(listJson([entry('old', 1846)])), ok(listJson([moved(1846)]))],
+    'stack push': [ok()],
+    'gh pr comment': [ok()],
+  })
+  assert.equal(stackPush(['--enqueue'], requeued.deps), EXIT.OK)
+  assert.doesNotMatch(requeued.err.text, /cancel/, '--enqueue already requeues')
+})
+
+test('--enqueue comments on every stack PR after the push, in one pass', () => {
+  const h = harness({
+    'stack list': [ok(listJson([entry('aaa')])), ok(listJson([entry('aaa', 21), entry('bbb', 22)]))],
+    'stack push': [ok()],
+    'gh pr comment': [ok()],
+  })
+  assert.equal(stackPush(['--enqueue'], h.deps), EXIT.OK)
+  const comments = h.calls.filter((c) => c[0] === 'gh')
+  assert.deepEqual(comments, [
+    ['gh', 'pr', 'comment', '21', '--body', '@mergifyio queue'],
+    ['gh', 'pr', 'comment', '22', '--body', '@mergifyio queue'],
+  ])
+  assert.ok(h.calls.indexOf(comments[0]) > h.calls.findIndex((c) => c[2] === 'push'))
+  assert.deepEqual(JSON.parse(h.out.text).enqueued, [21, 22])
+})
+
+test('a rebase conflict reports how to continue and enqueues nothing', () => {
+  const h = harness({
+    'stack list': [ok(listJson([entry('aaa', 31)]))],
+    'stack push': [{ status: 4, stdout: '', stderr: 'mergify: rebase failed — there may be conflicts\n' }],
+  })
+  assert.equal(stackPush(['--enqueue'], h.deps), EXIT.FAILED)
+  assert.match(h.err.text, /git rebase --continue/)
+  assert.ok(!h.calls.some((c) => c[0] === 'gh'))
+})
+
+test('a pushed commit left without a PR fails instead of reporting success', () => {
+  const h = harness({
+    'stack list': [ok(listJson([entry('aaa')])), ok(listJson([entry('aaa', 41), entry('bbb')]))],
+    'stack push': [ok()],
+  })
+  assert.equal(stackPush([], h.deps), EXIT.FAILED)
+  assert.match(h.err.text, /1 commit\(s\) have no PR: bbb/)
+  assert.equal(h.calls.filter((c) => c[0] === 'mergify' && c[2] === 'list').length, 1 + REREAD_ATTEMPTS, 'fails only after every re-read')
+})
+
+test('a PR the stack list sees only on a later re-read is reported, not failed (ai #1766)', () => {
+  // ai #1766 (2026-10-17): the push left no readable PR line and the first list lagged, so the
+  // script failed a push whose PR a `stack list` showed seconds later.
+  const h = harness({
+    'stack list': [ok(listJson([entry('aaa')])), ok(listJson([entry('aaa')])), ok(listJson([entry('aaa')])), ok(listJson([entry('aaa', 1766)]))],
+    'stack push': [ok('  ✓ read 1 pull request(s)\n')],
+  })
+  assert.equal(stackPush([], h.deps), EXIT.OK)
+  assert.deepEqual(JSON.parse(h.out.text).prs.map((p) => p.pr), [1766])
+  assert.equal(h.sleeps.length, 2, 'stops re-reading once every commit has its PR')
+})
+
+test('a fresh PR the follow-up stack list cannot see yet is taken from the push output', () => {
+  // fmm-express #1816 and ai #1756 (2026-10-16): the push created the PR, but `stack list` read
+  // straight after still had pull_number null, so the script failed a push that had succeeded.
+  const sha = 'ceb8e142d8840a35e4d109523f985713e94c3ab3'
+  // The exact text a real push printed (ai #1757): no sha, a middle dot, and tabs.
+  const plan = '  ✓ read 1 pull request(s)\n  ✓ branch `feat/x` rebased on `origin/main`\n    · [created]\t\thttps://github.com/o/r/pull/1816\tfeat: ceb8e142d8840a35e4d109523f985713e94c3ab3\nAlready up to date.\n'
+  const h = harness({ 'stack list': [ok(listJson([entry(sha)])), ok(listJson([entry(sha)]))], 'stack push': [ok(plan)] })
+  assert.equal(stackPush([], h.deps), EXIT.OK)
+  const result = JSON.parse(h.out.text)
+  assert.equal(result.prs[0].pr, 1816)
+  assert.equal(result.prs[0].url, 'https://github.com/o/r/pull/1816')
+  assert.match(h.err.text, /1 PR\(s\): #1816/)
+})
+
+test('pushedPrs reads every push line state and ignores lines without a PR', () => {
+  const text = '  ✓ read 2 pull request(s)\n    · [created]\t\thttps://github.com/o/r/pull/12\tfix: b\n    · [skipped]\t\tchore: c\n'
+  assert.deepEqual(pushedPrs(text).map((p) => [p.title, p.pr]), [['fix: b', 12]])
+  assert.deepEqual(pushedPrs(''), [])
+  const real = pushedPrs('    · [up-to-date]\t\thttps://github.com/1aboveio/ai/pull/1757\tfix(mergify): take a fresh PR\'s number\n')
+  assert.deepEqual(real, [{ title: "fix(mergify): take a fresh PR's number", url: 'https://github.com/1aboveio/ai/pull/1757', pr: 1757 }])
+  // fmm-express #1839 (2026-10-17): a check-mark bullet and the commit in the second column.
+  const checked = pushedPrs('    ✓ [created]\taf9adcc\thttps://github.com/1aboveio/fmm-express/pull/1839\tfix(ci): absorb handoff walk races\n')
+  assert.deepEqual(checked, [{ title: 'fix(ci): absorb handoff walk races', url: 'https://github.com/1aboveio/fmm-express/pull/1839', pr: 1839 }])
+})
+
+test('--dry-run passes through to mergify and stops after the plan', () => {
+  const h = harness({ 'stack list': [ok(listJson([entry('aaa')]))], 'stack push': [ok('plan\n')] })
+  assert.equal(stackPush(['--dry-run', '--trunk', 'upstream/develop'], h.deps), EXIT.OK)
+  assert.deepEqual(pushArgs(parseArgs(['--dry-run', '--trunk', 'upstream/develop'])).slice(2), ['--trunk', 'upstream/develop', '--keep-pull-request-title-and-body', '--dry-run'])
+  assert.equal(h.calls.filter((c) => c[0] === 'mergify' && c[2] === 'list').length, 1)
+  assert.equal(JSON.parse(h.out.text).dryRun, true)
+})
+
+test('rejects unknown flags, a malformed trunk, and --enqueue with --dry-run', () => {
+  for (const argv of [['--repo', 'o/r'], ['--trunk', 'main'], ['--enqueue', '--dry-run'], ['--no-verify']]) {
+    const h = harness({})
+    assert.equal(stackPush(argv, h.deps), EXIT.USAGE, argv.join(' '))
+  }
+})
+
+test('honours a relative core.hooksPath', () => {
+  const h = harness({ 'stack list': [ok(listJson([]))] })
+  const base = h.deps.exec
+  h.deps.exec = (cmd, args) => (cmd === 'git' && args[0] === 'config' ? ok('.githooks\n') : base(cmd, args))
+  h.deps.exists = (path) => path === '/repo/.githooks/mergify-hooks'
+  assert.equal(stackPush([], h.deps), EXIT.FIX_COMMITS)
+})