Skip to content

Commit

Permalink
Merge pull request #363 from github/check-fixes
Browse files Browse the repository at this point in the history 
bug: `checks` input option is not respecting required checks in the pending state
  • Loading branch information
@GrantBirki
GrantBirki authored Jan 29, 2025
2 parents c8417fc + 37c13cf commit de6dba3
Show file tree
Hide file tree
Showing 4 changed files with 307 additions and 73 deletions.
186 changes: 160 additions & 26 deletions __tests__/functions/prechecks.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,9 @@ test('runs prechecks and finds that the IssueOps command is valid for a branch d
isFork: false
})

expect(debugMock).toHaveBeenCalledWith('ignoring ci check: markdown-lint')
expect(debugMock).toHaveBeenCalledWith(
'filterChecks() - ignoring ci check: markdown-lint'
)
})

test('runs prechecks and finds that the IssueOps command is valid for a branch deployment with a few explictly requested checks and a few ignored checks', async () => {
Expand Down Expand Up @@ -375,13 +377,113 @@ test('runs prechecks and finds that the IssueOps command is valid for a branch d
isFork: false
})

expect(debugMock).toHaveBeenCalledWith('explicitly including ci check: test')
expect(debugMock).toHaveBeenCalledWith(
'explicitly including ci check: acceptance-test'
'filterChecks() - explicitly including ci check: test'
)
expect(debugMock).toHaveBeenCalledWith(
'filterChecks() - explicitly including ci check: acceptance-test'
)
expect(debugMock).toHaveBeenCalledWith(
'filterChecks() - explicitly including ci check: lint'
)
expect(debugMock).toHaveBeenCalledWith(
'filterChecks() - markdown-lint is not in the explicit list of checks to include (test,acceptance-test,lint)'
)
expect(debugMock).not.toHaveBeenCalledWith(
'filterChecks() - ignoring ci check: markdown-lint'
)
expect(debugMock).toHaveBeenCalledWith(
'filterChecks() - ignoring ci check: lint'
)
})

test('runs prechecks and finds that the IssueOps command is valid for a branch deployment with a few explictly requested checks and a few ignored checks but one CI check is missing', async () => {
octokit.graphql = jest.fn().mockReturnValue({
repository: {
pullRequest: {
reviewDecision: 'APPROVED',
mergeStateStatus: 'CLEAN',
reviews: {
totalCount: 1
},
commits: {
nodes: [
{
commit: {
oid: 'abc123',
checkSuites: {
totalCount: 5
},
statusCheckRollup: {
state: 'FAILURE',
contexts: {
nodes: [
{
isRequired: true,
conclusion: 'SUCCESS',
name: 'test'
},
{
isRequired: false,
conclusion: 'SUCCESS',
name: 'acceptance-test'
},
{
isRequired: true,
conclusion: 'SKIPPED',
name: 'lint'
},
{
isRequired: false,
conclusion: 'FAILURE',
name: 'build'
},
{
isRequired: true,
conclusion: 'FAILURE',
name: 'markdown-lint'
}
]
}
}
}
}
]
}
}
}
})

data.inputs.checks = ['test', 'acceptance-test', 'quality-control', 'lint']
data.inputs.ignored_checks = ['lint']

expect(await prechecks(context, octokit, data)).toStrictEqual({
message:
'### ⚠️ Cannot proceed with deployment\n\n- reviewDecision: `APPROVED`\n- commitStatus: `MISSING`\n\n> The `checks` input option requires that all of the following checks are passing: `test,acceptance-test,quality-control,lint`. However, the following checks are missing: `quality-control`',
status: false
})

expect(warningMock).toHaveBeenCalledWith(
`the ${COLORS.info}checks${COLORS.reset} input option requires that all of the following checks are passing: ${COLORS.highlight}${data.inputs.checks.join(', ')}${COLORS.reset} - however, the following checks are missing: ${COLORS.highlight}quality-control${COLORS.reset}`
)
expect(debugMock).not.toHaveBeenCalledWith(
'filterChecks() - explicitly including ci check: test'
)
expect(debugMock).not.toHaveBeenCalledWith(
'filterChecks() - explicitly including ci check: acceptance-test'
)
expect(debugMock).not.toHaveBeenCalledWith(
'filterChecks() - explicitly including ci check: lint'
)
expect(debugMock).not.toHaveBeenCalledWith(
'filterChecks() - markdown-lint is not in the explicit list of checks to include (test,acceptance-test,lint)'
)
expect(debugMock).not.toHaveBeenCalledWith(
'filterChecks() - ignoring ci check: markdown-lint'
)
expect(debugMock).not.toHaveBeenCalledWith(
'filterChecks() - ignoring ci check: lint'
)
expect(debugMock).toHaveBeenCalledWith('explicitly including ci check: lint')
expect(debugMock).not.toHaveBeenCalledWith('ignoring ci check: markdown-lint')
expect(debugMock).toHaveBeenCalledWith('ignoring ci check: lint')
})

test('runs prechecks and finds that the IssueOps command is valid for a branch deployment but checks and ignore checks cancel eachother out', async () => {
Expand Down Expand Up @@ -465,22 +567,38 @@ test('runs prechecks and finds that the IssueOps command is valid for a branch d
isFork: false
})

expect(debugMock).toHaveBeenCalledWith('explicitly including ci check: test')
expect(debugMock).toHaveBeenCalledWith(
'explicitly including ci check: acceptance-test'
'filterChecks() - explicitly including ci check: test'
)
expect(debugMock).toHaveBeenCalledWith(
'filterChecks() - explicitly including ci check: acceptance-test'
)
expect(debugMock).toHaveBeenCalledWith('explicitly including ci check: lint')
expect(debugMock).toHaveBeenCalledWith(
'explicitly including ci check: markdown-lint'
)
expect(debugMock).toHaveBeenCalledWith('explicitly including ci check: build')
expect(debugMock).toHaveBeenCalledWith('ignoring ci check: markdown-lint')
expect(debugMock).toHaveBeenCalledWith('ignoring ci check: lint')
expect(debugMock).toHaveBeenCalledWith('ignoring ci check: build')
expect(debugMock).toHaveBeenCalledWith('ignoring ci check: test')
expect(debugMock).toHaveBeenCalledWith('ignoring ci check: acceptance-test')
'filterChecks() - explicitly including ci check: lint'
)
expect(debugMock).toHaveBeenCalledWith(
'filterChecks() - explicitly including ci check: markdown-lint'
)
expect(debugMock).toHaveBeenCalledWith(
'filterChecks() - explicitly including ci check: build'
)
expect(debugMock).toHaveBeenCalledWith(
'filterChecks() - ignoring ci check: markdown-lint'
)
expect(debugMock).toHaveBeenCalledWith(
'filterChecks() - ignoring ci check: lint'
)
expect(debugMock).toHaveBeenCalledWith(
'filterChecks() - ignoring ci check: build'
)
expect(debugMock).toHaveBeenCalledWith(
'filterChecks() - ignoring ci check: test'
)
expect(debugMock).toHaveBeenCalledWith(
'filterChecks() - ignoring ci check: acceptance-test'
)
expect(debugMock).toHaveBeenCalledWith(
'after filtering, no checks remain - this will result in a SUCCESS state as it is treated as if no checks are defined'
'filterChecks() - after filtering, no checks remain - this will result in a SUCCESS state as it is treated as if no checks are defined'
)
})

Expand Down Expand Up @@ -553,8 +671,12 @@ test('runs prechecks and finds that the IssueOps command is valid for a branch d
isFork: false
})

expect(debugMock).toHaveBeenCalledWith('ignoring ci check: build')
expect(debugMock).toHaveBeenCalledWith('ignoring ci check: markdown-lint')
expect(debugMock).toHaveBeenCalledWith(
'filterChecks() - ignoring ci check: build'
)
expect(debugMock).toHaveBeenCalledWith(
'filterChecks() - ignoring ci check: markdown-lint'
)
})

test('runs prechecks and finds that the IssueOps command is valid for a branch deployment with ALL checks being required but the user has provided some checks to ignore', async () => {
Expand Down Expand Up @@ -626,8 +748,12 @@ test('runs prechecks and finds that the IssueOps command is valid for a branch d
expect(debugMock).not.toHaveBeenCalledWith(
'explicitly including ci check: test'
)
expect(debugMock).not.toHaveBeenCalledWith('ignoring ci check: build')
expect(debugMock).not.toHaveBeenCalledWith('ignoring ci check: markdown-lint')
expect(debugMock).not.toHaveBeenCalledWith(
'filterChecks() - ignoring ci check: build'
)
expect(debugMock).not.toHaveBeenCalledWith(
'filterChecks() - ignoring ci check: markdown-lint'
)
})

test('runs prechecks and finds that the IssueOps command is valid for a branch deployment with ALL checks being required but the user has provided some checks to ignore but none match', async () => {
Expand Down Expand Up @@ -696,8 +822,12 @@ test('runs prechecks and finds that the IssueOps command is valid for a branch d
status: false
})

expect(debugMock).not.toHaveBeenCalledWith('ignoring ci check: build')
expect(debugMock).not.toHaveBeenCalledWith('ignoring ci check: markdown-lint')
expect(debugMock).not.toHaveBeenCalledWith(
'filterChecks() - ignoring ci check: build'
)
expect(debugMock).not.toHaveBeenCalledWith(
'filterChecks() - ignoring ci check: markdown-lint'
)
})

test('runs prechecks and finds that the IssueOps command is valid for a branch deployment with ALL checks being required and the user did not provided checks to ignore and some are failing', async () => {
Expand Down Expand Up @@ -766,8 +896,12 @@ test('runs prechecks and finds that the IssueOps command is valid for a branch d
status: false
})

expect(debugMock).not.toHaveBeenCalledWith('ignoring ci check: build')
expect(debugMock).not.toHaveBeenCalledWith('ignoring ci check: markdown-lint')
expect(debugMock).not.toHaveBeenCalledWith(
'filterChecks() - ignoring ci check: build'
)
expect(debugMock).not.toHaveBeenCalledWith(
'filterChecks() - ignoring ci check: markdown-lint'
)
})

test('runs prechecks and finds that the IssueOps command is valid for a rollback deployment', async () => {
Expand Down
Loading

0 comments on commit de6dba3

Please sign in to comment.