Skip to content

BuildkitTools.psm1: Use logger module #71

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: feature/logger
Choose a base branch
from
Draft

BuildkitTools.psm1: Use logger module #71

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e41836e
Use logger module for BuildkitTools.psm1 instead of Write-* commands
TinaMor May 20, 2025
8161087
Import logger modules
TinaMor May 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 25 additions & 25 deletions containers-toolkit/Public/BuildkitTools.psm1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
###########################################################################
###########################################################################
# #
# Copyright (c) Microsoft Corporation. All rights reserved. #
# #
Expand All @@ -8,6 +8,7 @@


using module "..\Private\CommonToolUtilities.psm1"
using module "..\Private\logger.psm1"

$ModuleParentPath = Split-Path -Parent $PSScriptRoot
Import-Module -Name "$ModuleParentPath\Private\CommonToolUtilities.psm1" -Force
Expand Down Expand Up @@ -74,7 +75,7 @@ function Install-Buildkit {
# Check if tool already exists at specified location
if ($isInstalled) {
$errMsg = "Buildkit already exists at $InstallPath or the directory is not empty"
Write-Warning $errMsg
[Logger]::Warning($errMsg)

# Uninstall if tool exists at specified location. Requires user consent
try {
Expand All @@ -91,7 +92,7 @@ function Install-Buildkit {
}
$Version = $Version.TrimStart('v')

Write-Output "Downloading and installing Buildkit v$Version at $InstallPath"
[Logger]::Info("Downloading and installing Buildkit v$Version at $InstallPath")

# Download files
$downloadParams = @{
Expand Down Expand Up @@ -124,7 +125,7 @@ function Install-Buildkit {
}
Install-RequiredFeature @params

Write-Output "Successfully installed Buildkit v$Version at $InstallPath`n"
[Logger]::Info("Successfully installed Buildkit v$Version at $InstallPath`n")

# Register Buildkitd service
$showCommands = $true
Expand All @@ -135,13 +136,13 @@ function Install-Buildkit {
}
}
catch {
Write-Warning "Failed to registed and start Buildkitd service. $_"
[Logger]::Warning("Failed to registed and start Buildkitd service. $_")
}

if ($showCommands) {
$commands = (Get-command -Name '*buildkit*' | Where-Object { $_.Source -like 'Containers-Toolkit' -and $_.Name -ne 'Install-Buildkit' }).Name
$message = "Other useful Buildkit commands: $($commands -join ', ').`nTo learn more about each command, run Get-Help <command-name>, e.g., 'Get-Help `"*buildkit*`"' or 'Get-Help Register-BuildkitdService'`n"
Write-Information -MessageData $message -Tags "Instructions" -InformationAction Continue
[Logger]::Info($message)
}

# Show buildkit binaries help
Expand All @@ -150,7 +151,7 @@ function Install-Buildkit {
# Remove extension from executable
$commandName = $executable -replace ".exe", ""
$message = "For $commandName usage: run `"$executable -h`""
Write-Information -MessageData "$message`n" -Tags "Instructions" -InformationAction Continue
[Logger]::Info("$message`n")
}
}
else {
Expand Down Expand Up @@ -239,13 +240,13 @@ function Register-BuildkitdService {

# If buildkitd is not installed, terminate execution
if (!(Test-BuildkitdServiceExists -BuildkitPath $BuildkitPath)) {
Write-Error "Buildkitd executable not installed."
[Logger]::Error("Buildkitd executable not installed.")
return
}

# Check buildkitd service is already registered
if (Test-ServiceRegistered -Service 'Buildkitd') {
Write-Warning ( -join @("buildkitd service already registered. To re-register the service, "
[Logger]::Warning( -join @("buildkitd service already registered. To re-register the service, "
"stop the service by running 'Stop-Service buildkitd' or 'Stop-BuildkitdService', then "
"run 'buildkitd --unregister-service'. Wait for buildkitd service to be deregistered, "
"then re-reun this command."))
Expand All @@ -255,13 +256,13 @@ function Register-BuildkitdService {
if (!$force) {
if (!$ENV:PESTER) {
if (-not ($PSCmdlet.ShouldContinue('', "Are you sure you want to register buildkitd service?"))) {
Write-Error "buildkitd service registration cancelled."
[Logger]::Error("buildkitd service registration cancelled.")
return
}
}
}

Write-Output "Configuring buildkitd service"
[Logger]::Info("Configuring buildkitd service")

$buildkitdExecutable = "$BuildKitPath\bin\buildkitd.exe"
Add-MpPreference -ExclusionProcess $buildkitdExecutable
Expand All @@ -284,12 +285,11 @@ function Register-BuildkitdService {
}

if ($consent) {
Write-Warning "Containerd conf file not found at $cniConfPath. Buildkit service will be registered without Containerd cni configurations."
[Logger]::Warning("Containerd conf file not found at $cniConfPath. Buildkit service will be registered without Containerd cni configurations.")
$command = "buildkitd.exe --register-service --debug --containerd-worker=true --service-name buildkitd"
}
else {
Write-Error "Failed to register buildkit service. Containerd conf file not found at $cniConfPath.`n`t1. Ensure that the required CNI plugins are installed or you can install them using 'Install-WinCNIPlugin'.`n`t2. Create the file to resolve this issue .`n`t3. Rerun this command 'Register-BuildkitdService'"
Throw "Failed to register buildkit service. Containerd conf file not found at $cniConfPath."
[Logger]::Fatal("Failed to register buildkit service. Containerd conf file not found at $cniConfPath.`n`t1. Ensure that the required CNI plugins are installed or you can install them using 'Install-WinCNIPlugin'.`n`t2. Create the file to resolve this issue .`n`t3. Rerun this command 'Register-BuildkitdService'")
}
}

Expand All @@ -305,22 +305,22 @@ function Register-BuildkitdService {
}

Set-Service buildkitd -StartupType Automatic
Write-Output "Successfully registered Buildkitd service."
[Logger]::Info("Successfully registered Buildkitd service.")

$output = Invoke-ExecutableCommand -Executable 'sc.exe' -arguments 'config buildkitd depend=containerd'
if ($output.ExitCode -ne 0) {
Write-Error "Failed to set dependency for buildkitd on containerd. $($output.StandardOutput.ReadToEnd())"
[Logger]::Error("Failed to set dependency for buildkitd on containerd. $($output.StandardOutput.ReadToEnd())")
}

if ($Start) {
Start-BuildkitdService
Write-Output "Successfully started Buildkitd service."
[Logger]::Info("Successfully started Buildkitd service.")
}
else {
Write-Information -InformationAction Continue -MessageData "To start buildkitd service, run 'Start-Service buildkitd' or 'Start-BuildkitdService'"
[Logger]::Info("To start buildkitd service, run 'Start-Service buildkitd' or 'Start-BuildkitdService'")
}

Write-Debug $(Get-Service 'buildkitd' -ErrorAction SilentlyContinue | Format-Table -AutoSize | Out-String)
[Logger]::Debug($(Get-Service 'buildkitd' -ErrorAction SilentlyContinue | Format-Table -AutoSize | Out-String))

# YAGNI: Do we need a buildkitd.toml on Windows?
}
Expand Down Expand Up @@ -357,7 +357,7 @@ function Uninstall-Buildkit {
process {
if ($PSCmdlet.ShouldProcess($env:COMPUTERNAME, $WhatIfMessage)) {
if (Test-EmptyDirectory -Path $path) {
Write-Output "$tool does not exist at $Path or the directory is empty"
[Logger]::Info("$tool does not exist at $Path or the directory is empty")
return
}

Expand All @@ -370,7 +370,7 @@ function Uninstall-Buildkit {
Throw "$tool uninstallation cancelled."
}

Write-Warning "Uninstalling preinstalled $tool at the path $path"
[Logger]::Warning("Uninstalling preinstalled $tool at the path $path")
try {
Uninstall-BuildkitHelper -Path $path
}
Expand All @@ -393,7 +393,7 @@ function Uninstall-BuildkitHelper {
)

if (Test-EmptyDirectory -Path $Path) {
Write-Error "Buildkit does not exist at $Path or the directory is empty."
[Logger]::Error("Buildkit does not exist at $Path or the directory is empty.")
return
}

Expand All @@ -419,7 +419,7 @@ function Uninstall-BuildkitHelper {
# Remove from env path
Remove-FeatureFromPath -Feature "buildkit"

Write-Output "Successfully uninstalled buildkit."
[Logger]::Info("Successfully uninstalled buildkit.")
}


Expand Down Expand Up @@ -448,14 +448,14 @@ function Test-BuildkitdServiceExists($buildkitPath) {

function Unregister-Buildkitd($buildkitPath) {
if (!(Test-ServiceRegistered -Service 'buildkitd')) {
Write-Warning "Buildkitd service does not exist as an installed service."
[Logger]::Warning("Buildkitd service does not exist as an installed service.")
return
}

# Unregister buildkit service
$buildkitdExecutable = "$buildkitPath\bin\buildkitd.exe"

Write-Debug "Buildkitd path: $buildkitdExecutable "
[Logger]::Debug("Buildkitd path: $buildkitdExecutable ")
$output = Invoke-ExecutableCommand -Executable $buildkitdExecutable -Arguments "--unregister-service"
if ($output.ExitCode -ne 0) {
Throw "Could not unregister buildkitd service. $($output.StandardError.ReadToEnd())"
Expand Down