actions/runner-images-sangeeth
1
0
Fork 0
mirror of https://github.com/actions/runner-images-sangeeth.git synced 2025-12-20 06:29:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

macOS: Cache only the latest version of CodeQL (#8420)

Browse Source 
Previously, we cached two versions since we prioritized hitting the
toolcache over landing new releases quicker. However after
experimenting with this, we have decided to prioritize getting new
releases into customers' hands more quickly.
This commit is contained in:
Henry Mercer
2023-10-17 21:18:48 +01:00
committed by GitHub
parent 5c4b424bf6
commit f2d892281b
4 changed files with 34 additions and 104 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
images/macos/provision/core/codeql-bundle.sh
View File

@@ -1,70 +1,28 @@
#!/bin/bash -e -o pipefail #!/bin/bash -e -o pipefail
source ~/utils/utils.sh source ~/utils/utils.sh
# Retrieve the CLI versions and bundle tags of the latest two CodeQL bundles. # Retrieve the CLI version of the latest CodeQL bundle.
base_url="$(curl -fsSL https://raw.githubusercontent.com/github/codeql-action/v2/src/defaults.json)" base_url="$(curl -fsSL https://raw.githubusercontent.com/github/codeql-action/v2/src/defaults.json)"
codeql_tag_name="$(echo "$base_url" | jq -r '.bundleVersion')" bundle_version="$(echo "$base_url" | jq -r '.cliVersion')"
codeql_cli_version="$(echo "$base_url" | jq -r '.cliVersion')" bundle_tag_name="codeql-bundle-v$bundle_version"
prior_codeql_tag_name="$(echo "$base_url" | jq -r '.priorBundleVersion')"
prior_codeql_cli_version="$(echo "$base_url" | jq -r '.priorCliVersion')"
# Compute the toolcache version number for each bundle. This is either `x.y.z` or `x.y.z-YYYYMMDD`. echo "Downloading CodeQL bundle $bundle_version..."
if [[ "${codeql_tag_name##*-}" == "v"* ]]; then # Note that this is the all-platforms CodeQL bundle, to support scenarios where customers run
# Tag name of the format `codeql-bundle-vx.y.z`, where x.y.z is the CLI version. # different operating systems within containers.
# We don't need to include the tag name in the toolcache version number because it's derivable download_with_retries "https://github.com/github/codeql-action/releases/download/$bundle_tag_name/codeql-bundle.tar.gz" "/tmp" "codeql-bundle.tar.gz"
# from the CLI version. codeql_archive="/tmp/codeql-bundle.tar.gz"
codeql_bundle_version="$codeql_cli_version"
elif [[ "${codeql_tag_name##*-}" =~ ^[0-9]+$ ]]; then
# Tag name of the format `codeql-bundle-YYYYMMDD`.
# We need to include the tag name in the toolcache version number because it can't be derived
# from the CLI version.
codeql_bundle_version="$codeql_cli_version-${codeql_tag_name##*-}"
else
echo "Unrecognised current CodeQL bundle tag name: $codeql_tag_name." \
"Could not compute toolcache version number."
exit 1
fi
if [[ "${prior_codeql_tag_name##*-}" == "v"* ]]; then
# Tag name of the format `codeql-bundle-vx.y.z`, where x.y.z is the CLI version.
# We don't need to include the tag name in the toolcache version number because it's derivable
# from the CLI version.
prior_codeql_bundle_version="$prior_codeql_cli_version"
elif [[ "${prior_codeql_tag_name##*-}" =~ ^[0-9]+$ ]]; then
# Tag name of the format `codeql-bundle-YYYYMMDD`.
# We need to include the tag name in the toolcache version number because it can't be derived
# from the CLI version.
prior_codeql_bundle_version="$prior_codeql_cli_version-${prior_codeql_tag_name##*-}"
else
echo "Unrecognised prior CodeQL bundle tag name: $prior_codeql_tag_name." \
"Could not compute toolcache version number."
exit 1
fi
# Download and name both CodeQL bundles. codeql_toolcache_path="$AGENT_TOOLSDIRECTORY/CodeQL/$bundle_version/x64"
codeql_bundle_versions=("${codeql_bundle_version}" "${prior_codeql_bundle_version}") mkdir -p "$codeql_toolcache_path"
codeql_tag_names=("${codeql_tag_name}" "${prior_codeql_tag_name}")
for index in "${!codeql_bundle_versions[@]}"; do echo "Unpacking the downloaded CodeQL bundle archive..."
bundle_version="${codeql_bundle_versions[$index]}" tar -xzf "$codeql_archive" -C "$codeql_toolcache_path"
bundle_tag_name="${codeql_tag_names[$index]}"
echo "Downloading CodeQL bundle $bundle_version..."
download_with_retries "https://github.com/github/codeql-action/releases/download/$bundle_tag_name/codeql-bundle.tar.gz" "/tmp" "codeql-bundle.tar.gz"
codeql_archive="/tmp/codeql-bundle.tar.gz"
codeql_toolcache_path="$AGENT_TOOLSDIRECTORY/CodeQL/$bundle_version/x64" # Touch a file to indicate to the CodeQL Action that this bundle shipped with the toolcache. This is
mkdir -p "$codeql_toolcache_path" # to support overriding the CodeQL version specified in defaults.json on GitHub Enterprise.
touch "$codeql_toolcache_path/pinned-version"
echo "Unpacking the downloaded CodeQL bundle archive..." # Touch a file to indicate to the toolcache that setting up CodeQL is complete.
tar -xzf "$codeql_archive" -C "$codeql_toolcache_path" touch "$codeql_toolcache_path.complete"
# We only pin the latest version in the toolcache, to support overriding the CodeQL version specified in defaults.json on GitHub Enterprise. invoke_tests "Common" "CodeQL Bundle"
if [[ "$bundle_version" == "$codeql_bundle_version" ]]; then
touch "$codeql_toolcache_path/pinned-version"
fi
# Touch a file to indicate to the toolcache that setting up CodeQL is complete.
touch "$codeql_toolcache_path.complete"
done
invoke_tests "Common" "CodeQLBundles"

18
images/macos/software-report/SoftwareReport.Common.psm1
View File

@@ -608,17 +608,13 @@ function Build-MiscellaneousEnvironmentTable {
} }
} }
function Get-CodeQLBundleVersions {
$CodeQLVersionsWildcard = Join-Path $Env:AGENT_TOOLSDIRECTORY -ChildPath "CodeQL" | Join-Path -ChildPath "*" function Get-CodeQLBundleVersion {
$CodeQLVersionPaths = Get-ChildItem $CodeQLVersionsWildcard $CodeQLVersionWildcard = Join-Path $Env:AGENT_TOOLSDIRECTORY -ChildPath "CodeQL" | Join-Path -ChildPath "*"
$CodeQlVersions=@() $CodeQLVersionPath = Get-ChildItem $CodeQLVersionWildcard | Select-Object -First 1 -Expand FullName
foreach ($CodeQLVersionPath in $CodeQLVersionPaths) { $CodeQLPath = Join-Path $CodeQLVersionPath -ChildPath "x64" | Join-Path -ChildPath "codeql" | Join-Path -ChildPath "codeql"
$FullCodeQLVersionPath = $CodeQLVersionPath | Select-Object -Expand FullName $CodeQLVersion = & $CodeQLPath version --quiet
$CodeQLPath = Join-Path $FullCodeQLVersionPath -ChildPath "x64" | Join-Path -ChildPath "codeql" | Join-Path -ChildPath "codeql" return $CodeQLVersion
$CodeQLVersion = & $CodeQLPath version --quiet
$CodeQLVersions += $CodeQLVersion
}
return $CodeQLVersions
} }
function Get-ColimaVersion { function Get-ColimaVersion {

2
images/macos/software-report/SoftwareReport.Generator.ps1
View File

@@ -172,7 +172,7 @@ if (-not $os.IsVenturaArm64) {
$tools.AddToolVersion("Cabal", $(Get-CabalVersion)) $tools.AddToolVersion("Cabal", $(Get-CabalVersion))
} }
$tools.AddToolVersion("Cmake", $(Get-CmakeVersion)) $tools.AddToolVersion("Cmake", $(Get-CmakeVersion))
$tools.AddToolVersion("CodeQL Action Bundles", $(Get-CodeQLBundleVersions)) $tools.AddToolVersion("CodeQL Action Bundle", $(Get-CodeQLBundleVersion))
if ($os.IsMonterey) { if ($os.IsMonterey) {
$tools.AddToolVersion("Colima", $(Get-ColimaVersion)) $tools.AddToolVersion("Colima", $(Get-ColimaVersion))
} }

40
images/macos/tests/Common.Tests.ps1
View File

@@ -129,39 +129,15 @@ Describe "VirtualBox" -Skip:($os.IsBigSur -or $os.IsVentura -or $os.IsVenturaArm
} }
} }
Describe "CodeQLBundles" { Describe "CodeQL Bundle" {
It "Latest CodeQL Bundle" { It "Is installed" {
$CodeQLVersionWildcards = Join-Path $Env:AGENT_TOOLSDIRECTORY -ChildPath "CodeQL" | Join-Path -ChildPath "*" $CodeQLVersionWildcard = Join-Path $Env:AGENT_TOOLSDIRECTORY -ChildPath "CodeQL" | Join-Path -ChildPath "*"
$LatestCodeQLVersionPath = Get-ChildItem $CodeQLVersionWildcards | Sort-Object -Property { [SemVer]$_.name } -Descending | Select-Object -First 1 -Expand FullName $CodeQLVersionPath = Get-ChildItem $CodeQLVersionWildcard | Select-Object -First 1 -Expand FullName
$LatestCodeQLPath = Join-Path $LatestCodeQLVersionPath -ChildPath "x64" | Join-Path -ChildPath "codeql" | Join-Path -ChildPath "codeql" $CodeQLPath = Join-Path $CodeQLVersionPath -ChildPath "x64" | Join-Path -ChildPath "codeql" | Join-Path -ChildPath "codeql"
"$LatestCodeQLPath version --quiet" | Should -ReturnZeroExitCode "$CodeQLPath version --quiet" | Should -ReturnZeroExitCode
$LatestCodeQLPacksPath = Join-Path $LatestCodeQLVersionPath -ChildPath "x64" | Join-Path -ChildPath "codeql" | Join-Path -ChildPath "qlpacks" $CodeQLPacksPath = Join-Path $CodeQLVersionPath -ChildPath "x64" | Join-Path -ChildPath "codeql" | Join-Path -ChildPath "qlpacks"
$LatestCodeQLPacksPath | Should -Exist $CodeQLPacksPath | Should -Exist
}
It "Prior CodeQL Bundle" {
$CodeQLVersionWildcards = Join-Path $Env:AGENT_TOOLSDIRECTORY -ChildPath "CodeQL" | Join-Path -ChildPath "*"
$PriorCodeQLVersionPath = Get-ChildItem $CodeQLVersionWildcards | Sort-Object -Property { [SemVer]$_.name } -Descending | Select-Object -Last 1 -Expand FullName
$PriorCodeQLPath = Join-Path $PriorCodeQLVersionPath -ChildPath "x64" | Join-Path -ChildPath "codeql" | Join-Path -ChildPath "codeql"
"$PriorCodeQLPath version --quiet" | Should -ReturnZeroExitCode
$PriorCodeQLPacksPath = Join-Path $PriorCodeQLVersionPath -ChildPath "x64" | Join-Path -ChildPath "codeql" | Join-Path -ChildPath "qlpacks"
$PriorCodeQLPacksPath | Should -Exist
}
It "Latest and Prior CodeQL Bundles are unique" {
$CodeQLVersionWildcards = Join-Path $Env:AGENT_TOOLSDIRECTORY -ChildPath "CodeQL" | Join-Path -ChildPath "*"
$LatestCodeQLVersionPath = Get-ChildItem $CodeQLVersionWildcards | Sort-Object -Property { [SemVer]$_.name } -Descending | Select-Object -First 1 -Expand FullName
$LatestCodeQLPath = Join-Path $LatestCodeQLVersionPath -ChildPath "x64" | Join-Path -ChildPath "codeql" | Join-Path -ChildPath "codeql"
$LatestCodeQLVersion = & $LatestCodeQLPath version --quiet
$PriorCodeQLVersionPath = Get-ChildItem $CodeQLVersionWildcards | Sort-Object -Property { [SemVer]$_.name } -Descending | Select-Object -Last 1 -Expand FullName
$PriorCodeQLPath = Join-Path $PriorCodeQLVersionPath -ChildPath "x64" | Join-Path -ChildPath "codeql" | Join-Path -ChildPath "codeql"
$PriorCodeQLVersion = & $PriorCodeQLPath version --quiet
$LatestCodeQLVersion | Should -Not -Match $PriorCodeQLVersion
} }
} }