Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Check if condition and needs input for pr-builder #112

Merged
merged 5 commits into from
Aug 23, 2024
Merged

Check if condition and needs input for pr-builder #112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2e100c9
Check if condition and needs input for pr-builder
KyleFromNVIDIA Aug 23, 2024
5c95bde
Ignore warning about expression expansion
KyleFromNVIDIA Aug 23, 2024
ac4855a
Rename function
KyleFromNVIDIA Aug 23, 2024
3622105
Remove stray newline
KyleFromNVIDIA Aug 23, 2024
61dc437
Add another test
KyleFromNVIDIA Aug 23, 2024
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
235 changes: 235 additions & 0 deletions tests/test_rapids-check-pr-job-dependencies.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,235 @@
import os.path
import pytest
import subprocess
from textwrap import dedent

TOOLS_DIR = os.path.join(os.path.dirname(os.path.realpath(__file__)), "..", "tools")


@pytest.mark.parametrize(
["contents", "ignored_jobs", "output", "exit_code"],
[
(
dedent(
"""\
jobs:
pr-builder:
needs:
- job1
- job2
job1:
job2:
"""
),
None,
"pr-builder depends on all other jobs.\n",
0,
),
(
dedent(
"""\
jobs:
pr-builder:
needs:
- job1
- job2
job1:
job2:
"""
),
[],
"pr-builder depends on all other jobs.\n",
0,
),
(
dedent(
"""\
jobs:
pr-builder:
needs:
- job1
- job2
job1:
job2:
job3:
"""
),
["job3"],
"pr-builder depends on all other jobs.\n",
0,
),
(
dedent(
"""\
jobs:
pr-builder:
needs:
- job1
- job2
job1:
job2:
job3:
"""
),
None,
dedent(
"""\
'pr-builder' job is missing the following dependent jobs:
- job3

Update '{filename}' to include these missing jobs for 'pr-builder'.
Alternatively, you may ignore these jobs by passing them as an argument to this script.
"""
),
1,
),
(
dedent(
"""\
jobs:
pr-builder:
needs:
- job1
- job2
if: true
job1:
job2:
"""
),
None,
dedent(
"""\
If 'pr-builder' job has an 'if' condition, it must be set to 'always()'.

Update '{filename}' to set the correct 'if' condition.
"""
),
1,
),
(
dedent(
"""\
jobs:
pr-builder:
needs:
- job1
- job2
if: always()
job1:
job2:
"""
),
None,
dedent(
"""\
If 'pr-builder' job has an 'if' condition, it must also set the 'needs' input to '${{{{ toJSON(needs) }}}}'.

Update '{filename}' to add the following:

with:
needs: ${{{{ toJSON(needs) }}}}
"""
),
1,
),
(
dedent(
"""\
jobs:
pr-builder:
needs:
- job1
- job2
if: always()
with:
job1:
job2:
"""
),
None,
dedent(
"""\
If 'pr-builder' job has an 'if' condition, it must also set the 'needs' input to '${{{{ toJSON(needs) }}}}'.

Update '{filename}' to add the following:

with:
needs: ${{{{ toJSON(needs) }}}}
"""
),
1,
),
(
dedent(
"""\
jobs:
pr-builder:
needs:
- job1
- job2
if: always()
with:
needs: invalid
job1:
job2:
"""
),
None,
dedent(
"""\
If 'pr-builder' job has an 'if' condition, it must also set the 'needs' input to '${{{{ toJSON(needs) }}}}'.

Update '{filename}' to add the following:

with:
needs: ${{{{ toJSON(needs) }}}}
"""
),
1,
),
(
dedent(
"""\
jobs:
pr-builder:
needs:
- job1
- job2
if: always()
with:
needs: ${{ toJSON(needs) }}
job1:
job2:
"""
),
None,
"pr-builder depends on all other jobs.\n",
0,
),
],
)
def test_rapids_check_pr_job_dependencies(
tmp_path: os.PathLike,
contents: str,
ignored_jobs: list[str],
output: str,
exit_code: int,
):
filename = os.path.join(tmp_path, "pr.yaml")
with open(filename, "w") as f:
f.write(contents)
result = subprocess.run(
[
os.path.join(TOOLS_DIR, "rapids-check-pr-job-dependencies"),
*([] if ignored_jobs is None else [" ".join(ignored_jobs)]),
],
env={
**os.environ,
"WORKFLOW_FILE": filename,
},
text=True,
capture_output=True,
)
assert result.stdout == output.format(filename=filename)
assert result.stderr == ""
assert result.returncode == exit_code
20 changes: 20 additions & 0 deletions tools/rapids-check-pr-job-dependencies
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,24 @@ if yq -en 'env(MISSING_JOBS) | length != 0' >/dev/null 2>&1; then
exit 1
fi

if if_condition="$(yq -e '.jobs.[env(PR_BUILDER_JOB_NAME)].if' "${WORKFLOW_FILE}" 2>/dev/null)"; then
if [[ "${if_condition}" != "always()" ]]; then
echo "If '${PR_BUILDER_JOB_NAME}' job has an 'if' condition, it must be set to 'always()'."
echo ""
echo "Update '${WORKFLOW_FILE}' to set the correct 'if' condition."
exit 1
fi

# shellcheck disable=SC2016
if yq -e '.jobs.[env(PR_BUILDER_JOB_NAME)].with.needs != "${{ toJSON(needs) }}"' "${WORKFLOW_FILE}" >/dev/null 2>&1; then
echo "If '${PR_BUILDER_JOB_NAME}' job has an 'if' condition, it must also set the 'needs' input to '\${{ toJSON(needs) }}'."
echo ""
echo "Update '${WORKFLOW_FILE}' to add the following:"
echo ""
echo "with:"
echo " needs: \${{ toJSON(needs) }}"
exit 1
fi
fi

echo "${PR_BUILDER_JOB_NAME} depends on all other jobs."