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
33 changes: 28 additions & 5 deletions .github/workflows/pr-backport.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -160,10 +160,10 @@ jobs:
PR_NUMBER: >-
${{ github.event_name == 'workflow_dispatch' && inputs.pr_number
|| github.event.pull_request.number }}
REQUESTED_TARGETS: ${{ steps.targets.outputs.targets }}
run: |
set -euo pipefail

REQUESTED_TARGETS="${{ steps.targets.outputs.targets }}"
if [ -z "$REQUESTED_TARGETS" ]; then
echo "skip=true" >> $GITHUB_OUTPUT
echo "pending-targets=" >> $GITHUB_OUTPUT
Expand All @@ -181,6 +181,7 @@ jobs:

PENDING=()
SKIPPED=()
MERGED=()
REUSED=()

for target in $REQUESTED_TARGETS; do
Expand All @@ -192,6 +193,21 @@ jobs:
continue
fi

MERGED_PR=$(
Comment thread
mattmillerai marked this conversation as resolved.
Resolved
gh pr list \
--state merged \
--head "${BACKPORT_BRANCH}" \
Comment thread
mattmillerai marked this conversation as resolved.
Resolved
--base "${target}" \
--json number,isCrossRepository \
--jq 'map(select(.isCrossRepository | not)) |
if length > 0 then .[0].number else "" end'
)
if [ -n "$MERGED_PR" ]; then
SKIPPED+=("${target} (merged PR #${MERGED_PR})")
MERGED+=("$target")
continue
fi

if printf '%s\n' "${EXISTING_BRANCHES[@]:-}" |
grep -Fq "refs/heads/${BACKPORT_BRANCH}"; then
OPEN_PR=$(
Expand Down Expand Up @@ -219,10 +235,16 @@ jobs:
echo "pending-targets=${PENDING_JOINED}" >> $GITHUB_OUTPUT
echo "reused-branches=${REUSED[*]:-}" >> $GITHUB_OUTPUT

if [ -z "$PENDING_JOINED" ] && [ "${#MERGED[@]}" -eq "${#SKIPPED[@]}" ]; then
echo "all-merged=true" >> $GITHUB_OUTPUT
else
echo "all-merged=false" >> $GITHUB_OUTPUT
fi

if [ -z "$PENDING_JOINED" ]; then
echo "skip=true" >> $GITHUB_OUTPUT
if [ -n "$SKIPPED_JOINED" ]; then
echo "::warning::Backport branches exist: ${SKIPPED_JOINED}"
echo "::warning::All backport targets already handled: ${SKIPPED_JOINED}"
Comment thread
mattmillerai marked this conversation as resolved.
Resolved
fi
else
echo "skip=false" >> $GITHUB_OUTPUT
Expand Down Expand Up @@ -546,9 +568,10 @@ jobs:
# already landed are skipped by "Filter already backported targets").
- name: Remove needs-backport label
if: >-
steps.filter-targets.outputs.skip != 'true' &&
steps.backport.outputs.failed == '' &&
steps.create-prs.outputs.pr-create-failed == ''
steps.filter-targets.outputs.all-merged == 'true' ||
(steps.filter-targets.outputs.skip != 'true' &&
steps.backport.outputs.failed == '' &&
steps.create-prs.outputs.pr-create-failed == '')
env:
GH_REPO: ${{ github.repository }}
PR_NUMBER: ${{ github.event_name == 'workflow_dispatch' && inputs.pr_number || github.event.pull_request.number }}
Expand Down
225 changes: 225 additions & 0 deletions scripts/cicd/pr-backport-filter.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,225 @@
import { spawnSync } from 'node:child_process'
import {
chmodSync,
mkdtempSync,
readFileSync,
rmSync,
writeFileSync
} from 'node:fs'
import { tmpdir } from 'node:os'
import { join } from 'node:path'

import { afterEach, beforeEach, describe, expect, it } from 'vitest'
import { parse } from 'yaml'
import { z } from 'zod'

const workflowSchema = z.object({
jobs: z.object({
backport: z.object({
steps: z.array(
z.object({ id: z.string().optional(), run: z.string().optional() })
)
})
})
})

const filterScript = () => {
const workflow = workflowSchema.parse(
parse(readFileSync('.github/workflows/pr-backport.yaml', 'utf8'))
)
const step = workflow.jobs.backport.steps.find(
(step) => step.id === 'filter-targets'
)
if (!step?.run) throw new Error('Missing filter-targets script')
return step.run
}

const GH_STUB = `#!/usr/bin/env bash
state="" head="" base="" filter="." fields=""
while [ $# -gt 0 ]; do
case "$1" in
--state) state="$2"; shift 2 ;;
--head) head="$2"; shift 2 ;;
--base) base="$2"; shift 2 ;;
--json) fields="$2"; shift 2 ;;
--jq) filter="$2"; shift 2 ;;
*) shift ;;
esac
done
matches="[]"
while IFS='|' read -r s h b n cross; do
[ -z "$s" ] && continue
if [ "$s" = "$state" ] && [ "$h" = "$head" ] && { [ -z "$base" ] || [ "$b" = "$base" ]; }; then
matches=$(jq -c --argjson n "$n" --argjson cross "$cross" '. + [{number: $n, isCrossRepository: $cross}]' <<< "$matches")
fi
done <<< "$STUB_PRS"
matches=$(jq -c --arg fields "$fields" 'map(with_entries(select(.key as $key | $fields | split(",") | index($key))))' <<< "$matches")
jq -r "$filter" <<< "$matches"
`

const GIT_STUB = `#!/usr/bin/env bash
for branch in $STUB_BRANCHES; do
printf '0000000\\trefs/heads/%s\\n' "$branch"
done
`

interface StubPr {
state: 'open' | 'merged'
head: string
base: string
number: number
crossRepository?: boolean
}

interface Scenario {
targets: string[]
prs?: StubPr[]
branches?: string[]
forceRerun?: boolean
}

let dir: string

beforeEach(() => {
dir = mkdtempSync(join(tmpdir(), 'pr-backport-filter-'))
for (const [name, body] of [
['gh', GH_STUB],
['git', GIT_STUB]
]) {
writeFileSync(join(dir, name), body)
chmodSync(join(dir, name), 0o755)
}
})

afterEach(() => {
rmSync(dir, { recursive: true, force: true })
})

function runFilter({
targets,
prs = [],
branches = [],
forceRerun = false
}: Scenario) {
const outputFile = join(dir, 'output')
writeFileSync(outputFile, '')
const result = spawnSync(
'bash',
['--noprofile', '--norc', '-c', filterScript()],
{
env: {
PATH: `${dir}:${process.env.PATH}`,
GITHUB_OUTPUT: outputFile,
EVENT_NAME: forceRerun ? 'workflow_dispatch' : 'pull_request_target',
FORCE_RERUN_INPUT: String(forceRerun),
PR_NUMBER: '21829',
REQUESTED_TARGETS: targets.join(' '),
STUB_PRS: prs
.map((pr) =>
[
pr.state,
pr.head,
pr.base,
pr.number,
pr.crossRepository ?? false
].join('|')
)
.join('\n'),
STUB_BRANCHES: branches.join(' ')
},
encoding: 'utf8'
}
)
if (result.status !== 0) throw new Error(result.stderr)
return Object.fromEntries(
readFileSync(outputFile, 'utf8')
.split('\n')
.filter(Boolean)
.map((line) => {
const index = line.indexOf('=')
return [line.slice(0, index), line.slice(index + 1)]
})
)
}

const mergedCore157: StubPr = {
state: 'merged',
head: 'backport-21829-to-core-1.57',
base: 'core/1.57',
number: 21880
}

describe('pr-backport filter-targets', () => {
it('attempts only the new target when an old target was already merged', () => {
expect(
runFilter({ targets: ['core/1.57', 'cloud/1.58'], prs: [mergedCore157] })
).toMatchObject({
skip: 'false',
'pending-targets': 'cloud/1.58',
'already-exists': 'core/1.57 (merged PR #21880)',
'all-merged': 'false'
})
})
Comment thread
mattmillerai marked this conversation as resolved.
Resolved

it('keeps completion false when a merged target and an open target are skipped', () => {
expect(
runFilter({
targets: ['core/1.57', 'cloud/1.58'],
branches: ['backport-21829-to-cloud-1.58'],
prs: [
mergedCore157,
{
state: 'open',
head: 'backport-21829-to-cloud-1.58',
base: 'cloud/1.58',
number: 21881
}
]
})
).toMatchObject({ skip: 'true', 'all-merged': 'false' })
})

it('skips the run when every target was already merged', () => {
expect(
runFilter({ targets: ['core/1.57'], prs: [mergedCore157] })
).toMatchObject({
skip: 'true',
'pending-targets': '',
'all-merged': 'true'
})
})

it.for([
{ name: 'a different base', pr: { ...mergedCore157, base: 'main' } },
{ name: 'a fork', pr: { ...mergedCore157, crossRepository: true } }
])('ignores a merged PR from $name', ({ pr }) => {
expect(runFilter({ targets: ['core/1.57'], prs: [pr] })).toMatchObject({
skip: 'false',
'pending-targets': 'core/1.57'
})
})

it('retries a merged target when force_rerun is set', () => {
expect(
runFilter({
targets: ['core/1.57'],
prs: [mergedCore157],
forceRerun: true
})
).toMatchObject({ skip: 'false', 'pending-targets': 'core/1.57' })
})

it('still skips a target whose backport PR is open', () => {
expect(
runFilter({
targets: ['core/1.57'],
branches: ['backport-21829-to-core-1.57'],
prs: [{ ...mergedCore157, state: 'open', number: 21881 }]
})
).toMatchObject({
skip: 'true',
'all-merged': 'false',
'already-exists': 'core/1.57 (PR #21881)'
})
})
})
Loading