mirror of
https://github.com/github/codeql-action.git
synced 2026-05-26 16:34:25 +00:00
Compare commits
321 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 95152f814a | |||
| f34cadbf2a | |||
| dda23c79a8 | |||
| 5fb81ae73e | |||
| eeaa56bdbb | |||
| bee9891358 | |||
| f4d0a7abf7 | |||
| f62fbc9627 | |||
| 2a7340616e | |||
| 3b0e64cb09 | |||
| 0a7280a837 | |||
| b79a976789 | |||
| eb9a790d15 | |||
| b8baf41834 | |||
| 5e9ae56429 | |||
| 8442bc0af9 | |||
| 26a1e570a6 | |||
| 9665bc2f5a | |||
| fcc1e3197f | |||
| c8a3492b26 | |||
| e94195c896 | |||
| 05e8f288eb | |||
| b71f5aebfc | |||
| 2365a46087 | |||
| cf51dca1af | |||
| b30a935ea5 | |||
| 5b815f25ca | |||
| 93c8a9ed99 | |||
| 2a02de1a14 | |||
| 67f403822c | |||
| bbef5ff663 | |||
| 7187b6ecc7 | |||
| f1ce9f4421 | |||
| 06c7e6fdd5 | |||
| 9e0d7b8d25 | |||
| 6d7d59927c | |||
| 51f7e38c69 | |||
| b43bb7bd69 | |||
| 064674dfa3 | |||
| ab5047bf8f | |||
| 2320f9d058 | |||
| 46959216a2 | |||
| 9e1f914560 | |||
| db84cb5ccb | |||
| d4b485515e | |||
| 931147e852 | |||
| 127de8117f | |||
| 7fde13f26a | |||
| dfa61e7305 | |||
| 52aafec073 | |||
| 0d08c01f78 | |||
| 1b65777c19 | |||
| 14085a675c | |||
| a32db48565 | |||
| aa005faaad | |||
| fcdf5dd4cf | |||
| e8d3fa290e | |||
| eb17ca4f4d | |||
| a41c444cd9 | |||
| d7e50c23fe | |||
| bb30f3132d | |||
| 336884853e | |||
| 2f137c9dc6 | |||
| 4795ef8153 | |||
| f0489abddd | |||
| 2e202367c7 | |||
| 9d7243005b | |||
| 237b03b3c3 | |||
| d4eab006fa | |||
| ea37b337cd | |||
| ba0a2f91b7 | |||
| 4041a11865 | |||
| 2a6fe1608c | |||
| 3c8c0ae6cb | |||
| 93d215d874 | |||
| 4235601f6f | |||
| 3d6ea97f26 | |||
| 7d25a3e590 | |||
| 4dc72761a6 | |||
| 9c3aedb4cd | |||
| a66f7bbb5a | |||
| b986640672 | |||
| a333d64ec4 | |||
| 97fb30df6b | |||
| d122da3c9f | |||
| de3e561d12 | |||
| c559992c9e | |||
| 6a4e35fad9 | |||
| 8d217609b0 | |||
| 257b3d3fc8 | |||
| 201a96b541 | |||
| 312a2fee96 | |||
| 2ca0fbdca8 | |||
| 12c1d88854 | |||
| 70419e3273 | |||
| b62aaa99a5 | |||
| 2f2dbd2e78 | |||
| b4ea7aa65a | |||
| 87ac48dae6 | |||
| 42d7f62579 | |||
| 540699dcca | |||
| 9a85234875 | |||
| 2a950b930c | |||
| 4f815a68d3 | |||
| 0aedbb71d8 | |||
| 868e2ea564 | |||
| 792c223bc1 | |||
| efc9b0a9e3 | |||
| 272ada693f | |||
| 610a6682b6 | |||
| 1627096569 | |||
| 68bde559de | |||
| 9739ad2d18 | |||
| b81d0d250f | |||
| a16cb53dd8 | |||
| 803d9e8c3c | |||
| 0c80cee806 | |||
| d032ee8c47 | |||
| 0fd9c7d135 | |||
| 922d6fb888 | |||
| df77e87896 | |||
| 6e3f985e4f | |||
| e7a347dfb1 | |||
| 17eabb2500 | |||
| aaef09c48d | |||
| ae1b9155d3 | |||
| 9f82f88f07 | |||
| 7525c68ea1 | |||
| 01bc9be56a | |||
| 9d6b456c59 | |||
| e259d26055 | |||
| 817b68489e | |||
| 1b5632783c | |||
| 1848b73afa | |||
| d1e9792bc8 | |||
| 2c9cd77837 | |||
| b967fdfbdc | |||
| 55d6319f96 | |||
| b0942116d7 | |||
| bc0b696b41 | |||
| a796e3e4ed | |||
| f9bb0e001c | |||
| 4b7faf0b3d | |||
| 09a1d9ec2a | |||
| f64a4491cf | |||
| 7fc86e0c37 | |||
| 5997e25ad9 | |||
| 7587714d0a | |||
| 8ab64a211d | |||
| a723e99345 | |||
| fbba1e03be | |||
| 933238e8d5 | |||
| e46ed2cbd0 | |||
| b73d1d1634 | |||
| 24e0bb00a9 | |||
| ec298daba7 | |||
| f8b93c30a6 | |||
| 8c6e48dbe0 | |||
| 80a72986d3 | |||
| e9e36aec74 | |||
| 719098349e | |||
| 2bb209555a | |||
| 4ed52dcbfa | |||
| 3cc8dd3e59 | |||
| 7851e55dc3 | |||
| 262a15f6cf | |||
| a6109b1c07 | |||
| 022ff3c73f | |||
| 0a4d574ac4 | |||
| d1edf2e4de | |||
| facd53f789 | |||
| b77983290b | |||
| fcf29e3d86 | |||
| 1fed3e9ba8 | |||
| 549683cee5 | |||
| 7a6ed56219 | |||
| 91fbc51606 | |||
| 35715ef8fe | |||
| bac7fdaf42 | |||
| 1517969c90 | |||
| f073360456 | |||
| 5145c112e7 | |||
| 7108503ac6 | |||
| 4fe9b1e243 | |||
| 56733fb5ae | |||
| 0a636086c9 | |||
| 97be3af35a | |||
| de303a9db5 | |||
| 7a818e6977 | |||
| 30e0f4391d | |||
| 7c5585e5cf | |||
| 245f6828c4 | |||
| c109008fac | |||
| e73c940c9b | |||
| cdb655d6d4 | |||
| 6153577cab | |||
| 8f02cfa11d | |||
| 0ed734b61b | |||
| efdcb31f11 | |||
| 4d2c7c6e10 | |||
| 70b2658d23 | |||
| 530fcb3bbf | |||
| 2acf81942b | |||
| d2a54a4507 | |||
| bc4097bbe1 | |||
| c8e26e209a | |||
| 0752451507 | |||
| 243c274daf | |||
| 5ded561dcd | |||
| 19b3a84f58 | |||
| faca00d3ae | |||
| 858a6149c1 | |||
| 5d1c58464f | |||
| c60c75576d | |||
| 59aede2113 | |||
| 6c35f8607b | |||
| c486cacf49 | |||
| 365478cc5b | |||
| f0e6490756 | |||
| 860353f245 | |||
| 4fb8483ef0 | |||
| c2574efbee | |||
| 4cbe7bef85 | |||
| f6a5638305 | |||
| 1279e8d41c | |||
| af1f613989 | |||
| 5026833be5 | |||
| 201ddc275d | |||
| 1dcdb940d5 | |||
| 0b7b740d4c | |||
| 0ac85966ba | |||
| 5019ed041c | |||
| d64d81d41f | |||
| 6777c894e9 | |||
| 79f9c0517c | |||
| 3b3a77544b | |||
| 9f95de42d6 | |||
| e2d518d895 | |||
| 9df9e9176e | |||
| 6847a42aa8 | |||
| f820c80d4d | |||
| ca7d6d3b79 | |||
| 8d9c36a0ce | |||
| 95e58e9a2c | |||
| 6f31bfe060 | |||
| d2e135a73a | |||
| 60abb65df0 | |||
| 5a0a562209 | |||
| f8b62132ab | |||
| 65216971a1 | |||
| 3c45af2dd2 | |||
| f1c339364c | |||
| 1024fc496c | |||
| 9dd4cfed96 | |||
| c1403f094c | |||
| 90d7616015 | |||
| 1aef4ed505 | |||
| cb52ba6486 | |||
| 7c9e131894 | |||
| 130ab2d721 | |||
| 8cf2dc52f9 | |||
| 8339b9254e | |||
| 97bcdd8c1e | |||
| e6c21da23c | |||
| bad0a744dd | |||
| ee09113642 | |||
| b669eab7e3 | |||
| 4e8c9ce33c | |||
| 1cf0431149 | |||
| a26cb68cc7 | |||
| 60991e61ac | |||
| 7197c2b792 | |||
| 597e12aa85 | |||
| d277a56348 | |||
| 111a537cd9 | |||
| 51d833290e | |||
| 5a17511bf0 | |||
| 43d8420a42 | |||
| 76a687e1d8 | |||
| 751f3e2f7c | |||
| 808513f048 | |||
| e452857e57 | |||
| b623f5fd57 | |||
| 35a38985d3 | |||
| 14ed573199 | |||
| 43d8864b35 | |||
| f8aff3ad8b | |||
| e6c83948f5 | |||
| 347f0c676d | |||
| 6eed62b035 | |||
| de1752b85d | |||
| 1065967b50 | |||
| e25c0a535a | |||
| 5f323cad05 | |||
| 212e28374b | |||
| 36075a4980 | |||
| 34950e1b11 | |||
| 57ec7e1000 | |||
| 311573e58e | |||
| 1f4c852aeb | |||
| 2e3aaaefca | |||
| e2203c62cf | |||
| 7b0c5b1669 | |||
| faf45e07f9 | |||
| 8b5e60477c | |||
| 99b8dd4d57 | |||
| c618c9bddb | |||
| 9fd9b64766 | |||
| 0c7c298b2a | |||
| a507a542a4 | |||
| be0a156326 | |||
| f98bf5e347 | |||
| 3db32b5d27 | |||
| 4e0952a3c0 | |||
| 0592832ed8 | |||
| 88a7e5118e | |||
| 6643a7d207 | |||
| 47f1709a3c | |||
| b1981a5480 | |||
| 4ed3c0efe6 | |||
| 4ea3a4b4af |
@@ -41,7 +41,38 @@ runs:
|
|||||||
git add .
|
git add .
|
||||||
git commit -m "Update changelog and version after ${VERSION}"
|
git commit -m "Update changelog and version after ${VERSION}"
|
||||||
|
|
||||||
git push origin "${NEW_BRANCH}"
|
# Update the build artifacts with the new version number
|
||||||
|
- name: Rebuild the Action
|
||||||
|
shell: bash
|
||||||
|
run: |
|
||||||
|
set -exu
|
||||||
|
npm ci
|
||||||
|
npm run build
|
||||||
|
|
||||||
|
- name: Check for rebuild changes
|
||||||
|
id: rebuild_changes
|
||||||
|
shell: bash
|
||||||
|
run: |
|
||||||
|
set -exu
|
||||||
|
git add --all
|
||||||
|
if git diff --cached --quiet; then
|
||||||
|
echo "has_changes=false" >> "${GITHUB_OUTPUT}"
|
||||||
|
else
|
||||||
|
echo "has_changes=true" >> "${GITHUB_OUTPUT}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: Commit rebuild
|
||||||
|
if: steps.rebuild_changes.outputs.has_changes == 'true'
|
||||||
|
shell: bash
|
||||||
|
run: |
|
||||||
|
set -exu
|
||||||
|
git commit -m "Rebuild"
|
||||||
|
|
||||||
|
- name: Push mergeback branch
|
||||||
|
shell: bash
|
||||||
|
env:
|
||||||
|
NEW_BRANCH: "${{ inputs.branch }}"
|
||||||
|
run: git push origin "${NEW_BRANCH}"
|
||||||
|
|
||||||
- name: Create PR
|
- name: Create PR
|
||||||
shell: bash
|
shell: bash
|
||||||
@@ -60,8 +91,6 @@ runs:
|
|||||||
|
|
||||||
Please do the following:
|
Please do the following:
|
||||||
|
|
||||||
- [ ] Remove and re-add the "Rebuild" label to the PR to trigger just this workflow.
|
|
||||||
- [ ] Wait for the "Rebuild" workflow to push a commit updating the distribution files.
|
|
||||||
- [ ] Mark the PR as ready for review to trigger the full set of PR checks.
|
- [ ] Mark the PR as ready for review to trigger the full set of PR checks.
|
||||||
- [ ] Approve and merge the PR. When merging the PR, make sure "Create a merge commit" is
|
- [ ] Approve and merge the PR. When merging the PR, make sure "Create a merge commit" is
|
||||||
selected rather than "Squash and merge" or "Rebase and merge".
|
selected rather than "Squash and merge" or "Rebase and merge".
|
||||||
@@ -74,7 +103,6 @@ runs:
|
|||||||
--head "${NEW_BRANCH}" \
|
--head "${NEW_BRANCH}" \
|
||||||
--base "${BASE_BRANCH}" \
|
--base "${BASE_BRANCH}" \
|
||||||
--title "${pr_title}" \
|
--title "${pr_title}" \
|
||||||
--label "Rebuild" \
|
|
||||||
--body "${pr_body}" \
|
--body "${pr_body}" \
|
||||||
--assignee "${GITHUB_ACTOR}" \
|
--assignee "${GITHUB_ACTOR}" \
|
||||||
--draft
|
--draft
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ runs:
|
|||||||
- name: Set up Node
|
- name: Set up Node
|
||||||
uses: actions/setup-node@v6
|
uses: actions/setup-node@v6
|
||||||
with:
|
with:
|
||||||
node-version: 20
|
node-version: 24
|
||||||
cache: 'npm'
|
cache: 'npm'
|
||||||
|
|
||||||
- name: Set up Python
|
- name: Set up Python
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
name: "CodeQL config"
|
name: "CodeQL config"
|
||||||
queries:
|
queries:
|
||||||
- name: Run custom queries
|
- name: Run custom queries
|
||||||
uses: ./queries
|
uses: ./queries
|
||||||
# Run all extra query suites, both because we want to
|
# Run all extra query suites, both because we want to
|
||||||
@@ -13,3 +13,5 @@ queries:
|
|||||||
paths-ignore:
|
paths-ignore:
|
||||||
- lib
|
- lib
|
||||||
- tests
|
- tests
|
||||||
|
- "**/*.test.ts"
|
||||||
|
- "**/testing-util.ts"
|
||||||
|
|||||||
@@ -1,7 +1,9 @@
|
|||||||
version: 2
|
version: 2
|
||||||
updates:
|
updates:
|
||||||
- package-ecosystem: npm
|
- package-ecosystem: npm
|
||||||
directory: "/"
|
directories:
|
||||||
|
- "/"
|
||||||
|
- "/pr-checks"
|
||||||
schedule:
|
schedule:
|
||||||
interval: weekly
|
interval: weekly
|
||||||
cooldown:
|
cooldown:
|
||||||
|
|||||||
@@ -16,12 +16,27 @@ No user facing changes.
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
# NB: This exact commit message is used to find commits for reverting during backports.
|
# NB: This exact commit message is used to find commits for reverting during backports.
|
||||||
# Changing it requires a transition period where both old and new versions are supported.
|
# Changing it requires a transition period where both old and new versions are supported.
|
||||||
BACKPORT_COMMIT_MESSAGE = 'Update version and changelog for v'
|
BACKPORT_COMMIT_MESSAGE = 'Update version and changelog for v'
|
||||||
|
|
||||||
|
# Commit message used for rebuild commits, both those produced by this script and those produced
|
||||||
|
# by the `Rebuild Action` workflow (`.github/workflows/rebuild.yml`).
|
||||||
|
REBUILD_COMMIT_MESSAGE = 'Rebuild'
|
||||||
|
|
||||||
# Name of the remote
|
# Name of the remote
|
||||||
ORIGIN = 'origin'
|
ORIGIN = 'origin'
|
||||||
|
|
||||||
|
# Environment variables to check for a GitHub API token.
|
||||||
|
TOKEN_ENVIRONMENT_VARIABLES = ('GH_TOKEN', 'GITHUB_TOKEN')
|
||||||
|
|
||||||
|
# Gets a GitHub API token from one of the supported environment variables.
|
||||||
|
def get_github_token():
|
||||||
|
for variable_name in TOKEN_ENVIRONMENT_VARIABLES:
|
||||||
|
token = os.environ.get(variable_name, '').strip()
|
||||||
|
if token:
|
||||||
|
return token
|
||||||
|
raise Exception('Missing GitHub token. Set GITHUB_TOKEN or GH_TOKEN.')
|
||||||
|
|
||||||
# Runs git with the given args and returns the stdout.
|
# Runs git with the given args and returns the stdout.
|
||||||
# Raises an error if git does not exit successfully (unless passed
|
# Raises an error if git does not exit successfully (unless passed
|
||||||
# allow_non_zero_exit_code=True).
|
# allow_non_zero_exit_code=True).
|
||||||
@@ -32,6 +47,28 @@ def run_git(*args, allow_non_zero_exit_code=False):
|
|||||||
raise Exception(f'Call to {" ".join(cmd)} exited with code {p.returncode} stderr: {p.stderr.decode("ascii")}.')
|
raise Exception(f'Call to {" ".join(cmd)} exited with code {p.returncode} stderr: {p.stderr.decode("ascii")}.')
|
||||||
return p.stdout.decode('ascii')
|
return p.stdout.decode('ascii')
|
||||||
|
|
||||||
|
# Runs the given command, streaming output to the console.
|
||||||
|
# Raises an error if the command does not exit successfully.
|
||||||
|
def run_command(*args):
|
||||||
|
cmd = list(args)
|
||||||
|
print(f'Running `{" ".join(cmd)}`.')
|
||||||
|
subprocess.run(cmd, check=True)
|
||||||
|
|
||||||
|
# Rebuilds the action and commits any changes.
|
||||||
|
def rebuild_action():
|
||||||
|
# For backports, the only source-level change vs the source branch is the new version number,
|
||||||
|
# so we just need to refresh the version embedded in `lib/`.
|
||||||
|
run_command('npm', 'ci')
|
||||||
|
run_command('npm', 'run', 'build')
|
||||||
|
|
||||||
|
run_git('add', '--all')
|
||||||
|
# `git diff --cached --quiet` exits 0 if there are no staged changes, 1 if there are.
|
||||||
|
if subprocess.run(['git', 'diff', '--cached', '--quiet']).returncode == 0:
|
||||||
|
print('Rebuild produced no changes; skipping Rebuild commit.')
|
||||||
|
else:
|
||||||
|
run_git('commit', '-m', REBUILD_COMMIT_MESSAGE)
|
||||||
|
print('Created Rebuild commit.')
|
||||||
|
|
||||||
# Returns true if the given branch exists on the origin remote
|
# Returns true if the given branch exists on the origin remote
|
||||||
def branch_exists_on_remote(branch_name):
|
def branch_exists_on_remote(branch_name):
|
||||||
return run_git('ls-remote', '--heads', ORIGIN, branch_name).strip() != ''
|
return run_git('ls-remote', '--heads', ORIGIN, branch_name).strip() != ''
|
||||||
@@ -87,9 +124,11 @@ def open_pr(
|
|||||||
body.append('Please do the following:')
|
body.append('Please do the following:')
|
||||||
if len(conflicted_files) > 0:
|
if len(conflicted_files) > 0:
|
||||||
body.append(' - [ ] Ensure `package.json` file contains the correct version.')
|
body.append(' - [ ] Ensure `package.json` file contains the correct version.')
|
||||||
body.append(' - [ ] Add commits to this branch to resolve the merge conflicts ' +
|
body.append(' - [ ] Add a commit to this branch to resolve the merge conflicts ' +
|
||||||
'in the following files:')
|
'in the following files:')
|
||||||
body.extend([f' - [ ] `{file}`' for file in conflicted_files])
|
body.extend([f' - `{file}`' for file in conflicted_files])
|
||||||
|
body.append(' - [ ] Rebuild the Action locally (`npm run build`) and push any changes to the ' +
|
||||||
|
f'built output in `lib` as a separate commit named exactly `{REBUILD_COMMIT_MESSAGE}`.')
|
||||||
body.append(' - [ ] Ensure another maintainer has reviewed the additional commits you added to this ' +
|
body.append(' - [ ] Ensure another maintainer has reviewed the additional commits you added to this ' +
|
||||||
'branch to resolve the merge conflicts.')
|
'branch to resolve the merge conflicts.')
|
||||||
body.append(' - [ ] Ensure the CHANGELOG displays the correct version and date.')
|
body.append(' - [ ] Ensure the CHANGELOG displays the correct version and date.')
|
||||||
@@ -97,10 +136,6 @@ def open_pr(
|
|||||||
body.append(f' - [ ] Check that there are not any unexpected commits being merged into the `{target_branch}` branch.')
|
body.append(f' - [ ] Check that there are not any unexpected commits being merged into the `{target_branch}` branch.')
|
||||||
body.append(' - [ ] Ensure the docs team is aware of any documentation changes that need to be released.')
|
body.append(' - [ ] Ensure the docs team is aware of any documentation changes that need to be released.')
|
||||||
|
|
||||||
if not is_primary_release:
|
|
||||||
body.append(' - [ ] Remove and re-add the "Rebuild" label to the PR to trigger just this workflow.')
|
|
||||||
body.append(' - [ ] Wait for the "Rebuild" workflow to push a commit updating the distribution files.')
|
|
||||||
|
|
||||||
body.append(' - [ ] Mark the PR as ready for review to trigger the full set of PR checks.')
|
body.append(' - [ ] Mark the PR as ready for review to trigger the full set of PR checks.')
|
||||||
body.append(' - [ ] Approve and merge this PR. Make sure `Create a merge commit` is selected rather than `Squash and merge` or `Rebase and merge`.')
|
body.append(' - [ ] Approve and merge this PR. Make sure `Create a merge commit` is selected rather than `Squash and merge` or `Rebase and merge`.')
|
||||||
|
|
||||||
@@ -109,13 +144,11 @@ def open_pr(
|
|||||||
body.append(' - [ ] Merge all backport PRs to older release branches, that will automatically be created once this PR is merged.')
|
body.append(' - [ ] Merge all backport PRs to older release branches, that will automatically be created once this PR is merged.')
|
||||||
|
|
||||||
title = f'Merge {source_branch} into {target_branch}'
|
title = f'Merge {source_branch} into {target_branch}'
|
||||||
labels = ['Rebuild'] if not is_primary_release else []
|
|
||||||
|
|
||||||
# Create the pull request
|
# Create the pull request
|
||||||
# PR checks won't be triggered on PRs created by Actions. Therefore mark the PR as draft so that
|
# PR checks won't be triggered on PRs created by Actions. Therefore mark the PR as draft so that
|
||||||
# a maintainer can take the PR out of draft, thereby triggering the PR checks.
|
# a maintainer can take the PR out of draft, thereby triggering the PR checks.
|
||||||
pr = repo.create_pull(title=title, body='\n'.join(body), head=new_branch_name, base=target_branch, draft=True)
|
pr = repo.create_pull(title=title, body='\n'.join(body), head=new_branch_name, base=target_branch, draft=True)
|
||||||
pr.add_to_labels(*labels)
|
|
||||||
print(f'Created PR #{str(pr.number)}')
|
print(f'Created PR #{str(pr.number)}')
|
||||||
|
|
||||||
# Assign the conductor
|
# Assign the conductor
|
||||||
@@ -270,12 +303,6 @@ def update_changelog(version):
|
|||||||
def main():
|
def main():
|
||||||
parser = argparse.ArgumentParser('update-release-branch.py')
|
parser = argparse.ArgumentParser('update-release-branch.py')
|
||||||
|
|
||||||
parser.add_argument(
|
|
||||||
'--github-token',
|
|
||||||
type=str,
|
|
||||||
required=True,
|
|
||||||
help='GitHub token, typically from GitHub Actions.'
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
'--repository-nwo',
|
'--repository-nwo',
|
||||||
type=str,
|
type=str,
|
||||||
@@ -313,7 +340,7 @@ def main():
|
|||||||
target_branch = args.target_branch
|
target_branch = args.target_branch
|
||||||
is_primary_release = args.is_primary_release
|
is_primary_release = args.is_primary_release
|
||||||
|
|
||||||
repo = Github(args.github_token).get_repo(args.repository_nwo)
|
repo = Github(get_github_token()).get_repo(args.repository_nwo)
|
||||||
|
|
||||||
# the target branch will be of the form releases/vN, where N is the major version number
|
# the target branch will be of the form releases/vN, where N is the major version number
|
||||||
target_branch_major_version = target_branch.strip('releases/v')
|
target_branch_major_version = target_branch.strip('releases/v')
|
||||||
@@ -380,8 +407,9 @@ def main():
|
|||||||
# releases.
|
# releases.
|
||||||
run_git('revert', vOlder_update_commits[0], '--no-edit')
|
run_git('revert', vOlder_update_commits[0], '--no-edit')
|
||||||
|
|
||||||
# Also revert the "Rebuild" commit created by Actions.
|
# Also revert the "Rebuild" commit, whether created by this script or by the
|
||||||
rebuild_commit = run_git('log', '--grep', '^Rebuild$', '--format=%H').split()[0]
|
# `Rebuild Action` workflow.
|
||||||
|
rebuild_commit = run_git('log', '--grep', f'^{REBUILD_COMMIT_MESSAGE}$', '--format=%H').split()[0]
|
||||||
print(f' Reverting {rebuild_commit}')
|
print(f' Reverting {rebuild_commit}')
|
||||||
run_git('revert', rebuild_commit, '--no-edit')
|
run_git('revert', rebuild_commit, '--no-edit')
|
||||||
|
|
||||||
@@ -396,9 +424,10 @@ def main():
|
|||||||
run_git('add', '.')
|
run_git('add', '.')
|
||||||
run_git('commit', '--no-edit')
|
run_git('commit', '--no-edit')
|
||||||
|
|
||||||
# Migrate the package version number from a vLatest version number to a vOlder version number
|
# Migrate the package version number from a vLatest version number to a vOlder version number.
|
||||||
|
# `package-lock.json` is updated as part of the subsequent rebuild step (see `rebuild_action`).
|
||||||
print(f'Setting version number to {version} in package.json')
|
print(f'Setting version number to {version} in package.json')
|
||||||
replace_version_package_json(get_current_version(), version) # We rely on the `Rebuild` workflow to update package-lock.json
|
replace_version_package_json(get_current_version(), version)
|
||||||
run_git('add', 'package.json')
|
run_git('add', 'package.json')
|
||||||
|
|
||||||
# Migrate the changelog notes from vLatest version numbers to vOlder version numbers
|
# Migrate the changelog notes from vLatest version numbers to vOlder version numbers
|
||||||
@@ -421,6 +450,13 @@ def main():
|
|||||||
run_git('add', 'CHANGELOG.md')
|
run_git('add', 'CHANGELOG.md')
|
||||||
run_git('commit', '-m', f'Update changelog for v{version}')
|
run_git('commit', '-m', f'Update changelog for v{version}')
|
||||||
|
|
||||||
|
if not is_primary_release:
|
||||||
|
if len(conflicted_files) == 0:
|
||||||
|
print('Rebuilding the Action.')
|
||||||
|
rebuild_action()
|
||||||
|
else:
|
||||||
|
print(f'Skipping automatic rebuild because the merge produced conflicts in {conflicted_files}.')
|
||||||
|
|
||||||
run_git('push', ORIGIN, new_branch_name)
|
run_git('push', ORIGIN, new_branch_name)
|
||||||
|
|
||||||
# Open a PR to update the branch
|
# Open a PR to update the branch
|
||||||
|
|||||||
+4
-4
@@ -49,10 +49,6 @@ jobs:
|
|||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
include:
|
include:
|
||||||
- os: ubuntu-latest
|
|
||||||
version: stable-v2.17.6
|
|
||||||
- os: ubuntu-latest
|
|
||||||
version: stable-v2.18.4
|
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
version: stable-v2.19.4
|
version: stable-v2.19.4
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
@@ -61,6 +57,10 @@ jobs:
|
|||||||
version: stable-v2.21.4
|
version: stable-v2.21.4
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
version: stable-v2.22.4
|
version: stable-v2.22.4
|
||||||
|
- os: ubuntu-latest
|
||||||
|
version: stable-v2.23.9
|
||||||
|
- os: ubuntu-latest
|
||||||
|
version: stable-v2.24.3
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
version: default
|
version: default
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
|
|||||||
+4
-4
@@ -49,10 +49,6 @@ jobs:
|
|||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
include:
|
include:
|
||||||
- os: ubuntu-latest
|
|
||||||
version: stable-v2.17.6
|
|
||||||
- os: ubuntu-latest
|
|
||||||
version: stable-v2.18.4
|
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
version: stable-v2.19.4
|
version: stable-v2.19.4
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
@@ -61,6 +57,10 @@ jobs:
|
|||||||
version: stable-v2.21.4
|
version: stable-v2.21.4
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
version: stable-v2.22.4
|
version: stable-v2.22.4
|
||||||
|
- os: ubuntu-latest
|
||||||
|
version: stable-v2.23.9
|
||||||
|
- os: ubuntu-latest
|
||||||
|
version: stable-v2.24.3
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
version: default
|
version: default
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
|
|||||||
+4
-4
@@ -49,10 +49,6 @@ jobs:
|
|||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
include:
|
include:
|
||||||
- os: ubuntu-latest
|
|
||||||
version: stable-v2.17.6
|
|
||||||
- os: ubuntu-latest
|
|
||||||
version: stable-v2.18.4
|
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
version: stable-v2.19.4
|
version: stable-v2.19.4
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
@@ -61,6 +57,10 @@ jobs:
|
|||||||
version: stable-v2.21.4
|
version: stable-v2.21.4
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
version: stable-v2.22.4
|
version: stable-v2.22.4
|
||||||
|
- os: ubuntu-latest
|
||||||
|
version: stable-v2.23.9
|
||||||
|
- os: ubuntu-latest
|
||||||
|
version: stable-v2.24.3
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
version: default
|
version: default
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
|
|||||||
Generated
+2
-2
@@ -60,12 +60,12 @@ jobs:
|
|||||||
setup-kotlin: 'true'
|
setup-kotlin: 'true'
|
||||||
- uses: ./../action/init
|
- uses: ./../action/init
|
||||||
with:
|
with:
|
||||||
languages: C#,java-kotlin,swift,typescript
|
languages: C#,java-kotlin,typescript
|
||||||
tools: ${{ steps.prepare-test.outputs.tools-url }}
|
tools: ${{ steps.prepare-test.outputs.tools-url }}
|
||||||
|
|
||||||
- name: 'Check languages'
|
- name: 'Check languages'
|
||||||
run: |
|
run: |
|
||||||
expected_languages="csharp,java,swift,javascript"
|
expected_languages="csharp,java,javascript"
|
||||||
actual_languages=$(jq -r '.languages | join(",")' "$RUNNER_TEMP"/config)
|
actual_languages=$(jq -r '.languages | join(",")' "$RUNNER_TEMP"/config)
|
||||||
|
|
||||||
if [ "$expected_languages" != "$actual_languages" ]; then
|
if [ "$expected_languages" != "$actual_languages" ]; then
|
||||||
|
|||||||
+15
-15
@@ -59,41 +59,41 @@ jobs:
|
|||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
include:
|
include:
|
||||||
- os: ubuntu-latest
|
|
||||||
version: stable-v2.17.6
|
|
||||||
- os: macos-latest
|
|
||||||
version: stable-v2.17.6
|
|
||||||
- os: ubuntu-latest
|
|
||||||
version: stable-v2.18.4
|
|
||||||
- os: macos-latest
|
|
||||||
version: stable-v2.18.4
|
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
version: stable-v2.19.4
|
version: stable-v2.19.4
|
||||||
- os: macos-latest
|
- os: macos-latest-xlarge
|
||||||
version: stable-v2.19.4
|
version: stable-v2.19.4
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
version: stable-v2.20.7
|
version: stable-v2.20.7
|
||||||
- os: macos-latest
|
- os: macos-latest-xlarge
|
||||||
version: stable-v2.20.7
|
version: stable-v2.20.7
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
version: stable-v2.21.4
|
version: stable-v2.21.4
|
||||||
- os: macos-latest
|
- os: macos-latest-xlarge
|
||||||
version: stable-v2.21.4
|
version: stable-v2.21.4
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
version: stable-v2.22.4
|
version: stable-v2.22.4
|
||||||
- os: macos-latest
|
- os: macos-latest-xlarge
|
||||||
version: stable-v2.22.4
|
version: stable-v2.22.4
|
||||||
|
- os: ubuntu-latest
|
||||||
|
version: stable-v2.23.9
|
||||||
|
- os: macos-latest-xlarge
|
||||||
|
version: stable-v2.23.9
|
||||||
|
- os: ubuntu-latest
|
||||||
|
version: stable-v2.24.3
|
||||||
|
- os: macos-latest-xlarge
|
||||||
|
version: stable-v2.24.3
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
version: default
|
version: default
|
||||||
- os: macos-latest
|
- os: macos-latest-xlarge
|
||||||
version: default
|
version: default
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
version: linked
|
version: linked
|
||||||
- os: macos-latest
|
- os: macos-latest-xlarge
|
||||||
version: linked
|
version: linked
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
version: nightly-latest
|
version: nightly-latest
|
||||||
- os: macos-latest
|
- os: macos-latest-xlarge
|
||||||
version: nightly-latest
|
version: nightly-latest
|
||||||
name: Multi-language repository
|
name: Multi-language repository
|
||||||
if: github.triggering_actor != 'dependabot[bot]'
|
if: github.triggering_actor != 'dependabot[bot]'
|
||||||
|
|||||||
+1
-1
@@ -59,7 +59,7 @@ jobs:
|
|||||||
use-all-platform-bundle: 'false'
|
use-all-platform-bundle: 'false'
|
||||||
setup-kotlin: 'true'
|
setup-kotlin: 'true'
|
||||||
- name: Set up Ruby
|
- name: Set up Ruby
|
||||||
uses: ruby/setup-ruby@319994f95fa847cf3fb3cd3dbe89f6dcde9f178f # v1.295.0
|
uses: ruby/setup-ruby@c4e5b1316158f92e3d49443a9d58b31d25ac0f8f # v1.306.0
|
||||||
with:
|
with:
|
||||||
ruby-version: 2.6
|
ruby-version: 2.6
|
||||||
- name: Install Code Scanning integration
|
- name: Install Code Scanning integration
|
||||||
|
|||||||
Generated
+1
-1
@@ -40,7 +40,7 @@ jobs:
|
|||||||
matrix:
|
matrix:
|
||||||
include:
|
include:
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
version: stable-v2.19.3
|
version: stable-v2.19.4
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
version: stable-v2.22.1
|
version: stable-v2.22.1
|
||||||
- os: ubuntu-latest
|
- os: ubuntu-latest
|
||||||
|
|||||||
Generated
+18
-1
@@ -71,7 +71,17 @@ jobs:
|
|||||||
id: proxy
|
id: proxy
|
||||||
uses: ./../action/start-proxy
|
uses: ./../action/start-proxy
|
||||||
with:
|
with:
|
||||||
registry_secrets: '[{ "type": "nuget_feed", "url": "https://api.nuget.org/v3/index.json" }]'
|
registry_secrets: |
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"type": "maven_repository",
|
||||||
|
"url": "https://repo.maven.apache.org/maven2/"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "maven_repository",
|
||||||
|
"url": "https://repo1.maven.org/maven2"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
|
||||||
- name: Print proxy outputs
|
- name: Print proxy outputs
|
||||||
run: |
|
run: |
|
||||||
@@ -82,5 +92,12 @@ jobs:
|
|||||||
- name: Fail if proxy outputs are not set
|
- name: Fail if proxy outputs are not set
|
||||||
if: (!steps.proxy.outputs.proxy_host) || (!steps.proxy.outputs.proxy_port) || (!steps.proxy.outputs.proxy_ca_certificate) || (!steps.proxy.outputs.proxy_urls)
|
if: (!steps.proxy.outputs.proxy_host) || (!steps.proxy.outputs.proxy_port) || (!steps.proxy.outputs.proxy_ca_certificate) || (!steps.proxy.outputs.proxy_urls)
|
||||||
run: exit 1
|
run: exit 1
|
||||||
|
|
||||||
|
- name: Fail if proxy_urls does not contain all registries
|
||||||
|
if: |
|
||||||
|
join(fromJSON(steps.proxy.outputs.proxy_urls)[*].type, ',') != 'maven_repository,maven_repository'
|
||||||
|
|| !contains(steps.proxy.outputs.proxy_urls, 'https://repo.maven.apache.org/maven2/')
|
||||||
|
|| !contains(steps.proxy.outputs.proxy_urls, 'https://repo1.maven.org/maven2')
|
||||||
|
run: exit 1
|
||||||
env:
|
env:
|
||||||
CODEQL_ACTION_TEST_MODE: true
|
CODEQL_ACTION_TEST_MODE: true
|
||||||
|
|||||||
Generated
+1
-1
@@ -39,7 +39,7 @@ jobs:
|
|||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
include:
|
include:
|
||||||
- os: macos-latest
|
- os: macos-latest-xlarge
|
||||||
version: nightly-latest
|
version: nightly-latest
|
||||||
name: Swift analysis using autobuild
|
name: Swift analysis using autobuild
|
||||||
if: github.triggering_actor != 'dependabot[bot]'
|
if: github.triggering_actor != 'dependabot[bot]'
|
||||||
|
|||||||
@@ -77,7 +77,7 @@ jobs:
|
|||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
os: [ubuntu-22.04,ubuntu-24.04,windows-2022,windows-2025,macos-14,macos-15]
|
os: [ubuntu-22.04,ubuntu-24.04,windows-2022,windows-2025,macos-14-xlarge,macos-15-xlarge]
|
||||||
tools: ${{ fromJson(needs.check-codeql-versions.outputs.versions) }}
|
tools: ${{ fromJson(needs.check-codeql-versions.outputs.versions) }}
|
||||||
runs-on: ${{ matrix.os }}
|
runs-on: ${{ matrix.os }}
|
||||||
|
|
||||||
|
|||||||
@@ -6,13 +6,6 @@ env:
|
|||||||
# Diff informed queries add an additional query filter which is not yet
|
# Diff informed queries add an additional query filter which is not yet
|
||||||
# taken into account by these tests.
|
# taken into account by these tests.
|
||||||
CODEQL_ACTION_DIFF_INFORMED_QUERIES: false
|
CODEQL_ACTION_DIFF_INFORMED_QUERIES: false
|
||||||
# Specify overlay enablement manually to ensure stability around the exclude-from-incremental
|
|
||||||
# query filter. Here we only enable for the default code scanning suite.
|
|
||||||
CODEQL_ACTION_OVERLAY_ANALYSIS: true
|
|
||||||
CODEQL_ACTION_OVERLAY_ANALYSIS_JAVASCRIPT: false
|
|
||||||
CODEQL_ACTION_OVERLAY_ANALYSIS_CODE_SCANNING_JAVASCRIPT: true
|
|
||||||
CODEQL_ACTION_OVERLAY_ANALYSIS_STATUS_CHECK: false
|
|
||||||
CODEQL_ACTION_OVERLAY_ANALYSIS_SKIP_RESOURCE_CHECKS: true
|
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
@@ -79,33 +72,13 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
version: ${{ matrix.version }}
|
version: ${{ matrix.version }}
|
||||||
|
|
||||||
# On PRs, overlay analysis may change the config that is passed to the CLI.
|
- name: Empty file
|
||||||
# Therefore, we have two variants of the following test, one for PRs and one for other events.
|
|
||||||
- name: Empty file (non-PR)
|
|
||||||
if: github.event_name != 'pull_request'
|
|
||||||
uses: ./../action/.github/actions/check-codescanning-config
|
uses: ./../action/.github/actions/check-codescanning-config
|
||||||
with:
|
with:
|
||||||
expected-config-file-contents: "{}"
|
expected-config-file-contents: "{}"
|
||||||
languages: javascript
|
languages: javascript
|
||||||
tools: ${{ steps.prepare-test.outputs.tools-url }}
|
tools: ${{ steps.prepare-test.outputs.tools-url }}
|
||||||
|
|
||||||
- name: Empty file (PR)
|
|
||||||
if: github.event_name == 'pull_request'
|
|
||||||
uses: ./../action/.github/actions/check-codescanning-config
|
|
||||||
with:
|
|
||||||
expected-config-file-contents: |
|
|
||||||
{
|
|
||||||
"query-filters": [
|
|
||||||
{
|
|
||||||
"exclude": {
|
|
||||||
"tags": "exclude-from-incremental"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
languages: javascript
|
|
||||||
tools: ${{ steps.prepare-test.outputs.tools-url }}
|
|
||||||
|
|
||||||
- name: Packs from input
|
- name: Packs from input
|
||||||
if: success() || failure()
|
if: success() || failure()
|
||||||
uses: ./../action/.github/actions/check-codescanning-config
|
uses: ./../action/.github/actions/check-codescanning-config
|
||||||
|
|||||||
@@ -66,6 +66,7 @@ jobs:
|
|||||||
uses: ./../action/.github/actions/verify-debug-artifact-scan-completed
|
uses: ./../action/.github/actions/verify-debug-artifact-scan-completed
|
||||||
- uses: ./../action/init
|
- uses: ./../action/init
|
||||||
with:
|
with:
|
||||||
|
languages: cpp,csharp,go,java,javascript,python
|
||||||
tools: ${{ steps.prepare-test.outputs.tools-url }}
|
tools: ${{ steps.prepare-test.outputs.tools-url }}
|
||||||
debug: true
|
debug: true
|
||||||
debug-artifact-name: my-debug-artifacts
|
debug-artifact-name: my-debug-artifacts
|
||||||
|
|||||||
@@ -0,0 +1,106 @@
|
|||||||
|
# Workflow runs on main, on a release branch, and that were triggered as part of a merge group have
|
||||||
|
# already passed CI before being merged. Therefore if they fail, we should make sure that there
|
||||||
|
# wasn't a transient failure by rerunning the failed jobs once before investigating further.
|
||||||
|
name: Deflake
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_run:
|
||||||
|
types: [completed]
|
||||||
|
# Exclude workflows that have significant side effects, like publishing releases. It's OK to
|
||||||
|
# retry CodeQL analysis.
|
||||||
|
workflows:
|
||||||
|
- Check Expected Release Files
|
||||||
|
- Code-Scanning config CLI tests
|
||||||
|
- CodeQL action
|
||||||
|
- Manual Check - go
|
||||||
|
- "PR Check - All-platform bundle"
|
||||||
|
- "PR Check - Analysis kinds"
|
||||||
|
- "PR Check - Analyze: 'ref' and 'sha' from inputs"
|
||||||
|
- "PR Check - autobuild-action"
|
||||||
|
- "PR Check - Autobuild direct tracing (custom working directory)"
|
||||||
|
- "PR Check - Autobuild working directory"
|
||||||
|
- "PR Check - Build mode autobuild"
|
||||||
|
- "PR Check - Build mode manual"
|
||||||
|
- "PR Check - Build mode none"
|
||||||
|
- "PR Check - Build mode rollback"
|
||||||
|
- "PR Check - Bundle: Caching checks"
|
||||||
|
- "PR Check - Bundle: From nightly"
|
||||||
|
- "PR Check - Bundle: From toolcache"
|
||||||
|
- "PR Check - Bundle: Zstandard checks"
|
||||||
|
- "PR Check - C/C\\+\\+: autoinstalling dependencies (Linux)"
|
||||||
|
- "PR Check - C/C\\+\\+: autoinstalling dependencies is skipped (macOS)"
|
||||||
|
- "PR Check - C/C\\+\\+: disabling autoinstalling dependencies (Linux)"
|
||||||
|
- "PR Check - Clean up database cluster directory"
|
||||||
|
- "PR Check - CodeQL Bundle All"
|
||||||
|
- "PR Check - Config export"
|
||||||
|
- "PR Check - Config input"
|
||||||
|
- "PR Check - Custom source root"
|
||||||
|
- "PR Check - Debug artifact upload"
|
||||||
|
- "PR Check - Debug artifacts after failure"
|
||||||
|
- "PR Check - Diagnostic export"
|
||||||
|
- "PR Check - Export file baseline information"
|
||||||
|
- "PR Check - Extractor ram and threads options test"
|
||||||
|
- "PR Check - Go: Custom queries"
|
||||||
|
- "PR Check - Go: diagnostic when Go is changed after init step"
|
||||||
|
- "PR Check - Go: diagnostic when `file` is not installed"
|
||||||
|
- "PR Check - Go: tracing with autobuilder step"
|
||||||
|
- "PR Check - Go: tracing with custom build steps"
|
||||||
|
- "PR Check - Go: tracing with legacy workflow"
|
||||||
|
- "PR Check - Go: workaround for indirect tracing"
|
||||||
|
- "PR Check - Job run UUID added to SARIF"
|
||||||
|
- "PR Check - Language aliases"
|
||||||
|
- "PR Check - Local CodeQL bundle"
|
||||||
|
- "PR Check - Multi-language repository"
|
||||||
|
- "PR Check - Overlay database init fallback"
|
||||||
|
- "PR Check - Packaging: Action input"
|
||||||
|
- "PR Check - Packaging: Config and input"
|
||||||
|
- "PR Check - Packaging: Config and input passed to the CLI"
|
||||||
|
- "PR Check - Packaging: Config file"
|
||||||
|
- "PR Check - Packaging: Download using registries"
|
||||||
|
- "PR Check - Proxy test"
|
||||||
|
- "PR Check - Remote config file"
|
||||||
|
- "PR Check - Resolve environment"
|
||||||
|
- "PR Check - RuboCop multi-language"
|
||||||
|
- "PR Check - Ruby analysis"
|
||||||
|
- "PR Check - Rust analysis"
|
||||||
|
- "PR Check - Split workflow"
|
||||||
|
- "PR Check - Start proxy"
|
||||||
|
- "PR Check - Submit SARIF after failure"
|
||||||
|
- "PR Check - Swift analysis using a custom build command"
|
||||||
|
- "PR Check - Swift analysis using autobuild"
|
||||||
|
- "PR Check - Test different uses of `upload-sarif`"
|
||||||
|
- "PR Check - Test unsetting environment variables"
|
||||||
|
- "PR Check - Upload-sarif: ref and sha from inputs"
|
||||||
|
- "PR Check - Use a custom `checkout_path`"
|
||||||
|
- PR Checks
|
||||||
|
- Query filters tests
|
||||||
|
- Test that the workaround for python 3.12 on windows works
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
rerun-on-failure:
|
||||||
|
name: Rerun failed jobs
|
||||||
|
if: >-
|
||||||
|
github.event.workflow_run.conclusion == 'failure' &&
|
||||||
|
github.event.workflow_run.run_attempt == 1 &&
|
||||||
|
(
|
||||||
|
github.event.workflow_run.head_branch == 'main' ||
|
||||||
|
startsWith(github.event.workflow_run.head_branch, 'releases/') ||
|
||||||
|
github.event.workflow_run.event == 'merge_group'
|
||||||
|
)
|
||||||
|
runs-on: ubuntu-slim
|
||||||
|
permissions:
|
||||||
|
actions: write
|
||||||
|
steps:
|
||||||
|
- name: Rerun failed jobs in ${{ github.event.workflow_run.name }}
|
||||||
|
env:
|
||||||
|
GH_TOKEN: ${{ github.token }}
|
||||||
|
GH_REPO: ${{ github.repository }}
|
||||||
|
RUN_ID: ${{ github.event.workflow_run.id }}
|
||||||
|
RUN_NAME: ${{ github.event.workflow_run.name }}
|
||||||
|
RUN_URL: ${{ github.event.workflow_run.html_url }}
|
||||||
|
run: |
|
||||||
|
echo "Rerunning failed jobs for workflow run ${RUN_ID}"
|
||||||
|
gh run rerun "${RUN_ID}" --failed
|
||||||
|
echo "### Reran failed jobs :recycle:" >> "$GITHUB_STEP_SUMMARY"
|
||||||
|
echo "" >> "$GITHUB_STEP_SUMMARY"
|
||||||
|
echo "Workflow: [${RUN_NAME}](${RUN_URL})" >> "$GITHUB_STEP_SUMMARY"
|
||||||
@@ -48,6 +48,9 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
fetch-depth: 0 # ensure we have all tags and can push commits
|
fetch-depth: 0 # ensure we have all tags and can push commits
|
||||||
- uses: actions/setup-node@v6
|
- uses: actions/setup-node@v6
|
||||||
|
with:
|
||||||
|
node-version: 24
|
||||||
|
cache: 'npm'
|
||||||
- uses: actions/setup-python@v6
|
- uses: actions/setup-python@v6
|
||||||
with:
|
with:
|
||||||
python-version: '3.12'
|
python-version: '3.12'
|
||||||
@@ -131,7 +134,7 @@ jobs:
|
|||||||
echo "::endgroup::"
|
echo "::endgroup::"
|
||||||
|
|
||||||
- name: Generate token
|
- name: Generate token
|
||||||
uses: actions/create-github-app-token@v3.0.0
|
uses: actions/create-github-app-token@v3.2.0
|
||||||
id: app-token
|
id: app-token
|
||||||
with:
|
with:
|
||||||
app-id: ${{ vars.AUTOMATION_APP_ID }}
|
app-id: ${{ vars.AUTOMATION_APP_ID }}
|
||||||
|
|||||||
@@ -54,11 +54,7 @@ jobs:
|
|||||||
|
|
||||||
- name: Run unit tests
|
- name: Run unit tests
|
||||||
if: always()
|
if: always()
|
||||||
run: npm run test-coverage
|
run: npm test
|
||||||
|
|
||||||
- name: Check code coverage
|
|
||||||
if: always()
|
|
||||||
run: npm run coverage
|
|
||||||
|
|
||||||
- name: Lint
|
- name: Lint
|
||||||
if: always() && matrix.os != 'windows-latest'
|
if: always() && matrix.os != 'windows-latest'
|
||||||
@@ -109,10 +105,10 @@ jobs:
|
|||||||
run: npx tsx --test
|
run: npx tsx --test
|
||||||
|
|
||||||
check-node-version:
|
check-node-version:
|
||||||
if: github.triggering_actor != 'dependabot[bot]'
|
if: github.triggering_actor != 'dependabot[bot]' && startsWith(github.head_ref, 'backport-')
|
||||||
name: Check Action Node versions
|
name: Check Action Node versions for Backport
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
timeout-minutes: 45
|
timeout-minutes: 5
|
||||||
env:
|
env:
|
||||||
BASE_REF: ${{ github.base_ref }}
|
BASE_REF: ${{ github.base_ref }}
|
||||||
|
|
||||||
@@ -120,31 +116,40 @@ jobs:
|
|||||||
contents: read
|
contents: read
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v6
|
- name: Checkout repository
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
with:
|
||||||
|
fetch-depth: 1
|
||||||
|
|
||||||
- id: head-version
|
- id: head-version
|
||||||
name: Verify all Actions use the same Node version
|
name: Determine Node version for HEAD
|
||||||
run: |
|
run: |
|
||||||
NODE_VERSION=$(find . -name "action.yml" -exec yq -e '.runs.using' {} \; | grep node | sort | uniq)
|
if [[ ! -f ".nvmrc" ]]; then
|
||||||
echo "NODE_VERSION: ${NODE_VERSION}"
|
echo "::error::Cannot find .nvmrc in the HEAD commit."
|
||||||
if [[ $(echo "$NODE_VERSION" | wc -l) -gt 1 ]]; then
|
|
||||||
echo "::error::More than one node version used in 'action.yml' files."
|
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
NODE_VERSION=$(cat .nvmrc)
|
||||||
|
echo "NODE_VERSION: ${NODE_VERSION}"
|
||||||
echo "node_version=${NODE_VERSION}" >> $GITHUB_OUTPUT
|
echo "node_version=${NODE_VERSION}" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
- id: checkout-base
|
- id: checkout-base
|
||||||
name: 'Backport: Check out base ref'
|
name: 'Backport: Check out base ref'
|
||||||
if: ${{ startsWith(github.head_ref, 'backport-') }}
|
|
||||||
uses: actions/checkout@v6
|
uses: actions/checkout@v6
|
||||||
with:
|
with:
|
||||||
ref: ${{ env.BASE_REF }}
|
ref: ${{ env.BASE_REF }}
|
||||||
|
fetch-depth: 1
|
||||||
|
|
||||||
- name: 'Backport: Verify Node versions unchanged'
|
- name: 'Backport: Verify Node versions unchanged'
|
||||||
if: steps.checkout-base.outcome == 'success'
|
|
||||||
env:
|
env:
|
||||||
HEAD_VERSION: ${{ steps.head-version.outputs.node_version }}
|
HEAD_VERSION: ${{ steps.head-version.outputs.node_version }}
|
||||||
run: |
|
run: |
|
||||||
BASE_VERSION=$(find . -name "action.yml" -exec yq -e '.runs.using' {} \; | grep node | sort | uniq)
|
if [[ ! -f ".nvmrc" ]]; then
|
||||||
|
echo "::error::Cannot find .nvmrc in the base commit."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
BASE_VERSION=$(cat .nvmrc)
|
||||||
echo "HEAD_VERSION: ${HEAD_VERSION}"
|
echo "HEAD_VERSION: ${HEAD_VERSION}"
|
||||||
echo "BASE_VERSION: ${BASE_VERSION}"
|
echo "BASE_VERSION: ${BASE_VERSION}"
|
||||||
if [[ "$BASE_VERSION" != "$HEAD_VERSION" ]]; then
|
if [[ "$BASE_VERSION" != "$HEAD_VERSION" ]]; then
|
||||||
|
|||||||
@@ -136,7 +136,7 @@ jobs:
|
|||||||
|
|
||||||
- name: Generate token
|
- name: Generate token
|
||||||
if: github.event_name == 'workflow_dispatch'
|
if: github.event_name == 'workflow_dispatch'
|
||||||
uses: actions/create-github-app-token@v3.0.0
|
uses: actions/create-github-app-token@v3.2.0
|
||||||
id: app-token
|
id: app-token
|
||||||
with:
|
with:
|
||||||
app-id: ${{ vars.AUTOMATION_APP_ID }}
|
app-id: ${{ vars.AUTOMATION_APP_ID }}
|
||||||
|
|||||||
@@ -57,6 +57,17 @@ jobs:
|
|||||||
- name: Update bundle
|
- name: Update bundle
|
||||||
uses: ./.github/actions/update-bundle
|
uses: ./.github/actions/update-bundle
|
||||||
|
|
||||||
|
- name: Set up CodeQL CLI from new bundle
|
||||||
|
id: setup-codeql
|
||||||
|
uses: ./setup-codeql
|
||||||
|
with:
|
||||||
|
tools: https://github.com/github/codeql-action/releases/download/${{ github.event.release.tag_name }}/codeql-bundle-linux64.tar.gz
|
||||||
|
|
||||||
|
- name: Update built-in languages
|
||||||
|
run: npx tsx pr-checks/update-builtin-languages.ts "$CODEQL_PATH"
|
||||||
|
env:
|
||||||
|
CODEQL_PATH: ${{ steps.setup-codeql.outputs.codeql-path }}
|
||||||
|
|
||||||
- name: Bump Action minor version if new CodeQL minor version series
|
- name: Bump Action minor version if new CodeQL minor version series
|
||||||
id: bump-action-version
|
id: bump-action-version
|
||||||
run: |
|
run: |
|
||||||
|
|||||||
@@ -64,11 +64,12 @@ jobs:
|
|||||||
|
|
||||||
- name: Update current release branch
|
- name: Update current release branch
|
||||||
if: github.event_name == 'workflow_dispatch'
|
if: github.event_name == 'workflow_dispatch'
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
run: |
|
run: |
|
||||||
echo SOURCE_BRANCH=${REF_NAME}
|
echo SOURCE_BRANCH=${REF_NAME}
|
||||||
echo TARGET_BRANCH=releases/${MAJOR_VERSION}
|
echo TARGET_BRANCH=releases/${MAJOR_VERSION}
|
||||||
python .github/update-release-branch.py \
|
python .github/update-release-branch.py \
|
||||||
--github-token ${{ secrets.GITHUB_TOKEN }} \
|
|
||||||
--repository-nwo ${{ github.repository }} \
|
--repository-nwo ${{ github.repository }} \
|
||||||
--source-branch '${{ env.REF_NAME }}' \
|
--source-branch '${{ env.REF_NAME }}' \
|
||||||
--target-branch 'releases/${{ env.MAJOR_VERSION }}' \
|
--target-branch 'releases/${{ env.MAJOR_VERSION }}' \
|
||||||
@@ -93,7 +94,7 @@ jobs:
|
|||||||
pull-requests: write # needed to create pull request
|
pull-requests: write # needed to create pull request
|
||||||
steps:
|
steps:
|
||||||
- name: Generate token
|
- name: Generate token
|
||||||
uses: actions/create-github-app-token@v3.0.0
|
uses: actions/create-github-app-token@v3.2.0
|
||||||
id: app-token
|
id: app-token
|
||||||
with:
|
with:
|
||||||
app-id: ${{ vars.AUTOMATION_APP_ID }}
|
app-id: ${{ vars.AUTOMATION_APP_ID }}
|
||||||
@@ -107,11 +108,12 @@ jobs:
|
|||||||
- uses: ./.github/actions/release-initialise
|
- uses: ./.github/actions/release-initialise
|
||||||
|
|
||||||
- name: Update older release branch
|
- name: Update older release branch
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
run: |
|
run: |
|
||||||
echo SOURCE_BRANCH=${SOURCE_BRANCH}
|
echo SOURCE_BRANCH=${SOURCE_BRANCH}
|
||||||
echo TARGET_BRANCH=${TARGET_BRANCH}
|
echo TARGET_BRANCH=${TARGET_BRANCH}
|
||||||
python .github/update-release-branch.py \
|
python .github/update-release-branch.py \
|
||||||
--github-token ${{ secrets.GITHUB_TOKEN }} \
|
|
||||||
--repository-nwo ${{ github.repository }} \
|
--repository-nwo ${{ github.repository }} \
|
||||||
--source-branch ${SOURCE_BRANCH} \
|
--source-branch ${SOURCE_BRANCH} \
|
||||||
--target-branch ${TARGET_BRANCH} \
|
--target-branch ${TARGET_BRANCH} \
|
||||||
|
|||||||
+2
-2
@@ -2,8 +2,6 @@
|
|||||||
node_modules/
|
node_modules/
|
||||||
# Build output for tests
|
# Build output for tests
|
||||||
build/
|
build/
|
||||||
# Code coverage information
|
|
||||||
coverage/
|
|
||||||
# Java build files
|
# Java build files
|
||||||
.gradle/
|
.gradle/
|
||||||
*.class
|
*.class
|
||||||
@@ -13,3 +11,5 @@ coverage/
|
|||||||
eslint.sarif
|
eslint.sarif
|
||||||
# for local incremental compilation
|
# for local incremental compilation
|
||||||
tsconfig.tsbuildinfo
|
tsconfig.tsbuildinfo
|
||||||
|
# esbuild metadata file
|
||||||
|
meta.json
|
||||||
|
|||||||
Vendored
+1
-1
@@ -19,7 +19,7 @@
|
|||||||
"scope": "javascript, typescript",
|
"scope": "javascript, typescript",
|
||||||
"prefix": "testMacro",
|
"prefix": "testMacro",
|
||||||
"body": [
|
"body": [
|
||||||
"const ${1:nameMacro} = test.macro({",
|
"const ${1:nameMacro} = makeMacro({",
|
||||||
" exec: async (t: ExecutionContext<unknown>) => {},",
|
" exec: async (t: ExecutionContext<unknown>) => {},",
|
||||||
"",
|
"",
|
||||||
" title: (providedTitle = \"\") => `${2:common title} - \\${providedTitle}`,",
|
" title: (providedTitle = \"\") => `${2:common title} - \\${providedTitle}`,",
|
||||||
|
|||||||
+29
-1
@@ -4,7 +4,35 @@ See the [releases page](https://github.com/github/codeql-action/releases) for th
|
|||||||
|
|
||||||
## [UNRELEASED]
|
## [UNRELEASED]
|
||||||
|
|
||||||
No user facing changes.
|
- _Breaking change_: Bump the minimum required CodeQL bundle version to 2.19.4. [#3894](https://github.com/github/codeql-action/pull/3894)
|
||||||
|
- Add support for SHA-256 Git object IDs. [#3893](https://github.com/github/codeql-action/pull/3893)
|
||||||
|
|
||||||
|
## 4.35.5 - 15 May 2026
|
||||||
|
|
||||||
|
- We have improved how the JavaScript bundles for the CodeQL Action are generated to avoid duplication across bundles and reduce the size of the repository by around 70%. This should have no effect on the runtime behaviour of the CodeQL Action. [#3899](https://github.com/github/codeql-action/pull/3899)
|
||||||
|
- For performance and accuracy reasons, [improved incremental analysis](https://github.com/github/roadmap/issues/1158) will now only be enabled on a pull request when diff-informed analysis is also enabled for that run. If diff-informed analysis is unavailable (for example, because the PR diff ranges could not be computed), the action will fall back to a full analysis. [#3791](https://github.com/github/codeql-action/pull/3791)
|
||||||
|
- If multiple inputs are provided for the GitHub-internal `analysis-kinds` input, only `code-scanning` will be enabled. The `analysis-kinds` input is experimental, for GitHub-internal use only, and may change without notice at any time. [#3892](https://github.com/github/codeql-action/pull/3892)
|
||||||
|
- Added an experimental change which, when running a Code Scanning analysis for a PR with [improved incremental analysis](https://github.com/github/roadmap/issues/1158) enabled, prefers CodeQL CLI versions that have a cached overlay-base database for the configured languages. This speeds up analysis for a repository when there is not yet a cached overlay-base database for the latest CLI version. We expect to roll this change out to everyone in May. [#3880](https://github.com/github/codeql-action/pull/3880)
|
||||||
|
|
||||||
|
## 4.35.4 - 07 May 2026
|
||||||
|
|
||||||
|
- Update default CodeQL bundle version to [2.25.4](https://github.com/github/codeql-action/releases/tag/codeql-bundle-v2.25.4). [#3881](https://github.com/github/codeql-action/pull/3881)
|
||||||
|
|
||||||
|
## 4.35.3 - 01 May 2026
|
||||||
|
|
||||||
|
- _Upcoming breaking change_: Add a deprecation warning for customers using CodeQL version 2.19.3 and earlier. These versions of CodeQL were discontinued on 9 April 2026 alongside GitHub Enterprise Server 3.15, and will be unsupported by the next minor release of the CodeQL Action. [#3837](https://github.com/github/codeql-action/pull/3837)
|
||||||
|
- Configurations for private registries that use Cloudsmith or GCP OIDC are now accepted. [#3850](https://github.com/github/codeql-action/pull/3850)
|
||||||
|
- Best-effort connection tests for private registries now use `GET` requests instead of `HEAD` for better compatibility with various registry implementations. For NuGet feeds, the test is now always performed against the service index. [#3853](https://github.com/github/codeql-action/pull/3853)
|
||||||
|
- Fixed a bug where two diagnostics produced within the same millisecond could overwrite each other on disk, causing one of them to be lost. [#3852](https://github.com/github/codeql-action/pull/3852)
|
||||||
|
- Update default CodeQL bundle version to [2.25.3](https://github.com/github/codeql-action/releases/tag/codeql-bundle-v2.25.3). [#3865](https://github.com/github/codeql-action/pull/3865)
|
||||||
|
|
||||||
|
## 4.35.2 - 15 Apr 2026
|
||||||
|
|
||||||
|
- The undocumented TRAP cache cleanup feature that could be enabled using the `CODEQL_ACTION_CLEANUP_TRAP_CACHES` environment variable is deprecated and will be removed in May 2026. If you are affected by this, we recommend disabling TRAP caching by passing the `trap-caching: false` input to the `init` Action. [#3795](https://github.com/github/codeql-action/pull/3795)
|
||||||
|
- The Git version 2.36.0 requirement for improved incremental analysis now only applies to repositories that contain submodules. [#3789](https://github.com/github/codeql-action/pull/3789)
|
||||||
|
- Python analysis on GHES no longer extracts the standard library, relying instead on models of the standard library. This should result in significantly faster extraction and analysis times, while the effect on alerts should be minimal. [#3794](https://github.com/github/codeql-action/pull/3794)
|
||||||
|
- Fixed a bug in the validation of OIDC configurations for private registries that was added in CodeQL Action 4.33.0 / 3.33.0. [#3807](https://github.com/github/codeql-action/pull/3807)
|
||||||
|
- Update default CodeQL bundle version to [2.25.2](https://github.com/github/codeql-action/releases/tag/codeql-bundle-v2.25.2). [#3823](https://github.com/github/codeql-action/pull/3823)
|
||||||
|
|
||||||
## 4.35.1 - 27 Mar 2026
|
## 4.35.1 - 27 Mar 2026
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -71,7 +71,7 @@ Once the mergeback and backport pull request have been merged, the release is co
|
|||||||
|
|
||||||
Since the `codeql-action` runs most of its testing through individual Actions workflows, there are over two hundred required jobs that need to pass in order for a PR to turn green. It would be too tedious to maintain that list manually. You can regenerate the set of required checks automatically by running the [sync-checks.ts](pr-checks/sync-checks.ts) script:
|
Since the `codeql-action` runs most of its testing through individual Actions workflows, there are over two hundred required jobs that need to pass in order for a PR to turn green. It would be too tedious to maintain that list manually. You can regenerate the set of required checks automatically by running the [sync-checks.ts](pr-checks/sync-checks.ts) script:
|
||||||
|
|
||||||
- At a minimum, you must provide an argument for the `--token` input. For example, `--token "$(gh auth token)"` to use the same token that `gh` uses. If no token is provided or the token has insufficient permissions, the script will fail.
|
- At a minimum, you must provide a token with permissions to update branch protection rules. For example, `gh auth token | pr-checks/sync-checks.ts --token-stdin` uses the same token that `gh` uses. You can also set the `GH_TOKEN` or `GITHUB_TOKEN` environment variable. If no token is provided or the token has insufficient permissions, the script will fail.
|
||||||
- By default, the script performs a dry run and outputs information about the changes it would make to the branch protection rules. To actually apply the changes, specify the `--apply` flag.
|
- By default, the script performs a dry run and outputs information about the changes it would make to the branch protection rules. To actually apply the changes, specify the `--apply` flag.
|
||||||
- If you run the script without any other arguments, it will retrieve the set of workflows that ran for the latest commit on `main`.
|
- If you run the script without any other arguments, it will retrieve the set of workflows that ran for the latest commit on `main`.
|
||||||
- You can specify a different git ref with the `--ref` input. You will likely want to use this if you have a PR that removes or adds PR checks. For example, `--ref "some/branch/name"` to use the HEAD of the `some/branch/name` branch.
|
- You can specify a different git ref with the `--ref` input. You will likely want to use this if you have a PR that removes or adds PR checks. For example, `--ref "some/branch/name"` to use the HEAD of the `some/branch/name` branch.
|
||||||
|
|||||||
@@ -72,13 +72,12 @@ We typically release new minor versions of the CodeQL Action and Bundle when a n
|
|||||||
|
|
||||||
| Minimum CodeQL Action | Minimum CodeQL Bundle Version | GitHub Environment | Notes |
|
| Minimum CodeQL Action | Minimum CodeQL Bundle Version | GitHub Environment | Notes |
|
||||||
|-----------------------|-------------------------------|--------------------|-------|
|
|-----------------------|-------------------------------|--------------------|-------|
|
||||||
|
| `v4.33.0` | `2.24.3` | Enterprise Server 3.21 | |
|
||||||
| `v4.31.10` | `2.23.9` | Enterprise Server 3.20 | |
|
| `v4.31.10` | `2.23.9` | Enterprise Server 3.20 | |
|
||||||
| `v3.29.11` | `2.22.4` | Enterprise Server 3.19 | |
|
| `v3.29.11` | `2.22.4` | Enterprise Server 3.19 | |
|
||||||
| `v3.28.21` | `2.21.3` | Enterprise Server 3.18 | |
|
| `v3.28.21` | `2.21.3` | Enterprise Server 3.18 | |
|
||||||
| `v3.28.12` | `2.20.7` | Enterprise Server 3.17 | |
|
| `v3.28.12` | `2.20.7` | Enterprise Server 3.17 | |
|
||||||
| `v3.28.6` | `2.20.3` | Enterprise Server 3.16 | |
|
| `v3.28.6` | `2.20.3` | Enterprise Server 3.16 | |
|
||||||
| `v3.28.6` | `2.20.3` | Enterprise Server 3.15 | |
|
|
||||||
| `v3.28.6` | `2.20.3` | Enterprise Server 3.14 | |
|
|
||||||
|
|
||||||
See the full list of GHES release and deprecation dates at [GitHub Enterprise Server releases](https://docs.github.com/en/enterprise-server/admin/all-releases#releases-of-github-enterprise-server).
|
See the full list of GHES release and deprecation dates at [GitHub Enterprise Server releases](https://docs.github.com/en/enterprise-server/admin/all-releases#releases-of-github-enterprise-server).
|
||||||
|
|
||||||
|
|||||||
+2
-2
@@ -95,5 +95,5 @@ outputs:
|
|||||||
description: The ID of the uploaded SARIF file.
|
description: The ID of the uploaded SARIF file.
|
||||||
runs:
|
runs:
|
||||||
using: node24
|
using: node24
|
||||||
main: "../lib/analyze-action.js"
|
main: "../lib/analyze-entry.js"
|
||||||
post: "../lib/analyze-action-post.js"
|
post: "../lib/analyze-post-entry.js"
|
||||||
|
|||||||
@@ -16,4 +16,4 @@ inputs:
|
|||||||
required: false
|
required: false
|
||||||
runs:
|
runs:
|
||||||
using: node24
|
using: node24
|
||||||
main: '../lib/autobuild-action.js'
|
main: '../lib/autobuild-entry.js'
|
||||||
|
|||||||
@@ -1,9 +1,10 @@
|
|||||||
import { copyFile, rm } from "node:fs/promises";
|
import { copyFile, readFile, rm, writeFile } from "node:fs/promises";
|
||||||
import { dirname, join } from "node:path";
|
import { basename, dirname, join } from "node:path";
|
||||||
import { fileURLToPath } from "node:url";
|
import { fileURLToPath } from "node:url";
|
||||||
|
|
||||||
import * as esbuild from "esbuild";
|
import * as esbuild from "esbuild";
|
||||||
import { globSync } from "glob";
|
import { globSync } from "glob";
|
||||||
|
import * as yaml from "js-yaml";
|
||||||
|
|
||||||
import pkg from "./package.json" with { type: "json" };
|
import pkg from "./package.json" with { type: "json" };
|
||||||
|
|
||||||
@@ -27,6 +28,70 @@ const cleanPlugin = {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/** A plugin that checks that the Node versions in all `action.yml` files are the same. */
|
||||||
|
const checkNodeVersionsPlugin = {
|
||||||
|
name: "check-node-versions",
|
||||||
|
setup(build) {
|
||||||
|
build.onStart(async () => {
|
||||||
|
// Find all the `action.yml` files. We don't care about the stub in the repository root,
|
||||||
|
// since that is a `composite` action.
|
||||||
|
const actionSpecifications = globSync("*/action.yml");
|
||||||
|
|
||||||
|
// Track the Node versions we find for each file.
|
||||||
|
const nodeVersions = {};
|
||||||
|
|
||||||
|
// We will store the first Node version we find and use it to compare against the others.
|
||||||
|
// If there's any disagreement, we set `versionMismatch` to `true` and throw an error
|
||||||
|
// that includes all the discovered Node versions at the end.
|
||||||
|
let nodeVersion = undefined;
|
||||||
|
let versionMismatch = false;
|
||||||
|
|
||||||
|
for (const actionSpecification of actionSpecifications) {
|
||||||
|
// Read the contents of the action.yml file.
|
||||||
|
const contents = await readFile(actionSpecification, "utf-8");
|
||||||
|
const specification = yaml.load(contents);
|
||||||
|
|
||||||
|
// Find the `runs.using` value in the specification.
|
||||||
|
const using = specification.runs.using;
|
||||||
|
if (using === undefined || using === null) {
|
||||||
|
throw new Error(
|
||||||
|
`Couldn't find 'runs.using' in ${actionSpecification}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof using !== "string" || !using.startsWith("node")) {
|
||||||
|
throw new Error(
|
||||||
|
`Expected 'runs.using' to be a string starting with 'node' in ${actionSpecification}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (nodeVersion === undefined) {
|
||||||
|
// First one we found: set it as the baseline.
|
||||||
|
nodeVersion = using;
|
||||||
|
} else if (nodeVersion !== using) {
|
||||||
|
// Disagreement: set `versionMismatch` to indicate that we should throw an error later.
|
||||||
|
versionMismatch = true;
|
||||||
|
}
|
||||||
|
nodeVersions[actionSpecification] = using;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Throw an error if there was a version mismatch.
|
||||||
|
if (versionMismatch) {
|
||||||
|
throw new Error(
|
||||||
|
`More than one node version used in 'action.yml' files: ${JSON.stringify(nodeVersions)}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Write the node version to `.nvmrc`.
|
||||||
|
await writeFile(
|
||||||
|
join(__dirname, ".nvmrc"),
|
||||||
|
nodeVersion.substring("node".length) + "\n",
|
||||||
|
"utf-8",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Copy defaults.json to the output directory since other projects depend on it.
|
* Copy defaults.json to the output directory since other projects depend on it.
|
||||||
*
|
*
|
||||||
@@ -62,19 +127,167 @@ const onEndPlugin = {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/** The name of the virtual `entry-points` module. */
|
||||||
|
const SHARED_ENTRYPOINT = "entry-points";
|
||||||
|
|
||||||
|
/** The property name under which `upload-lib`'s namespace is exposed in `entry-points`. */
|
||||||
|
const UPLOAD_LIB_EXPORT = "uploadLib";
|
||||||
|
|
||||||
|
/** The relative source path of the `upload-lib` module that we re-export from `entry-points`. */
|
||||||
|
const UPLOAD_LIB_SRC = "./src/upload-lib";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This plugin finds all source files that contain Action entry points. It then generates the
|
||||||
|
* virtual `entry-points` module which imports all identified files, and re-exports their
|
||||||
|
* `runWrapper` functions with suitable aliases.
|
||||||
|
*
|
||||||
|
* The virtual module additionally re-exports `upload-lib` under the `uploadLib` namespace so that
|
||||||
|
* external consumers can access it via the small `lib/upload-lib.js` stub emitted below.
|
||||||
|
*
|
||||||
|
* A tiny stub file is emitted for each Action entrypoint, and one for `upload-lib`. Each stub
|
||||||
|
* imports the shared bundle and calls/re-exports from the respective entry point.
|
||||||
|
*
|
||||||
|
* @type {esbuild.Plugin}
|
||||||
|
*/
|
||||||
|
const entryPointsPlugin = {
|
||||||
|
name: "entry-points",
|
||||||
|
setup(build) {
|
||||||
|
const namespace = "actions";
|
||||||
|
const actions = [];
|
||||||
|
|
||||||
|
const toPascal = (s) =>
|
||||||
|
s.replace(/(^|-)([a-z0-9])/gi, (_, __, c) => c.toUpperCase());
|
||||||
|
|
||||||
|
// Find the source files containing Action entry points.
|
||||||
|
build.onStart(() => {
|
||||||
|
const actionFiles = globSync("src/*-action{,-post}.ts");
|
||||||
|
for (const actionFile of actionFiles) {
|
||||||
|
const match = basename(actionFile).match(/(.*)-action(-post)?/);
|
||||||
|
|
||||||
|
if (match.length < 2) {
|
||||||
|
throw new Error(`'${actionFile}' didn't match expected pattern.`);
|
||||||
|
}
|
||||||
|
|
||||||
|
const actionName = match[1];
|
||||||
|
const isPost = match[2] !== undefined;
|
||||||
|
|
||||||
|
actions.push({
|
||||||
|
path: actionFile,
|
||||||
|
name: actionName,
|
||||||
|
isPost,
|
||||||
|
pascalCaseName: `${toPascal(actionName)}${isPost ? "Post" : ""}Action`,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Resolve the virtual `entry-points` file and set the corresponding namespace.
|
||||||
|
// Ideally, we'd `RegExp.escape` the entrypoint here, but that API isn't supported in Node 20.
|
||||||
|
// Since we're dealing with a hardcoded string, this isn't too much of a problem.
|
||||||
|
build.onResolve({ filter: new RegExp(`^${SHARED_ENTRYPOINT}$`) }, () => {
|
||||||
|
return { path: SHARED_ENTRYPOINT, namespace };
|
||||||
|
});
|
||||||
|
|
||||||
|
// Generate the virtual `entry-points` file based on the Actions we discovered.
|
||||||
|
// Restrict using the namespace. The path filter does not need to discriminate any further.
|
||||||
|
build.onLoad({ filter: /.*/, namespace }, async () => {
|
||||||
|
const wrapperTemplatePath = "entry-wrapper.js.tpl";
|
||||||
|
const wrapperTemplate = await readFile(
|
||||||
|
join(SRC_DIR, wrapperTemplatePath),
|
||||||
|
"utf-8",
|
||||||
|
);
|
||||||
|
|
||||||
|
const actionsSorted = actions.sort((a, b) =>
|
||||||
|
a.name.localeCompare(b.name),
|
||||||
|
);
|
||||||
|
const imports = actionsSorted
|
||||||
|
.map(
|
||||||
|
(action) =>
|
||||||
|
`import * as ${action.pascalCaseName} from "./src/${basename(action.path)}";`,
|
||||||
|
)
|
||||||
|
.join("\n");
|
||||||
|
const wrappers = actionsSorted
|
||||||
|
.map((action) =>
|
||||||
|
wrapperTemplate.replaceAll("__ACTION__", action.pascalCaseName),
|
||||||
|
)
|
||||||
|
.join("\n\n");
|
||||||
|
|
||||||
|
// Also re-export the `upload-lib` namespace so that external consumers can reach it
|
||||||
|
// via the `lib/upload-lib.js` stub without us having to bundle a second copy.
|
||||||
|
const uploadLibReExport = `export * as ${UPLOAD_LIB_EXPORT} from "${UPLOAD_LIB_SRC}";`;
|
||||||
|
|
||||||
|
return {
|
||||||
|
contents: `"use strict";\n${imports}\n\n${uploadLibReExport}\n\n${wrappers}\n`,
|
||||||
|
resolveDir: ".",
|
||||||
|
loader: "ts",
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
// Emit entry point stubs for each Action using the entry template.
|
||||||
|
build.onEnd(async () => {
|
||||||
|
const makeHeader = (templatePath, sourceFile) =>
|
||||||
|
`// Automatically generated from '${templatePath}' for 'src/${basename(sourceFile)}'.\n\n`;
|
||||||
|
|
||||||
|
// Read the entry point template.
|
||||||
|
const actionTemplatePath = "action-entry.js.tpl";
|
||||||
|
const actionTemplate = await readFile(
|
||||||
|
join(SRC_DIR, actionTemplatePath),
|
||||||
|
"utf-8",
|
||||||
|
);
|
||||||
|
|
||||||
|
// Write entry point stubs for each Action.
|
||||||
|
for (const action of actions) {
|
||||||
|
await writeFile(
|
||||||
|
join(
|
||||||
|
OUT_DIR,
|
||||||
|
`${action.name}${action.isPost ? "-post" : ""}-entry.js`,
|
||||||
|
),
|
||||||
|
makeHeader(actionTemplatePath, action.path) +
|
||||||
|
actionTemplate.replaceAll("__ACTION__", action.pascalCaseName),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Write a small stub for `upload-lib` that re-exports it from the shared bundle.
|
||||||
|
// External callers (e.g. internal testing environments) `require("./lib/upload-lib")`
|
||||||
|
// and expect the same shape as before, so we expose the namespace as `module.exports`.
|
||||||
|
const uploadLibStubTemplatePath = "upload-lib-stub.js.tpl";
|
||||||
|
const uploadLibStubTemplate = await readFile(
|
||||||
|
join(SRC_DIR, uploadLibStubTemplatePath),
|
||||||
|
"utf-8",
|
||||||
|
);
|
||||||
|
await writeFile(
|
||||||
|
join(OUT_DIR, "upload-lib.js"),
|
||||||
|
makeHeader(uploadLibStubTemplatePath, `${UPLOAD_LIB_SRC}.ts`) +
|
||||||
|
uploadLibStubTemplate.replaceAll(
|
||||||
|
"__UPLOAD_LIB_EXPORT__",
|
||||||
|
UPLOAD_LIB_EXPORT,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
const context = await esbuild.context({
|
const context = await esbuild.context({
|
||||||
// Include upload-lib.ts as an entry point for use in testing environments.
|
entryPoints: [{ in: SHARED_ENTRYPOINT, out: SHARED_ENTRYPOINT }],
|
||||||
entryPoints: globSync([`${SRC_DIR}/*-action.ts`, `${SRC_DIR}/*-action-post.ts`, "src/upload-lib.ts"]),
|
|
||||||
bundle: true,
|
bundle: true,
|
||||||
format: "cjs",
|
format: "cjs",
|
||||||
outdir: OUT_DIR,
|
outdir: OUT_DIR,
|
||||||
platform: "node",
|
platform: "node",
|
||||||
plugins: [cleanPlugin, copyDefaultsPlugin, onEndPlugin],
|
external: ["./entry-points"],
|
||||||
|
plugins: [
|
||||||
|
cleanPlugin,
|
||||||
|
checkNodeVersionsPlugin,
|
||||||
|
copyDefaultsPlugin,
|
||||||
|
entryPointsPlugin,
|
||||||
|
onEndPlugin,
|
||||||
|
],
|
||||||
target: ["node20"],
|
target: ["node20"],
|
||||||
define: {
|
define: {
|
||||||
__CODEQL_ACTION_VERSION__: JSON.stringify(pkg.version),
|
__CODEQL_ACTION_VERSION__: JSON.stringify(pkg.version),
|
||||||
},
|
},
|
||||||
|
metafile: true,
|
||||||
});
|
});
|
||||||
|
|
||||||
await context.rebuild();
|
const result = await context.rebuild();
|
||||||
|
await writeFile(join(__dirname, "meta.json"), JSON.stringify(result.metafile));
|
||||||
|
|
||||||
await context.dispose();
|
await context.dispose();
|
||||||
|
|||||||
+2
-2
@@ -171,5 +171,5 @@ outputs:
|
|||||||
description: The version of the CodeQL binary used for analysis
|
description: The version of the CodeQL binary used for analysis
|
||||||
runs:
|
runs:
|
||||||
using: node24
|
using: node24
|
||||||
main: '../lib/init-action.js'
|
main: '../lib/init-entry.js'
|
||||||
post: '../lib/init-action-post.js'
|
post: '../lib/init-post-entry.js'
|
||||||
|
|||||||
Generated
-163791
File diff suppressed because one or more lines are too long
Generated
-113693
File diff suppressed because one or more lines are too long
Generated
+6
@@ -0,0 +1,6 @@
|
|||||||
|
// Automatically generated from 'action-entry.js.tpl' for 'src/analyze-action.ts'.
|
||||||
|
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
const import_entry_points = require("./entry-points");
|
||||||
|
void (0, import_entry_points.runAnalyzeAction)();
|
||||||
Generated
+6
@@ -0,0 +1,6 @@
|
|||||||
|
// Automatically generated from 'action-entry.js.tpl' for 'src/analyze-action-post.ts'.
|
||||||
|
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
const import_entry_points = require("./entry-points");
|
||||||
|
void (0, import_entry_points.runAnalyzePostAction)();
|
||||||
Generated
-106089
File diff suppressed because one or more lines are too long
Generated
+6
@@ -0,0 +1,6 @@
|
|||||||
|
// Automatically generated from 'action-entry.js.tpl' for 'src/autobuild-action.ts'.
|
||||||
|
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
const import_entry_points = require("./entry-points");
|
||||||
|
void (0, import_entry_points.runAutobuildAction)();
|
||||||
+4
-4
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"bundleVersion": "codeql-bundle-v2.25.1",
|
"bundleVersion": "codeql-bundle-v2.25.4",
|
||||||
"cliVersion": "2.25.1",
|
"cliVersion": "2.25.4",
|
||||||
"priorBundleVersion": "codeql-bundle-v2.24.3",
|
"priorBundleVersion": "codeql-bundle-v2.25.3",
|
||||||
"priorCliVersion": "2.24.3"
|
"priorCliVersion": "2.25.3"
|
||||||
}
|
}
|
||||||
|
|||||||
+71294
-81233
File diff suppressed because one or more lines are too long
Generated
-110681
File diff suppressed because one or more lines are too long
Generated
+6
@@ -0,0 +1,6 @@
|
|||||||
|
// Automatically generated from 'action-entry.js.tpl' for 'src/init-action.ts'.
|
||||||
|
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
const import_entry_points = require("./entry-points");
|
||||||
|
void (0, import_entry_points.runInitAction)();
|
||||||
Generated
+6
@@ -0,0 +1,6 @@
|
|||||||
|
// Automatically generated from 'action-entry.js.tpl' for 'src/init-action-post.ts'.
|
||||||
|
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
const import_entry_points = require("./entry-points");
|
||||||
|
void (0, import_entry_points.runInitPostAction)();
|
||||||
Generated
-105652
File diff suppressed because one or more lines are too long
Generated
+6
@@ -0,0 +1,6 @@
|
|||||||
|
// Automatically generated from 'action-entry.js.tpl' for 'src/resolve-environment-action.ts'.
|
||||||
|
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
const import_entry_points = require("./entry-points");
|
||||||
|
void (0, import_entry_points.runResolveEnvironmentAction)();
|
||||||
Generated
-107159
File diff suppressed because one or more lines are too long
Generated
+6
@@ -0,0 +1,6 @@
|
|||||||
|
// Automatically generated from 'action-entry.js.tpl' for 'src/setup-codeql-action.ts'.
|
||||||
|
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
const import_entry_points = require("./entry-points");
|
||||||
|
void (0, import_entry_points.runSetupCodeqlAction)();
|
||||||
Generated
-162618
File diff suppressed because one or more lines are too long
Generated
-122864
File diff suppressed because one or more lines are too long
Generated
+6
@@ -0,0 +1,6 @@
|
|||||||
|
// Automatically generated from 'action-entry.js.tpl' for 'src/start-proxy-action.ts'.
|
||||||
|
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
const import_entry_points = require("./entry-points");
|
||||||
|
void (0, import_entry_points.runStartProxyAction)();
|
||||||
Generated
+6
@@ -0,0 +1,6 @@
|
|||||||
|
// Automatically generated from 'action-entry.js.tpl' for 'src/start-proxy-action-post.ts'.
|
||||||
|
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
const import_entry_points = require("./entry-points");
|
||||||
|
void (0, import_entry_points.runStartProxyPostAction)();
|
||||||
Generated
+3
-111368
File diff suppressed because one or more lines are too long
Generated
-162643
File diff suppressed because one or more lines are too long
Generated
-112051
File diff suppressed because one or more lines are too long
Generated
+6
@@ -0,0 +1,6 @@
|
|||||||
|
// Automatically generated from 'action-entry.js.tpl' for 'src/upload-sarif-action.ts'.
|
||||||
|
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
const import_entry_points = require("./entry-points");
|
||||||
|
void (0, import_entry_points.runUploadSarifAction)();
|
||||||
Generated
+6
@@ -0,0 +1,6 @@
|
|||||||
|
// Automatically generated from 'action-entry.js.tpl' for 'src/upload-sarif-action-post.ts'.
|
||||||
|
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
const import_entry_points = require("./entry-points");
|
||||||
|
void (0, import_entry_points.runUploadSarifPostAction)();
|
||||||
Generated
+1091
-1030
File diff suppressed because it is too large
Load Diff
+22
-29
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "codeql",
|
"name": "codeql",
|
||||||
"version": "4.35.2",
|
"version": "4.36.0",
|
||||||
"private": true,
|
"private": true,
|
||||||
"description": "CodeQL action",
|
"description": "CodeQL action",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
@@ -12,9 +12,8 @@
|
|||||||
"ava": "npm run transpile && ava --verbose",
|
"ava": "npm run transpile && ava --verbose",
|
||||||
"test": "npm run ava -- src/",
|
"test": "npm run ava -- src/",
|
||||||
"test-debug": "npm run test -- --timeout=20m",
|
"test-debug": "npm run test -- --timeout=20m",
|
||||||
"test-coverage": "c8 npm run test",
|
"transpile": "tsc --build --verbose tsconfig.json",
|
||||||
"transpile": "tsc --build --verbose",
|
"update-pr-checks": "./pr-checks/sync.sh"
|
||||||
"coverage": "c8 report --check-coverage"
|
|
||||||
},
|
},
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"workspaces": [
|
"workspaces": [
|
||||||
@@ -31,47 +30,46 @@
|
|||||||
"@actions/http-client": "^3.0.0",
|
"@actions/http-client": "^3.0.0",
|
||||||
"@actions/io": "^2.0.0",
|
"@actions/io": "^2.0.0",
|
||||||
"@actions/tool-cache": "^3.0.1",
|
"@actions/tool-cache": "^3.0.1",
|
||||||
"@octokit/plugin-retry": "^8.0.0",
|
"@octokit/plugin-retry": "^8.1.0",
|
||||||
"archiver": "^7.0.1",
|
"archiver": "^7.0.1",
|
||||||
"fast-deep-equal": "^3.1.3",
|
"fast-deep-equal": "^3.1.3",
|
||||||
"follow-redirects": "^1.15.11",
|
"follow-redirects": "^1.16.0",
|
||||||
"get-folder-size": "^5.0.0",
|
"get-folder-size": "^5.0.0",
|
||||||
"https-proxy-agent": "^7.0.6",
|
"https-proxy-agent": "^7.0.6",
|
||||||
"js-yaml": "^4.1.1",
|
"js-yaml": "^4.1.1",
|
||||||
"jsonschema": "1.4.1",
|
"jsonschema": "1.5.0",
|
||||||
"long": "^5.3.2",
|
"long": "^5.3.2",
|
||||||
"node-forge": "^1.4.0",
|
"node-forge": "^1.4.0",
|
||||||
"semver": "^7.7.4",
|
"semver": "^7.7.4",
|
||||||
"uuid": "^13.0.0"
|
"uuid": "^14.0.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@ava/typescript": "6.0.0",
|
"@ava/typescript": "6.0.0",
|
||||||
"@eslint/compat": "^2.0.3",
|
"@eslint/compat": "^2.0.5",
|
||||||
"@microsoft/eslint-formatter-sarif": "^3.1.0",
|
"@microsoft/eslint-formatter-sarif": "^3.1.0",
|
||||||
"@octokit/types": "^16.0.0",
|
"@octokit/types": "^16.0.0",
|
||||||
"@types/archiver": "^7.0.0",
|
"@types/archiver": "^7.0.0",
|
||||||
"@types/follow-redirects": "^1.14.4",
|
"@types/follow-redirects": "^1.14.4",
|
||||||
"@types/js-yaml": "^4.0.9",
|
"@types/js-yaml": "^4.0.9",
|
||||||
"@types/node": "^20.19.9",
|
"@types/node": "^20.19.39",
|
||||||
"@types/node-forge": "^1.3.14",
|
"@types/node-forge": "^1.3.14",
|
||||||
"@types/sarif": "^2.1.7",
|
"@types/sarif": "^2.1.7",
|
||||||
"@types/semver": "^7.7.1",
|
"@types/semver": "^7.7.1",
|
||||||
"@types/sinon": "^21.0.0",
|
"@types/sinon": "^21.0.1",
|
||||||
"ava": "^7.0.0",
|
"ava": "^6.4.1",
|
||||||
"c8": "^11.0.0",
|
"esbuild": "^0.28.0",
|
||||||
"esbuild": "^0.27.4",
|
"eslint": "^9.39.4",
|
||||||
"eslint": "^9.39.2",
|
"eslint-import-resolver-typescript": "^4.4.4",
|
||||||
"eslint-import-resolver-typescript": "^3.8.7",
|
|
||||||
"eslint-plugin-github": "^6.0.0",
|
"eslint-plugin-github": "^6.0.0",
|
||||||
"eslint-plugin-import-x": "^4.16.2",
|
"eslint-plugin-import-x": "^4.16.2",
|
||||||
"eslint-plugin-jsdoc": "^62.8.0",
|
"eslint-plugin-jsdoc": "^62.9.0",
|
||||||
"eslint-plugin-no-async-foreach": "^0.1.1",
|
"eslint-plugin-no-async-foreach": "^0.1.1",
|
||||||
"glob": "^11.1.0",
|
"glob": "^11.1.0",
|
||||||
"globals": "^17.4.0",
|
"globals": "^17.6.0",
|
||||||
"nock": "^14.0.11",
|
"nock": "^14.0.12",
|
||||||
"sinon": "^21.0.3",
|
"sinon": "^22.0.0",
|
||||||
"typescript": "^5.9.3",
|
"typescript": "^6.0.3",
|
||||||
"typescript-eslint": "^8.57.1"
|
"typescript-eslint": "^8.59.2"
|
||||||
},
|
},
|
||||||
"overrides": {
|
"overrides": {
|
||||||
"@actions/tool-cache": {
|
"@actions/tool-cache": {
|
||||||
@@ -92,12 +90,7 @@
|
|||||||
"eslint-plugin-jsx-a11y": {
|
"eslint-plugin-jsx-a11y": {
|
||||||
"semver": ">=6.3.1"
|
"semver": ">=6.3.1"
|
||||||
},
|
},
|
||||||
"brace-expansion@2.0.1": "2.0.2",
|
"glob": "^11.1.0",
|
||||||
"glob": "^11.1.0"
|
"undici": "^6.24.0"
|
||||||
},
|
|
||||||
"c8": {
|
|
||||||
"functions": 80,
|
|
||||||
"lines": 80,
|
|
||||||
"branches": 80
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,13 @@
|
|||||||
|
import * as githubUtils from "@actions/github/lib/utils";
|
||||||
|
import { type Octokit } from "@octokit/core";
|
||||||
|
import { type PaginateInterface } from "@octokit/plugin-paginate-rest";
|
||||||
|
import { type Api } from "@octokit/plugin-rest-endpoint-methods";
|
||||||
|
|
||||||
|
/** The type of the Octokit client. */
|
||||||
|
export type ApiClient = Octokit & Api & { paginate: PaginateInterface };
|
||||||
|
|
||||||
|
/** Constructs an `ApiClient` using `token` for authentication. */
|
||||||
|
export function getApiClient(token: string): ApiClient {
|
||||||
|
const opts = githubUtils.getOctokitOptions(token);
|
||||||
|
return new githubUtils.GitHub(opts);
|
||||||
|
}
|
||||||
Executable
+48
@@ -0,0 +1,48 @@
|
|||||||
|
#!/usr/bin/env npx tsx
|
||||||
|
|
||||||
|
import * as fs from "node:fs/promises";
|
||||||
|
|
||||||
|
import { BUNDLE_METADATA_FILE } from "./config";
|
||||||
|
|
||||||
|
interface InputInfo {
|
||||||
|
bytesInOutput: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
type Inputs = Record<string, InputInfo>;
|
||||||
|
|
||||||
|
interface Output {
|
||||||
|
bytes: number;
|
||||||
|
inputs: Inputs;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Metadata {
|
||||||
|
outputs: Record<string, Output>;
|
||||||
|
}
|
||||||
|
|
||||||
|
function toMB(bytes: number): string {
|
||||||
|
return `${(bytes / (1024 * 1024)).toFixed(2)}MB`;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function main() {
|
||||||
|
const fileContents = await fs.readFile(BUNDLE_METADATA_FILE);
|
||||||
|
const metadata = JSON.parse(String(fileContents)) as Metadata;
|
||||||
|
|
||||||
|
for (const [outputFile, outputData] of Object.entries(
|
||||||
|
metadata.outputs,
|
||||||
|
).reverse()) {
|
||||||
|
console.info(`${outputFile}: ${toMB(outputData.bytes)}`);
|
||||||
|
|
||||||
|
for (const [inputName, inputData] of Object.entries(outputData.inputs)) {
|
||||||
|
// Ignore any inputs that make up less than 5% of the output.
|
||||||
|
const percentage = (inputData.bytesInOutput / outputData.bytes) * 100.0;
|
||||||
|
if (percentage < 5.0) continue;
|
||||||
|
|
||||||
|
console.info(` ${inputName}: ${toMB(inputData.bytesInOutput)}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Only call `main` if this script was run directly.
|
||||||
|
if (require.main === module) {
|
||||||
|
void main();
|
||||||
|
}
|
||||||
@@ -5,12 +5,12 @@ versions:
|
|||||||
steps:
|
steps:
|
||||||
- uses: ./../action/init
|
- uses: ./../action/init
|
||||||
with:
|
with:
|
||||||
languages: C#,java-kotlin,swift,typescript
|
languages: C#,java-kotlin,typescript
|
||||||
tools: ${{ steps.prepare-test.outputs.tools-url }}
|
tools: ${{ steps.prepare-test.outputs.tools-url }}
|
||||||
|
|
||||||
- name: "Check languages"
|
- name: "Check languages"
|
||||||
run: |
|
run: |
|
||||||
expected_languages="csharp,java,swift,javascript"
|
expected_languages="csharp,java,javascript"
|
||||||
actual_languages=$(jq -r '.languages | join(",")' "$RUNNER_TEMP"/config)
|
actual_languages=$(jq -r '.languages | join(",")' "$RUNNER_TEMP"/config)
|
||||||
|
|
||||||
if [ "$expected_languages" != "$actual_languages" ]; then
|
if [ "$expected_languages" != "$actual_languages" ]; then
|
||||||
|
|||||||
@@ -2,7 +2,8 @@ name: "Multi-language repository"
|
|||||||
description: "An end-to-end integration test of a multi-language repository using automatic language detection"
|
description: "An end-to-end integration test of a multi-language repository using automatic language detection"
|
||||||
operatingSystems:
|
operatingSystems:
|
||||||
- ubuntu
|
- ubuntu
|
||||||
- macos
|
- os: macos
|
||||||
|
runner-image: macos-latest-xlarge
|
||||||
env:
|
env:
|
||||||
CODEQL_ACTION_RESOLVE_SUPPORTED_LANGUAGES_USING_CLI: true
|
CODEQL_ACTION_RESOLVE_SUPPORTED_LANGUAGES_USING_CLI: true
|
||||||
installGo: true
|
installGo: true
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ versions:
|
|||||||
- default
|
- default
|
||||||
steps:
|
steps:
|
||||||
- name: Set up Ruby
|
- name: Set up Ruby
|
||||||
uses: ruby/setup-ruby@319994f95fa847cf3fb3cd3dbe89f6dcde9f178f # v1.295.0
|
uses: ruby/setup-ruby@c4e5b1316158f92e3d49443a9d58b31d25ac0f8f # v1.306.0
|
||||||
with:
|
with:
|
||||||
ruby-version: 2.6
|
ruby-version: 2.6
|
||||||
- name: Install Code Scanning integration
|
- name: Install Code Scanning integration
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ name: "Rust analysis"
|
|||||||
description: "Tests creation of a Rust database"
|
description: "Tests creation of a Rust database"
|
||||||
versions:
|
versions:
|
||||||
# experimental rust support introduced, requires action to set `CODEQL_ENABLE_EXPERIMENTAL_FEATURES`
|
# experimental rust support introduced, requires action to set `CODEQL_ENABLE_EXPERIMENTAL_FEATURES`
|
||||||
- stable-v2.19.3
|
- stable-v2.19.4
|
||||||
# first public preview version
|
# first public preview version
|
||||||
- stable-v2.22.1
|
- stable-v2.22.1
|
||||||
- linked
|
- linked
|
||||||
|
|||||||
@@ -16,7 +16,17 @@ steps:
|
|||||||
id: proxy
|
id: proxy
|
||||||
uses: ./../action/start-proxy
|
uses: ./../action/start-proxy
|
||||||
with:
|
with:
|
||||||
registry_secrets: '[{ "type": "nuget_feed", "url": "https://api.nuget.org/v3/index.json" }]'
|
registry_secrets: |
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"type": "maven_repository",
|
||||||
|
"url": "https://repo.maven.apache.org/maven2/"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "maven_repository",
|
||||||
|
"url": "https://repo1.maven.org/maven2"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
|
||||||
- name: Print proxy outputs
|
- name: Print proxy outputs
|
||||||
run: |
|
run: |
|
||||||
@@ -27,3 +37,10 @@ steps:
|
|||||||
- name: Fail if proxy outputs are not set
|
- name: Fail if proxy outputs are not set
|
||||||
if: (!steps.proxy.outputs.proxy_host) || (!steps.proxy.outputs.proxy_port) || (!steps.proxy.outputs.proxy_ca_certificate) || (!steps.proxy.outputs.proxy_urls)
|
if: (!steps.proxy.outputs.proxy_host) || (!steps.proxy.outputs.proxy_port) || (!steps.proxy.outputs.proxy_ca_certificate) || (!steps.proxy.outputs.proxy_urls)
|
||||||
run: exit 1
|
run: exit 1
|
||||||
|
|
||||||
|
- name: Fail if proxy_urls does not contain all registries
|
||||||
|
if: |
|
||||||
|
join(fromJSON(steps.proxy.outputs.proxy_urls)[*].type, ',') != 'maven_repository,maven_repository'
|
||||||
|
|| !contains(steps.proxy.outputs.proxy_urls, 'https://repo.maven.apache.org/maven2/')
|
||||||
|
|| !contains(steps.proxy.outputs.proxy_urls, 'https://repo1.maven.org/maven2')
|
||||||
|
run: exit 1
|
||||||
|
|||||||
@@ -3,7 +3,8 @@ description: "Tests creation of a Swift database using autobuild"
|
|||||||
versions:
|
versions:
|
||||||
- nightly-latest
|
- nightly-latest
|
||||||
operatingSystems:
|
operatingSystems:
|
||||||
- macos
|
- os: macos
|
||||||
|
runner-image: macos-latest-xlarge
|
||||||
steps:
|
steps:
|
||||||
- uses: ./../action/init
|
- uses: ./../action/init
|
||||||
id: init
|
id: init
|
||||||
|
|||||||
@@ -8,3 +8,16 @@ export const PR_CHECKS_DIR = __dirname;
|
|||||||
|
|
||||||
/** The path of the file configuring which checks shouldn't be required. */
|
/** The path of the file configuring which checks shouldn't be required. */
|
||||||
export const PR_CHECK_EXCLUDED_FILE = path.join(PR_CHECKS_DIR, "excluded.yml");
|
export const PR_CHECK_EXCLUDED_FILE = path.join(PR_CHECKS_DIR, "excluded.yml");
|
||||||
|
|
||||||
|
/** The path to the esbuild metadata file. */
|
||||||
|
export const BUNDLE_METADATA_FILE = path.join(PR_CHECKS_DIR, "..", "meta.json");
|
||||||
|
|
||||||
|
/** The `src` directory. */
|
||||||
|
const SOURCE_ROOT = path.join(PR_CHECKS_DIR, "..", "src");
|
||||||
|
|
||||||
|
/** The path to the built-in languages file. */
|
||||||
|
export const BUILTIN_LANGUAGES_FILE = path.join(
|
||||||
|
SOURCE_ROOT,
|
||||||
|
"languages",
|
||||||
|
"builtin.json",
|
||||||
|
);
|
||||||
|
|||||||
@@ -7,10 +7,10 @@
|
|||||||
"@octokit/core": "^7.0.6",
|
"@octokit/core": "^7.0.6",
|
||||||
"@octokit/plugin-paginate-rest": ">=9.2.2",
|
"@octokit/plugin-paginate-rest": ">=9.2.2",
|
||||||
"@octokit/plugin-rest-endpoint-methods": "^17.0.0",
|
"@octokit/plugin-rest-endpoint-methods": "^17.0.0",
|
||||||
"yaml": "^2.8.3"
|
"yaml": "^2.8.4"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/node": "^20.19.9",
|
"@types/node": "^20.19.39",
|
||||||
"tsx": "^4.21.0"
|
"tsx": "^4.21.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,7 +7,13 @@ Tests for the sync-checks.ts script
|
|||||||
import * as assert from "node:assert/strict";
|
import * as assert from "node:assert/strict";
|
||||||
import { describe, it } from "node:test";
|
import { describe, it } from "node:test";
|
||||||
|
|
||||||
import { CheckInfo, Exclusions, Options, removeExcluded } from "./sync-checks";
|
import {
|
||||||
|
CheckInfo,
|
||||||
|
Exclusions,
|
||||||
|
Options,
|
||||||
|
removeExcluded,
|
||||||
|
resolveToken,
|
||||||
|
} from "./sync-checks";
|
||||||
|
|
||||||
const defaultOptions: Options = {
|
const defaultOptions: Options = {
|
||||||
apply: false,
|
apply: false,
|
||||||
@@ -58,3 +64,46 @@ describe("removeExcluded", async () => {
|
|||||||
assert.deepEqual(retained, expectedExactMatches);
|
assert.deepEqual(retained, expectedExactMatches);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe("resolveToken", async () => {
|
||||||
|
await it("reads the token from standard input", async () => {
|
||||||
|
const token = await resolveToken(
|
||||||
|
{ tokenStdin: true },
|
||||||
|
{ env: {}, readStdin: async () => " stdin-token\n" },
|
||||||
|
);
|
||||||
|
assert.equal(token, "stdin-token");
|
||||||
|
});
|
||||||
|
|
||||||
|
await it("reads the token from the GH_TOKEN environment variable", async () => {
|
||||||
|
const token = await resolveToken(
|
||||||
|
{},
|
||||||
|
{ env: { GH_TOKEN: "env-token" }, readStdin: async () => "" },
|
||||||
|
);
|
||||||
|
assert.equal(token, "env-token");
|
||||||
|
});
|
||||||
|
|
||||||
|
await it("reads the token from the GITHUB_TOKEN environment variable", async () => {
|
||||||
|
const token = await resolveToken(
|
||||||
|
{},
|
||||||
|
{ env: { GITHUB_TOKEN: "env-token" }, readStdin: async () => "" },
|
||||||
|
);
|
||||||
|
assert.equal(token, "env-token");
|
||||||
|
});
|
||||||
|
|
||||||
|
await it("rejects an empty standard input token", async () => {
|
||||||
|
await assert.rejects(
|
||||||
|
resolveToken(
|
||||||
|
{ tokenStdin: true },
|
||||||
|
{ env: {}, readStdin: async () => "\n" },
|
||||||
|
),
|
||||||
|
/No token received on standard input/,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
await it("rejects missing token sources", async () => {
|
||||||
|
await assert.rejects(
|
||||||
|
resolveToken({}, { env: {}, readStdin: async () => "" }),
|
||||||
|
/Missing authentication token/,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|||||||
+70
-22
@@ -5,12 +5,9 @@
|
|||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { parseArgs } from "node:util";
|
import { parseArgs } from "node:util";
|
||||||
|
|
||||||
import * as githubUtils from "@actions/github/lib/utils";
|
|
||||||
import { type Octokit } from "@octokit/core";
|
|
||||||
import { type PaginateInterface } from "@octokit/plugin-paginate-rest";
|
|
||||||
import { type Api } from "@octokit/plugin-rest-endpoint-methods";
|
|
||||||
import * as yaml from "yaml";
|
import * as yaml from "yaml";
|
||||||
|
|
||||||
|
import { type ApiClient, getApiClient } from "./api-client";
|
||||||
import {
|
import {
|
||||||
OLDEST_SUPPORTED_MAJOR_VERSION,
|
OLDEST_SUPPORTED_MAJOR_VERSION,
|
||||||
PR_CHECK_EXCLUDED_FILE,
|
PR_CHECK_EXCLUDED_FILE,
|
||||||
@@ -18,8 +15,8 @@ import {
|
|||||||
|
|
||||||
/** Represents the command-line options. */
|
/** Represents the command-line options. */
|
||||||
export interface Options {
|
export interface Options {
|
||||||
/** The token to use to authenticate to the GitHub API. */
|
/** Whether to read the GitHub API token from standard input. */
|
||||||
token?: string;
|
tokenStdin?: boolean;
|
||||||
/** The git ref to use the checks for. */
|
/** The git ref to use the checks for. */
|
||||||
ref?: string;
|
ref?: string;
|
||||||
/** Whether to actually apply the changes or not. */
|
/** Whether to actually apply the changes or not. */
|
||||||
@@ -34,6 +31,65 @@ const codeqlActionRepo = {
|
|||||||
repo: "codeql-action",
|
repo: "codeql-action",
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/** Environment variables to check for a GitHub API token. */
|
||||||
|
const TOKEN_ENVIRONMENT_VARIABLES = ["GH_TOKEN", "GITHUB_TOKEN"];
|
||||||
|
|
||||||
|
/** Represents the sources from which we can retrieve the GitHub API token. */
|
||||||
|
interface TokenSource {
|
||||||
|
/** Environment variables to inspect. */
|
||||||
|
env: NodeJS.ProcessEnv;
|
||||||
|
/** Reads a token from standard input. */
|
||||||
|
readStdin: () => Promise<string>;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Reads the GitHub API token from standard input. */
|
||||||
|
async function readTokenFromStdin(): Promise<string> {
|
||||||
|
let token = "";
|
||||||
|
process.stdin.setEncoding("utf8");
|
||||||
|
for await (const chunk of process.stdin) {
|
||||||
|
token += chunk;
|
||||||
|
}
|
||||||
|
return token.trim();
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Gets a GitHub API token from one of the supported environment variables. */
|
||||||
|
function getTokenFromEnvironment(env: NodeJS.ProcessEnv): string | undefined {
|
||||||
|
for (const variableName of TOKEN_ENVIRONMENT_VARIABLES) {
|
||||||
|
const token = env[variableName]?.trim();
|
||||||
|
if (token) {
|
||||||
|
return token;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Gets the token to use to authenticate to the GitHub API. */
|
||||||
|
export async function resolveToken(
|
||||||
|
options: Pick<Options, "tokenStdin">,
|
||||||
|
tokenSource: TokenSource = {
|
||||||
|
env: process.env,
|
||||||
|
readStdin: readTokenFromStdin,
|
||||||
|
},
|
||||||
|
): Promise<string> {
|
||||||
|
if (options.tokenStdin) {
|
||||||
|
const token = (await tokenSource.readStdin()).trim();
|
||||||
|
if (token.length === 0) {
|
||||||
|
throw new Error("No token received on standard input.");
|
||||||
|
}
|
||||||
|
return token;
|
||||||
|
}
|
||||||
|
|
||||||
|
const environmentToken = getTokenFromEnvironment(tokenSource.env);
|
||||||
|
if (environmentToken !== undefined) {
|
||||||
|
return environmentToken;
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new Error(
|
||||||
|
"Missing authentication token. Set GH_TOKEN/GITHUB_TOKEN or pipe a token " +
|
||||||
|
"to --token-stdin.",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
/** Represents a configuration of which checks should not be set up as required checks. */
|
/** Represents a configuration of which checks should not be set up as required checks. */
|
||||||
export interface Exclusions {
|
export interface Exclusions {
|
||||||
/** A list of strings that, if contained in a check name, are excluded. */
|
/** A list of strings that, if contained in a check name, are excluded. */
|
||||||
@@ -49,15 +105,6 @@ function loadExclusions(): Exclusions {
|
|||||||
) as Exclusions;
|
) as Exclusions;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** The type of the Octokit client. */
|
|
||||||
type ApiClient = Octokit & Api & { paginate: PaginateInterface };
|
|
||||||
|
|
||||||
/** Constructs an `ApiClient` using `token` for authentication. */
|
|
||||||
function getApiClient(token: string): ApiClient {
|
|
||||||
const opts = githubUtils.getOctokitOptions(token);
|
|
||||||
return new githubUtils.GitHub(opts);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Represents information about a check run. We track the `app_id` that generated the check,
|
* Represents information about a check run. We track the `app_id` that generated the check,
|
||||||
* because the API will require it in addition to the name in the future.
|
* because the API will require it in addition to the name in the future.
|
||||||
@@ -217,9 +264,10 @@ async function updateBranch(
|
|||||||
async function main(): Promise<void> {
|
async function main(): Promise<void> {
|
||||||
const { values: options } = parseArgs({
|
const { values: options } = parseArgs({
|
||||||
options: {
|
options: {
|
||||||
// The token to use to authenticate to the API.
|
// Read the token to use to authenticate to the API from standard input.
|
||||||
token: {
|
"token-stdin": {
|
||||||
type: "string",
|
type: "boolean",
|
||||||
|
default: false,
|
||||||
},
|
},
|
||||||
// The git ref for which to retrieve the check runs.
|
// The git ref for which to retrieve the check runs.
|
||||||
ref: {
|
ref: {
|
||||||
@@ -240,16 +288,16 @@ async function main(): Promise<void> {
|
|||||||
strict: true,
|
strict: true,
|
||||||
});
|
});
|
||||||
|
|
||||||
if (options.token === undefined) {
|
const token = await resolveToken({
|
||||||
throw new Error("Missing --token");
|
tokenStdin: options["token-stdin"],
|
||||||
}
|
});
|
||||||
|
|
||||||
console.info(
|
console.info(
|
||||||
`Oldest supported major version is: ${OLDEST_SUPPORTED_MAJOR_VERSION}`,
|
`Oldest supported major version is: ${OLDEST_SUPPORTED_MAJOR_VERSION}`,
|
||||||
);
|
);
|
||||||
|
|
||||||
// Initialise the API client.
|
// Initialise the API client.
|
||||||
const client = getApiClient(options.token);
|
const client = getApiClient(token);
|
||||||
|
|
||||||
// Find the check runs for the specified `ref` that we will later set as the required checks
|
// Find the check runs for the specified `ref` that we will later set as the required checks
|
||||||
// for the main and release branches.
|
// for the main and release branches.
|
||||||
|
|||||||
+47
-16
@@ -5,7 +5,7 @@ import * as path from "path";
|
|||||||
|
|
||||||
import * as yaml from "yaml";
|
import * as yaml from "yaml";
|
||||||
|
|
||||||
import { KnownLanguage } from "../src/languages";
|
import { BuiltInLanguage } from "../src/languages";
|
||||||
|
|
||||||
/** Known workflow input names. */
|
/** Known workflow input names. */
|
||||||
enum KnownInputName {
|
enum KnownInputName {
|
||||||
@@ -28,6 +28,24 @@ interface WorkflowInput {
|
|||||||
/** A partial mapping from known input names to input definitions. */
|
/** A partial mapping from known input names to input definitions. */
|
||||||
type WorkflowInputs = Partial<Record<KnownInputName, WorkflowInput>>;
|
type WorkflowInputs = Partial<Record<KnownInputName, WorkflowInput>>;
|
||||||
|
|
||||||
|
/** An operating system identifier. */
|
||||||
|
type OperatingSystemIdentifier = "ubuntu" | "macos" | "windows";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents an operating system matrix entry for a generated PR check workflow.
|
||||||
|
*
|
||||||
|
* Either a string containing the OS identifier or an object containing the OS identifier and an
|
||||||
|
* optional runner image label.
|
||||||
|
*/
|
||||||
|
type OperatingSystem =
|
||||||
|
| OperatingSystemIdentifier
|
||||||
|
| {
|
||||||
|
/** OS identifier. */
|
||||||
|
os: OperatingSystemIdentifier;
|
||||||
|
/** Optional runner image label. */
|
||||||
|
"runner-image"?: string;
|
||||||
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Represents PR check specifications.
|
* Represents PR check specifications.
|
||||||
*/
|
*/
|
||||||
@@ -36,8 +54,8 @@ interface Specification extends JobSpecification {
|
|||||||
inputs?: Record<string, WorkflowInput>;
|
inputs?: Record<string, WorkflowInput>;
|
||||||
/** CodeQL bundle versions to test against. Defaults to `DEFAULT_TEST_VERSIONS`. */
|
/** CodeQL bundle versions to test against. Defaults to `DEFAULT_TEST_VERSIONS`. */
|
||||||
versions?: string[];
|
versions?: string[];
|
||||||
/** Operating system prefixes used to select runner images (e.g. `["ubuntu", "macos"]`). */
|
/** Operating system prefixes, either as strings or with explicit runner image labels. */
|
||||||
operatingSystems?: string[];
|
operatingSystems?: OperatingSystem[];
|
||||||
/** Per-OS version overrides. If specified for an OS, only those versions are tested on that OS. */
|
/** Per-OS version overrides. If specified for an OS, only those versions are tested on that OS. */
|
||||||
osCodeQlVersions?: Record<string, string[]>;
|
osCodeQlVersions?: Record<string, string[]>;
|
||||||
/** Whether to use the all-platform CodeQL bundle. */
|
/** Whether to use the all-platform CodeQL bundle. */
|
||||||
@@ -91,16 +109,12 @@ interface LanguageSetup {
|
|||||||
steps: Step[];
|
steps: Step[];
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Describes partial mappings from known languages to their specific setup information. */
|
/** Describes partial mappings from built-in languages to their specific setup information. */
|
||||||
type LanguageSetups = Partial<Record<KnownLanguage, LanguageSetup>>;
|
type LanguageSetups = Partial<Record<BuiltInLanguage, LanguageSetup>>;
|
||||||
|
|
||||||
// The default set of CodeQL Bundle versions to use for the PR checks.
|
// The default set of CodeQL Bundle versions to use for the PR checks.
|
||||||
const defaultTestVersions = [
|
const defaultTestVersions = [
|
||||||
// The oldest supported CodeQL version. If bumping, update `CODEQL_MINIMUM_VERSION` in `codeql.ts`
|
// The oldest supported CodeQL version. If bumping, update `CODEQL_MINIMUM_VERSION` in `codeql.ts`
|
||||||
"stable-v2.17.6",
|
|
||||||
// The last CodeQL release in the 2.18 series.
|
|
||||||
"stable-v2.18.4",
|
|
||||||
// The last CodeQL release in the 2.19 series.
|
|
||||||
"stable-v2.19.4",
|
"stable-v2.19.4",
|
||||||
// The last CodeQL release in the 2.20 series.
|
// The last CodeQL release in the 2.20 series.
|
||||||
"stable-v2.20.7",
|
"stable-v2.20.7",
|
||||||
@@ -108,6 +122,10 @@ const defaultTestVersions = [
|
|||||||
"stable-v2.21.4",
|
"stable-v2.21.4",
|
||||||
// The last CodeQL release in the 2.22 series.
|
// The last CodeQL release in the 2.22 series.
|
||||||
"stable-v2.22.4",
|
"stable-v2.22.4",
|
||||||
|
// The last CodeQL release in the 2.23 series.
|
||||||
|
"stable-v2.23.9",
|
||||||
|
// The last CodeQL release in the 2.24 series.
|
||||||
|
"stable-v2.24.3",
|
||||||
// The default version of CodeQL for Dotcom, as determined by feature flags.
|
// The default version of CodeQL for Dotcom, as determined by feature flags.
|
||||||
"default",
|
"default",
|
||||||
// The version of CodeQL shipped with the Action in `defaults.json`. During the release process
|
// The version of CodeQL shipped with the Action in `defaults.json`. During the release process
|
||||||
@@ -125,7 +143,7 @@ const defaultLanguageVersions = {
|
|||||||
java: "17",
|
java: "17",
|
||||||
python: "3.13",
|
python: "3.13",
|
||||||
csharp: "9.x",
|
csharp: "9.x",
|
||||||
} as const satisfies Partial<Record<KnownLanguage, string>>;
|
} as const satisfies Partial<Record<BuiltInLanguage, string>>;
|
||||||
|
|
||||||
/** A mapping from known input names to their specifications. */
|
/** A mapping from known input names to their specifications. */
|
||||||
const inputSpecs: WorkflowInputs = {
|
const inputSpecs: WorkflowInputs = {
|
||||||
@@ -311,10 +329,19 @@ function generateJobMatrix(
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
const runnerImages = ["ubuntu-latest", "macos-latest", "windows-latest"];
|
const defaultRunnerImages = [
|
||||||
|
"ubuntu-latest",
|
||||||
|
"macos-latest",
|
||||||
|
"windows-latest",
|
||||||
|
];
|
||||||
const operatingSystems = checkSpecification.operatingSystems ?? ["ubuntu"];
|
const operatingSystems = checkSpecification.operatingSystems ?? ["ubuntu"];
|
||||||
|
|
||||||
for (const operatingSystem of operatingSystems) {
|
for (const operatingSystemConfig of operatingSystems) {
|
||||||
|
const operatingSystem =
|
||||||
|
typeof operatingSystemConfig === "string"
|
||||||
|
? operatingSystemConfig
|
||||||
|
: operatingSystemConfig.os;
|
||||||
|
|
||||||
// If osCodeQlVersions is set for this OS, only include the specified CodeQL versions.
|
// If osCodeQlVersions is set for this OS, only include the specified CodeQL versions.
|
||||||
const allowedVersions =
|
const allowedVersions =
|
||||||
checkSpecification.osCodeQlVersions?.[operatingSystem];
|
checkSpecification.osCodeQlVersions?.[operatingSystem];
|
||||||
@@ -322,9 +349,13 @@ function generateJobMatrix(
|
|||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
const runnerImagesForOs = runnerImages.filter((image) =>
|
const runnerImagesForOs =
|
||||||
image.startsWith(operatingSystem),
|
typeof operatingSystemConfig === "string" ||
|
||||||
);
|
operatingSystemConfig["runner-image"] === undefined
|
||||||
|
? defaultRunnerImages.filter((image) =>
|
||||||
|
image.startsWith(operatingSystem),
|
||||||
|
)
|
||||||
|
: [operatingSystemConfig["runner-image"]];
|
||||||
|
|
||||||
for (const runnerImage of runnerImagesForOs) {
|
for (const runnerImage of runnerImagesForOs) {
|
||||||
matrix.push({
|
matrix.push({
|
||||||
@@ -364,7 +395,7 @@ function getSetupSteps(checkSpecification: JobSpecification): {
|
|||||||
const inputs: Array<Set<KnownInputName>> = [];
|
const inputs: Array<Set<KnownInputName>> = [];
|
||||||
const steps: Step[] = [];
|
const steps: Step[] = [];
|
||||||
|
|
||||||
for (const language of Object.values(KnownLanguage).sort()) {
|
for (const language of Object.values(BuiltInLanguage).sort()) {
|
||||||
const setupSpec = languageSetups[language];
|
const setupSpec = languageSetups[language];
|
||||||
|
|
||||||
if (
|
if (
|
||||||
|
|||||||
@@ -3,6 +3,7 @@
|
|||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
/* Basic Options */
|
/* Basic Options */
|
||||||
"lib": ["esnext"],
|
"lib": ["esnext"],
|
||||||
|
"module": "preserve",
|
||||||
"rootDir": "..",
|
"rootDir": "..",
|
||||||
"sourceMap": false,
|
"sourceMap": false,
|
||||||
"noEmit": true,
|
"noEmit": true,
|
||||||
|
|||||||
@@ -0,0 +1,131 @@
|
|||||||
|
#!/usr/bin/env npx tsx
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Updates src/languages/builtin.json by querying the CodeQL CLI for:
|
||||||
|
* - Languages that have default queries (via codeql-extractor.yml)
|
||||||
|
* - Language aliases (via `codeql resolve languages --format=betterjson --extractor-include-aliases`)
|
||||||
|
*
|
||||||
|
* Usage:
|
||||||
|
* npx tsx pr-checks/update-builtin-languages.ts [path-to-codeql]
|
||||||
|
*
|
||||||
|
* If no path is given, falls back to "codeql".
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { execFileSync } from "node:child_process";
|
||||||
|
import * as fs from "node:fs";
|
||||||
|
import * as path from "node:path";
|
||||||
|
|
||||||
|
import * as yaml from "yaml";
|
||||||
|
|
||||||
|
import { EnvVar } from "../src/environment";
|
||||||
|
|
||||||
|
import { BUILTIN_LANGUAGES_FILE } from "./config";
|
||||||
|
|
||||||
|
/** Resolve all known language extractor directories. */
|
||||||
|
function resolveLanguages(codeqlPath: string): Record<string, string[]> {
|
||||||
|
return JSON.parse(
|
||||||
|
execFileSync(codeqlPath, ["resolve", "languages", "--format=json"], {
|
||||||
|
encoding: "utf8",
|
||||||
|
env: {
|
||||||
|
...process.env,
|
||||||
|
[EnvVar.EXPERIMENTAL_FEATURES]: "true", // include experimental languages
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
) as Record<string, string[]>;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return the sorted list of languages whose extractors ship default queries.
|
||||||
|
*
|
||||||
|
* @param extractorDirs - Map from language to list of extractor directories
|
||||||
|
*/
|
||||||
|
function findLanguagesWithDefaultQueries(
|
||||||
|
extractorDirs: Record<string, string[]>,
|
||||||
|
): string[] {
|
||||||
|
const languages: string[] = [];
|
||||||
|
|
||||||
|
for (const [language, dirs] of Object.entries(extractorDirs)) {
|
||||||
|
if (dirs.length !== 1) {
|
||||||
|
throw new Error(
|
||||||
|
`Expected exactly one extractor directory for language '${language}', but found ${dirs.length}: ${dirs.join(
|
||||||
|
", ",
|
||||||
|
)}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const extractorYmlPath = path.join(dirs[0], "codeql-extractor.yml");
|
||||||
|
|
||||||
|
if (!fs.existsSync(extractorYmlPath)) {
|
||||||
|
throw new Error(
|
||||||
|
`Extractor YAML not found for language '${language}' at expected path: ${extractorYmlPath}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const extractorYml = yaml.parse(fs.readFileSync(extractorYmlPath, "utf8"));
|
||||||
|
const defaultQueries: unknown[] | undefined = extractorYml.default_queries;
|
||||||
|
|
||||||
|
if (Array.isArray(defaultQueries) && defaultQueries.length > 0) {
|
||||||
|
console.log(
|
||||||
|
` ✅ ${language}: included (default queries: ${JSON.stringify(defaultQueries)})`,
|
||||||
|
);
|
||||||
|
languages.push(language);
|
||||||
|
} else {
|
||||||
|
console.log(` ❌ ${language}: excluded (no default queries)`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return languages.sort();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resolve language aliases from the CodeQL CLI, keeping only those whose
|
||||||
|
* target is in the given set of included languages.
|
||||||
|
*/
|
||||||
|
function resolveAliases(
|
||||||
|
codeqlPath: string,
|
||||||
|
includedLanguages: Set<string>,
|
||||||
|
): Record<string, string> {
|
||||||
|
const betterjsonOutput = JSON.parse(
|
||||||
|
execFileSync(
|
||||||
|
codeqlPath,
|
||||||
|
[
|
||||||
|
"resolve",
|
||||||
|
"languages",
|
||||||
|
"--format=betterjson",
|
||||||
|
"--extractor-include-aliases",
|
||||||
|
],
|
||||||
|
{ encoding: "utf8" },
|
||||||
|
),
|
||||||
|
);
|
||||||
|
|
||||||
|
return Object.fromEntries(
|
||||||
|
Object.entries((betterjsonOutput.aliases ?? {}) as Record<string, string>)
|
||||||
|
.filter(([, target]) => includedLanguages.has(target))
|
||||||
|
.sort(([a], [b]) => a.localeCompare(b)),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Write the built-in languages data to disk. */
|
||||||
|
function writeBuiltinLanguages(
|
||||||
|
languages: string[],
|
||||||
|
aliases: Record<string, string>,
|
||||||
|
): void {
|
||||||
|
const content = `${JSON.stringify({ languages, aliases }, null, 2)}\n`;
|
||||||
|
fs.mkdirSync(path.dirname(BUILTIN_LANGUAGES_FILE), { recursive: true });
|
||||||
|
fs.writeFileSync(BUILTIN_LANGUAGES_FILE, content);
|
||||||
|
|
||||||
|
console.log(`\nWrote ${BUILTIN_LANGUAGES_FILE}`);
|
||||||
|
console.log(` Languages: ${languages.join(", ")}`);
|
||||||
|
console.log(` Aliases: ${Object.keys(aliases).join(", ")}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
function main(): void {
|
||||||
|
const codeqlPath = process.argv[2] || "codeql";
|
||||||
|
|
||||||
|
const extractorDirs = resolveLanguages(codeqlPath);
|
||||||
|
const languages = findLanguagesWithDefaultQueries(extractorDirs);
|
||||||
|
const aliases = resolveAliases(codeqlPath, new Set(languages));
|
||||||
|
writeBuiltinLanguages(languages, aliases);
|
||||||
|
}
|
||||||
|
|
||||||
|
main();
|
||||||
@@ -22,4 +22,4 @@ outputs:
|
|||||||
description: The inferred build environment configuration.
|
description: The inferred build environment configuration.
|
||||||
runs:
|
runs:
|
||||||
using: node24
|
using: node24
|
||||||
main: '../lib/resolve-environment-action.js'
|
main: '../lib/resolve-environment-entry.js'
|
||||||
|
|||||||
+20
-1
@@ -19,6 +19,25 @@ inputs:
|
|||||||
If not specified, the Action will check in several places until it finds
|
If not specified, the Action will check in several places until it finds
|
||||||
the CodeQL tools.
|
the CodeQL tools.
|
||||||
required: false
|
required: false
|
||||||
|
languages:
|
||||||
|
description: >-
|
||||||
|
A comma-separated list of CodeQL languages that will be analyzed in subsequent
|
||||||
|
`github/codeql-action/init` and `github/codeql-action/analyze` invocations. If specified, the
|
||||||
|
Action may use this list to select a CodeQL CLI version that is best suited to analyzing those
|
||||||
|
languages, for example by preferring a version that has a cached overlay-base database for the
|
||||||
|
specified languages. This input is not remembered and must also be passed to
|
||||||
|
`github/codeql-action/init`.
|
||||||
|
required: false
|
||||||
|
analysis-kinds:
|
||||||
|
description: >-
|
||||||
|
[Internal] A comma-separated list of analysis kinds that subsequent
|
||||||
|
`github/codeql-action/init` invocations will enable. If specified, the Action may use this
|
||||||
|
list to select a CodeQL CLI version that is best suited to those analysis kinds. This input is
|
||||||
|
not remembered and must also be passed to `github/codeql-action/init`.
|
||||||
|
|
||||||
|
Available options are the same as for the `analysis-kinds` input on the `init` Action.
|
||||||
|
default: 'code-scanning'
|
||||||
|
required: true
|
||||||
token:
|
token:
|
||||||
description: GitHub token to use for authenticating with this instance of GitHub.
|
description: GitHub token to use for authenticating with this instance of GitHub.
|
||||||
default: ${{ github.token }}
|
default: ${{ github.token }}
|
||||||
@@ -36,4 +55,4 @@ outputs:
|
|||||||
description: The version of the CodeQL binary that was installed.
|
description: The version of the CodeQL binary that was installed.
|
||||||
runs:
|
runs:
|
||||||
using: node24
|
using: node24
|
||||||
main: '../lib/setup-codeql-action.js'
|
main: '../lib/setup-codeql-entry.js'
|
||||||
|
|||||||
@@ -0,0 +1,4 @@
|
|||||||
|
"use strict";
|
||||||
|
|
||||||
|
const import_entry_points = require("./entry-points");
|
||||||
|
void (0, import_entry_points.run__ACTION__)();
|
||||||
+96
-9
@@ -16,7 +16,12 @@ import {
|
|||||||
} from "./analyses";
|
} from "./analyses";
|
||||||
import { EnvVar } from "./environment";
|
import { EnvVar } from "./environment";
|
||||||
import { getRunnerLogger } from "./logging";
|
import { getRunnerLogger } from "./logging";
|
||||||
import { setupTests } from "./testing-utils";
|
import {
|
||||||
|
createFeatures,
|
||||||
|
RecordingLogger,
|
||||||
|
setupBaseActionsVars,
|
||||||
|
setupTests,
|
||||||
|
} from "./testing-utils";
|
||||||
import { AssessmentPayload } from "./upload-lib/types";
|
import { AssessmentPayload } from "./upload-lib/types";
|
||||||
import { ConfigurationError } from "./util";
|
import { ConfigurationError } from "./util";
|
||||||
|
|
||||||
@@ -53,24 +58,91 @@ test("Parsing analysis kinds requires at least one analysis kind", async (t) =>
|
|||||||
test.serial(
|
test.serial(
|
||||||
"getAnalysisKinds - returns expected analysis kinds for `analysis-kinds` input",
|
"getAnalysisKinds - returns expected analysis kinds for `analysis-kinds` input",
|
||||||
async (t) => {
|
async (t) => {
|
||||||
|
process.env[EnvVar.TEST_MODE] = "true";
|
||||||
|
const features = createFeatures([]);
|
||||||
const requiredInputStub = sinon.stub(actionsUtil, "getRequiredInput");
|
const requiredInputStub = sinon.stub(actionsUtil, "getRequiredInput");
|
||||||
requiredInputStub
|
requiredInputStub
|
||||||
.withArgs("analysis-kinds")
|
.withArgs("analysis-kinds")
|
||||||
.returns("code-scanning,code-quality");
|
.returns("code-scanning,code-quality");
|
||||||
const result = await getAnalysisKinds(getRunnerLogger(true), true);
|
const result = await getAnalysisKinds(
|
||||||
|
getRunnerLogger(true),
|
||||||
|
features,
|
||||||
|
true,
|
||||||
|
);
|
||||||
t.assert(result.includes(AnalysisKind.CodeScanning));
|
t.assert(result.includes(AnalysisKind.CodeScanning));
|
||||||
t.assert(result.includes(AnalysisKind.CodeQuality));
|
t.assert(result.includes(AnalysisKind.CodeQuality));
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
|
test.serial(
|
||||||
|
"getAnalysisKinds - only use `code-scanning` for multiple analysis kinds outside of test mode",
|
||||||
|
async (t) => {
|
||||||
|
setupBaseActionsVars();
|
||||||
|
process.env[EnvVar.TEST_MODE] = "false";
|
||||||
|
const features = createFeatures([]);
|
||||||
|
const logger = new RecordingLogger();
|
||||||
|
const requiredInputStub = sinon.stub(actionsUtil, "getRequiredInput");
|
||||||
|
requiredInputStub
|
||||||
|
.withArgs("analysis-kinds")
|
||||||
|
.returns("code-scanning,code-quality");
|
||||||
|
const result = await getAnalysisKinds(logger, features, true);
|
||||||
|
t.deepEqual(result, [AnalysisKind.CodeScanning]);
|
||||||
|
t.assert(
|
||||||
|
logger.hasMessage(
|
||||||
|
"Continuing with only `analysis-kinds: code-scanning`.",
|
||||||
|
),
|
||||||
|
);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
test.serial(
|
||||||
|
"getAnalysisKinds - logs error for non-default `analysis-kinds` in custom workflow",
|
||||||
|
async (t) => {
|
||||||
|
setupBaseActionsVars({ GITHUB_EVENT_NAME: "push" });
|
||||||
|
process.env[EnvVar.TEST_MODE] = "false";
|
||||||
|
const features = createFeatures([]);
|
||||||
|
const logger = new RecordingLogger();
|
||||||
|
const requiredInputStub = sinon.stub(actionsUtil, "getRequiredInput");
|
||||||
|
requiredInputStub.withArgs("analysis-kinds").returns("code-quality");
|
||||||
|
const result = await getAnalysisKinds(logger, features, true);
|
||||||
|
t.deepEqual(result, [AnalysisKind.CodeQuality]);
|
||||||
|
t.assert(
|
||||||
|
logger.hasMessage(
|
||||||
|
"An analysis kind other than `code-scanning` was specified in a custom workflow.",
|
||||||
|
),
|
||||||
|
);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
test.serial(
|
||||||
|
"getAnalysisKinds - no error for non-default `analysis-kinds` in managed workflow",
|
||||||
|
async (t) => {
|
||||||
|
setupBaseActionsVars({ GITHUB_EVENT_NAME: "dynamic" });
|
||||||
|
process.env[EnvVar.TEST_MODE] = "false";
|
||||||
|
const features = createFeatures([]);
|
||||||
|
const logger = new RecordingLogger();
|
||||||
|
const requiredInputStub = sinon.stub(actionsUtil, "getRequiredInput");
|
||||||
|
requiredInputStub.withArgs("analysis-kinds").returns("code-quality");
|
||||||
|
const result = await getAnalysisKinds(logger, features, true);
|
||||||
|
t.deepEqual(result, [AnalysisKind.CodeQuality]);
|
||||||
|
t.deepEqual(logger.messages, []);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
test.serial(
|
test.serial(
|
||||||
"getAnalysisKinds - includes `code-quality` when deprecated `quality-queries` input is used",
|
"getAnalysisKinds - includes `code-quality` when deprecated `quality-queries` input is used",
|
||||||
async (t) => {
|
async (t) => {
|
||||||
|
process.env[EnvVar.TEST_MODE] = "true";
|
||||||
|
const features = createFeatures([]);
|
||||||
const requiredInputStub = sinon.stub(actionsUtil, "getRequiredInput");
|
const requiredInputStub = sinon.stub(actionsUtil, "getRequiredInput");
|
||||||
requiredInputStub.withArgs("analysis-kinds").returns("code-scanning");
|
requiredInputStub.withArgs("analysis-kinds").returns("code-scanning");
|
||||||
const optionalInputStub = sinon.stub(actionsUtil, "getOptionalInput");
|
const optionalInputStub = sinon.stub(actionsUtil, "getOptionalInput");
|
||||||
optionalInputStub.withArgs("quality-queries").returns("code-quality");
|
optionalInputStub.withArgs("quality-queries").returns("code-quality");
|
||||||
const result = await getAnalysisKinds(getRunnerLogger(true), true);
|
const result = await getAnalysisKinds(
|
||||||
|
getRunnerLogger(true),
|
||||||
|
features,
|
||||||
|
true,
|
||||||
|
);
|
||||||
t.assert(result.includes(AnalysisKind.CodeScanning));
|
t.assert(result.includes(AnalysisKind.CodeScanning));
|
||||||
t.assert(result.includes(AnalysisKind.CodeQuality));
|
t.assert(result.includes(AnalysisKind.CodeQuality));
|
||||||
},
|
},
|
||||||
@@ -79,9 +151,12 @@ test.serial(
|
|||||||
test.serial(
|
test.serial(
|
||||||
"getAnalysisKinds - throws if `analysis-kinds` input is invalid",
|
"getAnalysisKinds - throws if `analysis-kinds` input is invalid",
|
||||||
async (t) => {
|
async (t) => {
|
||||||
|
const features = createFeatures([]);
|
||||||
const requiredInputStub = sinon.stub(actionsUtil, "getRequiredInput");
|
const requiredInputStub = sinon.stub(actionsUtil, "getRequiredInput");
|
||||||
requiredInputStub.withArgs("analysis-kinds").returns("no-such-thing");
|
requiredInputStub.withArgs("analysis-kinds").returns("no-such-thing");
|
||||||
await t.throwsAsync(getAnalysisKinds(getRunnerLogger(true), true));
|
await t.throwsAsync(
|
||||||
|
getAnalysisKinds(getRunnerLogger(true), features, true),
|
||||||
|
);
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
@@ -98,11 +173,18 @@ for (let i = 0; i < analysisKinds.length; i++) {
|
|||||||
test.serial(
|
test.serial(
|
||||||
`getAnalysisKinds - allows ${analysisKind} with ${otherAnalysis}`,
|
`getAnalysisKinds - allows ${analysisKind} with ${otherAnalysis}`,
|
||||||
async (t) => {
|
async (t) => {
|
||||||
|
setupBaseActionsVars();
|
||||||
|
process.env[EnvVar.TEST_MODE] = "true";
|
||||||
|
const features = createFeatures([]);
|
||||||
const requiredInputStub = sinon.stub(actionsUtil, "getRequiredInput");
|
const requiredInputStub = sinon.stub(actionsUtil, "getRequiredInput");
|
||||||
requiredInputStub
|
requiredInputStub
|
||||||
.withArgs("analysis-kinds")
|
.withArgs("analysis-kinds")
|
||||||
.returns([analysisKind, otherAnalysis].join(","));
|
.returns([analysisKind, otherAnalysis].join(","));
|
||||||
const result = await getAnalysisKinds(getRunnerLogger(true), true);
|
const result = await getAnalysisKinds(
|
||||||
|
getRunnerLogger(true),
|
||||||
|
features,
|
||||||
|
true,
|
||||||
|
);
|
||||||
t.is(result.length, 2);
|
t.is(result.length, 2);
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
@@ -110,14 +192,19 @@ for (let i = 0; i < analysisKinds.length; i++) {
|
|||||||
test.serial(
|
test.serial(
|
||||||
`getAnalysisKinds - throws if ${analysisKind} is enabled with ${otherAnalysis}`,
|
`getAnalysisKinds - throws if ${analysisKind} is enabled with ${otherAnalysis}`,
|
||||||
async (t) => {
|
async (t) => {
|
||||||
|
setupBaseActionsVars();
|
||||||
|
const features = createFeatures([]);
|
||||||
const requiredInputStub = sinon.stub(actionsUtil, "getRequiredInput");
|
const requiredInputStub = sinon.stub(actionsUtil, "getRequiredInput");
|
||||||
requiredInputStub
|
requiredInputStub
|
||||||
.withArgs("analysis-kinds")
|
.withArgs("analysis-kinds")
|
||||||
.returns([analysisKind, otherAnalysis].join(","));
|
.returns([analysisKind, otherAnalysis].join(","));
|
||||||
await t.throwsAsync(getAnalysisKinds(getRunnerLogger(true), true), {
|
await t.throwsAsync(
|
||||||
instanceOf: ConfigurationError,
|
getAnalysisKinds(getRunnerLogger(true), features, true),
|
||||||
message: `${analysisKind} and ${otherAnalysis} cannot be enabled at the same time`,
|
{
|
||||||
});
|
instanceOf: ConfigurationError,
|
||||||
|
message: `${analysisKind} and ${otherAnalysis} cannot be enabled at the same time`,
|
||||||
|
},
|
||||||
|
);
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
+58
-1
@@ -2,15 +2,17 @@ import {
|
|||||||
fixCodeQualityCategory,
|
fixCodeQualityCategory,
|
||||||
getOptionalInput,
|
getOptionalInput,
|
||||||
getRequiredInput,
|
getRequiredInput,
|
||||||
|
isDynamicWorkflow,
|
||||||
} from "./actions-util";
|
} from "./actions-util";
|
||||||
import { EnvVar } from "./environment";
|
import { EnvVar } from "./environment";
|
||||||
|
import { Feature, FeatureEnablement } from "./feature-flags";
|
||||||
import { Logger } from "./logging";
|
import { Logger } from "./logging";
|
||||||
import {
|
import {
|
||||||
AssessmentPayload,
|
AssessmentPayload,
|
||||||
BasePayload,
|
BasePayload,
|
||||||
UploadPayload,
|
UploadPayload,
|
||||||
} from "./upload-lib/types";
|
} from "./upload-lib/types";
|
||||||
import { ConfigurationError, getRequiredEnvParam } from "./util";
|
import { ConfigurationError, getRequiredEnvParam, isInTestMode } from "./util";
|
||||||
|
|
||||||
export enum AnalysisKind {
|
export enum AnalysisKind {
|
||||||
CodeScanning = "code-scanning",
|
CodeScanning = "code-scanning",
|
||||||
@@ -64,6 +66,21 @@ export async function parseAnalysisKinds(
|
|||||||
// Used to avoid re-parsing the input after we have done it once.
|
// Used to avoid re-parsing the input after we have done it once.
|
||||||
let cachedAnalysisKinds: AnalysisKind[] | undefined;
|
let cachedAnalysisKinds: AnalysisKind[] | undefined;
|
||||||
|
|
||||||
|
/** Determines whether `code-scanning` is the only enabled analysis kind in `analysisKinds`. */
|
||||||
|
function isOnlyCodeScanningEnabled(analysisKinds: AnalysisKind[]) {
|
||||||
|
return (
|
||||||
|
analysisKinds.length === 1 && analysisKinds[0] === AnalysisKind.CodeScanning
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Prepends a generic message about the intended usage for `analysis-kinds` to `message`. */
|
||||||
|
function makeAnalysisKindUsageError(message: string) {
|
||||||
|
return (
|
||||||
|
"The `analysis-kinds` input is experimental and for GitHub-internal use only. " +
|
||||||
|
`Its behaviour may change at any time or be removed entirely. ${message}`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Initialises the analysis kinds for the analysis based on the `analysis-kinds` input.
|
* Initialises the analysis kinds for the analysis based on the `analysis-kinds` input.
|
||||||
* This function will also use the deprecated `quality-queries` input as an indicator to enable `code-quality`.
|
* This function will also use the deprecated `quality-queries` input as an indicator to enable `code-quality`.
|
||||||
@@ -77,6 +94,7 @@ let cachedAnalysisKinds: AnalysisKind[] | undefined;
|
|||||||
*/
|
*/
|
||||||
export async function getAnalysisKinds(
|
export async function getAnalysisKinds(
|
||||||
logger: Logger,
|
logger: Logger,
|
||||||
|
features: FeatureEnablement,
|
||||||
skipCache: boolean = false,
|
skipCache: boolean = false,
|
||||||
): Promise<AnalysisKind[]> {
|
): Promise<AnalysisKind[]> {
|
||||||
if (!skipCache && cachedAnalysisKinds !== undefined) {
|
if (!skipCache && cachedAnalysisKinds !== undefined) {
|
||||||
@@ -87,6 +105,26 @@ export async function getAnalysisKinds(
|
|||||||
getRequiredInput("analysis-kinds"),
|
getRequiredInput("analysis-kinds"),
|
||||||
);
|
);
|
||||||
|
|
||||||
|
// Log an error if we are outside of a GitHub-managed workflow and an analysis kind
|
||||||
|
// other than `code-scanning` is enabled.
|
||||||
|
if (
|
||||||
|
!isInTestMode() &&
|
||||||
|
!isDynamicWorkflow() &&
|
||||||
|
!isOnlyCodeScanningEnabled(analysisKinds)
|
||||||
|
) {
|
||||||
|
const codeQualityHint = analysisKinds.includes(AnalysisKind.CodeQuality)
|
||||||
|
? " If your intention is to use quality queries outside of Code Quality, " +
|
||||||
|
"use the `queries` input with `code-quality` instead."
|
||||||
|
: "";
|
||||||
|
|
||||||
|
logger.error(
|
||||||
|
makeAnalysisKindUsageError(
|
||||||
|
"An analysis kind other than `code-scanning` was specified in a custom workflow. " +
|
||||||
|
`This is not supported and will become a fatal error in a future version of the CodeQL Action.${codeQualityHint}`,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
// Warn that `quality-queries` is deprecated if there is an argument for it.
|
// Warn that `quality-queries` is deprecated if there is an argument for it.
|
||||||
const qualityQueriesInput = getOptionalInput("quality-queries");
|
const qualityQueriesInput = getOptionalInput("quality-queries");
|
||||||
|
|
||||||
@@ -120,6 +158,25 @@ export async function getAnalysisKinds(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Log an error if we have multiple inputs for `analysis-kinds` outside of test mode,
|
||||||
|
// and enable only `code-scanning`.
|
||||||
|
if (
|
||||||
|
!isInTestMode() &&
|
||||||
|
analysisKinds.length > 1 &&
|
||||||
|
!(await features.getValue(Feature.AllowMultipleAnalysisKinds))
|
||||||
|
) {
|
||||||
|
logger.error(
|
||||||
|
makeAnalysisKindUsageError(
|
||||||
|
"Specifying multiple values as input is no longer supported. " +
|
||||||
|
"Continuing with only `analysis-kinds: code-scanning`.",
|
||||||
|
),
|
||||||
|
);
|
||||||
|
|
||||||
|
// Only enable Code Scanning.
|
||||||
|
cachedAnalysisKinds = [AnalysisKind.CodeScanning];
|
||||||
|
return cachedAnalysisKinds;
|
||||||
|
}
|
||||||
|
|
||||||
// Cache the analysis kinds and return them.
|
// Cache the analysis kinds and return them.
|
||||||
cachedAnalysisKinds = analysisKinds;
|
cachedAnalysisKinds = analysisKinds;
|
||||||
return cachedAnalysisKinds;
|
return cachedAnalysisKinds;
|
||||||
|
|||||||
@@ -1,90 +0,0 @@
|
|||||||
import test from "ava";
|
|
||||||
import * as sinon from "sinon";
|
|
||||||
|
|
||||||
import * as actionsUtil from "./actions-util";
|
|
||||||
import * as analyze from "./analyze";
|
|
||||||
import * as api from "./api-client";
|
|
||||||
import * as configUtils from "./config-utils";
|
|
||||||
import * as gitUtils from "./git-utils";
|
|
||||||
import * as statusReport from "./status-report";
|
|
||||||
import {
|
|
||||||
setupTests,
|
|
||||||
setupActionsVars,
|
|
||||||
mockFeatureFlagApiEndpoint,
|
|
||||||
} from "./testing-utils";
|
|
||||||
import * as util from "./util";
|
|
||||||
|
|
||||||
setupTests(test);
|
|
||||||
|
|
||||||
// This test needs to be in its own file so that ava would run it in its own
|
|
||||||
// nodejs process. The code being tested is in analyze-action.ts, which runs
|
|
||||||
// immediately on load. So the file needs to be loaded during part of the test,
|
|
||||||
// and that can happen only once per nodejs process. If multiple such tests are
|
|
||||||
// in the same test file, ava would run them in the same nodejs process, and all
|
|
||||||
// but the first test would fail.
|
|
||||||
|
|
||||||
test("analyze action with RAM & threads from environment variables", async (t) => {
|
|
||||||
// This test frequently times out on Windows with the default timeout, so we bump
|
|
||||||
// it a bit to 20s.
|
|
||||||
t.timeout(1000 * 20);
|
|
||||||
await util.withTmpDir(async (tmpDir) => {
|
|
||||||
setupActionsVars(tmpDir, tmpDir);
|
|
||||||
sinon
|
|
||||||
.stub(statusReport, "createStatusReportBase")
|
|
||||||
.resolves({} as statusReport.StatusReportBase);
|
|
||||||
sinon.stub(statusReport, "sendStatusReport").resolves();
|
|
||||||
sinon.stub(gitUtils, "isAnalyzingDefaultBranch").resolves(true);
|
|
||||||
|
|
||||||
const gitHubVersion: util.GitHubVersion = {
|
|
||||||
type: util.GitHubVariant.DOTCOM,
|
|
||||||
};
|
|
||||||
sinon.stub(configUtils, "getConfig").resolves({
|
|
||||||
gitHubVersion,
|
|
||||||
augmentationProperties: {},
|
|
||||||
languages: [],
|
|
||||||
packs: [],
|
|
||||||
trapCaches: {},
|
|
||||||
} as unknown as configUtils.Config);
|
|
||||||
const requiredInputStub = sinon.stub(actionsUtil, "getRequiredInput");
|
|
||||||
requiredInputStub.withArgs("token").returns("fake-token");
|
|
||||||
requiredInputStub.withArgs("upload-database").returns("false");
|
|
||||||
requiredInputStub.withArgs("output").returns("out");
|
|
||||||
const optionalInputStub = sinon.stub(actionsUtil, "getOptionalInput");
|
|
||||||
optionalInputStub.withArgs("expect-error").returns("false");
|
|
||||||
sinon.stub(api, "getGitHubVersion").resolves(gitHubVersion);
|
|
||||||
mockFeatureFlagApiEndpoint(200, {});
|
|
||||||
|
|
||||||
// When there are no action inputs for RAM and threads, the action uses
|
|
||||||
// environment variables (passed down from the init action) to set RAM and
|
|
||||||
// threads usage.
|
|
||||||
process.env["CODEQL_THREADS"] = "-1";
|
|
||||||
process.env["CODEQL_RAM"] = "4992";
|
|
||||||
|
|
||||||
const runFinalizeStub = sinon.stub(analyze, "runFinalize");
|
|
||||||
const runQueriesStub = sinon.stub(analyze, "runQueries");
|
|
||||||
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
|
||||||
const analyzeAction = require("./analyze-action");
|
|
||||||
|
|
||||||
// When analyze-action.ts loads, it runs an async function from the top
|
|
||||||
// level but does not wait for it to finish. To ensure that calls to
|
|
||||||
// runFinalize and runQueries are correctly captured by spies, we explicitly
|
|
||||||
// wait for the action promise to complete before starting verification.
|
|
||||||
await analyzeAction.runPromise;
|
|
||||||
|
|
||||||
t.assert(
|
|
||||||
runFinalizeStub.calledOnceWith(
|
|
||||||
sinon.match.any,
|
|
||||||
sinon.match.any,
|
|
||||||
"--threads=-1",
|
|
||||||
"--ram=4992",
|
|
||||||
),
|
|
||||||
);
|
|
||||||
t.assert(
|
|
||||||
runQueriesStub.calledOnceWith(
|
|
||||||
sinon.match.any,
|
|
||||||
"--ram=4992",
|
|
||||||
"--threads=-1",
|
|
||||||
),
|
|
||||||
);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,88 +0,0 @@
|
|||||||
import test from "ava";
|
|
||||||
import * as sinon from "sinon";
|
|
||||||
|
|
||||||
import * as actionsUtil from "./actions-util";
|
|
||||||
import * as analyze from "./analyze";
|
|
||||||
import * as api from "./api-client";
|
|
||||||
import * as configUtils from "./config-utils";
|
|
||||||
import * as gitUtils from "./git-utils";
|
|
||||||
import * as statusReport from "./status-report";
|
|
||||||
import {
|
|
||||||
setupTests,
|
|
||||||
setupActionsVars,
|
|
||||||
mockFeatureFlagApiEndpoint,
|
|
||||||
} from "./testing-utils";
|
|
||||||
import * as util from "./util";
|
|
||||||
|
|
||||||
setupTests(test);
|
|
||||||
|
|
||||||
// This test needs to be in its own file so that ava would run it in its own
|
|
||||||
// nodejs process. The code being tested is in analyze-action.ts, which runs
|
|
||||||
// immediately on load. So the file needs to be loaded during part of the test,
|
|
||||||
// and that can happen only once per nodejs process. If multiple such tests are
|
|
||||||
// in the same test file, ava would run them in the same nodejs process, and all
|
|
||||||
// but the first test would fail.
|
|
||||||
|
|
||||||
test("analyze action with RAM & threads from action inputs", async (t) => {
|
|
||||||
t.timeout(1000 * 20);
|
|
||||||
await util.withTmpDir(async (tmpDir) => {
|
|
||||||
setupActionsVars(tmpDir, tmpDir);
|
|
||||||
sinon
|
|
||||||
.stub(statusReport, "createStatusReportBase")
|
|
||||||
.resolves({} as statusReport.StatusReportBase);
|
|
||||||
sinon.stub(statusReport, "sendStatusReport").resolves();
|
|
||||||
const gitHubVersion: util.GitHubVersion = {
|
|
||||||
type: util.GitHubVariant.DOTCOM,
|
|
||||||
};
|
|
||||||
sinon.stub(configUtils, "getConfig").resolves({
|
|
||||||
gitHubVersion,
|
|
||||||
augmentationProperties: {},
|
|
||||||
languages: [],
|
|
||||||
packs: [],
|
|
||||||
trapCaches: {},
|
|
||||||
} as unknown as configUtils.Config);
|
|
||||||
const requiredInputStub = sinon.stub(actionsUtil, "getRequiredInput");
|
|
||||||
requiredInputStub.withArgs("token").returns("fake-token");
|
|
||||||
requiredInputStub.withArgs("upload-database").returns("false");
|
|
||||||
requiredInputStub.withArgs("output").returns("out");
|
|
||||||
const optionalInputStub = sinon.stub(actionsUtil, "getOptionalInput");
|
|
||||||
optionalInputStub.withArgs("expect-error").returns("false");
|
|
||||||
sinon.stub(api, "getGitHubVersion").resolves(gitHubVersion);
|
|
||||||
sinon.stub(gitUtils, "isAnalyzingDefaultBranch").resolves(true);
|
|
||||||
mockFeatureFlagApiEndpoint(200, {});
|
|
||||||
|
|
||||||
process.env["CODEQL_THREADS"] = "1";
|
|
||||||
process.env["CODEQL_RAM"] = "4992";
|
|
||||||
|
|
||||||
// Action inputs have precedence over environment variables.
|
|
||||||
optionalInputStub.withArgs("threads").returns("-1");
|
|
||||||
optionalInputStub.withArgs("ram").returns("3012");
|
|
||||||
|
|
||||||
const runFinalizeStub = sinon.stub(analyze, "runFinalize");
|
|
||||||
const runQueriesStub = sinon.stub(analyze, "runQueries");
|
|
||||||
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
|
||||||
const analyzeAction = require("./analyze-action");
|
|
||||||
|
|
||||||
// When analyze-action.ts loads, it runs an async function from the top
|
|
||||||
// level but does not wait for it to finish. To ensure that calls to
|
|
||||||
// runFinalize and runQueries are correctly captured by spies, we explicitly
|
|
||||||
// wait for the action promise to complete before starting verification.
|
|
||||||
await analyzeAction.runPromise;
|
|
||||||
|
|
||||||
t.assert(
|
|
||||||
runFinalizeStub.calledOnceWith(
|
|
||||||
sinon.match.any,
|
|
||||||
sinon.match.any,
|
|
||||||
"--threads=-1",
|
|
||||||
"--ram=3012",
|
|
||||||
),
|
|
||||||
);
|
|
||||||
t.assert(
|
|
||||||
runQueriesStub.calledOnceWith(
|
|
||||||
sinon.match.any,
|
|
||||||
"--ram=3012",
|
|
||||||
"--threads=-1",
|
|
||||||
),
|
|
||||||
);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -20,7 +20,7 @@ import { EnvVar } from "./environment";
|
|||||||
import { getActionsLogger } from "./logging";
|
import { getActionsLogger } from "./logging";
|
||||||
import { checkGitHubVersionInRange, getErrorMessage } from "./util";
|
import { checkGitHubVersionInRange, getErrorMessage } from "./util";
|
||||||
|
|
||||||
async function runWrapper() {
|
export async function runWrapper() {
|
||||||
// To capture errors appropriately, keep as much code within the try-catch as
|
// To capture errors appropriately, keep as much code within the try-catch as
|
||||||
// possible, and only use safe functions outside.
|
// possible, and only use safe functions outside.
|
||||||
|
|
||||||
@@ -72,5 +72,3 @@ async function runWrapper() {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
void runWrapper();
|
|
||||||
|
|||||||
@@ -0,0 +1,142 @@
|
|||||||
|
import test from "ava";
|
||||||
|
import * as sinon from "sinon";
|
||||||
|
|
||||||
|
import * as actionsUtil from "./actions-util";
|
||||||
|
import * as analyze from "./analyze";
|
||||||
|
import { runWrapper } from "./analyze-action";
|
||||||
|
import * as api from "./api-client";
|
||||||
|
import * as configUtils from "./config-utils";
|
||||||
|
import * as gitUtils from "./git-utils";
|
||||||
|
import * as statusReport from "./status-report";
|
||||||
|
import {
|
||||||
|
setupTests,
|
||||||
|
setupActionsVars,
|
||||||
|
mockFeatureFlagApiEndpoint,
|
||||||
|
} from "./testing-utils";
|
||||||
|
import * as util from "./util";
|
||||||
|
|
||||||
|
setupTests(test);
|
||||||
|
|
||||||
|
test.serial(
|
||||||
|
"analyze action with RAM & threads from environment variables",
|
||||||
|
async (t) => {
|
||||||
|
// This test frequently times out on Windows with the default timeout, so we bump
|
||||||
|
// it a bit to 20s.
|
||||||
|
t.timeout(1000 * 20);
|
||||||
|
await util.withTmpDir(async (tmpDir) => {
|
||||||
|
setupActionsVars(tmpDir, tmpDir);
|
||||||
|
sinon
|
||||||
|
.stub(statusReport, "createStatusReportBase")
|
||||||
|
.resolves({} as statusReport.StatusReportBase);
|
||||||
|
sinon.stub(statusReport, "sendStatusReport").resolves();
|
||||||
|
sinon.stub(gitUtils, "isAnalyzingDefaultBranch").resolves(true);
|
||||||
|
|
||||||
|
const gitHubVersion: util.GitHubVersion = {
|
||||||
|
type: util.GitHubVariant.DOTCOM,
|
||||||
|
};
|
||||||
|
sinon.stub(configUtils, "getConfig").resolves({
|
||||||
|
gitHubVersion,
|
||||||
|
augmentationProperties: {},
|
||||||
|
languages: [],
|
||||||
|
packs: [],
|
||||||
|
trapCaches: {},
|
||||||
|
} as unknown as configUtils.Config);
|
||||||
|
const requiredInputStub = sinon.stub(actionsUtil, "getRequiredInput");
|
||||||
|
requiredInputStub.withArgs("token").returns("fake-token");
|
||||||
|
requiredInputStub.withArgs("upload-database").returns("false");
|
||||||
|
requiredInputStub.withArgs("output").returns("out");
|
||||||
|
const optionalInputStub = sinon.stub(actionsUtil, "getOptionalInput");
|
||||||
|
optionalInputStub.withArgs("expect-error").returns("false");
|
||||||
|
sinon.stub(api, "getGitHubVersion").resolves(gitHubVersion);
|
||||||
|
mockFeatureFlagApiEndpoint(200, {});
|
||||||
|
|
||||||
|
// When there are no action inputs for RAM and threads, the action uses
|
||||||
|
// environment variables (passed down from the init action) to set RAM and
|
||||||
|
// threads usage.
|
||||||
|
process.env["CODEQL_THREADS"] = "-1";
|
||||||
|
process.env["CODEQL_RAM"] = "4992";
|
||||||
|
|
||||||
|
const runFinalizeStub = sinon.stub(analyze, "runFinalize");
|
||||||
|
const runQueriesStub = sinon.stub(analyze, "runQueries");
|
||||||
|
|
||||||
|
await runWrapper();
|
||||||
|
|
||||||
|
t.assert(
|
||||||
|
runFinalizeStub.calledOnceWith(
|
||||||
|
sinon.match.any,
|
||||||
|
sinon.match.any,
|
||||||
|
"--threads=-1",
|
||||||
|
"--ram=4992",
|
||||||
|
),
|
||||||
|
);
|
||||||
|
t.assert(
|
||||||
|
runQueriesStub.calledOnceWith(
|
||||||
|
sinon.match.any,
|
||||||
|
"--ram=4992",
|
||||||
|
"--threads=-1",
|
||||||
|
),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
test.serial(
|
||||||
|
"analyze action with RAM & threads from action inputs",
|
||||||
|
async (t) => {
|
||||||
|
t.timeout(1000 * 20);
|
||||||
|
await util.withTmpDir(async (tmpDir) => {
|
||||||
|
setupActionsVars(tmpDir, tmpDir);
|
||||||
|
sinon
|
||||||
|
.stub(statusReport, "createStatusReportBase")
|
||||||
|
.resolves({} as statusReport.StatusReportBase);
|
||||||
|
sinon.stub(statusReport, "sendStatusReport").resolves();
|
||||||
|
const gitHubVersion: util.GitHubVersion = {
|
||||||
|
type: util.GitHubVariant.DOTCOM,
|
||||||
|
};
|
||||||
|
sinon.stub(configUtils, "getConfig").resolves({
|
||||||
|
gitHubVersion,
|
||||||
|
augmentationProperties: {},
|
||||||
|
languages: [],
|
||||||
|
packs: [],
|
||||||
|
trapCaches: {},
|
||||||
|
} as unknown as configUtils.Config);
|
||||||
|
const requiredInputStub = sinon.stub(actionsUtil, "getRequiredInput");
|
||||||
|
requiredInputStub.withArgs("token").returns("fake-token");
|
||||||
|
requiredInputStub.withArgs("upload-database").returns("false");
|
||||||
|
requiredInputStub.withArgs("output").returns("out");
|
||||||
|
const optionalInputStub = sinon.stub(actionsUtil, "getOptionalInput");
|
||||||
|
optionalInputStub.withArgs("expect-error").returns("false");
|
||||||
|
sinon.stub(api, "getGitHubVersion").resolves(gitHubVersion);
|
||||||
|
sinon.stub(gitUtils, "isAnalyzingDefaultBranch").resolves(true);
|
||||||
|
mockFeatureFlagApiEndpoint(200, {});
|
||||||
|
|
||||||
|
process.env["CODEQL_THREADS"] = "1";
|
||||||
|
process.env["CODEQL_RAM"] = "4992";
|
||||||
|
|
||||||
|
// Action inputs have precedence over environment variables.
|
||||||
|
optionalInputStub.withArgs("threads").returns("-1");
|
||||||
|
optionalInputStub.withArgs("ram").returns("3012");
|
||||||
|
|
||||||
|
const runFinalizeStub = sinon.stub(analyze, "runFinalize");
|
||||||
|
const runQueriesStub = sinon.stub(analyze, "runQueries");
|
||||||
|
|
||||||
|
await runWrapper();
|
||||||
|
|
||||||
|
t.assert(
|
||||||
|
runFinalizeStub.calledOnceWith(
|
||||||
|
sinon.match.any,
|
||||||
|
sinon.match.any,
|
||||||
|
"--threads=-1",
|
||||||
|
"--ram=3012",
|
||||||
|
),
|
||||||
|
);
|
||||||
|
t.assert(
|
||||||
|
runQueriesStub.calledOnceWith(
|
||||||
|
sinon.match.any,
|
||||||
|
"--ram=3012",
|
||||||
|
"--threads=-1",
|
||||||
|
),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
},
|
||||||
|
);
|
||||||
+14
-15
@@ -30,9 +30,9 @@ import {
|
|||||||
} from "./dependency-caching";
|
} from "./dependency-caching";
|
||||||
import { EnvVar } from "./environment";
|
import { EnvVar } from "./environment";
|
||||||
import { initFeatures } from "./feature-flags";
|
import { initFeatures } from "./feature-flags";
|
||||||
import { KnownLanguage } from "./languages";
|
import { BuiltInLanguage } from "./languages";
|
||||||
import { getActionsLogger, Logger } from "./logging";
|
import { getActionsLogger, Logger } from "./logging";
|
||||||
import { cleanupAndUploadOverlayBaseDatabaseToCache } from "./overlay";
|
import { cleanupAndUploadOverlayBaseDatabaseToCache } from "./overlay/caching";
|
||||||
import { getRepositoryNwo } from "./repository";
|
import { getRepositoryNwo } from "./repository";
|
||||||
import * as statusReport from "./status-report";
|
import * as statusReport from "./status-report";
|
||||||
import {
|
import {
|
||||||
@@ -135,9 +135,13 @@ function hasBadExpectErrorInput(): boolean {
|
|||||||
function doesGoExtractionOutputExist(config: Config): boolean {
|
function doesGoExtractionOutputExist(config: Config): boolean {
|
||||||
const golangDbDirectory = util.getCodeQLDatabasePath(
|
const golangDbDirectory = util.getCodeQLDatabasePath(
|
||||||
config,
|
config,
|
||||||
KnownLanguage.go,
|
BuiltInLanguage.go,
|
||||||
|
);
|
||||||
|
const trapDirectory = path.join(
|
||||||
|
golangDbDirectory,
|
||||||
|
"trap",
|
||||||
|
BuiltInLanguage.go,
|
||||||
);
|
);
|
||||||
const trapDirectory = path.join(golangDbDirectory, "trap", KnownLanguage.go);
|
|
||||||
return (
|
return (
|
||||||
fs.existsSync(trapDirectory) &&
|
fs.existsSync(trapDirectory) &&
|
||||||
fs
|
fs
|
||||||
@@ -169,7 +173,7 @@ function doesGoExtractionOutputExist(config: Config): boolean {
|
|||||||
* whether any extraction output already exists for Go.
|
* whether any extraction output already exists for Go.
|
||||||
*/
|
*/
|
||||||
async function runAutobuildIfLegacyGoWorkflow(config: Config, logger: Logger) {
|
async function runAutobuildIfLegacyGoWorkflow(config: Config, logger: Logger) {
|
||||||
if (!config.languages.includes(KnownLanguage.go)) {
|
if (!config.languages.includes(BuiltInLanguage.go)) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
if (config.buildMode) {
|
if (config.buildMode) {
|
||||||
@@ -182,7 +186,7 @@ async function runAutobuildIfLegacyGoWorkflow(config: Config, logger: Logger) {
|
|||||||
logger.debug("Won't run Go autobuild since it has already been run.");
|
logger.debug("Won't run Go autobuild since it has already been run.");
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
if (dbIsFinalized(config, KnownLanguage.go, logger)) {
|
if (dbIsFinalized(config, BuiltInLanguage.go, logger)) {
|
||||||
logger.debug(
|
logger.debug(
|
||||||
"Won't run Go autobuild since there is already a finalized database for Go.",
|
"Won't run Go autobuild since there is already a finalized database for Go.",
|
||||||
);
|
);
|
||||||
@@ -205,7 +209,7 @@ async function runAutobuildIfLegacyGoWorkflow(config: Config, logger: Logger) {
|
|||||||
logger.debug(
|
logger.debug(
|
||||||
"Running Go autobuild because extraction output (TRAP files) for Go code has not been found.",
|
"Running Go autobuild because extraction output (TRAP files) for Go code has not been found.",
|
||||||
);
|
);
|
||||||
await runAutobuild(config, KnownLanguage.go, logger);
|
await runAutobuild(config, BuiltInLanguage.go, logger);
|
||||||
}
|
}
|
||||||
|
|
||||||
async function run(startedAt: Date) {
|
async function run(startedAt: Date) {
|
||||||
@@ -519,14 +523,11 @@ async function run(startedAt: Date) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Module-level startedAt so it can be accessed by runWrapper for error reporting
|
export async function runWrapper() {
|
||||||
const startedAt = new Date();
|
const startedAt = new Date();
|
||||||
export const runPromise = run(startedAt);
|
|
||||||
|
|
||||||
async function runWrapper() {
|
|
||||||
const logger = getActionsLogger();
|
const logger = getActionsLogger();
|
||||||
try {
|
try {
|
||||||
await runPromise;
|
await run(startedAt);
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
core.setFailed(`analyze action failed: ${util.getErrorMessage(error)}`);
|
core.setFailed(`analyze action failed: ${util.getErrorMessage(error)}`);
|
||||||
await sendUnhandledErrorStatusReport(
|
await sendUnhandledErrorStatusReport(
|
||||||
@@ -538,5 +539,3 @@ async function runWrapper() {
|
|||||||
}
|
}
|
||||||
await util.checkForTimeout();
|
await util.checkForTimeout();
|
||||||
}
|
}
|
||||||
|
|
||||||
void runWrapper();
|
|
||||||
|
|||||||
+6
-6
@@ -14,7 +14,7 @@ import {
|
|||||||
} from "./analyze";
|
} from "./analyze";
|
||||||
import { createStubCodeQL } from "./codeql";
|
import { createStubCodeQL } from "./codeql";
|
||||||
import { Feature } from "./feature-flags";
|
import { Feature } from "./feature-flags";
|
||||||
import { KnownLanguage } from "./languages";
|
import { BuiltInLanguage } from "./languages";
|
||||||
import { getRunnerLogger } from "./logging";
|
import { getRunnerLogger } from "./logging";
|
||||||
import {
|
import {
|
||||||
setupTests,
|
setupTests,
|
||||||
@@ -41,7 +41,7 @@ test.serial("status report fields", async (t) => {
|
|||||||
const threadsFlag = "";
|
const threadsFlag = "";
|
||||||
sinon.stub(uploadLib, "validateSarifFileSchema");
|
sinon.stub(uploadLib, "validateSarifFileSchema");
|
||||||
|
|
||||||
for (const language of Object.values(KnownLanguage)) {
|
for (const language of Object.values(BuiltInLanguage)) {
|
||||||
const codeql = createStubCodeQL({
|
const codeql = createStubCodeQL({
|
||||||
databaseRunQueries: async () => {},
|
databaseRunQueries: async () => {},
|
||||||
databaseInterpretResults: async (
|
databaseInterpretResults: async (
|
||||||
@@ -130,13 +130,13 @@ test.serial("status report fields", async (t) => {
|
|||||||
test("resolveQuerySuiteAlias", (t) => {
|
test("resolveQuerySuiteAlias", (t) => {
|
||||||
// default query suite names should resolve to something language-specific ending in `.qls`.
|
// default query suite names should resolve to something language-specific ending in `.qls`.
|
||||||
for (const suite of defaultSuites) {
|
for (const suite of defaultSuites) {
|
||||||
const resolved = resolveQuerySuiteAlias(KnownLanguage.go, suite);
|
const resolved = resolveQuerySuiteAlias(BuiltInLanguage.go, suite);
|
||||||
t.assert(
|
t.assert(
|
||||||
path.extname(resolved) === ".qls",
|
path.extname(resolved) === ".qls",
|
||||||
"Resolved default suite doesn't end in .qls",
|
"Resolved default suite doesn't end in .qls",
|
||||||
);
|
);
|
||||||
t.assert(
|
t.assert(
|
||||||
resolved.indexOf(KnownLanguage.go) >= 0,
|
resolved.indexOf(BuiltInLanguage.go) >= 0,
|
||||||
"Resolved default suite doesn't contain language name",
|
"Resolved default suite doesn't contain language name",
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -145,12 +145,12 @@ test("resolveQuerySuiteAlias", (t) => {
|
|||||||
const names = ["foo", "bar", "codeql/go-queries@1.0"];
|
const names = ["foo", "bar", "codeql/go-queries@1.0"];
|
||||||
|
|
||||||
for (const name of names) {
|
for (const name of names) {
|
||||||
t.deepEqual(resolveQuerySuiteAlias(KnownLanguage.go, name), name);
|
t.deepEqual(resolveQuerySuiteAlias(BuiltInLanguage.go, name), name);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
test("addSarifExtension", (t) => {
|
test("addSarifExtension", (t) => {
|
||||||
for (const language of Object.values(KnownLanguage)) {
|
for (const language of Object.values(BuiltInLanguage)) {
|
||||||
t.deepEqual(addSarifExtension(CodeScanning, language), `${language}.sarif`);
|
t.deepEqual(addSarifExtension(CodeScanning, language), `${language}.sarif`);
|
||||||
t.deepEqual(
|
t.deepEqual(
|
||||||
addSarifExtension(CodeQuality, language),
|
addSarifExtension(CodeQuality, language),
|
||||||
|
|||||||
+16
-28
@@ -21,9 +21,9 @@ import {
|
|||||||
} from "./diff-informed-analysis-utils";
|
} from "./diff-informed-analysis-utils";
|
||||||
import { EnvVar } from "./environment";
|
import { EnvVar } from "./environment";
|
||||||
import { FeatureEnablement, Feature } from "./feature-flags";
|
import { FeatureEnablement, Feature } from "./feature-flags";
|
||||||
import { KnownLanguage, Language } from "./languages";
|
import { BuiltInLanguage, Language } from "./languages";
|
||||||
import { Logger, withGroupAsync } from "./logging";
|
import { Logger, withGroupAsync } from "./logging";
|
||||||
import { OverlayDatabaseMode } from "./overlay";
|
import { OverlayDatabaseMode } from "./overlay/overlay-database-mode";
|
||||||
import type * as sarif from "./sarif";
|
import type * as sarif from "./sarif";
|
||||||
import { DatabaseCreationTimings, EventReport } from "./status-report";
|
import { DatabaseCreationTimings, EventReport } from "./status-report";
|
||||||
import { endTracingForCluster } from "./tracer-config";
|
import { endTracingForCluster } from "./tracer-config";
|
||||||
@@ -41,7 +41,7 @@ export class CodeQLAnalysisError extends Error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
type KnownLanguageKey = keyof typeof KnownLanguage;
|
type BuiltInLanguageKey = keyof typeof BuiltInLanguage;
|
||||||
|
|
||||||
type RunQueriesDurationStatusReport = {
|
type RunQueriesDurationStatusReport = {
|
||||||
/**
|
/**
|
||||||
@@ -50,12 +50,12 @@ type RunQueriesDurationStatusReport = {
|
|||||||
* The "builtin" designation is now outdated with the move to CLI config parsing: this is the time
|
* The "builtin" designation is now outdated with the move to CLI config parsing: this is the time
|
||||||
* taken to run _all_ the queries.
|
* taken to run _all_ the queries.
|
||||||
*/
|
*/
|
||||||
[L in KnownLanguageKey as `analyze_builtin_queries_${L}_duration_ms`]?: number;
|
[L in BuiltInLanguageKey as `analyze_builtin_queries_${L}_duration_ms`]?: number;
|
||||||
};
|
};
|
||||||
|
|
||||||
type InterpretResultsDurationStatusReport = {
|
type InterpretResultsDurationStatusReport = {
|
||||||
/** Time taken in ms to interpret results for the language (or undefined if this language was not analyzed). */
|
/** Time taken in ms to interpret results for the language (or undefined if this language was not analyzed). */
|
||||||
[L in KnownLanguageKey as `interpret_results_${L}_duration_ms`]?: number;
|
[L in BuiltInLanguageKey as `interpret_results_${L}_duration_ms`]?: number;
|
||||||
};
|
};
|
||||||
|
|
||||||
export interface QueriesStatusReport
|
export interface QueriesStatusReport
|
||||||
@@ -115,12 +115,12 @@ export async function runExtraction(
|
|||||||
|
|
||||||
if (await shouldExtractLanguage(codeql, config, language)) {
|
if (await shouldExtractLanguage(codeql, config, language)) {
|
||||||
logger.startGroup(`Extracting ${language}`);
|
logger.startGroup(`Extracting ${language}`);
|
||||||
if (language === KnownLanguage.python) {
|
if (language === BuiltInLanguage.python) {
|
||||||
await setupPythonExtractor(logger);
|
await setupPythonExtractor(logger);
|
||||||
}
|
}
|
||||||
if (config.buildMode) {
|
if (config.buildMode) {
|
||||||
if (
|
if (
|
||||||
language === KnownLanguage.cpp &&
|
language === BuiltInLanguage.cpp &&
|
||||||
config.buildMode === BuildMode.Autobuild
|
config.buildMode === BuildMode.Autobuild
|
||||||
) {
|
) {
|
||||||
await setupCppAutobuild(codeql, logger);
|
await setupCppAutobuild(codeql, logger);
|
||||||
@@ -131,14 +131,14 @@ export async function runExtraction(
|
|||||||
// a stable path that caches can be restored into and that we can cache at the
|
// a stable path that caches can be restored into and that we can cache at the
|
||||||
// end of the workflow (i.e. that does not get removed when the scratch directory is).
|
// end of the workflow (i.e. that does not get removed when the scratch directory is).
|
||||||
if (
|
if (
|
||||||
language === KnownLanguage.java &&
|
language === BuiltInLanguage.java &&
|
||||||
config.buildMode === BuildMode.None
|
config.buildMode === BuildMode.None
|
||||||
) {
|
) {
|
||||||
process.env["CODEQL_EXTRACTOR_JAVA_OPTION_BUILDLESS_DEPENDENCY_DIR"] =
|
process.env["CODEQL_EXTRACTOR_JAVA_OPTION_BUILDLESS_DEPENDENCY_DIR"] =
|
||||||
getJavaTempDependencyDir();
|
getJavaTempDependencyDir();
|
||||||
}
|
}
|
||||||
if (
|
if (
|
||||||
language === KnownLanguage.csharp &&
|
language === BuiltInLanguage.csharp &&
|
||||||
config.buildMode === BuildMode.None &&
|
config.buildMode === BuildMode.None &&
|
||||||
(await features.getValue(Feature.CsharpCacheBuildModeNone))
|
(await features.getValue(Feature.CsharpCacheBuildModeNone))
|
||||||
) {
|
) {
|
||||||
@@ -251,16 +251,9 @@ export async function setupDiffInformedQueryRun(
|
|||||||
diffRanges,
|
diffRanges,
|
||||||
checkoutPath,
|
checkoutPath,
|
||||||
);
|
);
|
||||||
if (packDir === undefined) {
|
logger.info(
|
||||||
logger.warning(
|
`Successfully created diff range extension pack at ${packDir}.`,
|
||||||
"Cannot create diff range extension pack for diff-informed queries; " +
|
);
|
||||||
"reverting to performing full analysis.",
|
|
||||||
);
|
|
||||||
} else {
|
|
||||||
logger.info(
|
|
||||||
`Successfully created diff range extension pack at ${packDir}.`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
return packDir;
|
return packDir;
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
@@ -314,18 +307,13 @@ extensions:
|
|||||||
* @param ranges The file line ranges, as returned by
|
* @param ranges The file line ranges, as returned by
|
||||||
* `getPullRequestEditedDiffRanges`.
|
* `getPullRequestEditedDiffRanges`.
|
||||||
* @param checkoutPath The path at which the repository was checked out.
|
* @param checkoutPath The path at which the repository was checked out.
|
||||||
* @returns The absolute path of the directory containing the extension pack, or
|
* @returns The absolute path of the directory containing the extension pack.
|
||||||
* `undefined` if no extension pack was created.
|
|
||||||
*/
|
*/
|
||||||
function writeDiffRangeDataExtensionPack(
|
function writeDiffRangeDataExtensionPack(
|
||||||
logger: Logger,
|
logger: Logger,
|
||||||
ranges: DiffThunkRange[] | undefined,
|
ranges: DiffThunkRange[],
|
||||||
checkoutPath: string,
|
checkoutPath: string,
|
||||||
): string | undefined {
|
): string {
|
||||||
if (ranges === undefined) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (ranges.length === 0) {
|
if (ranges.length === 0) {
|
||||||
// An empty diff range means that there are no added or modified lines in
|
// An empty diff range means that there are no added or modified lines in
|
||||||
// the pull request. But the `restrictAlertsTo` extensible predicate
|
// the pull request. But the `restrictAlertsTo` extensible predicate
|
||||||
@@ -698,7 +686,7 @@ export async function warnIfGoInstalledAfterInit(
|
|||||||
|
|
||||||
addDiagnostic(
|
addDiagnostic(
|
||||||
config,
|
config,
|
||||||
KnownLanguage.go,
|
BuiltInLanguage.go,
|
||||||
makeDiagnostic(
|
makeDiagnostic(
|
||||||
"go/workflow/go-installed-after-codeql-init",
|
"go/workflow/go-installed-after-codeql-init",
|
||||||
"Go was installed after the `codeql-action/init` Action was run",
|
"Go was installed after the `codeql-action/init` Action was run",
|
||||||
|
|||||||
+22
-5
@@ -128,6 +128,8 @@ export async function getGitHubVersionFromApi(
|
|||||||
|
|
||||||
// Doesn't strictly have to be the meta endpoint as we're only
|
// Doesn't strictly have to be the meta endpoint as we're only
|
||||||
// using the response headers which are available on every request.
|
// using the response headers which are available on every request.
|
||||||
|
//
|
||||||
|
// See https://docs.github.com/en/rest/meta/meta#get-github-meta-information.
|
||||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
|
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
|
||||||
const response = await apiClient.rest.meta.get();
|
const response = await apiClient.rest.meta.get();
|
||||||
|
|
||||||
@@ -164,6 +166,9 @@ export async function getGitHubVersion(): Promise<GitHubVersion> {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the path of the currently executing workflow relative to the repository root.
|
* Get the path of the currently executing workflow relative to the repository root.
|
||||||
|
*
|
||||||
|
* See https://docs.github.com/en/rest/actions/workflow-runs#get-a-workflow-run
|
||||||
|
* and https://docs.github.com/en/rest/actions/workflows#get-a-workflow.
|
||||||
*/
|
*/
|
||||||
export async function getWorkflowRelativePath(): Promise<string> {
|
export async function getWorkflowRelativePath(): Promise<string> {
|
||||||
const repo_nwo = getRepositoryNwo();
|
const repo_nwo = getRepositoryNwo();
|
||||||
@@ -252,9 +257,13 @@ export interface ActionsCacheItem {
|
|||||||
size_in_bytes?: number;
|
size_in_bytes?: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** List all Actions cache entries matching the provided key and ref. */
|
/**
|
||||||
|
* List all Actions cache entries starting with the provided key prefix and matching the provided ref.
|
||||||
|
*
|
||||||
|
* See https://docs.github.com/en/rest/actions/cache#list-github-actions-caches-for-a-repository.
|
||||||
|
*/
|
||||||
export async function listActionsCaches(
|
export async function listActionsCaches(
|
||||||
key: string,
|
keyPrefix: string,
|
||||||
ref?: string,
|
ref?: string,
|
||||||
): Promise<ActionsCacheItem[]> {
|
): Promise<ActionsCacheItem[]> {
|
||||||
const repositoryNwo = getRepositoryNwo();
|
const repositoryNwo = getRepositoryNwo();
|
||||||
@@ -264,13 +273,17 @@ export async function listActionsCaches(
|
|||||||
{
|
{
|
||||||
owner: repositoryNwo.owner,
|
owner: repositoryNwo.owner,
|
||||||
repo: repositoryNwo.repo,
|
repo: repositoryNwo.repo,
|
||||||
key,
|
key: keyPrefix,
|
||||||
ref,
|
ref,
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Delete an Actions cache item by its ID. */
|
/**
|
||||||
|
* Delete an Actions cache item by its ID.
|
||||||
|
*
|
||||||
|
* See https://docs.github.com/en/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id.
|
||||||
|
*/
|
||||||
export async function deleteActionsCache(id: number) {
|
export async function deleteActionsCache(id: number) {
|
||||||
const repositoryNwo = getRepositoryNwo();
|
const repositoryNwo = getRepositoryNwo();
|
||||||
|
|
||||||
@@ -281,7 +294,11 @@ export async function deleteActionsCache(id: number) {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Retrieve all custom repository properties. */
|
/**
|
||||||
|
* Retrieve all custom repository properties.
|
||||||
|
*
|
||||||
|
* See https://docs.github.com/en/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository.
|
||||||
|
*/
|
||||||
export async function getRepositoryProperties(repositoryNwo: RepositoryNwo) {
|
export async function getRepositoryProperties(repositoryNwo: RepositoryNwo) {
|
||||||
return getApiClient().request("GET /repos/:owner/:repo/properties/values", {
|
return getApiClient().request("GET /repos/:owner/:repo/properties/values", {
|
||||||
owner: repositoryNwo.owner,
|
owner: repositoryNwo.owner,
|
||||||
|
|||||||
@@ -1 +1 @@
|
|||||||
{"maximumVersion": "3.21", "minimumVersion": "3.14"}
|
{"maximumVersion": "3.21", "minimumVersion": "3.16"}
|
||||||
|
|||||||
@@ -141,9 +141,9 @@ test("scanArtifactsForTokens handles files without tokens", async (t) => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// `scanArchiveFile` does not support Windows, so we skip this test there.
|
||||||
if (os.platform() !== "win32") {
|
if (os.platform() !== "win32") {
|
||||||
test("scanArtifactsForTokens finds token in debug artifacts", async (t) => {
|
test("scanArtifactsForTokens finds token in debug artifacts", async (t) => {
|
||||||
t.timeout(30 * 1000); // 30 seconds
|
|
||||||
const messages: LoggedMessage[] = [];
|
const messages: LoggedMessage[] = [];
|
||||||
const logger = getRecordingLogger(messages, { logToConsole: false });
|
const logger = getRecordingLogger(messages, { logToConsole: false });
|
||||||
// The zip here is a regression test based on
|
// The zip here is a regression test based on
|
||||||
|
|||||||
@@ -156,6 +156,10 @@ async function scanArchiveFile(
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (process.platform === "win32") {
|
||||||
|
throw new Error("Scanning archives is not supported on Windows.");
|
||||||
|
}
|
||||||
|
|
||||||
const result: ScanResult = {
|
const result: ScanResult = {
|
||||||
scannedFiles: 0,
|
scannedFiles: 0,
|
||||||
findings: [],
|
findings: [],
|
||||||
|
|||||||
@@ -142,7 +142,7 @@ async function run(startedAt: Date) {
|
|||||||
await sendCompletedStatusReport(config, logger, startedAt, languages ?? []);
|
await sendCompletedStatusReport(config, logger, startedAt, languages ?? []);
|
||||||
}
|
}
|
||||||
|
|
||||||
async function runWrapper() {
|
export async function runWrapper() {
|
||||||
const startedAt = new Date();
|
const startedAt = new Date();
|
||||||
const logger = getActionsLogger();
|
const logger = getActionsLogger();
|
||||||
try {
|
try {
|
||||||
@@ -157,5 +157,3 @@ async function runWrapper() {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
void runWrapper();
|
|
||||||
|
|||||||
+5
-5
@@ -7,7 +7,7 @@ import * as configUtils from "./config-utils";
|
|||||||
import { DocUrl } from "./doc-url";
|
import { DocUrl } from "./doc-url";
|
||||||
import { EnvVar } from "./environment";
|
import { EnvVar } from "./environment";
|
||||||
import { Feature, featureConfig, initFeatures } from "./feature-flags";
|
import { Feature, featureConfig, initFeatures } from "./feature-flags";
|
||||||
import { KnownLanguage, Language } from "./languages";
|
import { BuiltInLanguage, Language } from "./languages";
|
||||||
import { Logger } from "./logging";
|
import { Logger } from "./logging";
|
||||||
import { getRepositoryNwo } from "./repository";
|
import { getRepositoryNwo } from "./repository";
|
||||||
import { asyncFilter, BuildMode } from "./util";
|
import { asyncFilter, BuildMode } from "./util";
|
||||||
@@ -72,7 +72,7 @@ export async function determineAutobuildLanguages(
|
|||||||
* version of the CodeQL Action.
|
* version of the CodeQL Action.
|
||||||
*/
|
*/
|
||||||
const autobuildLanguagesWithoutGo = autobuildLanguages.filter(
|
const autobuildLanguagesWithoutGo = autobuildLanguages.filter(
|
||||||
(l) => l !== KnownLanguage.go,
|
(l) => l !== BuiltInLanguage.go,
|
||||||
);
|
);
|
||||||
|
|
||||||
const languages: Language[] = [];
|
const languages: Language[] = [];
|
||||||
@@ -84,7 +84,7 @@ export async function determineAutobuildLanguages(
|
|||||||
// If Go is requested, run the Go autobuilder last to ensure it doesn't
|
// If Go is requested, run the Go autobuilder last to ensure it doesn't
|
||||||
// interfere with the other autobuilder.
|
// interfere with the other autobuilder.
|
||||||
if (autobuildLanguages.length !== autobuildLanguagesWithoutGo.length) {
|
if (autobuildLanguages.length !== autobuildLanguagesWithoutGo.length) {
|
||||||
languages.push(KnownLanguage.go);
|
languages.push(BuiltInLanguage.go);
|
||||||
}
|
}
|
||||||
|
|
||||||
logger.debug(`Will autobuild ${languages.join(" and ")}.`);
|
logger.debug(`Will autobuild ${languages.join(" and ")}.`);
|
||||||
@@ -156,7 +156,7 @@ export async function runAutobuild(
|
|||||||
) {
|
) {
|
||||||
logger.startGroup(`Attempting to automatically build ${language} code`);
|
logger.startGroup(`Attempting to automatically build ${language} code`);
|
||||||
const codeQL = await getCodeQL(config.codeQLCmd);
|
const codeQL = await getCodeQL(config.codeQLCmd);
|
||||||
if (language === KnownLanguage.cpp) {
|
if (language === BuiltInLanguage.cpp) {
|
||||||
await setupCppAutobuild(codeQL, logger);
|
await setupCppAutobuild(codeQL, logger);
|
||||||
}
|
}
|
||||||
if (config.buildMode) {
|
if (config.buildMode) {
|
||||||
@@ -164,7 +164,7 @@ export async function runAutobuild(
|
|||||||
} else {
|
} else {
|
||||||
await codeQL.runAutobuild(config, language);
|
await codeQL.runAutobuild(config, language);
|
||||||
}
|
}
|
||||||
if (language === KnownLanguage.go) {
|
if (language === BuiltInLanguage.go) {
|
||||||
core.exportVariable(EnvVar.DID_AUTOBUILD_GOLANG, "true");
|
core.exportVariable(EnvVar.DID_AUTOBUILD_GOLANG, "true");
|
||||||
}
|
}
|
||||||
logger.endGroup();
|
logger.endGroup();
|
||||||
|
|||||||
@@ -299,6 +299,20 @@ test("wrapCliConfigurationError - swift build failed", (t) => {
|
|||||||
t.true(wrappedError instanceof ConfigurationError);
|
t.true(wrappedError instanceof ConfigurationError);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test("wrapCliConfigurationError - swift incompatible os", (t) => {
|
||||||
|
const commandError = new CommandInvocationError(
|
||||||
|
"codeql",
|
||||||
|
["swift/tools/autobuild.sh"],
|
||||||
|
1,
|
||||||
|
"2026-04-01 18:35:00 EST ERRO [extractor/main] [incompatible-os] Currently, Swift analysis is only supported on macOS. (IncompatibleOs.cpp:26)",
|
||||||
|
);
|
||||||
|
const cliError = new CliError(commandError);
|
||||||
|
|
||||||
|
const wrappedError = wrapCliConfigurationError(cliError);
|
||||||
|
|
||||||
|
t.true(wrappedError instanceof ConfigurationError);
|
||||||
|
});
|
||||||
|
|
||||||
test("wrapCliConfigurationError - pack cannot be found", (t) => {
|
test("wrapCliConfigurationError - pack cannot be found", (t) => {
|
||||||
const commandError = new CommandInvocationError(
|
const commandError = new CommandInvocationError(
|
||||||
"codeql",
|
"codeql",
|
||||||
|
|||||||
@@ -144,6 +144,7 @@ export enum CliConfigErrorCategory {
|
|||||||
OutOfMemoryOrDisk = "OutOfMemoryOrDisk",
|
OutOfMemoryOrDisk = "OutOfMemoryOrDisk",
|
||||||
PackCannotBeFound = "PackCannotBeFound",
|
PackCannotBeFound = "PackCannotBeFound",
|
||||||
PackMissingAuth = "PackMissingAuth",
|
PackMissingAuth = "PackMissingAuth",
|
||||||
|
SwiftIncompatibleOs = "SwiftIncompatibleOs",
|
||||||
SwiftBuildFailed = "SwiftBuildFailed",
|
SwiftBuildFailed = "SwiftBuildFailed",
|
||||||
UnsupportedBuildMode = "UnsupportedBuildMode",
|
UnsupportedBuildMode = "UnsupportedBuildMode",
|
||||||
}
|
}
|
||||||
@@ -281,6 +282,12 @@ const cliErrorsConfig: Record<CliConfigErrorCategory, CliErrorConfiguration> = {
|
|||||||
),
|
),
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
[CliConfigErrorCategory.SwiftIncompatibleOs]: {
|
||||||
|
cliErrorMessageCandidates: [
|
||||||
|
new RegExp("\\[incompatible-os\\]"),
|
||||||
|
new RegExp("Swift analysis is only supported on macOS"),
|
||||||
|
],
|
||||||
|
},
|
||||||
[CliConfigErrorCategory.UnsupportedBuildMode]: {
|
[CliConfigErrorCategory.UnsupportedBuildMode]: {
|
||||||
cliErrorMessageCandidates: [
|
cliErrorMessageCandidates: [
|
||||||
new RegExp(
|
new RegExp(
|
||||||
|
|||||||
+65
-43
@@ -21,7 +21,7 @@ import {
|
|||||||
import type { Config } from "./config-utils";
|
import type { Config } from "./config-utils";
|
||||||
import * as defaults from "./defaults.json";
|
import * as defaults from "./defaults.json";
|
||||||
import { DocUrl } from "./doc-url";
|
import { DocUrl } from "./doc-url";
|
||||||
import { KnownLanguage } from "./languages";
|
import { BuiltInLanguage } from "./languages";
|
||||||
import { getRunnerLogger } from "./logging";
|
import { getRunnerLogger } from "./logging";
|
||||||
import { ToolsSource } from "./setup-codeql";
|
import { ToolsSource } from "./setup-codeql";
|
||||||
import {
|
import {
|
||||||
@@ -33,6 +33,7 @@ import {
|
|||||||
mockBundleDownloadApi,
|
mockBundleDownloadApi,
|
||||||
makeVersionInfo,
|
makeVersionInfo,
|
||||||
createTestConfig,
|
createTestConfig,
|
||||||
|
makeMacro,
|
||||||
} from "./testing-utils";
|
} from "./testing-utils";
|
||||||
import { ToolsDownloadStatusReport } from "./tools-download";
|
import { ToolsDownloadStatusReport } from "./tools-download";
|
||||||
import * as util from "./util";
|
import * as util from "./util";
|
||||||
@@ -46,7 +47,7 @@ test.beforeEach(() => {
|
|||||||
initializeEnvironment("1.2.3");
|
initializeEnvironment("1.2.3");
|
||||||
|
|
||||||
stubConfig = createTestConfig({
|
stubConfig = createTestConfig({
|
||||||
languages: [KnownLanguage.cpp],
|
languages: [BuiltInLanguage.cpp],
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -70,8 +71,10 @@ async function installIntoToolcache({
|
|||||||
tmpDir,
|
tmpDir,
|
||||||
util.GitHubVariant.GHES,
|
util.GitHubVariant.GHES,
|
||||||
cliVersion !== undefined
|
cliVersion !== undefined
|
||||||
? { cliVersion, tagName }
|
? { enabledVersions: [{ cliVersion, tagName }] }
|
||||||
: SAMPLE_DEFAULT_CLI_VERSION,
|
: SAMPLE_DEFAULT_CLI_VERSION,
|
||||||
|
undefined, // rawLanguages
|
||||||
|
false, // useOverlayAwareDefaultCliVersion
|
||||||
createFeatures([]),
|
createFeatures([]),
|
||||||
getRunnerLogger(true),
|
getRunnerLogger(true),
|
||||||
false,
|
false,
|
||||||
@@ -115,7 +118,7 @@ async function stubCodeql(): Promise<codeql.CodeQL> {
|
|||||||
sinon.stub(codeqlObject, "getVersion").resolves(makeVersionInfo("2.17.6"));
|
sinon.stub(codeqlObject, "getVersion").resolves(makeVersionInfo("2.17.6"));
|
||||||
sinon
|
sinon
|
||||||
.stub(codeqlObject, "isTracedLanguage")
|
.stub(codeqlObject, "isTracedLanguage")
|
||||||
.withArgs(KnownLanguage.cpp)
|
.withArgs(BuiltInLanguage.cpp)
|
||||||
.resolves(true);
|
.resolves(true);
|
||||||
return codeqlObject;
|
return codeqlObject;
|
||||||
}
|
}
|
||||||
@@ -143,6 +146,8 @@ test.serial(
|
|||||||
tmpDir,
|
tmpDir,
|
||||||
util.GitHubVariant.DOTCOM,
|
util.GitHubVariant.DOTCOM,
|
||||||
SAMPLE_DEFAULT_CLI_VERSION,
|
SAMPLE_DEFAULT_CLI_VERSION,
|
||||||
|
undefined, // rawLanguages
|
||||||
|
false, // useOverlayAwareDefaultCliVersion
|
||||||
features,
|
features,
|
||||||
getRunnerLogger(true),
|
getRunnerLogger(true),
|
||||||
false,
|
false,
|
||||||
@@ -175,6 +180,8 @@ test.serial(
|
|||||||
tmpDir,
|
tmpDir,
|
||||||
util.GitHubVariant.DOTCOM,
|
util.GitHubVariant.DOTCOM,
|
||||||
SAMPLE_DEFAULT_CLI_VERSION,
|
SAMPLE_DEFAULT_CLI_VERSION,
|
||||||
|
undefined, // rawLanguages
|
||||||
|
false, // useOverlayAwareDefaultCliVersion
|
||||||
features,
|
features,
|
||||||
getRunnerLogger(true),
|
getRunnerLogger(true),
|
||||||
false,
|
false,
|
||||||
@@ -214,6 +221,8 @@ test.serial(
|
|||||||
tmpDir,
|
tmpDir,
|
||||||
util.GitHubVariant.DOTCOM,
|
util.GitHubVariant.DOTCOM,
|
||||||
SAMPLE_DEFAULT_CLI_VERSION,
|
SAMPLE_DEFAULT_CLI_VERSION,
|
||||||
|
undefined, // rawLanguages
|
||||||
|
false, // useOverlayAwareDefaultCliVersion
|
||||||
features,
|
features,
|
||||||
getRunnerLogger(true),
|
getRunnerLogger(true),
|
||||||
false,
|
false,
|
||||||
@@ -264,6 +273,8 @@ for (const {
|
|||||||
tmpDir,
|
tmpDir,
|
||||||
util.GitHubVariant.DOTCOM,
|
util.GitHubVariant.DOTCOM,
|
||||||
SAMPLE_DEFAULT_CLI_VERSION,
|
SAMPLE_DEFAULT_CLI_VERSION,
|
||||||
|
undefined, // rawLanguages
|
||||||
|
false, // useOverlayAwareDefaultCliVersion
|
||||||
features,
|
features,
|
||||||
getRunnerLogger(true),
|
getRunnerLogger(true),
|
||||||
false,
|
false,
|
||||||
@@ -284,11 +295,11 @@ for (const {
|
|||||||
for (const toolcacheVersion of [
|
for (const toolcacheVersion of [
|
||||||
// Test that we use the tools from the toolcache when `SAMPLE_DEFAULT_CLI_VERSION` is requested
|
// Test that we use the tools from the toolcache when `SAMPLE_DEFAULT_CLI_VERSION` is requested
|
||||||
// and `SAMPLE_DEFAULT_CLI_VERSION-` is in the toolcache.
|
// and `SAMPLE_DEFAULT_CLI_VERSION-` is in the toolcache.
|
||||||
SAMPLE_DEFAULT_CLI_VERSION.cliVersion,
|
SAMPLE_DEFAULT_CLI_VERSION.enabledVersions[0].cliVersion,
|
||||||
`${SAMPLE_DEFAULT_CLI_VERSION.cliVersion}-20230101`,
|
`${SAMPLE_DEFAULT_CLI_VERSION.enabledVersions[0].cliVersion}-20230101`,
|
||||||
]) {
|
]) {
|
||||||
test.serial(
|
test.serial(
|
||||||
`uses tools from toolcache when ${SAMPLE_DEFAULT_CLI_VERSION.cliVersion} is requested and ` +
|
`uses tools from toolcache when ${SAMPLE_DEFAULT_CLI_VERSION.enabledVersions[0].cliVersion} is requested and ` +
|
||||||
`${toolcacheVersion} is installed`,
|
`${toolcacheVersion} is installed`,
|
||||||
async (t) => {
|
async (t) => {
|
||||||
const features = createFeatures([]);
|
const features = createFeatures([]);
|
||||||
@@ -308,11 +319,16 @@ for (const toolcacheVersion of [
|
|||||||
tmpDir,
|
tmpDir,
|
||||||
util.GitHubVariant.DOTCOM,
|
util.GitHubVariant.DOTCOM,
|
||||||
SAMPLE_DEFAULT_CLI_VERSION,
|
SAMPLE_DEFAULT_CLI_VERSION,
|
||||||
|
undefined, // rawLanguages
|
||||||
|
false, // useOverlayAwareDefaultCliVersion
|
||||||
features,
|
features,
|
||||||
getRunnerLogger(true),
|
getRunnerLogger(true),
|
||||||
false,
|
false,
|
||||||
);
|
);
|
||||||
t.is(result.toolsVersion, SAMPLE_DEFAULT_CLI_VERSION.cliVersion);
|
t.is(
|
||||||
|
result.toolsVersion,
|
||||||
|
SAMPLE_DEFAULT_CLI_VERSION.enabledVersions[0].cliVersion,
|
||||||
|
);
|
||||||
t.is(result.toolsSource, ToolsSource.Toolcache);
|
t.is(result.toolsSource, ToolsSource.Toolcache);
|
||||||
t.is(result.toolsDownloadStatusReport?.combinedDurationMs, undefined);
|
t.is(result.toolsDownloadStatusReport?.combinedDurationMs, undefined);
|
||||||
t.is(result.toolsDownloadStatusReport?.downloadDurationMs, undefined);
|
t.is(result.toolsDownloadStatusReport?.downloadDurationMs, undefined);
|
||||||
@@ -342,9 +358,15 @@ test.serial(
|
|||||||
tmpDir,
|
tmpDir,
|
||||||
util.GitHubVariant.GHES,
|
util.GitHubVariant.GHES,
|
||||||
{
|
{
|
||||||
cliVersion: defaults.cliVersion,
|
enabledVersions: [
|
||||||
tagName: defaults.bundleVersion,
|
{
|
||||||
|
cliVersion: defaults.cliVersion,
|
||||||
|
tagName: defaults.bundleVersion,
|
||||||
|
},
|
||||||
|
],
|
||||||
},
|
},
|
||||||
|
undefined, // rawLanguages
|
||||||
|
false, // useOverlayAwareDefaultCliVersion
|
||||||
features,
|
features,
|
||||||
getRunnerLogger(true),
|
getRunnerLogger(true),
|
||||||
false,
|
false,
|
||||||
@@ -384,9 +406,15 @@ test.serial(
|
|||||||
tmpDir,
|
tmpDir,
|
||||||
util.GitHubVariant.GHES,
|
util.GitHubVariant.GHES,
|
||||||
{
|
{
|
||||||
cliVersion: defaults.cliVersion,
|
enabledVersions: [
|
||||||
tagName: defaults.bundleVersion,
|
{
|
||||||
|
cliVersion: defaults.cliVersion,
|
||||||
|
tagName: defaults.bundleVersion,
|
||||||
|
},
|
||||||
|
],
|
||||||
},
|
},
|
||||||
|
undefined, // rawLanguages
|
||||||
|
false, // useOverlayAwareDefaultCliVersion
|
||||||
features,
|
features,
|
||||||
getRunnerLogger(true),
|
getRunnerLogger(true),
|
||||||
false,
|
false,
|
||||||
@@ -426,6 +454,8 @@ test.serial(
|
|||||||
tmpDir,
|
tmpDir,
|
||||||
util.GitHubVariant.DOTCOM,
|
util.GitHubVariant.DOTCOM,
|
||||||
SAMPLE_DEFAULT_CLI_VERSION,
|
SAMPLE_DEFAULT_CLI_VERSION,
|
||||||
|
undefined, // rawLanguages
|
||||||
|
false, // useOverlayAwareDefaultCliVersion
|
||||||
features,
|
features,
|
||||||
getRunnerLogger(true),
|
getRunnerLogger(true),
|
||||||
false,
|
false,
|
||||||
@@ -467,6 +497,8 @@ test.serial(
|
|||||||
tmpDir,
|
tmpDir,
|
||||||
util.GitHubVariant.DOTCOM,
|
util.GitHubVariant.DOTCOM,
|
||||||
SAMPLE_DEFAULT_CLI_VERSION,
|
SAMPLE_DEFAULT_CLI_VERSION,
|
||||||
|
undefined, // rawLanguages
|
||||||
|
false, // useOverlayAwareDefaultCliVersion
|
||||||
features,
|
features,
|
||||||
getRunnerLogger(true),
|
getRunnerLogger(true),
|
||||||
false,
|
false,
|
||||||
@@ -540,7 +572,7 @@ test.serial("getExtraOptions throws for bad content", (t) => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
// Test macro for ensuring different variants of injected augmented configurations
|
// Test macro for ensuring different variants of injected augmented configurations
|
||||||
const injectedConfigMacro = test.macro({
|
const injectedConfigMacro = makeMacro({
|
||||||
exec: async (
|
exec: async (
|
||||||
t: ExecutionContext<unknown>,
|
t: ExecutionContext<unknown>,
|
||||||
augmentationProperties: AugmentationProperties,
|
augmentationProperties: AugmentationProperties,
|
||||||
@@ -590,9 +622,8 @@ const injectedConfigMacro = test.macro({
|
|||||||
`databaseInitCluster() injected config: ${providedTitle}`,
|
`databaseInitCluster() injected config: ${providedTitle}`,
|
||||||
});
|
});
|
||||||
|
|
||||||
test.serial(
|
injectedConfigMacro.serial(
|
||||||
"basic",
|
"basic",
|
||||||
injectedConfigMacro,
|
|
||||||
{
|
{
|
||||||
...defaultAugmentationProperties,
|
...defaultAugmentationProperties,
|
||||||
},
|
},
|
||||||
@@ -600,9 +631,8 @@ test.serial(
|
|||||||
{},
|
{},
|
||||||
);
|
);
|
||||||
|
|
||||||
test.serial(
|
injectedConfigMacro.serial(
|
||||||
"injected packs from input",
|
"injected packs from input",
|
||||||
injectedConfigMacro,
|
|
||||||
{
|
{
|
||||||
...defaultAugmentationProperties,
|
...defaultAugmentationProperties,
|
||||||
packsInput: ["xxx", "yyy"],
|
packsInput: ["xxx", "yyy"],
|
||||||
@@ -613,9 +643,8 @@ test.serial(
|
|||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
test.serial(
|
injectedConfigMacro.serial(
|
||||||
"injected packs from input with existing packs combines",
|
"injected packs from input with existing packs combines",
|
||||||
injectedConfigMacro,
|
|
||||||
{
|
{
|
||||||
...defaultAugmentationProperties,
|
...defaultAugmentationProperties,
|
||||||
packsInputCombines: true,
|
packsInputCombines: true,
|
||||||
@@ -635,9 +664,8 @@ test.serial(
|
|||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
test.serial(
|
injectedConfigMacro.serial(
|
||||||
"injected packs from input with existing packs overrides",
|
"injected packs from input with existing packs overrides",
|
||||||
injectedConfigMacro,
|
|
||||||
{
|
{
|
||||||
...defaultAugmentationProperties,
|
...defaultAugmentationProperties,
|
||||||
packsInput: ["xxx", "yyy"],
|
packsInput: ["xxx", "yyy"],
|
||||||
@@ -655,9 +683,8 @@ test.serial(
|
|||||||
);
|
);
|
||||||
|
|
||||||
// similar, but with queries
|
// similar, but with queries
|
||||||
test.serial(
|
injectedConfigMacro.serial(
|
||||||
"injected queries from input",
|
"injected queries from input",
|
||||||
injectedConfigMacro,
|
|
||||||
{
|
{
|
||||||
...defaultAugmentationProperties,
|
...defaultAugmentationProperties,
|
||||||
queriesInput: [{ uses: "xxx" }, { uses: "yyy" }],
|
queriesInput: [{ uses: "xxx" }, { uses: "yyy" }],
|
||||||
@@ -675,9 +702,8 @@ test.serial(
|
|||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
test.serial(
|
injectedConfigMacro.serial(
|
||||||
"injected queries from input overrides",
|
"injected queries from input overrides",
|
||||||
injectedConfigMacro,
|
|
||||||
{
|
{
|
||||||
...defaultAugmentationProperties,
|
...defaultAugmentationProperties,
|
||||||
queriesInput: [{ uses: "xxx" }, { uses: "yyy" }],
|
queriesInput: [{ uses: "xxx" }, { uses: "yyy" }],
|
||||||
@@ -699,9 +725,8 @@ test.serial(
|
|||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
test.serial(
|
injectedConfigMacro.serial(
|
||||||
"injected queries from input combines",
|
"injected queries from input combines",
|
||||||
injectedConfigMacro,
|
|
||||||
{
|
{
|
||||||
...defaultAugmentationProperties,
|
...defaultAugmentationProperties,
|
||||||
queriesInputCombines: true,
|
queriesInputCombines: true,
|
||||||
@@ -727,9 +752,8 @@ test.serial(
|
|||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
test.serial(
|
injectedConfigMacro.serial(
|
||||||
"injected queries from input combines 2",
|
"injected queries from input combines 2",
|
||||||
injectedConfigMacro,
|
|
||||||
{
|
{
|
||||||
...defaultAugmentationProperties,
|
...defaultAugmentationProperties,
|
||||||
queriesInputCombines: true,
|
queriesInputCombines: true,
|
||||||
@@ -749,9 +773,8 @@ test.serial(
|
|||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
test.serial(
|
injectedConfigMacro.serial(
|
||||||
"injected queries and packs, but empty",
|
"injected queries and packs, but empty",
|
||||||
injectedConfigMacro,
|
|
||||||
{
|
{
|
||||||
...defaultAugmentationProperties,
|
...defaultAugmentationProperties,
|
||||||
queriesInputCombines: true,
|
queriesInputCombines: true,
|
||||||
@@ -768,9 +791,8 @@ test.serial(
|
|||||||
{},
|
{},
|
||||||
);
|
);
|
||||||
|
|
||||||
test.serial(
|
injectedConfigMacro.serial(
|
||||||
"repo property queries have the highest precedence",
|
"repo property queries have the highest precedence",
|
||||||
injectedConfigMacro,
|
|
||||||
{
|
{
|
||||||
...defaultAugmentationProperties,
|
...defaultAugmentationProperties,
|
||||||
queriesInputCombines: true,
|
queriesInputCombines: true,
|
||||||
@@ -790,9 +812,8 @@ test.serial(
|
|||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
test.serial(
|
injectedConfigMacro.serial(
|
||||||
"repo property queries combines with queries input",
|
"repo property queries combines with queries input",
|
||||||
injectedConfigMacro,
|
|
||||||
{
|
{
|
||||||
...defaultAugmentationProperties,
|
...defaultAugmentationProperties,
|
||||||
queriesInputCombines: false,
|
queriesInputCombines: false,
|
||||||
@@ -817,9 +838,8 @@ test.serial(
|
|||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
test.serial(
|
injectedConfigMacro.serial(
|
||||||
"repo property queries combines everything else",
|
"repo property queries combines everything else",
|
||||||
injectedConfigMacro,
|
|
||||||
{
|
{
|
||||||
...defaultAugmentationProperties,
|
...defaultAugmentationProperties,
|
||||||
queriesInputCombines: true,
|
queriesInputCombines: true,
|
||||||
@@ -956,7 +976,8 @@ test.serial("runTool summarizes autobuilder errors", async (t) => {
|
|||||||
sinon.stub(io, "which").resolves("");
|
sinon.stub(io, "which").resolves("");
|
||||||
|
|
||||||
await t.throwsAsync(
|
await t.throwsAsync(
|
||||||
async () => await codeqlObject.runAutobuild(stubConfig, KnownLanguage.java),
|
async () =>
|
||||||
|
await codeqlObject.runAutobuild(stubConfig, BuiltInLanguage.java),
|
||||||
{
|
{
|
||||||
instanceOf: util.ConfigurationError,
|
instanceOf: util.ConfigurationError,
|
||||||
message:
|
message:
|
||||||
@@ -982,7 +1003,8 @@ test.serial("runTool truncates long autobuilder errors", async (t) => {
|
|||||||
sinon.stub(io, "which").resolves("");
|
sinon.stub(io, "which").resolves("");
|
||||||
|
|
||||||
await t.throwsAsync(
|
await t.throwsAsync(
|
||||||
async () => await codeqlObject.runAutobuild(stubConfig, KnownLanguage.java),
|
async () =>
|
||||||
|
await codeqlObject.runAutobuild(stubConfig, BuiltInLanguage.java),
|
||||||
{
|
{
|
||||||
instanceOf: util.ConfigurationError,
|
instanceOf: util.ConfigurationError,
|
||||||
message:
|
message:
|
||||||
@@ -1050,7 +1072,7 @@ test.serial(
|
|||||||
);
|
);
|
||||||
|
|
||||||
test.serial(
|
test.serial(
|
||||||
"Avoids duplicating --overwrite flag if specified in CODEQL_ACTION_EXTRA_OPTIONS",
|
"Avoids duplicating --force-overwrite flag if specified in CODEQL_ACTION_EXTRA_OPTIONS",
|
||||||
async (t) => {
|
async (t) => {
|
||||||
const runnerConstructorStub = stubToolRunnerConstructor();
|
const runnerConstructorStub = stubToolRunnerConstructor();
|
||||||
const codeqlObject = await stubCodeql();
|
const codeqlObject = await stubCodeql();
|
||||||
@@ -1058,7 +1080,7 @@ test.serial(
|
|||||||
sinon.stub(io, "which").resolves("");
|
sinon.stub(io, "which").resolves("");
|
||||||
|
|
||||||
process.env["CODEQL_ACTION_EXTRA_OPTIONS"] =
|
process.env["CODEQL_ACTION_EXTRA_OPTIONS"] =
|
||||||
'{ "database": { "init": ["--overwrite"] } }';
|
'{ "database": { "init": ["--force-overwrite"] } }';
|
||||||
|
|
||||||
await codeqlObject.databaseInitCluster(
|
await codeqlObject.databaseInitCluster(
|
||||||
stubConfig,
|
stubConfig,
|
||||||
@@ -1071,9 +1093,9 @@ test.serial(
|
|||||||
t.true(runnerConstructorStub.calledOnce);
|
t.true(runnerConstructorStub.calledOnce);
|
||||||
const args = runnerConstructorStub.firstCall.args[1] as string[];
|
const args = runnerConstructorStub.firstCall.args[1] as string[];
|
||||||
t.is(
|
t.is(
|
||||||
args.filter((option: string) => option === "--overwrite").length,
|
args.filter((option: string) => option === "--force-overwrite").length,
|
||||||
1,
|
1,
|
||||||
"--overwrite should only be passed once",
|
"--force-overwrite should only be passed once",
|
||||||
);
|
);
|
||||||
|
|
||||||
// Clean up
|
// Clean up
|
||||||
|
|||||||
+24
-26
@@ -24,11 +24,8 @@ import {
|
|||||||
import { isAnalyzingDefaultBranch } from "./git-utils";
|
import { isAnalyzingDefaultBranch } from "./git-utils";
|
||||||
import { Language } from "./languages";
|
import { Language } from "./languages";
|
||||||
import { Logger } from "./logging";
|
import { Logger } from "./logging";
|
||||||
import {
|
import { writeBaseDatabaseOidsFile, writeOverlayChangesFile } from "./overlay";
|
||||||
OverlayDatabaseMode,
|
import { OverlayDatabaseMode } from "./overlay/overlay-database-mode";
|
||||||
writeBaseDatabaseOidsFile,
|
|
||||||
writeOverlayChangesFile,
|
|
||||||
} from "./overlay";
|
|
||||||
import * as setupCodeql from "./setup-codeql";
|
import * as setupCodeql from "./setup-codeql";
|
||||||
import { ZstdAvailability } from "./tar";
|
import { ZstdAvailability } from "./tar";
|
||||||
import { ToolsDownloadStatusReport } from "./tools-download";
|
import { ToolsDownloadStatusReport } from "./tools-download";
|
||||||
@@ -280,22 +277,22 @@ let cachedCodeQL: CodeQL | undefined = undefined;
|
|||||||
* The version flags below can be used to conditionally enable certain features
|
* The version flags below can be used to conditionally enable certain features
|
||||||
* on versions newer than this.
|
* on versions newer than this.
|
||||||
*/
|
*/
|
||||||
const CODEQL_MINIMUM_VERSION = "2.17.6";
|
const CODEQL_MINIMUM_VERSION = "2.19.4";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This version will shortly become the oldest version of CodeQL that the Action will run with.
|
* This version will shortly become the oldest version of CodeQL that the Action will run with.
|
||||||
*/
|
*/
|
||||||
const CODEQL_NEXT_MINIMUM_VERSION = "2.17.6";
|
const CODEQL_NEXT_MINIMUM_VERSION = "2.19.4";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This is the version of GHES that was most recently deprecated.
|
* This is the version of GHES that was most recently deprecated.
|
||||||
*/
|
*/
|
||||||
const GHES_VERSION_MOST_RECENTLY_DEPRECATED = "3.13";
|
const GHES_VERSION_MOST_RECENTLY_DEPRECATED = "3.15";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This is the deprecation date for the version of GHES that was most recently deprecated.
|
* This is the deprecation date for the version of GHES that was most recently deprecated.
|
||||||
*/
|
*/
|
||||||
const GHES_MOST_RECENT_DEPRECATION_DATE = "2025-06-19";
|
const GHES_MOST_RECENT_DEPRECATION_DATE = "2026-04-09";
|
||||||
|
|
||||||
/** The CLI verbosity level to use for extraction in debug mode. */
|
/** The CLI verbosity level to use for extraction in debug mode. */
|
||||||
const EXTRACTION_DEBUG_MODE_VERBOSITY = "progress++";
|
const EXTRACTION_DEBUG_MODE_VERBOSITY = "progress++";
|
||||||
@@ -308,6 +305,8 @@ const EXTRACTION_DEBUG_MODE_VERBOSITY = "progress++";
|
|||||||
* @param tempDir
|
* @param tempDir
|
||||||
* @param variant
|
* @param variant
|
||||||
* @param defaultCliVersion
|
* @param defaultCliVersion
|
||||||
|
* @param rawLanguages Raw set of languages.
|
||||||
|
* @param useOverlayAwareDefaultCliVersion Whether to select an overlay-aware default CLI version.
|
||||||
* @param features Information about the features that are enabled.
|
* @param features Information about the features that are enabled.
|
||||||
* @param logger
|
* @param logger
|
||||||
* @param checkVersion Whether to check that CodeQL CLI meets the minimum
|
* @param checkVersion Whether to check that CodeQL CLI meets the minimum
|
||||||
@@ -320,6 +319,8 @@ export async function setupCodeQL(
|
|||||||
tempDir: string,
|
tempDir: string,
|
||||||
variant: util.GitHubVariant,
|
variant: util.GitHubVariant,
|
||||||
defaultCliVersion: CodeQLDefaultVersionInfo,
|
defaultCliVersion: CodeQLDefaultVersionInfo,
|
||||||
|
rawLanguages: string[] | undefined,
|
||||||
|
useOverlayAwareDefaultCliVersion: boolean,
|
||||||
features: FeatureEnablement,
|
features: FeatureEnablement,
|
||||||
logger: Logger,
|
logger: Logger,
|
||||||
checkVersion: boolean,
|
checkVersion: boolean,
|
||||||
@@ -343,6 +344,8 @@ export async function setupCodeQL(
|
|||||||
tempDir,
|
tempDir,
|
||||||
variant,
|
variant,
|
||||||
defaultCliVersion,
|
defaultCliVersion,
|
||||||
|
rawLanguages,
|
||||||
|
useOverlayAwareDefaultCliVersion,
|
||||||
features,
|
features,
|
||||||
logger,
|
logger,
|
||||||
);
|
);
|
||||||
@@ -589,13 +592,6 @@ async function getCodeQLForCmd(
|
|||||||
extraArgs.push(`--qlconfig-file=${qlconfigFile}`);
|
extraArgs.push(`--qlconfig-file=${qlconfigFile}`);
|
||||||
}
|
}
|
||||||
|
|
||||||
const overwriteFlag = isSupportedToolsFeature(
|
|
||||||
await this.getVersion(),
|
|
||||||
ToolsFeature.ForceOverwrite,
|
|
||||||
)
|
|
||||||
? "--force-overwrite"
|
|
||||||
: "--overwrite";
|
|
||||||
|
|
||||||
const overlayDatabaseMode = config.overlayDatabaseMode;
|
const overlayDatabaseMode = config.overlayDatabaseMode;
|
||||||
if (overlayDatabaseMode === OverlayDatabaseMode.Overlay) {
|
if (overlayDatabaseMode === OverlayDatabaseMode.Overlay) {
|
||||||
const overlayChangesFile = await writeOverlayChangesFile(
|
const overlayChangesFile = await writeOverlayChangesFile(
|
||||||
@@ -622,7 +618,7 @@ async function getCodeQLForCmd(
|
|||||||
"init",
|
"init",
|
||||||
...(overlayDatabaseMode === OverlayDatabaseMode.Overlay
|
...(overlayDatabaseMode === OverlayDatabaseMode.Overlay
|
||||||
? []
|
? []
|
||||||
: [overwriteFlag]),
|
: ["--force-overwrite"]),
|
||||||
"--db-cluster",
|
"--db-cluster",
|
||||||
config.dbLocation,
|
config.dbLocation,
|
||||||
`--source-root=${sourceRoot}`,
|
`--source-root=${sourceRoot}`,
|
||||||
@@ -633,7 +629,14 @@ async function getCodeQLForCmd(
|
|||||||
// Some user configs specify `--no-calculate-baseline` as an additional
|
// Some user configs specify `--no-calculate-baseline` as an additional
|
||||||
// argument to `codeql database init`. Therefore ignore the baseline file
|
// argument to `codeql database init`. Therefore ignore the baseline file
|
||||||
// options here to avoid specifying the same argument twice and erroring.
|
// options here to avoid specifying the same argument twice and erroring.
|
||||||
ignoringOptions: ["--overwrite", ...baselineFilesOptions],
|
//
|
||||||
|
// Ignore `--overwrite` to avoid passing both `--force-overwrite` and `--overwrite` if
|
||||||
|
// the user has configured `--overwrite`.
|
||||||
|
ignoringOptions: [
|
||||||
|
"--force-overwrite",
|
||||||
|
"--overwrite",
|
||||||
|
...baselineFilesOptions,
|
||||||
|
],
|
||||||
}),
|
}),
|
||||||
],
|
],
|
||||||
{ stdin: externalRepositoryToken },
|
{ stdin: externalRepositoryToken },
|
||||||
@@ -850,7 +853,7 @@ async function getCodeQLForCmd(
|
|||||||
"--sarif-group-rules-by-pack",
|
"--sarif-group-rules-by-pack",
|
||||||
"--sarif-include-query-help=always",
|
"--sarif-include-query-help=always",
|
||||||
"--sublanguage-file-coverage",
|
"--sublanguage-file-coverage",
|
||||||
...(await getJobRunUuidSarifOptions(this)),
|
...(await getJobRunUuidSarifOptions()),
|
||||||
...getExtraOptionsFromEnv(["database", "interpret-results"]),
|
...getExtraOptionsFromEnv(["database", "interpret-results"]),
|
||||||
];
|
];
|
||||||
if (sarifRunPropertyFlag !== undefined) {
|
if (sarifRunPropertyFlag !== undefined) {
|
||||||
@@ -1280,13 +1283,8 @@ function applyAutobuildAzurePipelinesTimeoutFix() {
|
|||||||
].join(" ");
|
].join(" ");
|
||||||
}
|
}
|
||||||
|
|
||||||
async function getJobRunUuidSarifOptions(codeql: CodeQL) {
|
async function getJobRunUuidSarifOptions() {
|
||||||
const jobRunUuid = process.env[EnvVar.JOB_RUN_UUID];
|
const jobRunUuid = process.env[EnvVar.JOB_RUN_UUID];
|
||||||
|
|
||||||
return jobRunUuid &&
|
return jobRunUuid ? [`--sarif-run-property=jobRunUuid=${jobRunUuid}`] : [];
|
||||||
(await codeql.supportsFeature(
|
|
||||||
ToolsFeature.DatabaseInterpretResultsSupportsSarifRunProperty,
|
|
||||||
))
|
|
||||||
? [`--sarif-run-property=jobRunUuid=${jobRunUuid}`]
|
|
||||||
: [];
|
|
||||||
}
|
}
|
||||||
|
|||||||
+238
-191
File diff suppressed because it is too large
Load Diff
+90
-39
@@ -31,7 +31,7 @@ import {
|
|||||||
addNoLanguageDiagnostic,
|
addNoLanguageDiagnostic,
|
||||||
makeTelemetryDiagnostic,
|
makeTelemetryDiagnostic,
|
||||||
} from "./diagnostics";
|
} from "./diagnostics";
|
||||||
import { shouldPerformDiffInformedAnalysis } from "./diff-informed-analysis-utils";
|
import { prepareDiffInformedAnalysis } from "./diff-informed-analysis-utils";
|
||||||
import { EnvVar } from "./environment";
|
import { EnvVar } from "./environment";
|
||||||
import * as errorMessages from "./error-messages";
|
import * as errorMessages from "./error-messages";
|
||||||
import { Feature, FeatureEnablement } from "./feature-flags";
|
import { Feature, FeatureEnablement } from "./feature-flags";
|
||||||
@@ -43,17 +43,19 @@ import {
|
|||||||
getGeneratedFiles,
|
getGeneratedFiles,
|
||||||
getGitRoot,
|
getGitRoot,
|
||||||
getGitVersionOrThrow,
|
getGitVersionOrThrow,
|
||||||
GIT_MINIMUM_VERSION_FOR_OVERLAY,
|
GIT_MINIMUM_VERSION_FOR_OVERLAY_WITH_SUBMODULES,
|
||||||
GitVersionInfo,
|
GitVersionInfo,
|
||||||
|
hasSubmodules,
|
||||||
isAnalyzingDefaultBranch,
|
isAnalyzingDefaultBranch,
|
||||||
} from "./git-utils";
|
} from "./git-utils";
|
||||||
import { KnownLanguage, Language } from "./languages";
|
import { BuiltInLanguage, Language } from "./languages";
|
||||||
import { Logger } from "./logging";
|
import { Logger } from "./logging";
|
||||||
import { CODEQL_OVERLAY_MINIMUM_VERSION, OverlayDatabaseMode } from "./overlay";
|
import { CODEQL_OVERLAY_MINIMUM_VERSION } from "./overlay";
|
||||||
import {
|
import {
|
||||||
addOverlayDisablementDiagnostics,
|
addOverlayDisablementDiagnostics,
|
||||||
OverlayDisabledReason,
|
OverlayDisabledReason,
|
||||||
} from "./overlay/diagnostics";
|
} from "./overlay/diagnostics";
|
||||||
|
import { OverlayDatabaseMode } from "./overlay/overlay-database-mode";
|
||||||
import { shouldSkipOverlayAnalysis } from "./overlay/status";
|
import { shouldSkipOverlayAnalysis } from "./overlay/status";
|
||||||
import { RepositoryNwo } from "./repository";
|
import { RepositoryNwo } from "./repository";
|
||||||
import { ToolsFeature } from "./tools-features";
|
import { ToolsFeature } from "./tools-features";
|
||||||
@@ -272,10 +274,10 @@ async function getSupportedLanguageMap(
|
|||||||
for (const extractor of Object.keys(resolveResult.extractors)) {
|
for (const extractor of Object.keys(resolveResult.extractors)) {
|
||||||
// If the CLI supports resolving languages with default queries, use these
|
// If the CLI supports resolving languages with default queries, use these
|
||||||
// as the set of supported languages. Otherwise, require the language to be
|
// as the set of supported languages. Otherwise, require the language to be
|
||||||
// a known language.
|
// a built-in language.
|
||||||
if (
|
if (
|
||||||
resolveSupportedLanguagesUsingCli ||
|
resolveSupportedLanguagesUsingCli ||
|
||||||
KnownLanguage[extractor] !== undefined
|
BuiltInLanguage[extractor] !== undefined
|
||||||
) {
|
) {
|
||||||
supportedLanguages[extractor] = extractor;
|
supportedLanguages[extractor] = extractor;
|
||||||
}
|
}
|
||||||
@@ -405,6 +407,7 @@ export async function getLanguages(
|
|||||||
return languages;
|
return languages;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** Splits the `languages` input into a list of raw languages without checking if they are supported by CodeQL. */
|
||||||
export function getRawLanguagesNoAutodetect(
|
export function getRawLanguagesNoAutodetect(
|
||||||
languagesInput: string | undefined,
|
languagesInput: string | undefined,
|
||||||
): string[] {
|
): string[] {
|
||||||
@@ -945,7 +948,7 @@ async function validateOverlayDatabaseMode(
|
|||||||
await Promise.all(
|
await Promise.all(
|
||||||
languages.map(
|
languages.map(
|
||||||
async (l) =>
|
async (l) =>
|
||||||
l !== KnownLanguage.go && // Workaround to allow overlay analysis for Go with any build
|
l !== BuiltInLanguage.go && // Workaround to allow overlay analysis for Go with any build
|
||||||
// mode, since it does not yet support BMN. The Go autobuilder and/or extractor will
|
// mode, since it does not yet support BMN. The Go autobuilder and/or extractor will
|
||||||
// ensure that overlay-base databases are only created for supported Go build setups,
|
// ensure that overlay-base databases are only created for supported Go build setups,
|
||||||
// and that we'll fall back to full databases in other cases.
|
// and that we'll fall back to full databases in other cases.
|
||||||
@@ -969,7 +972,8 @@ async function validateOverlayDatabaseMode(
|
|||||||
);
|
);
|
||||||
return new Failure(OverlayDisabledReason.IncompatibleCodeQl);
|
return new Failure(OverlayDisabledReason.IncompatibleCodeQl);
|
||||||
}
|
}
|
||||||
if ((await getGitRoot(sourceRoot)) === undefined) {
|
const gitRoot = await getGitRoot(sourceRoot);
|
||||||
|
if (gitRoot === undefined) {
|
||||||
logger.warning(
|
logger.warning(
|
||||||
`Cannot build an ${overlayDatabaseMode} database because ` +
|
`Cannot build an ${overlayDatabaseMode} database because ` +
|
||||||
`the source root "${sourceRoot}" is not inside a git repository. ` +
|
`the source root "${sourceRoot}" is not inside a git repository. ` +
|
||||||
@@ -977,21 +981,26 @@ async function validateOverlayDatabaseMode(
|
|||||||
);
|
);
|
||||||
return new Failure(OverlayDisabledReason.NoGitRoot);
|
return new Failure(OverlayDisabledReason.NoGitRoot);
|
||||||
}
|
}
|
||||||
if (gitVersion === undefined) {
|
if (hasSubmodules(gitRoot)) {
|
||||||
logger.warning(
|
if (gitVersion === undefined) {
|
||||||
`Cannot build an ${overlayDatabaseMode} database because ` +
|
logger.warning(
|
||||||
"the Git version could not be determined. " +
|
`Cannot build an ${overlayDatabaseMode} database because ` +
|
||||||
"Falling back to creating a normal full database instead.",
|
"the repository has submodules and the Git version could not be determined. " +
|
||||||
);
|
"Falling back to creating a normal full database instead.",
|
||||||
return new Failure(OverlayDisabledReason.IncompatibleGit);
|
);
|
||||||
}
|
return new Failure(OverlayDisabledReason.IncompatibleGit);
|
||||||
if (!gitVersion.isAtLeast(GIT_MINIMUM_VERSION_FOR_OVERLAY)) {
|
}
|
||||||
logger.warning(
|
if (
|
||||||
`Cannot build an ${overlayDatabaseMode} database because ` +
|
!gitVersion.isAtLeast(GIT_MINIMUM_VERSION_FOR_OVERLAY_WITH_SUBMODULES)
|
||||||
`the installed Git version is older than ${GIT_MINIMUM_VERSION_FOR_OVERLAY}. ` +
|
) {
|
||||||
"Falling back to creating a normal full database instead.",
|
logger.warning(
|
||||||
);
|
`Cannot build an ${overlayDatabaseMode} database because ` +
|
||||||
return new Failure(OverlayDisabledReason.IncompatibleGit);
|
"the repository has submodules and the installed Git version is older " +
|
||||||
|
`than ${GIT_MINIMUM_VERSION_FOR_OVERLAY_WITH_SUBMODULES}. ` +
|
||||||
|
"Falling back to creating a normal full database instead.",
|
||||||
|
);
|
||||||
|
return new Failure(OverlayDisabledReason.IncompatibleGit);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return new Success({
|
return new Success({
|
||||||
@@ -1028,13 +1037,13 @@ async function setCppTrapCachingEnvironmentVariables(
|
|||||||
config: Config,
|
config: Config,
|
||||||
logger: Logger,
|
logger: Logger,
|
||||||
): Promise<void> {
|
): Promise<void> {
|
||||||
if (config.languages.includes(KnownLanguage.cpp)) {
|
if (config.languages.includes(BuiltInLanguage.cpp)) {
|
||||||
const envVar = "CODEQL_EXTRACTOR_CPP_TRAP_CACHING";
|
const envVar = "CODEQL_EXTRACTOR_CPP_TRAP_CACHING";
|
||||||
if (process.env[envVar]) {
|
if (process.env[envVar]) {
|
||||||
logger.info(
|
logger.info(
|
||||||
`Environment variable ${envVar} already set, leaving it unchanged.`,
|
`Environment variable ${envVar} already set, leaving it unchanged.`,
|
||||||
);
|
);
|
||||||
} else if (config.trapCaches[KnownLanguage.cpp]) {
|
} else if (config.trapCaches[BuiltInLanguage.cpp]) {
|
||||||
logger.info("Enabling TRAP caching for C/C++.");
|
logger.info("Enabling TRAP caching for C/C++.");
|
||||||
core.exportVariable(envVar, "true");
|
core.exportVariable(envVar, "true");
|
||||||
} else {
|
} else {
|
||||||
@@ -1068,6 +1077,48 @@ function hasQueryCustomisation(userConfig: UserConfig): boolean {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Finalize the incremental-analysis configuration for this run.
|
||||||
|
*
|
||||||
|
* Overlay analysis has only been validated in combination with diff-informed
|
||||||
|
* analysis, so if `Overlay` mode was selected for a pull request but the diff
|
||||||
|
* ranges could not be computed, fall back to a full non-overlay analysis.
|
||||||
|
*
|
||||||
|
* Query exclusions for incremental-only queries are then applied whenever the
|
||||||
|
* diff ranges are available — which, after the fallback above, is exactly the
|
||||||
|
* set of runs where any kind of incremental analysis (overlay or
|
||||||
|
* diff-informed) is in effect.
|
||||||
|
*/
|
||||||
|
export async function applyIncrementalAnalysisSettings(
|
||||||
|
config: Config,
|
||||||
|
hasDiffRanges: boolean,
|
||||||
|
codeql: CodeQL,
|
||||||
|
logger: Logger,
|
||||||
|
): Promise<void> {
|
||||||
|
if (
|
||||||
|
config.overlayDatabaseMode === OverlayDatabaseMode.Overlay &&
|
||||||
|
!hasDiffRanges
|
||||||
|
) {
|
||||||
|
logger.info(
|
||||||
|
`Reverting overlay database mode to ${OverlayDatabaseMode.None} ` +
|
||||||
|
"because the PR diff ranges could not be computed.",
|
||||||
|
);
|
||||||
|
config.overlayDatabaseMode = OverlayDatabaseMode.None;
|
||||||
|
config.useOverlayDatabaseCaching = false;
|
||||||
|
await addOverlayDisablementDiagnostics(
|
||||||
|
config,
|
||||||
|
codeql,
|
||||||
|
OverlayDisabledReason.DiffInformedAnalysisNotEnabled,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (hasDiffRanges) {
|
||||||
|
config.extraQueryExclusions.push({
|
||||||
|
exclude: { tags: "exclude-from-incremental" },
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Load and return the config.
|
* Load and return the config.
|
||||||
*
|
*
|
||||||
@@ -1222,18 +1273,18 @@ export async function initConfig(
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (
|
const hasDiffRanges = await prepareDiffInformedAnalysis(
|
||||||
config.overlayDatabaseMode === OverlayDatabaseMode.Overlay ||
|
inputs.codeql,
|
||||||
(await shouldPerformDiffInformedAnalysis(
|
inputs.features,
|
||||||
inputs.codeql,
|
logger,
|
||||||
inputs.features,
|
);
|
||||||
logger,
|
|
||||||
))
|
await applyIncrementalAnalysisSettings(
|
||||||
) {
|
config,
|
||||||
config.extraQueryExclusions.push({
|
hasDiffRanges,
|
||||||
exclude: { tags: "exclude-from-incremental" },
|
inputs.codeql,
|
||||||
});
|
logger,
|
||||||
}
|
);
|
||||||
|
|
||||||
if (await isTrapCachingEnabled(features, config.overlayDatabaseMode)) {
|
if (await isTrapCachingEnabled(features, config.overlayDatabaseMode)) {
|
||||||
const { trapCaches, trapCacheDownloadTime } = await downloadCacheWithTime(
|
const { trapCaches, trapCacheDownloadTime } = await downloadCacheWithTime(
|
||||||
@@ -1531,7 +1582,7 @@ export async function parseBuildModeInput(
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (
|
if (
|
||||||
languages.includes(KnownLanguage.csharp) &&
|
languages.includes(BuiltInLanguage.csharp) &&
|
||||||
(await features.getValue(Feature.DisableCsharpBuildless))
|
(await features.getValue(Feature.DisableCsharpBuildless))
|
||||||
) {
|
) {
|
||||||
logger.warning(
|
logger.warning(
|
||||||
@@ -1541,7 +1592,7 @@ export async function parseBuildModeInput(
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (
|
if (
|
||||||
languages.includes(KnownLanguage.java) &&
|
languages.includes(BuiltInLanguage.java) &&
|
||||||
(await features.getValue(Feature.DisableJavaBuildlessEnabled))
|
(await features.getValue(Feature.DisableJavaBuildlessEnabled))
|
||||||
) {
|
) {
|
||||||
logger.warning(
|
logger.warning(
|
||||||
|
|||||||
@@ -1,12 +1,13 @@
|
|||||||
import test, { ExecutionContext } from "ava";
|
import test, { ExecutionContext } from "ava";
|
||||||
|
|
||||||
import { RepositoryProperties } from "../feature-flags/properties";
|
import { RepositoryProperties } from "../feature-flags/properties";
|
||||||
import { KnownLanguage, Language } from "../languages";
|
import { BuiltInLanguage, Language } from "../languages";
|
||||||
import { getRunnerLogger } from "../logging";
|
import { getRunnerLogger } from "../logging";
|
||||||
import {
|
import {
|
||||||
checkExpectedLogMessages,
|
checkExpectedLogMessages,
|
||||||
getRecordingLogger,
|
getRecordingLogger,
|
||||||
LoggedMessage,
|
LoggedMessage,
|
||||||
|
makeMacro,
|
||||||
} from "../testing-utils";
|
} from "../testing-utils";
|
||||||
import { ConfigurationError, prettyPrintPack } from "../util";
|
import { ConfigurationError, prettyPrintPack } from "../util";
|
||||||
|
|
||||||
@@ -15,7 +16,7 @@ import * as dbConfig from "./db-config";
|
|||||||
/**
|
/**
|
||||||
* Test macro for ensuring the packs block is valid
|
* Test macro for ensuring the packs block is valid
|
||||||
*/
|
*/
|
||||||
const parsePacksMacro = test.macro({
|
const parsePacksMacro = makeMacro({
|
||||||
exec: (
|
exec: (
|
||||||
t: ExecutionContext<unknown>,
|
t: ExecutionContext<unknown>,
|
||||||
packsInput: string,
|
packsInput: string,
|
||||||
@@ -33,7 +34,7 @@ const parsePacksMacro = test.macro({
|
|||||||
/**
|
/**
|
||||||
* Test macro for testing when the packs block is invalid
|
* Test macro for testing when the packs block is invalid
|
||||||
*/
|
*/
|
||||||
const parsePacksErrorMacro = test.macro({
|
const parsePacksErrorMacro = makeMacro({
|
||||||
exec: (
|
exec: (
|
||||||
t: ExecutionContext<unknown>,
|
t: ExecutionContext<unknown>,
|
||||||
packsInput: string,
|
packsInput: string,
|
||||||
@@ -49,45 +50,42 @@ const parsePacksErrorMacro = test.macro({
|
|||||||
/**
|
/**
|
||||||
* Test macro for testing when the packs block is invalid
|
* Test macro for testing when the packs block is invalid
|
||||||
*/
|
*/
|
||||||
const invalidPackNameMacro = test.macro({
|
const invalidPackNameMacro = makeMacro({
|
||||||
exec: (t: ExecutionContext, name: string) =>
|
exec: (t: ExecutionContext, arg: string) =>
|
||||||
parsePacksErrorMacro.exec(
|
parsePacksErrorMacro.fn(
|
||||||
t,
|
t,
|
||||||
name,
|
arg,
|
||||||
[KnownLanguage.cpp],
|
[BuiltInLanguage.cpp],
|
||||||
new RegExp(`^"${name}" is not a valid pack$`),
|
new RegExp(`^"${arg}" is not a valid pack$`),
|
||||||
),
|
),
|
||||||
title: (_providedTitle: string | undefined, arg: string | undefined) =>
|
title: (_providedTitle: string | undefined, arg: string | undefined) =>
|
||||||
`Invalid pack string: ${arg}`,
|
`Invalid pack string: ${arg}`,
|
||||||
});
|
});
|
||||||
|
|
||||||
test("no packs", parsePacksMacro, "", [], undefined);
|
parsePacksMacro("no packs", "", [], undefined);
|
||||||
test("two packs", parsePacksMacro, "a/b,c/d@1.2.3", [KnownLanguage.cpp], {
|
parsePacksMacro("two packs", "a/b,c/d@1.2.3", [BuiltInLanguage.cpp], {
|
||||||
[KnownLanguage.cpp]: ["a/b", "c/d@1.2.3"],
|
[BuiltInLanguage.cpp]: ["a/b", "c/d@1.2.3"],
|
||||||
});
|
});
|
||||||
test(
|
parsePacksMacro(
|
||||||
"two packs with spaces",
|
"two packs with spaces",
|
||||||
parsePacksMacro,
|
|
||||||
" a/b , c/d@1.2.3 ",
|
" a/b , c/d@1.2.3 ",
|
||||||
[KnownLanguage.cpp],
|
[BuiltInLanguage.cpp],
|
||||||
{
|
{
|
||||||
[KnownLanguage.cpp]: ["a/b", "c/d@1.2.3"],
|
[BuiltInLanguage.cpp]: ["a/b", "c/d@1.2.3"],
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
test(
|
parsePacksErrorMacro(
|
||||||
"two packs with language",
|
"two packs with language",
|
||||||
parsePacksErrorMacro,
|
|
||||||
"a/b,c/d@1.2.3",
|
"a/b,c/d@1.2.3",
|
||||||
[KnownLanguage.cpp, KnownLanguage.java],
|
[BuiltInLanguage.cpp, BuiltInLanguage.java],
|
||||||
new RegExp(
|
new RegExp(
|
||||||
"Cannot specify a 'packs' input in a multi-language analysis. " +
|
"Cannot specify a 'packs' input in a multi-language analysis. " +
|
||||||
"Use a codeql-config.yml file instead and specify packs by language.",
|
"Use a codeql-config.yml file instead and specify packs by language.",
|
||||||
),
|
),
|
||||||
);
|
);
|
||||||
|
|
||||||
test(
|
parsePacksMacro(
|
||||||
"packs with other valid names",
|
"packs with other valid names",
|
||||||
parsePacksMacro,
|
|
||||||
[
|
[
|
||||||
// ranges are ok
|
// ranges are ok
|
||||||
"c/d@1.0",
|
"c/d@1.0",
|
||||||
@@ -106,9 +104,9 @@ test(
|
|||||||
// (globbing is not done)
|
// (globbing is not done)
|
||||||
"c/d@1.2.3:+*)_(",
|
"c/d@1.2.3:+*)_(",
|
||||||
].join(","),
|
].join(","),
|
||||||
[KnownLanguage.cpp],
|
[BuiltInLanguage.cpp],
|
||||||
{
|
{
|
||||||
[KnownLanguage.cpp]: [
|
[BuiltInLanguage.cpp]: [
|
||||||
"c/d@1.0",
|
"c/d@1.0",
|
||||||
"c/d@~1.0.0",
|
"c/d@~1.0.0",
|
||||||
"c/d@~1.0.0:a/b",
|
"c/d@~1.0.0:a/b",
|
||||||
@@ -123,23 +121,23 @@ test(
|
|||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
test(invalidPackNameMacro, "c"); // all packs require at least a scope and a name
|
invalidPackNameMacro.test("c"); // all packs require at least a scope and a name
|
||||||
test(invalidPackNameMacro, "c-/d");
|
invalidPackNameMacro.test("c-/d");
|
||||||
test(invalidPackNameMacro, "-c/d");
|
invalidPackNameMacro.test("-c/d");
|
||||||
test(invalidPackNameMacro, "c/d_d");
|
invalidPackNameMacro.test("c/d_d");
|
||||||
test(invalidPackNameMacro, "c/d@@");
|
invalidPackNameMacro.test("c/d@@");
|
||||||
test(invalidPackNameMacro, "c/d@1.0.0:");
|
invalidPackNameMacro.test("c/d@1.0.0:");
|
||||||
test(invalidPackNameMacro, "c/d:");
|
invalidPackNameMacro.test("c/d:");
|
||||||
test(invalidPackNameMacro, "c/d:/a");
|
invalidPackNameMacro.test("c/d:/a");
|
||||||
test(invalidPackNameMacro, "@1.0.0:a");
|
invalidPackNameMacro.test("@1.0.0:a");
|
||||||
test(invalidPackNameMacro, "c/d@../a");
|
invalidPackNameMacro.test("c/d@../a");
|
||||||
test(invalidPackNameMacro, "c/d@b/../a");
|
invalidPackNameMacro.test("c/d@b/../a");
|
||||||
test(invalidPackNameMacro, "c/d:z@1");
|
invalidPackNameMacro.test("c/d:z@1");
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Test macro for pretty printing pack specs
|
* Test macro for pretty printing pack specs
|
||||||
*/
|
*/
|
||||||
const packSpecPrettyPrintingMacro = test.macro({
|
const packSpecPrettyPrintingMacro = makeMacro({
|
||||||
exec: (t: ExecutionContext, packStr: string, packObj: dbConfig.Pack) => {
|
exec: (t: ExecutionContext, packStr: string, packObj: dbConfig.Pack) => {
|
||||||
const parsed = dbConfig.parsePacksSpecification(packStr);
|
const parsed = dbConfig.parsePacksSpecification(packStr);
|
||||||
t.deepEqual(parsed, packObj, "parsed pack spec is correct");
|
t.deepEqual(parsed, packObj, "parsed pack spec is correct");
|
||||||
@@ -163,36 +161,35 @@ const packSpecPrettyPrintingMacro = test.macro({
|
|||||||
) => `Prettyprint pack spec: '${packStr}'`,
|
) => `Prettyprint pack spec: '${packStr}'`,
|
||||||
});
|
});
|
||||||
|
|
||||||
test(packSpecPrettyPrintingMacro, "a/b", {
|
packSpecPrettyPrintingMacro.test("a/b", {
|
||||||
name: "a/b",
|
name: "a/b",
|
||||||
version: undefined,
|
version: undefined,
|
||||||
path: undefined,
|
path: undefined,
|
||||||
});
|
});
|
||||||
test(packSpecPrettyPrintingMacro, "a/b@~1.2.3", {
|
packSpecPrettyPrintingMacro.test("a/b@~1.2.3", {
|
||||||
name: "a/b",
|
name: "a/b",
|
||||||
version: "~1.2.3",
|
version: "~1.2.3",
|
||||||
path: undefined,
|
path: undefined,
|
||||||
});
|
});
|
||||||
test(packSpecPrettyPrintingMacro, "a/b@~1.2.3:abc/def", {
|
packSpecPrettyPrintingMacro.test("a/b@~1.2.3:abc/def", {
|
||||||
name: "a/b",
|
name: "a/b",
|
||||||
version: "~1.2.3",
|
version: "~1.2.3",
|
||||||
path: "abc/def",
|
path: "abc/def",
|
||||||
});
|
});
|
||||||
test(packSpecPrettyPrintingMacro, "a/b:abc/def", {
|
packSpecPrettyPrintingMacro.test("a/b:abc/def", {
|
||||||
name: "a/b",
|
name: "a/b",
|
||||||
version: undefined,
|
version: undefined,
|
||||||
path: "abc/def",
|
path: "abc/def",
|
||||||
});
|
});
|
||||||
test(packSpecPrettyPrintingMacro, " a/b:abc/def ", {
|
packSpecPrettyPrintingMacro.test(" a/b:abc/def ", {
|
||||||
name: "a/b",
|
name: "a/b",
|
||||||
version: undefined,
|
version: undefined,
|
||||||
path: "abc/def",
|
path: "abc/def",
|
||||||
});
|
});
|
||||||
|
|
||||||
const calculateAugmentationMacro = test.macro({
|
const calculateAugmentationMacro = makeMacro({
|
||||||
exec: async (
|
exec: async (
|
||||||
t: ExecutionContext,
|
t: ExecutionContext,
|
||||||
_title: string,
|
|
||||||
rawPacksInput: string | undefined,
|
rawPacksInput: string | undefined,
|
||||||
rawQueriesInput: string | undefined,
|
rawQueriesInput: string | undefined,
|
||||||
languages: Language[],
|
languages: Language[],
|
||||||
@@ -207,27 +204,25 @@ const calculateAugmentationMacro = test.macro({
|
|||||||
);
|
);
|
||||||
t.deepEqual(actualAugmentationProperties, expectedAugmentationProperties);
|
t.deepEqual(actualAugmentationProperties, expectedAugmentationProperties);
|
||||||
},
|
},
|
||||||
title: (_, title) => `Calculate Augmentation: ${title}`,
|
title: (title) => `Calculate Augmentation: ${title}`,
|
||||||
});
|
});
|
||||||
|
|
||||||
test(
|
calculateAugmentationMacro(
|
||||||
calculateAugmentationMacro,
|
|
||||||
"All empty",
|
"All empty",
|
||||||
undefined,
|
undefined,
|
||||||
undefined,
|
undefined,
|
||||||
[KnownLanguage.javascript],
|
[BuiltInLanguage.javascript],
|
||||||
{},
|
{},
|
||||||
{
|
{
|
||||||
...dbConfig.defaultAugmentationProperties,
|
...dbConfig.defaultAugmentationProperties,
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
test(
|
calculateAugmentationMacro(
|
||||||
calculateAugmentationMacro,
|
|
||||||
"With queries",
|
"With queries",
|
||||||
undefined,
|
undefined,
|
||||||
" a, b , c, d",
|
" a, b , c, d",
|
||||||
[KnownLanguage.javascript],
|
[BuiltInLanguage.javascript],
|
||||||
{},
|
{},
|
||||||
{
|
{
|
||||||
...dbConfig.defaultAugmentationProperties,
|
...dbConfig.defaultAugmentationProperties,
|
||||||
@@ -235,12 +230,11 @@ test(
|
|||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
test(
|
calculateAugmentationMacro(
|
||||||
calculateAugmentationMacro,
|
|
||||||
"With queries combining",
|
"With queries combining",
|
||||||
undefined,
|
undefined,
|
||||||
" + a, b , c, d ",
|
" + a, b , c, d ",
|
||||||
[KnownLanguage.javascript],
|
[BuiltInLanguage.javascript],
|
||||||
{},
|
{},
|
||||||
{
|
{
|
||||||
...dbConfig.defaultAugmentationProperties,
|
...dbConfig.defaultAugmentationProperties,
|
||||||
@@ -249,12 +243,11 @@ test(
|
|||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
test(
|
calculateAugmentationMacro(
|
||||||
calculateAugmentationMacro,
|
|
||||||
"With packs",
|
"With packs",
|
||||||
" codeql/a , codeql/b , codeql/c , codeql/d ",
|
" codeql/a , codeql/b , codeql/c , codeql/d ",
|
||||||
undefined,
|
undefined,
|
||||||
[KnownLanguage.javascript],
|
[BuiltInLanguage.javascript],
|
||||||
{},
|
{},
|
||||||
{
|
{
|
||||||
...dbConfig.defaultAugmentationProperties,
|
...dbConfig.defaultAugmentationProperties,
|
||||||
@@ -262,12 +255,11 @@ test(
|
|||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
test(
|
calculateAugmentationMacro(
|
||||||
calculateAugmentationMacro,
|
|
||||||
"With packs combining",
|
"With packs combining",
|
||||||
" + codeql/a, codeql/b, codeql/c, codeql/d",
|
" + codeql/a, codeql/b, codeql/c, codeql/d",
|
||||||
undefined,
|
undefined,
|
||||||
[KnownLanguage.javascript],
|
[BuiltInLanguage.javascript],
|
||||||
{},
|
{},
|
||||||
{
|
{
|
||||||
...dbConfig.defaultAugmentationProperties,
|
...dbConfig.defaultAugmentationProperties,
|
||||||
@@ -276,12 +268,11 @@ test(
|
|||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
test(
|
calculateAugmentationMacro(
|
||||||
calculateAugmentationMacro,
|
|
||||||
"With repo property queries",
|
"With repo property queries",
|
||||||
undefined,
|
undefined,
|
||||||
undefined,
|
undefined,
|
||||||
[KnownLanguage.javascript],
|
[BuiltInLanguage.javascript],
|
||||||
{
|
{
|
||||||
"github-codeql-extra-queries": "a, b, c, d",
|
"github-codeql-extra-queries": "a, b, c, d",
|
||||||
},
|
},
|
||||||
@@ -294,12 +285,11 @@ test(
|
|||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
test(
|
calculateAugmentationMacro(
|
||||||
calculateAugmentationMacro,
|
|
||||||
"With repo property queries combining",
|
"With repo property queries combining",
|
||||||
undefined,
|
undefined,
|
||||||
undefined,
|
undefined,
|
||||||
[KnownLanguage.javascript],
|
[BuiltInLanguage.javascript],
|
||||||
{
|
{
|
||||||
"github-codeql-extra-queries": "+ a, b, c, d",
|
"github-codeql-extra-queries": "+ a, b, c, d",
|
||||||
},
|
},
|
||||||
@@ -312,10 +302,9 @@ test(
|
|||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
const calculateAugmentationErrorMacro = test.macro({
|
const calculateAugmentationErrorMacro = makeMacro({
|
||||||
exec: async (
|
exec: async (
|
||||||
t: ExecutionContext,
|
t: ExecutionContext,
|
||||||
_title: string,
|
|
||||||
rawPacksInput: string | undefined,
|
rawPacksInput: string | undefined,
|
||||||
rawQueriesInput: string | undefined,
|
rawQueriesInput: string | undefined,
|
||||||
languages: Language[],
|
languages: Language[],
|
||||||
@@ -333,53 +322,48 @@ const calculateAugmentationErrorMacro = test.macro({
|
|||||||
{ message: expectedError },
|
{ message: expectedError },
|
||||||
);
|
);
|
||||||
},
|
},
|
||||||
title: (_, title) => `Calculate Augmentation Error: ${title}`,
|
title: (title) => `Calculate Augmentation Error: ${title}`,
|
||||||
});
|
});
|
||||||
|
|
||||||
test(
|
calculateAugmentationErrorMacro(
|
||||||
calculateAugmentationErrorMacro,
|
|
||||||
"Plus (+) with nothing else (queries)",
|
"Plus (+) with nothing else (queries)",
|
||||||
undefined,
|
undefined,
|
||||||
" + ",
|
" + ",
|
||||||
[KnownLanguage.javascript],
|
[BuiltInLanguage.javascript],
|
||||||
{},
|
{},
|
||||||
/The workflow property "queries" is invalid/,
|
/The workflow property "queries" is invalid/,
|
||||||
);
|
);
|
||||||
|
|
||||||
test(
|
calculateAugmentationErrorMacro(
|
||||||
calculateAugmentationErrorMacro,
|
|
||||||
"Plus (+) with nothing else (packs)",
|
"Plus (+) with nothing else (packs)",
|
||||||
" + ",
|
" + ",
|
||||||
undefined,
|
undefined,
|
||||||
[KnownLanguage.javascript],
|
[BuiltInLanguage.javascript],
|
||||||
{},
|
{},
|
||||||
/The workflow property "packs" is invalid/,
|
/The workflow property "packs" is invalid/,
|
||||||
);
|
);
|
||||||
|
|
||||||
test(
|
calculateAugmentationErrorMacro(
|
||||||
calculateAugmentationErrorMacro,
|
|
||||||
"Plus (+) with nothing else (repo property queries)",
|
"Plus (+) with nothing else (repo property queries)",
|
||||||
undefined,
|
undefined,
|
||||||
undefined,
|
undefined,
|
||||||
[KnownLanguage.javascript],
|
[BuiltInLanguage.javascript],
|
||||||
{
|
{
|
||||||
"github-codeql-extra-queries": " + ",
|
"github-codeql-extra-queries": " + ",
|
||||||
},
|
},
|
||||||
/The repository property "github-codeql-extra-queries" is invalid/,
|
/The repository property "github-codeql-extra-queries" is invalid/,
|
||||||
);
|
);
|
||||||
|
|
||||||
test(
|
calculateAugmentationErrorMacro(
|
||||||
calculateAugmentationErrorMacro,
|
|
||||||
"Packs input with multiple languages",
|
"Packs input with multiple languages",
|
||||||
" + a/b, c/d ",
|
" + a/b, c/d ",
|
||||||
undefined,
|
undefined,
|
||||||
[KnownLanguage.javascript, KnownLanguage.java],
|
[BuiltInLanguage.javascript, BuiltInLanguage.java],
|
||||||
{},
|
{},
|
||||||
/Cannot specify a 'packs' input in a multi-language analysis/,
|
/Cannot specify a 'packs' input in a multi-language analysis/,
|
||||||
);
|
);
|
||||||
|
|
||||||
test(
|
calculateAugmentationErrorMacro(
|
||||||
calculateAugmentationErrorMacro,
|
|
||||||
"Packs input with no languages",
|
"Packs input with no languages",
|
||||||
" + a/b, c/d ",
|
" + a/b, c/d ",
|
||||||
undefined,
|
undefined,
|
||||||
@@ -388,12 +372,11 @@ test(
|
|||||||
/No languages specified/,
|
/No languages specified/,
|
||||||
);
|
);
|
||||||
|
|
||||||
test(
|
calculateAugmentationErrorMacro(
|
||||||
calculateAugmentationErrorMacro,
|
|
||||||
"Invalid packs",
|
"Invalid packs",
|
||||||
" a-pack-without-a-scope ",
|
" a-pack-without-a-scope ",
|
||||||
undefined,
|
undefined,
|
||||||
[KnownLanguage.javascript],
|
[BuiltInLanguage.javascript],
|
||||||
{},
|
{},
|
||||||
/"a-pack-without-a-scope" is not a valid pack/,
|
/"a-pack-without-a-scope" is not a valid pack/,
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ import { createStubCodeQL } from "./codeql";
|
|||||||
import { Config } from "./config-utils";
|
import { Config } from "./config-utils";
|
||||||
import { cleanupAndUploadDatabases } from "./database-upload";
|
import { cleanupAndUploadDatabases } from "./database-upload";
|
||||||
import * as gitUtils from "./git-utils";
|
import * as gitUtils from "./git-utils";
|
||||||
import { KnownLanguage } from "./languages";
|
import { BuiltInLanguage } from "./languages";
|
||||||
import { RepositoryNwo } from "./repository";
|
import { RepositoryNwo } from "./repository";
|
||||||
import {
|
import {
|
||||||
checkExpectedLogMessages,
|
checkExpectedLogMessages,
|
||||||
@@ -45,7 +45,7 @@ const testApiDetails: GitHubApiDetails = {
|
|||||||
|
|
||||||
function getTestConfig(tmpDir: string): Config {
|
function getTestConfig(tmpDir: string): Config {
|
||||||
return createTestConfig({
|
return createTestConfig({
|
||||||
languages: [KnownLanguage.javascript],
|
languages: [BuiltInLanguage.javascript],
|
||||||
dbLocation: tmpDir,
|
dbLocation: tmpDir,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user