build.ps1

#!/usr/bin/env pwsh

# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
using module ./helpers.build.psm1

<#
    .SYNOPSIS
    DSC project build script

    .DESCRIPTION

    .PARAMETER Release
    Determines whether to compile the Rust projects with the release profile. The release profile
    uses significant optimizations for runtime size and speed but compiles much more slowly.

    .PARAMETER Architecture
    Determines which platform architecture to compile for. The default architecture is `current`,
    meaning the current operating system. You can specify an alternate architecture to compile for,
    as Rust supports cross-compilation.

    Valid values are:

    - `current` (default) - The platform matching the current operating system.
    - `aarch64-pc-windows-msvc` - Windows on ARM with MSVC build chain.
    - `x86_64-pc-windows-msvc` - Windows on x86 with MSVC build chain.
    - `aarch64-apple-darwin` - macOS on ARM.
    - `x86_64-apple-darwin` - macOS on x86.
    - `aarch64-unknown-linux-gnu` - Linux on ARM with the glibc build chain.
    - `aarch64-unknown-linux-musl` - Linux on ARM with the musl build chain.
    - `x86_64-unknown-linux-gnu` - Linux on x86 with the glibc build chain.
    - `x86_64-unknown-linux-musl` - Linux on x86 with the musl build chain.

    When packaging, you _must_ specify a specific architecture.

    .PARAMETER Clippy
    Determines whether to lint the Rust projects with Clippy. When you specify this parameter, the
    build script lints the Rust projects before building them. Unlike the legacy script, it still
    produces build artifacts unless a crate fails the linting.

    .PARAMETER SkipBuild
    Determines whether to skip building the project.

    .PARAMETER Test
    Determines whether to run Rust and Pester tests for the project.

    .PARAMETER CodeCoverage
    Enables code coverage instrumentation using cargo-llvm-cov. When specified, the build and
    tests run with coverage instrumentation enabled and an LCOV report is generated at the path
    specified by `-CodeCoverageOutputPath` (defaults to `lcov.info` in the repository root).
    Installs cargo-llvm-cov and the llvm-tools-preview rustup component automatically if not present.

    When `-CodeCoverageBaseSha` and `-CodeCoverageHeadSha` are provided, the script first checks
    whether any `.rs` files were changed between those commits. If no Rust files were changed,
    coverage is skipped entirely and the script exits early.

    .PARAMETER CodeCoverageOutputPath
    Specifies the output path for the LCOV code coverage report. Only used when `-CodeCoverage`
    is specified. Defaults to `lcov.info` in the repository root.

    .PARAMETER CodeCoverageBaseSha
    The base commit SHA to compare against when detecting changed Rust files. When specified
    along with `-CodeCoverageHeadSha`, coverage is skipped if no `.rs` files were modified.

    .PARAMETER CodeCoverageHeadSha
    The head commit SHA to compare when detecting changed Rust files. When specified along with
    `-CodeCoverageBaseSha`, coverage is skipped if no `.rs` files were modified.

    .PARAMETER CodeCoverageShowFiles
    When specified, displays a file-by-file coverage breakdown sorted by coverage percentage
    (lowest first) after the summary. Use with `-CodeCoverage`.

    .PARAMETER CodeCoverageShowUncoveredLines
    When specified, displays the actual uncovered source lines for files below the threshold
    set by `-CodeCoverageUncoveredThreshold`. Implies file-level display. Use with `-CodeCoverage`.

    .PARAMETER CodeCoverageUncoveredThreshold
    Files with coverage at or below this percentage will have uncovered lines shown when
    `-CodeCoverageShowUncoveredLines` is specified. Defaults to 80.

    .PARAMETER CodeCoverageTopFiles
    Limits the file-by-file display to the N files with the lowest coverage. Defaults to 0
    (show all files). Use with `-CodeCoverageShowFiles` or `-CodeCoverageShowUncoveredLines`.

    .PARAMETER GetPackageVersion
    Short circuits the build to return the current version of the DSC CLI crate.

    .PARAMETER PackageType
    Determines which package type to create. Must specify a single package type at a time. Valid
    package types are:

    - `msix` - MSIX package, requires a specific architecture.
    - `msix-private` - MSIX private package, requires a specific architecture.
    - `msixbundle` - MSIX bundle package, builds for both Windows targets.
    - `tgz` - Packages the project as a `.tar.gz` file, only for Linux/macOS.
    - `deb` - Packages the project as a `.deb` file, only for Linux.
    - `rpm` - Packages the project as a `.rpm` file, only for Linux.
    - `zip` - Packages the project as a `.zip` file, only for Windows.
#>
[CmdletBinding()]
param(
    [switch]$Release,
    [ValidateSet(
        'current',
        'aarch64-pc-windows-msvc',
        'x86_64-pc-windows-msvc',
        'aarch64-apple-darwin',
        'x86_64-apple-darwin',
        'aarch64-unknown-linux-gnu',
        'aarch64-unknown-linux-musl',
        'x86_64-unknown-linux-gnu',
        'x86_64-unknown-linux-musl'
    )]
    $Architecture = 'current',
    [switch]$Clippy,
    [switch]$SkipBuild,
    [ValidateSet(
        'deb',
        'msix',
        'msix-private',
        'msixbundle',
        'rpm',
        'tgz',
        'zip'
    )]
    $PackageType,
    [switch]$Test,
    [switch]$CodeCoverage,
    [string]$CodeCoverageOutputPath = (Join-Path $PSScriptRoot 'lcov.info'),
    [string]$CodeCoverageBaseSha,
    [string]$CodeCoverageHeadSha,
    [switch]$CodeCoverageShowFiles,
    [switch]$CodeCoverageShowUncoveredLines,
    [int]$CodeCoverageUncoveredThreshold = 80,
    [int]$CodeCoverageTopFiles = 0,
    [string[]]$Project,
    [switch]$ExcludeRustTests,
    [string]$RustTestFilter,
    [switch]$ExcludePesterTests,
    [ValidateSet("dsc", "adapters", "extensions", "grammars", "resources")]
    [string[]]$PesterTestGroup,
    [switch]$GetPackageVersion,
    [switch]$SkipLinkCheck,
    [switch]$UseX64MakeAppx,
    [switch]$UseCFS,
    [switch]$UpdateLockFile,
    [switch]$Audit,
    [switch]$Clean,
    [switch]$CacheRustBuild,
    [switch]$RustDocs,
    [switch]$Quiet
)

begin {
    if ($Quiet) {
        $VerbosePreference = 'SilentlyContinue'
        $InformationPreference = 'SilentlyContinue'
        $ProgressPreference = 'Continue'
    } else {
        $InformationPreference = 'Continue'
        $ProgressPreference = 'SilentlyContinue'
    }

    $progressParams = @{
        Activity = "Executing build script"
        Quiet    = $Quiet
    }

    Import-Module ./helpers.build.psm1 -Force -Verbose:$false
    $usingADO = ($null -ne $env:TF_BUILD)
    if ($usingADO) {
        $UseCFS = $true
    }
    # Import the build data
    $BuildData = Import-DscBuildData -RefreshProjects
    # Filter projects if needed.
    if ($Project.Count -ge 1) {
        $BuildData.Projects = $BuildData.Projects | Where-Object -FilterScript {
            $_.Name -in $Project
        }
    }
    $VerboseParam = @{}
    if ($VerbosePreference -eq 'Continue' -and -not $Quiet) {
        $VerboseParam.Verbose = $true
    }

    function Write-BuildProgress {
        [cmdletbinding()]
        param(
            [string]$Activity,
            [string]$Status,
            [switch]$Completed,
            [switch]$Quiet
        )

        process {
            if ($Quiet) {
                $params = [hashtable]$PSBoundParameters
                $params.Remove('Quiet') > $null
                Write-Progress @params
            } elseif ($Completed) {
                Write-Host "Finished build script" -ForegroundColor Green
            } else {
                $message = "BUILD:   $Activity"
                if (-not [string]::IsNullOrEmpty($Status)) {
                    $message += "::$Status"
                }
                Write-Host $message -ForegroundColor Cyan
            }
        }
    }
}

process {
    trap {
        Write-Error "An error occurred: $($_ | Out-String)"
        exit 1
    }

    if ($GetPackageVersion) {
        return Get-DscCliVersion @VerboseParam
    }
    Write-BuildProgress @progressParams

    #region    Setup
    $progressParams.Activity = 'Performing setup steps'
    Write-BuildProgress @progressParams
    Write-BuildProgress @progressParams -Status "Determining rustup info"
    $rustup, $channel = Get-RustUp @VerboseParam

    if ($null -ne $PackageType) {
        $SkipBuild = $true
    } else {
        Write-BuildProgress @progressParams -Status 'Configuring Rust environment'
        [hashtable]$priorRustEnvironment = Set-RustEnvironment -CacheRustBuild:$CacheRustBuild @VerboseParam
        Write-BuildProgress @progressParams -Status 'Configuring Cargo environment'
        Set-CargoEnvironment -UseCFS:$UseCFS @VerboseParam

        # Install or update rust
        if (!$usingADO) {
            Write-BuildProgress @progressParams -Status 'Ensuring Rust is up-to-date'
            Update-Rust @VerboseParam
        }

        if ($Clippy) {
            Write-BuildProgress @progressParams -Status 'Ensuring Clippy is available and updated'
            Install-Clippy -UseCFS:$UseCFS -Architecture $Architecture @VerboseParam
        }

        if (!$SkipBuild -and !$SkipLinkCheck -and $IsWindows) {
            Write-BuildProgress @progressParams -Status "Ensuring Windows C++ build tools are available"
            Install-WindowsCPlusPlusBuildTools @VerboseParam
        }

        if (-not ($SkipBuild -and $Test -and $ExcludeRustTests)) {
            Write-BuildProgress @progressParams -Status 'Ensuring Protobuf is available'
            Install-Protobuf @VerboseParam

            Write-BuildProgress @progressParams -Status 'Ensuring Node.JS is available'
            Install-NodeJS @VerboseParam

            Write-BuildProgress @progressParams -Status 'Ensuring tree-sitter is available'
            Install-TreeSitter -UseCFS:$UseCFS @VerboseParam
        }
    }

    #endregion Setup

    #region    Code coverage instrumentation
    if ($CodeCoverage) {
        # Code coverage requires tests to run
        $Test = $true
        $progressParams.Activity = 'Setting up code coverage'
        Write-BuildProgress @progressParams

        if ($CodeCoverageBaseSha -and $CodeCoverageHeadSha) {
            Write-BuildProgress @progressParams -Status 'Checking for changed Rust files'
            $changedRustFiles = Get-ChangedRustFile -BaseSha $CodeCoverageBaseSha -HeadSha $CodeCoverageHeadSha @VerboseParam
            if ($changedRustFiles.Count -eq 0) {
                Write-Warning 'No Rust files changed between the specified commits. Skipping code coverage.'
                return
            }
        }

        Write-BuildProgress @progressParams -Status 'Configuring cargo-llvm-cov environment'
        Remove-Item $CodeCoverageOutputPath -Force -ErrorAction Ignore
        Initialize-CodeCoverage -UseCFS:$UseCFS @VerboseParam

        Write-BuildProgress @progressParams -Status 'Setting llvm-cov environment variables'
        $priorLlvmCovEnv = Set-LlvmCovEnvironment @VerboseParam
    }
    #endregion Code coverage instrumentation

    if (!$SkipBuild) {
        if ($UpdateLockFile) {
            $lockFile = Join-Path $PSScriptRoot "Cargo.lock"
            Remove-Item $lockFile -Force
        }

        $progressParams.Activity = 'Building the projects'
        Write-BuildProgress @progressParams
        Write-BuildProgress @progressParams -Status 'Generating grammar bindings'
        Export-GrammarBinding -Project $BuildData.Projects @VerboseParam

        if ($RustDocs) {
            $progressParams.Activity = 'Generating Rust documentation'
            Write-BuildProgress @progressParams

            $docsParams = @{
                Project      = $BuildData.Projects
                Architecture = $Architecture
                Release      = $Release
            }
            Export-RustDocs @docsParams @VerboseParam
        } else {
            $buildParams = @{
                Project      = $BuildData.Projects
                Architecture = $Architecture
                Release      = $Release
                Clean        = $Clean
            }
            Write-BuildProgress @progressParams -Status 'Compiling Rust'
            Build-RustProject @buildParams -Audit:$Audit -Clippy:$Clippy @VerboseParam
            Write-BuildProgress @progressParams -Status "Copying build artifacts"
            Copy-BuildArtifact @buildParams -ExecutableFile $BuildData.PackageFiles.Executable @VerboseParam
        }
    }

    # Ensure PATH includes the output artifacts after building and before testing.
    if ((!$Clippy -and !$SkipBuild) -or $Test) {
        $progressParams.Activity = 'Updating environment variables'
        Write-BuildProgress @progressParams
        Update-PathEnvironment -Architecture $Architecture -Release:$Release @VerboseParam
    }

    if ($Test) {
        $progressParams.Activity = 'Testing projects'
        Write-BuildProgress @progressParams

        if (-not $ExcludeRustTests) {
            $rustTestParams = @{
                Project      = $BuildData.Projects
                Architecture = $Architecture
                Release      = $Release
            }
            if (-not [string]::IsNullOrEmpty($RustTestFilter)) {
                $rustTestParams.TestFilter = $RustTestFilter
            }
            Write-BuildProgress @progressParams -Status "Testing Rust projects"
            Test-RustProject @rustTestParams @VerboseParam
        }
        if ($RustDocs) {
            $docTestParams = @{
                Project      = $BuildData.Projects
                Architecture = $Architecture
                Release      = $Release
                Docs         = $true
            }
            Write-BuildProgress @progressParams -Status "Testing documentation for Rust projects"
            Test-RustProject @docTestParams @VerboseParam
        }
        if (-not $ExcludePesterTests) {
            $installParams = @{
                UsingADO = $usingADO
            }
            $pesterParams = @{
                UsingADO = $usingADO
            }
            if ($null -ne $PesterTestGroup) {
                $pesterParams.Group = $PesterTestGroup
            }
            Write-BuildProgress @progressParams -Status "Installing PowerShell test prerequisites"
            Install-PowerShellTestPrerequisite @installParams @VerboseParam
            Write-BuildProgress @progressParams -Status "Invoking pester"
            Test-ProjectWithPester @pesterParams @VerboseParam
        }
    }

    #region    Code coverage report
    if ($CodeCoverage) {
        $progressParams.Activity = 'Generating code coverage report'
        Write-BuildProgress @progressParams
        Write-BuildProgress @progressParams -Status "Writing LCOV report to $CodeCoverageOutputPath"
        Export-CodeCoverageReport -OutputPath $CodeCoverageOutputPath @VerboseParam

        Write-BuildProgress @progressParams -Status 'Restoring environment variables'
        Reset-LlvmCovEnvironment -PriorValues $priorLlvmCovEnv @VerboseParam

        # Full codebase coverage summary
        $progressParams.Activity = 'Analyzing code coverage'
        Write-BuildProgress @progressParams -Status 'Computing full codebase coverage'
        $fullReport = Get-FullCodeCoverageReport -LcovPath $CodeCoverageOutputPath @VerboseParam
        Write-Host ""
        Write-Host "$($PSStyle.Bold)Full Codebase Coverage: $($fullReport.Percentage)% ($($fullReport.Label))$($PSStyle.BoldOff)"
        Write-Host "  Total executable lines: $($fullReport.TotalLines) | Lines covered: $($fullReport.CoveredLines)"

        # File-by-file breakdown and line-level detail
        if ($CodeCoverageShowFiles -or $CodeCoverageShowUncoveredLines) {
            $showParams = @{
                LcovPath = $CodeCoverageOutputPath
            }
            if ($CodeCoverageShowUncoveredLines) {
                $showParams.ShowUncoveredLines = $true
                $showParams.UncoveredThreshold = $CodeCoverageUncoveredThreshold
            }
            if ($CodeCoverageTopFiles -gt 0) {
                $showParams.Top = $CodeCoverageTopFiles
            }
            Show-FullCodeCoverageReport @showParams
        }

        # Determine base and head SHAs for changed-code analysis
        $baseSha = $CodeCoverageBaseSha
        $headSha = $CodeCoverageHeadSha

        if (-not $baseSha -or -not $headSha) {
            # Try to discover from current branch vs its upstream/default
            $currentBranch = git rev-parse --abbrev-ref HEAD 2>$null
            $defaultBranch = git rev-parse --abbrev-ref origin/HEAD 2>$null
            if (-not $defaultBranch) {
                $defaultBranch = 'origin/main'
            }
            $discoveredBase = git merge-base $defaultBranch $currentBranch 2>$null
            $discoveredHead = git rev-parse HEAD 2>$null

            if ($discoveredBase -and $discoveredHead -and $discoveredBase -ne $discoveredHead) {
                $baseSha = $discoveredBase
                $headSha = $discoveredHead
                Write-Verbose -Verbose "Discovered coverage comparison: $baseSha...$headSha"
            }
        }

        if ($baseSha -and $headSha) {
            Write-BuildProgress @progressParams -Status 'Analyzing changed code coverage'
            $report = Get-CodeCoverageReport -LcovPath $CodeCoverageOutputPath -BaseSha $baseSha -HeadSha $headSha @VerboseParam
            Write-Host ""
            Write-Host "$($PSStyle.Bold)Changed Code Coverage: $($report.Percentage)% ($($report.Label))$($PSStyle.BoldOff)"
            Write-Host "  Changed lines analyzed: $($report.TotalLines) | Lines covered: $($report.CoveredLines)"
        } else {
            Write-Host ""
            Write-Host "No base branch detected for changed-code analysis. Showing full report only."
            Write-Host "Use -CodeCoverageBaseSha and -CodeCoverageHeadSha for changed-code coverage."
        }

        Write-Host ""
        Write-Host "LCOV report: $CodeCoverageOutputPath"
    }
    #endregion Code coverage report

    if (-not [string]::IsNullOrEmpty($PackageType)) {
        $progressParams.Activity = "Packaging"
        $packageParams = @{
            BuildData      = $BuildData
            PackageType    = $PackageType
            Architecture   = $Architecture
            Release        = $Release
            UseX64MakeAppx = $UseX64MakeAppx
        }
        Write-BuildProgress @progressParams
        Build-DscPackage @packageParams @VerboseParam
    }
}

clean {
    $progressParams.Activity = 'Cleaning up'
    Write-BuildProgress @progressParams

    if ($null -ne $priorRustEnvironment) {
        Write-BuildProgress @progressParams -Status "Restoring rust environment"
        Reset-RustEnvironment -PriorEnvironment $priorRustEnvironment @VerboseParam
    }

    Write-BuildProgress -Completed
}