[Packaging] Improved script for creating Windows installers

This commit is contained in:
Alexandr Stelnykovych 2025-03-05 17:36:18 +02:00
parent df6e95dcd7
commit 93b9130a69

View file

@ -1,75 +1,174 @@
# Tested with docker image 'abrarov/msvc-2022:latest'
# sha256:f49435d194108cd56f173ad5bc6a27c70eed98b7e8cd54488f5acd85efbd51c9
# Run:
# Start powershell and cd to the root of the project. Then run:
# $path = Convert-Path . # Get the absolute path of the current directory
# docker run -it --rm -v "${path}:C:/app" -w "C:/app" abrarov/msvc-2022 powershell -NoProfile -File C:/app/packaging/windows/generate_windows_installer.ps1
# Running inside Docker container
#
# Note! Ensure you switched Docker Desktop to use Windows containers.
# Start powershell and cd to the root of the project.
# Then run:
# $path = Convert-Path . # Get the absolute path of the current directory
# docker run -it --rm -v "${path}:C:/app" -w "C:/app" abrarov/msvc-2022 powershell -NoProfile -File C:/app/packaging/windows/generate_windows_installers.ps1
# Optional arguments:
# -i, --interactive: Can prompt for user input (e.g. when a file is not found in the primary folder but found in the alternate folder)
param (
[Alias('i')]
[switch]$interactive
)
# Save the current directory
$originalDirectory = Get-Location
# <<<<<<<<<<<<<<<<<<<<<<< Functions <<<<<<<<<<<<<<<<<<<<<<<
# Function to copy a file, with fallback to an alternative location and detailed logging
# Parameters:
# $SourceDir - Primary directory to search for the file
# $File - Name of the file to copy
# $DestinationDir - Directory where the file will be copied to
# $AlternateSourceDir - Fallback directory if file is not found in $SourceDir
#
# Behavior:
# - Checks if the file exists in the primary source directory
# - If not found and an alternate directory is provided, checks there
# - In interactive mode, asks for confirmation before using the alternate source
# - Logs details about the copied file (path, size, timestamp, version)
# - Returns error and exits if file cannot be found or copied
function Find-And-Copy-File {
param (
[string]$SourceDir,
[string]$File,
[string]$DestinationDir,
[string]$AlternateSourceDir
)
$destinationPath = "$DestinationDir/$File"
$fullSourcePath = if ($SourceDir) { "$SourceDir/$File" } else { "" }
if ($AlternateSourceDir -and (-not $fullSourcePath -or -not (Test-Path -Path $fullSourcePath))) {
# File doesn't exist, check in alternate folder
$fallbackSourcePath = "$AlternateSourceDir/$File"
if (Test-Path -Path $fallbackSourcePath) {
if ($interactive -and $fullSourcePath) { # Do not prompt if the sourceDir is empty or "interactive" mode is not set
$response = Read-Host " [?] The file '$File' found only in fallback '$AlternateSourceDir' folder.`n Do you want to use it? (y/n)"
if ($response -ne 'y' -and $response -ne 'Y') {
Write-Error "Cancelled. Required file not found: $fullSourcePath"
exit 1
}
}
$fullSourcePath = $fallbackSourcePath
} else {
Write-Error "Required file '$File' not found in: '$SourceDir', '$AlternateSourceDir'"
exit 1
}
}
try {
# Print details about the file
$fileInfo = Get-Item -Path $fullSourcePath
$output = "{0,-22}: {1,-28} -> {2,-38} [{3,-20} {4,18}{5}]" -f
$File,
$(Split-Path -Path $fullSourcePath -Parent),
$(Split-Path -Path $destinationPath -Parent),
"$($fileInfo.LastAccessTime.ToString("yyyy-MM-dd HH:mm:ss"));",
"$($fileInfo.Length) bytes",
$(if ($fileInfo.VersionInfo.FileVersion) { "; v$($fileInfo.VersionInfo.FileVersion)" } else { "" })
Write-Output "$output"
# Create destination directory if not exists
if (-not (Test-Path -Path $DestinationDir)) {
New-Item -ItemType Directory -Path $DestinationDir -ErrorAction Stop > $null
}
# Copy the file
Copy-Item -Force -Path "${fullSourcePath}" -Destination "${destinationPath}" -ErrorAction Stop
} catch {
Write-Error "Failed to copy file from '$fullSourcePath' to '$destinationPath'.`nError: $_"
exit 1
}
}
# >>>>>>>>>>>>>>>>>>>>>>> End Functions >>>>>>>>>>>>>>>>>>>>>>>>
# CONSTANTS
$destinationDir = "desktop/tauri/src-tauri"
$binaryDir = "$destinationDir/binary"
$intelDir = "$destinationDir/intel"
$targetDir = "$destinationDir/target/release"
$binaryDir = "$destinationDir/binary" #portmaster\desktop\tauri\src-tauri\binary
$intelDir = "$destinationDir/intel" #portmaster\desktop\tauri\src-tauri\intel
$targetDir = "$destinationDir/target/release" #portmaster\desktop\tauri\src-tauri\target\release
# Make sure binary folder exists.
if (-not (Test-Path -Path $binaryDir)) {
New-Item -ItemType Directory -Path $binaryDir > $null
# Copying BINARY FILES
Write-Output "`n[+] Copying binary files:"
$filesToCopy = @(
@{Folder=""; File="portmaster-kext.sys"; Destination=$binaryDir; AlternateFolder="dist/download/windows_amd64"},
@{Folder="dist/binary/windows_amd64"; File="portmaster-core.dll"; Destination=$binaryDir; AlternateFolder="dist/download/windows_amd64"},
@{Folder="dist/binary/windows_amd64"; File="portmaster-core.exe"; Destination=$binaryDir},
@{Folder="dist/binary/windows_amd64"; File="WebView2Loader.dll"; Destination=$binaryDir},
@{Folder="dist/binary/all"; File="portmaster.zip"; Destination=$binaryDir},
@{Folder="dist/binary/all"; File="assets.zip"; Destination=$binaryDir},
@{Folder="dist/binary"; File="index.json"; Destination=$binaryDir},
@{Folder="dist/binary/windows_amd64"; File="portmaster.exe"; Destination=$targetDir}
)
foreach ($file in $filesToCopy) {
Find-And-Copy-File -SourceDir $file.Folder -File $file.File -DestinationDir $file.Destination -AlternateSourceDir $file.AlternateFolder
}
Write-Output "Copying binary files"
Copy-Item -Force -Path "dist/download/windows_amd64/portmaster-kext.sys" -Destination "$binaryDir/portmaster-kext.sys"
Copy-Item -Force -Path "dist/download/windows_amd64/portmaster-core.dll" -Destination "$binaryDir/portmaster-core.dll"
Copy-Item -Force -Path "dist/binary/windows_amd64/portmaster-core.exe" -Destination "$binaryDir/portmaster-core.exe"
Copy-Item -Force -Path "dist/binary/windows_amd64/WebView2Loader.dll" -Destination "$binaryDir/WebView2Loader.dll"
Copy-Item -Force -Path "dist/binary/all/portmaster.zip" -Destination "$binaryDir/portmaster.zip"
Copy-Item -Force -Path "dist/binary/all/assets.zip" -Destination "$binaryDir/assets.zip"
Copy-Item -Force -Path "dist/binary/index.json" -Destination "$binaryDir/index.json"
# Make sure target folder exists.
if (-not (Test-Path -Path $targetDir)) {
New-Item -ItemType Directory -Path $targetDir > $null
}
Copy-Item -Force -Path "dist/binary/windows_amd64/portmaster.exe" -Destination "$targetDir/portmaster.exe"
# Make sure intel folder exists.
# Copying INTEL FILES
Write-Output "`n[+] Copying intel files"
if (-not (Test-Path -Path $intelDir)) {
New-Item -ItemType Directory -Path $intelDir > $null
New-Item -ItemType Directory -Path $intelDir -ErrorAction Stop > $null
}
Write-Output "Copying intel files"
Copy-Item -Force -Path "dist/intel/*" -Destination "$intelDir/"
Copy-Item -Force -Path "dist/intel/*" -Destination "$intelDir/" -ErrorAction Stop
Set-Location $destinationDir
try {
# Ensure Rust toolchain is installed
if (-not (Get-Command cargo -ErrorAction SilentlyContinue)) {
Write-Output "[+] Installing rust toolchain..."
Start-BitsTransfer -Source "https://win.rustup.rs/x86_64" -Destination "rustup.exe"
./rustup.exe install --no-self-update stable
$env:PATH += ";C:\Users\ContainerAdministrator\.rustup\toolchains\stable-x86_64-pc-windows-msvc\bin\"
}
if (-not (Get-Command cargo -ErrorAction SilentlyContinue)) {
Write-Output "Installing rust toolchain..."
Invoke-WebRequest -Uri https://win.rustup.rs/x86_64 -OutFile rustup.exe
./rustup.exe install stable
$env:PATH += ";C:\Users\ContainerAdministrator\.rustup\toolchains\stable-x86_64-pc-windows-msvc\bin\"
} else {
Write-Output "'cargo' command is already available"
# Ensure Tauri CLI is available
$cargoTauriCommand = "cargo-tauri.exe"
if (-not (Get-Command $cargoTauriCommand -ErrorAction SilentlyContinue)) {
if (-not (Test-Path "./tauri-cli/cargo-tauri.exe")) {
Write-Output "[+] Tauri CLI not found. Downloading tauri-cli"
Start-BitsTransfer -Source "https://github.com/tauri-apps/tauri/releases/download/tauri-cli-v2.2.7/cargo-tauri-x86_64-pc-windows-msvc.zip" -Destination "tauri-cli.zip"
Expand-Archive -Force tauri-cli.zip
}
if (-not (Test-Path "./tauri-cli/cargo-tauri.exe")) {
Write-Error "Tauri CLI not found. Download failed."
exit 1
}
$cargoTauriCommand = "./tauri-cli/cargo-tauri.exe"
}
Write-Output "[i] VERSIONS INFO:"
Write-Output " Tauri CLI: $((& $cargoTauriCommand -V | Out-String).Trim().Replace("`r`n", " "))"
Write-Output " Rust : $((rustc -V | Out-String).Trim().Replace("`r`n", " ")); $((cargo -V | Out-String).Trim().Replace("`r`n", " "))"
Write-Output ""
# Building Tauri app bundle
Write-Output "[+] Building Tauri app bundle"
& $cargoTauriCommand bundle
if ($LASTEXITCODE -ne 0) {
Write-Error "Tauri bundle command failed with exit code $LASTEXITCODE"
exit 1
}
Write-Output "[+] Copying generated bundles"
$installerDist = "..\..\..\dist\windows_amd64\"
if (-not (Test-Path -Path $installerDist)) {
New-Item -ItemType Directory -Path $installerDist -ErrorAction Stop > $null
}
Copy-Item -Path ".\target\release\bundle\msi\*" -Destination $installerDist -ErrorAction Stop
Copy-Item -Path ".\target\release\bundle\nsis\*" -Destination $installerDist -ErrorAction Stop
Write-Output "[i] Done."
Write-Output " Installer files are available in: $(Resolve-Path $installerDist)"
} catch {
Write-Error "[!] Failed! Error: $_"
exit 1
}
Write-Output "Downloading tauri-cli"
Invoke-WebRequest -Uri https://github.com/tauri-apps/tauri/releases/download/tauri-cli-v2.2.7/cargo-tauri-x86_64-pc-windows-msvc.zip -OutFile tauri-cli.zip
Expand-Archive -Force tauri-cli.zip
./tauri-cli/cargo-tauri.exe bundle
Write-Output "Copying generated bundles"
$installerDist = "..\..\..\dist\windows_amd64\"
# Make sure distination folder exists.
if (-not (Test-Path -Path $installerDist)) {
New-Item -ItemType Directory -Path $installerDist > $null
}
Copy-Item -Path ".\target\release\bundle\msi\*" -Destination $installerDist
Copy-Item -Path ".\target\release\bundle\nsis\*" -Destination $installerDist
# Restore the original directory
Set-Location $originalDirectory
finally {
# Restore the original directory if not already done
Set-Location $originalDirectory
}