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

[ubuntu] Refactor PowerShell build scripts (#9064)

Browse Source 
* [ubuntu] Refactor PowerShell build scripts

* Add Module import

* Add Invoke-DownloadWithRetry function

* Fix temp download dir

* Update function to Add-GlobalEnvironmentVariable
This commit is contained in:
Shamil Mubarakshin
2023-12-27 18:39:58 +01:00
committed by GitHub
parent 62aeae3a20
commit e9057a22fc
5 changed files with 158 additions and 101 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
images/ubuntu/scripts/build/Configure-Toolset.ps1
View File

@@ -4,92 +4,80 @@
## Desc: Configure toolset ## Desc: Configure toolset
################################################################################ ################################################################################
Import-Module "$env:HELPER_SCRIPTS/../tests/Helpers.psm1" -DisableNameChecking Import-Module "$env:HELPER_SCRIPTS/../tests/Helpers.psm1"
function Get-ToolsetToolFullPath function Get-TCToolVersionPath {
{ param(
param [Parameter(Mandatory)]
( [string] $ToolName,
[Parameter(Mandatory)] [string] $ToolName, [Parameter(Mandatory)]
[Parameter(Mandatory)] [string] $ToolVersion, [string] $ToolVersion,
[Parameter(Mandatory)] [string] $ToolArchitecture [Parameter(Mandatory)]
[string] $ToolArchitecture
) )
$toolPath = Join-Path -Path $env:AGENT_TOOLSDIRECTORY -ChildPath $toolName $toolPath = Join-Path -Path $env:AGENT_TOOLSDIRECTORY -ChildPath $ToolName
$toolPathVersion = Join-Path -Path $toolPath -ChildPath $toolVersion $toolPathVersion = Join-Path -Path $toolPath -ChildPath $ToolVersion
$foundVersion = Get-Item $toolPathVersion | Sort-Object -Property { [version] $_.name } -Descending | Select-Object -First 1 $foundVersion = Get-Item $toolPathVersion | Sort-Object -Property { [version] $_.name } -Descending | Select-Object -First 1
$installationDir = Join-Path -Path $foundVersion -ChildPath $toolArchitecture $installationDir = Join-Path -Path $foundVersion -ChildPath $ToolArchitecture
return $installationDir return $installationDir
} }
function Add-EnvironmentVariable function Add-GlobalEnvironmentVariable {
{ param(
param [Parameter(Mandatory)]
( [string] $Name,
[Parameter(Mandatory)] [string] $Name, [Parameter(Mandatory)]
[Parameter(Mandatory)] [string] $Value, [string] $Value,
[string] $FilePath = "/etc/environment" [string] $FilePath = "/etc/environment"
) )
$envVar = "{0}={1}" -f $name, $value $envVar = "{0}={1}" -f $Name, $Value
Tee-Object -InputObject $envVar -FilePath $filePath -Append Tee-Object -InputObject $envVar -FilePath $FilePath -Append
} }
$ErrorActionPreference = "Stop" $ErrorActionPreference = "Stop"
Write-Host "Configure toolset tools environment..." Write-Host "Configure toolcache tools environment..."
$toolsEnvironment = @{ $toolEnvConfigs = @{
go = @{ go = @{
command = "ln -s {0}/bin/* /usr/bin/" command = "ln -s {0}/bin/* /usr/bin/"
variableTemplate = "GOROOT_{0}_{1}_X64" variableTemplate = "GOROOT_{0}_{1}_X64"
} }
} }
$toolset = Get-Content -Path "$env:INSTALLER_SCRIPT_FOLDER/toolset.json" -Raw | ConvertFrom-Json # Get toolcache content from toolset
$tools = (Get-ToolsetContent).toolcache | Where-Object { $toolEnvConfigs.Keys -contains $_.name }
foreach ($tool in $toolset.toolcache) foreach ($tool in $tools) {
{ $toolEnvConfig = $toolEnvConfigs[$tool.name]
$toolName = $tool.name
$toolArch = $tool.arch
$toolEnvironment = $toolsEnvironment[$toolName]
if (-not $toolEnvironment) if (-not ([string]::IsNullOrEmpty($toolEnvConfig.variableTemplate))) {
{ foreach ($toolVersion in $tool.versions) {
continue Write-Host "Set $($tool.name) $toolVersion environment variable..."
$toolPath = Get-TCToolVersionPath -ToolName $tool.name -ToolVersion $toolVersion -ToolArchitecture $tool.arch
$envVariableName = $toolEnvConfig.variableTemplate -f $toolVersion.split(".")
Add-GlobalEnvironmentVariable -Name $envVariableName -Value $toolPath
} }
foreach ($toolVersion in $tool.versions)
{
Write-Host "Set $toolName $toolVersion environment variable..."
$toolPath = Get-ToolsetToolFullPath -ToolName $toolName -ToolVersion $toolVersion -ToolArchitecture $toolArch
$envName = $toolEnvironment.variableTemplate -f $toolVersion.split(".")
# Add environment variable name=value
Add-EnvironmentVariable -Name $envName -Value $toolPath
} }
# Invoke command and add env variable for the default tool version # Invoke command and add env variable for the default tool version
$toolDefVersion = $tool.default if (-not ([string]::IsNullOrEmpty($tool.default))) {
if (-not $toolDefVersion) $toolDefaultPath = Get-TCToolVersionPath -ToolName $tool.name -ToolVersion $tool.default -ToolArchitecture $tool.arch
{
continue if (-not ([string]::IsNullOrEmpty($toolEnvConfig.defaultVariable))) {
Write-Host "Set default $($toolEnvConfig.defaultVariable) for $($tool.name) $($tool.default) environment variable..."
Add-GlobalEnvironmentVariable -Name $toolEnvConfig.defaultVariable -Value $toolDefaultPath
} }
$envDefName = $toolEnvironment.defaultVariable if (-not ([string]::IsNullOrEmpty($toolEnvConfig.command))) {
$toolPath = Get-ToolsetToolFullPath -ToolName $toolName -ToolVersion $toolDefVersion -ToolArchitecture $toolArch $command = $toolEnvConfig.command -f $toolDefaultPath
Write-Host "Invoke $command command for default $($tool.name) $($tool.default) ..."
if ($envDefName)
{
Write-Host "Set default $envDefName for $toolName $toolDefVersion environment variable..."
Add-EnvironmentVariable -Name $envDefName -Value $toolPath
}
if ($toolEnvironment.command)
{
$command = $toolEnvironment.command -f $toolPath
Write-Host "Invoke $command command for default $toolName $toolDefVersion..."
Invoke-Expression -Command $command Invoke-Expression -Command $command
} }
} }
}
Invoke-PesterTests -TestFile "Toolset" -TestName "Toolset" Invoke-PesterTests -TestFile "Toolset" -TestName "Toolset"

20
images/ubuntu/scripts/build/Install-PowerShellAzModules.ps1
View File

@@ -6,18 +6,17 @@
$ErrorActionPreference = "Stop" $ErrorActionPreference = "Stop"
$ProgressPreference = "SilentlyContinue" $ProgressPreference = "SilentlyContinue"
Import-Module "$env:HELPER_SCRIPTS/../tests/Helpers.psm1" -DisableNameChecking Import-Module "$env:HELPER_SCRIPTS/../tests/Helpers.psm1"
# Get modules content from toolset # Get modules content from toolset
$modules = (Get-ToolsetContent).azureModules $modules = (Get-ToolsetContent).azureModules
$installPSModulePath = "/usr/share" $installPSModulePath = "/usr/share"
foreach ($module in $modules) foreach ($module in $modules) {
{
$moduleName = $module.name $moduleName = $module.name
Write-Host "Installing ${moduleName} to the ${installPSModulePath} path..." Write-Host "Installing ${moduleName} to the ${installPSModulePath} path..."
foreach ($version in $module.versions) foreach ($version in $module.versions) {
{
$modulePath = Join-Path -Path $installPSModulePath -ChildPath "${moduleName}_${version}" $modulePath = Join-Path -Path $installPSModulePath -ChildPath "${moduleName}_${version}"
Write-Host " - $version [$modulePath]" Write-Host " - $version [$modulePath]"
Save-Module -Path $modulePath -Name $moduleName -RequiredVersion $version -Force Save-Module -Path $modulePath -Name $moduleName -RequiredVersion $version -Force
@@ -31,14 +30,13 @@ foreach ($module in $modules)
| Select-Object -ExpandProperty files ` | Select-Object -ExpandProperty files `
| Select-Object -First 1 | Select-Object -First 1
Write-Host "Installing $($module.name) $toolVersion ..." if (-not $asset) {
if ($null -ne $asset) { Write-Host "Asset for ${moduleName} ${toolVersion} was not found in versions manifest"
Write-Host "Download $($asset.filename)"
wget $asset.download_url -nv --retry-connrefused --tries=10 -P $installPSModulePath
} else {
Write-Host "Asset was not found in versions manifest"
exit 1 exit 1
} }
Write-Host "Downloading asset for ${moduleName} ${toolVersion}: $($asset.filename)"
Invoke-DownloadWithRetry $asset.download_url -Destination "$installPSModulePath/$($asset.filename)"
} }
} }

18
images/ubuntu/scripts/build/Install-PowerShellModules.ps1
View File

@@ -6,7 +6,7 @@
$ErrorActionPreference = "Stop" $ErrorActionPreference = "Stop"
$ProgressPreference = "SilentlyContinue" $ProgressPreference = "SilentlyContinue"
Import-Module "$env:HELPER_SCRIPTS/../tests/Helpers.psm1" -DisableNameChecking Import-Module "$env:HELPER_SCRIPTS/../tests/Helpers.psm1"
# Specifies the installation policy # Specifies the installation policy
Set-PSRepository -InstallationPolicy Trusted -Name PSGallery Set-PSRepository -InstallationPolicy Trusted -Name PSGallery
@@ -18,22 +18,18 @@ Update-Module -Name PowerShellGet -Force
# Install PowerShell modules # Install PowerShell modules
$modules = (Get-ToolsetContent).powershellModules $modules = (Get-ToolsetContent).powershellModules
foreach($module in $modules) foreach($module in $modules) {
{
$moduleName = $module.name $moduleName = $module.name
Write-Host "Installing ${moduleName} module"
if ($module.versions) Write-Host "Installing ${moduleName} module"
{ if ($module.versions) {
foreach ($version in $module.versions) foreach ($version in $module.versions) {
{
Write-Host " - $version" Write-Host " - $version"
Install-Module -Name $moduleName -RequiredVersion $version -Scope AllUsers -SkipPublisherCheck -Force Install-Module -Name $moduleName -RequiredVersion $version -Scope AllUsers -SkipPublisherCheck -Force
} }
continue } else {
}
Install-Module -Name $moduleName -Scope AllUsers -SkipPublisherCheck -Force Install-Module -Name $moduleName -Scope AllUsers -SkipPublisherCheck -Force
} }
}
Invoke-PesterTests -TestFile "PowerShellModules" -TestName "PowerShellModules" Invoke-PesterTests -TestFile "PowerShellModules" -TestName "PowerShellModules"

29
images/ubuntu/scripts/build/Install-Toolset.ps1
View File

@@ -4,19 +4,21 @@
## Desc: Install toolset ## Desc: Install toolset
################################################################################ ################################################################################
Function Install-Asset { Import-Module "$env:HELPER_SCRIPTS/../tests/Helpers.psm1"
function Install-Asset {
param( param(
[Parameter(Mandatory = $true)] [Parameter(Mandatory = $true)]
[object] $ReleaseAsset [object] $ReleaseAsset
) )
Write-Host "Download $($ReleaseAsset.filename)" Write-Host "Download $($ReleaseAsset.filename)"
wget $ReleaseAsset.download_url -nv --retry-connrefused --tries=10 $assetArchivePath = Invoke-DownloadWithRetry $ReleaseAsset.download_url
Write-Host "Extract $($ReleaseAsset.filename) content..." Write-Host "Extract $($ReleaseAsset.filename) content..."
$assetFolderPath = Join-Path "/tmp" $($ReleaseAsset.filename) $assetFolderPath = Join-Path "/tmp" "$($ReleaseAsset.filename)-temp-dir"
New-Item -ItemType Directory -Path $assetFolderPath New-Item -ItemType Directory -Path $assetFolderPath | Out-Null
tar -xzf $ReleaseAsset.filename -C $assetFolderPath tar -xzf $assetArchivePath -C $assetFolderPath
Write-Host "Invoke installation script..." Write-Host "Invoke installation script..."
Push-Location -Path $assetFolderPath Push-Location -Path $assetFolderPath
@@ -26,10 +28,8 @@ Function Install-Asset {
$ErrorActionPreference = "Stop" $ErrorActionPreference = "Stop"
# Get toolset content # Get toolcache content from toolset
$toolset = Get-Content -Path "$env:INSTALLER_SCRIPT_FOLDER/toolset.json" -Raw $tools = (Get-ToolsetContent).toolcache | Where-Object { $_.url -ne $null }
$tools = ConvertFrom-Json -InputObject $toolset | Select-Object -ExpandProperty toolcache | Where-Object {$_.url -ne $null }
foreach ($tool in $tools) { foreach ($tool in $tools) {
# Get versions manifest for current tool # Get versions manifest for current tool
@@ -42,13 +42,14 @@ foreach ($tool in $tools) {
| Where-Object { ($_.platform -eq $tool.platform) -and ($_.platform_version -eq $tool.platform_version)} ` | Where-Object { ($_.platform -eq $tool.platform) -and ($_.platform_version -eq $tool.platform_version)} `
| Select-Object -First 1 | Select-Object -First 1
Write-Host "Installing $($tool.name) $toolVersion $($tool.arch)..." if (-not $asset) {
if ($null -ne $asset) { Write-Host "Asset for $($tool.name) $toolVersion $($tool.arch) not found in versions manifest"
Install-Asset -ReleaseAsset $asset
} else {
Write-Host "Asset was not found in versions manifest"
exit 1 exit 1
} }
Write-Host "Installing $($tool.name) $toolVersion $($tool.arch)..."
Install-Asset -ReleaseAsset $asset
} }
chown -R "$($env:SUDO_USER):$($env:SUDO_USER)" "/opt/hostedtoolcache/$($tool.name)" chown -R "$($env:SUDO_USER):$($env:SUDO_USER)" "/opt/hostedtoolcache/$($tool.name)"
} }

74
images/ubuntu/scripts/helpers/Common.Helpers.psm1
View File

@@ -76,3 +76,77 @@ function Get-ToolsetContent {
$toolsetJson = Get-Content -Path $toolsetPath -Raw $toolsetJson = Get-Content -Path $toolsetPath -Raw
ConvertFrom-Json -InputObject $toolsetJson ConvertFrom-Json -InputObject $toolsetJson
} }
function Invoke-DownloadWithRetry {
<#
.SYNOPSIS
Downloads a file from a given URL with retry functionality.
.DESCRIPTION
The Invoke-DownloadWithRetry function downloads a file from the specified URL
to the specified path. It includes retry functionality in case the download fails.
.PARAMETER Url
The URL of the file to download.
.PARAMETER Path
The path where the downloaded file will be saved. If not provided, a temporary path
will be used.
.EXAMPLE
Invoke-DownloadWithRetry -Url "https://example.com/file.zip" -Path "/usr/local/bin"
Downloads the file from the specified URL and saves it to the specified path.
.EXAMPLE
Invoke-DownloadWithRetry -Url "https://example.com/file.zip"
Downloads the file from the specified URL and saves it to a temporary path.
.OUTPUTS
The path where the downloaded file is saved.
#>
param(
[Parameter(Mandatory)]
[string] $Url,
[Alias("Destination")]
[string] $DestinationPath
)
if (-not $DestinationPath) {
$invalidChars = [IO.Path]::GetInvalidFileNameChars() -join ''
$re = "[{0}]" -f [RegEx]::Escape($invalidChars)
$fileName = [IO.Path]::GetFileName($Url) -replace $re
if ([String]::IsNullOrEmpty($fileName)) {
$fileName = [System.IO.Path]::GetRandomFileName()
}
$DestinationPath = Join-Path -Path "/tmp" -ChildPath $fileName
}
Write-Host "Downloading package from $Url to $DestinationPath..."
$interval = 30
$downloadStartTime = Get-Date
for ($retries = 20; $retries -gt 0; $retries--) {
try {
$attemptStartTime = Get-Date
(New-Object System.Net.WebClient).DownloadFile($Url, $DestinationPath)
$attemptSeconds = [math]::Round(($(Get-Date) - $attemptStartTime).TotalSeconds, 2)
Write-Host "Package downloaded in $attemptSeconds seconds"
break
} catch {
$attemptSeconds = [math]::Round(($(Get-Date) - $attemptStartTime).TotalSeconds, 2)
Write-Warning "Package download failed in $attemptSeconds seconds"
Write-Warning $_.Exception.Message
}
if ($retries -eq 0) {
$totalSeconds = [math]::Round(($(Get-Date) - $downloadStartTime).TotalSeconds, 2)
throw "Package download failed after $totalSeconds seconds"
}
Write-Warning "Waiting $interval seconds before retrying (retries left: $retries)..."
Start-Sleep -Seconds $interval
}
return $DestinationPath
}