build.ps1

[CmdletBinding(SupportsShouldProcess=$true)]
param (
    [switch]$test,
    [switch]$SkipTestToolBuild,
    [switch]$BuildTestTool,
    [switch]$build,
    [switch]$publish,
    [switch]$signed,
    [switch]$package,
    [switch]$coverage,
    [switch]$CopySBOM
    )

$Name = "Microsoft.PowerShell.Crescendo"
$ModRoot = "${PSScriptRoot}/${Name}"
$SrcRoot = "${ModRoot}/src"
$TestRoot = "${ModRoot}/test"
$SampleRoot = "${ModRoot}/Samples"
$SchemaRoot = "${ModRoot}/Schemas"
$ManifestPath = "${SrcRoot}/${Name}.psd1"
$ExpRoot = "${SrcRoot}/Experimental/HelpParsers"
$ManifestData = Import-PowerShellDataFile -path $ManifestPath
$Version = ${ManifestData}.ModuleVersion
$PubBase  = "${PSScriptRoot}/out"
$PubRoot  = "${PubBase}/${Name}"
$SignRoot = "${PSScriptRoot}/signed/${Name}"
$SignVersion = "${SignRoot}/${Version}"
$PubDir   = "${PubRoot}/${Version}"
$PreRelease = ${ManifestData}.PrivateData.PSData.Prerelease

if (-not $test -and -not $build -and -not $publish -and -not $package -and -not $BuildTestTool) {
    throw "must use 'build', 'test', 'publish', 'package', 'BuildTestTool'"
}

[bool]$verboseValue = $PSBoundParameters['Verbose'].IsPresent ? $PSBoundParameters['Verbose'].ToBool() : $false

$FileManifest = @(
    @{ SRC = "${SampleRoot}"; NAME = "GetFileList.Crescendo.json"         ; SIGN = $false ; DEST = "OUTDIR/Samples" }
    @{ SRC = "${SampleRoot}"; NAME = "dd.Crescendo.json"                  ; SIGN = $false ; DEST = "OUTDIR/Samples" }
    @{ SRC = "${SampleRoot}"; NAME = "dockerRmImage.Crescendo.json"       ; SIGN = $false ; DEST = "OUTDIR/Samples" }
    @{ SRC = "${SampleRoot}"; NAME = "dockergetimage.Crescendo.json"      ; SIGN = $false ; DEST = "OUTDIR/Samples" }
    @{ SRC = "${SampleRoot}"; NAME = "dockergetps.Crescendo.json"         ; SIGN = $false ; DEST = "OUTDIR/Samples" }
    @{ SRC = "${SampleRoot}"; NAME = "dockerinspectimage.Crescendo.json"  ; SIGN = $false ; DEST = "OUTDIR/Samples" }
    @{ SRC = "${SampleRoot}"; NAME = "ifconfig.Crescendo.json"            ; SIGN = $false ; DEST = "OUTDIR/Samples" }
    @{ SRC = "${SampleRoot}"; NAME = "ls.Crescendo.json"                  ; SIGN = $false ; DEST = "OUTDIR/Samples" }
    @{ SRC = "${SampleRoot}"; NAME = "tar.Crescendo.json"                 ; SIGN = $false ; DEST = "OUTDIR/Samples" }
    @{ SRC = "${SampleRoot}"; NAME = "who.Crescendo.json"                 ; SIGN = $false ; DEST = "OUTDIR/Samples" }

    @{ SRC = "${ExpRoot}";    NAME = "Convert-DockerHelp.ps1"             ; SIGN = $true  ; DEST = "OUTDIR/Experimental/HelpParsers" }
    @{ SRC = "${ExpRoot}";    NAME = "Convert-KubectlHelp.ps1"            ; SIGN = $true  ; DEST = "OUTDIR/Experimental/HelpParsers" }
    @{ SRC = "${ExpRoot}";    NAME = "Convert-NetshHelp.ps1"              ; SIGN = $true  ; DEST = "OUTDIR/Experimental/HelpParsers" }
    @{ SRC = "${ExpRoot}";    NAME = "Convert-OpenFaasHelp.ps1"           ; SIGN = $true  ; DEST = "OUTDIR/Experimental/HelpParsers" }
    @{ SRC = "${ExpRoot}";    NAME = "Convert-WingetHelp.ps1"             ; SIGN = $true  ; DEST = "OUTDIR/Experimental/HelpParsers" }
    @{ SRC = "${ExpRoot}";    NAME = "README.md"                          ; SIGN = $false ; DEST = "OUTDIR/Experimental/HelpParsers" }
    @{ SRC = "${ExpRoot}";    NAME = "HelpConversion002.gif"              ; SIGN = $false ; DEST = "OUTDIR/Experimental/HelpParsers" }
    @{ SRC = "${ExpRoot}";    NAME = "HelpConversion002.mp4"              ; SIGN = $false ; DEST = "OUTDIR/Experimental/HelpParsers" }

    @{ SRC = "${SrcRoot}";    NAME = "${Name}.Types.ps1xml"               ; SIGN = $true  ; DEST = "OUTDIR" }
    @{ SRC = "${SrcRoot}";    NAME = "${Name}.Format.ps1xml"              ; SIGN = $true  ; DEST = "OUTDIR" }
    @{ SRC = "${SrcRoot}";    NAME = "${Name}.psd1"                       ; SIGN = $true  ; DEST = "OUTDIR" }
    @{ SRC = "${SrcRoot}";    NAME = "${Name}.psm1"                       ; SIGN = $true  ; DEST = "OUTDIR" }
    @{ SRC = "${SchemaRoot}"; NAME = "2021-11"                            ; SIGN = $false ; DEST = "OUTDIR/Schemas" }
    @{ SRC = "${SchemaRoot}"; NAME = "2022-06"                            ; SIGN = $false ; DEST = "OUTDIR/Schemas" }
)

if ($build) {
    Write-Verbose -Verbose -Message "No action for build"
}

# this takes the files for the module and publishes them to a created, local repository
# so the nupkg can be used to publish to the PSGallery
function Export-Module
{
    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingWriteHost", "")]
    param()
    if ( $signed ) {
        $packageRoot = $SignRoot
    }
    else {
        $packageRoot = $PubRoot
    }

    if ( -not (test-path $packageRoot)) {
        throw "'$packageRoot' does not exist"
    }
    # now constuct a nupkg by registering a local repository and calling publish module
    $repoName = [guid]::newGuid().ToString("N")
    Register-PSRepository -Name $repoName -SourceLocation ${packageRoot} -InstallationPolicy Trusted
    Publish-Module -Path $packageRoot -Repository $repoName
    Unregister-PSRepository -Name $repoName
    Get-ChildItem -Recurse -Name $packageRoot | Write-Verbose -Verbose
    if ($PreRelease) {
        $nupkgName = "{0}.{1}-{2}.nupkg" -f ${Name},${Version},${PreRelease}
    }
    else {
        $nupkgName = "{0}.{1}.nupkg" -f ${Name},${Version}
    }
    $nupkgPath = Join-Path $packageRoot $nupkgName
    if ($env:TF_BUILD) {
        # In Azure DevOps
        Write-Host "##vso[artifact.upload containerfolder=$nupkgName;artifactname=$nupkgName;]$nupkgPath"
    }
    else {
        Write-Verbose -Verbose "package path: $nupkgPath (exists:$(Test-Path $nupkgPath))"
    }
}

if ($publish) {
    Write-Verbose "Publishing to '$PubDir'"
    if (-not (test-path $PubDir)) {
        $null = New-Item -ItemType Directory $PubDir -Force
    }
    foreach ($file in $FileManifest) {
        if ($signed -and $file.SIGN) {
            $src = Join-Path -Path $PSScriptRoot -AdditionalChildPath $file.NAME -ChildPath signed
        }
        else {
            $src = Join-Path -Path $file.SRC -ChildPath $file.NAME
        }
        $targetDir = $file.DEST -creplace "OUTDIR","$PubDir"
        if (-not (Test-Path $src)) {
            throw ("file '" + $src + "' not found")
        }
        if (-not (Test-Path $targetDir)) {
            $null = New-Item -ItemType Directory $targetDir -Force
        }
        Copy-Item -Path $src -destination $targetDir -Verbose:$verboseValue


    }
}

# this copies the manifest before creating the module nupkg
# if -CopySBOM is used.
if ($package) {
    if($CopySBOM) {
        Copy-Item -Recurse -Path "signed/_manifest" -Destination $SignVersion
    }
    Export-Module
}

function Build-TestTool {
    # build the echo test executable
    if ($IsWindows) {
        $runtime = "win-x64"
    }
    elseif ($IsLinux) {
        $runtime = "linux-x64"
    }
    else {
        $runtime = "osx-x64"
    }
    $dotnetArgs = "publish",
        "${PSScriptRoot}/Microsoft.PowerShell.Crescendo/test/src/EchoTool/EchoTool.csproj",
        "--configuration",
        "Release",
        "--runtime",
        $runtime,
        "--self-contained",
        "--nologo",
        "--output",
        "${PSScriptRoot}/Microsoft.PowerShell.Crescendo/test"
    if (!$SkipTestToolBuild) {
        $dotnet = Find-DotNet
        & $dotnet $dotnetArgs
    }
}

# we have to find the proper dotnet as there may be multiple installations
# try really hard
function Find-DotNet {
    if ( $IsWindows ) {
        $dotnetDir = "AppData/Local/Microsoft/dotnet"
    }
    else {
        $dotnetDir = ".dotnet"
    }
    $env:PATH += "$([io.path]::PathSeparator)${HOME}/${dotnetDir}"
    $dotnets = Get-Command -all -name dotnet -CommandType Application
    [array]$dotnetLocations = $dotnets.Source
    foreach ( $dotnet in $dotnetLocations ) {
        if ( Test-Dotnet $dotnet ) {
            return $dotnet
        }
    }
    throw "Could not find proper dotnet"
}

function Install-DotNet {
    $installObtainUrl = "https://dotnet.microsoft.com/download/dotnet/scripts/v1"
    $reqVersion = Get-RequiredDotnetVersion
    if ( $IsWindows  ) {
        $installScript = "dotnet-install.ps1"
    }
    else {
        $installScript = "dotnet-install.sh"
    }
    Invoke-WebRequest -Uri $installObtainUrl/$installScript -OutFile $installScript
    if ( ! $IsWindows ) {
        chmod +x $installScript
    }
    & "./$installScript" -v $reqVersion -skipnonversionedfiles
}

function Get-RequiredDotnetVersion {
    $globalConfig = "global.json"
    $reqVersion = (Get-Content $globalConfig | ConvertFrom-Json).sdk.version
    $reqVersion
}

function Test-DotNet {
    param ( $dotnet = "dotnet" ) # default to the first one in the path
    if ( -not (Get-Command $dotnet -ea ignore)) {
        return $false
    }
    $reqVersion = Get-RequiredDotnetVersion
    $present = & $dotnet --list-sdks | Where-Object {$_ -match $reqVersion }
    @($present).Count -ne 0
}

if ($BuildTestTool) {
    if ( -not (Test-DotNet)) {
        Install-DotNet
    }
    Build-TestTool
}

if ($test) {
    Build-TestTool

    # run the tests, but we do this in a separate process
    $script = @"
    # be sure to not get pester 5
    if ( Get-Module Pester ) {
        Get-Module Pester | Where-Object { $_.Version -gt "4.9.9" } | Remove-Module
    }
    Import-Module -Force -Name Pester -MaximumVersion 4.99

    Import-Module -force "${PubRoot}"
    Push-Location "${TestRoot}"
    try {
        `$pesterArgs = @{ PassThru = `$true }
        if ( `$$coverage ) {
            `$pesterArgs['CodeCoverageOutputFile'] = "${PSScriptRoot}/CoverageOutput.xml"
            `$pesterArgs['CodeCoverage'] = "${PSScriptRoot}/out/Microsoft.PowerShell.Crescendo/${Version}/Microsoft.PowerShell.Crescendo.psm1"
        }
        `$result = Invoke-Pester @pesterArgs
        if (0 -ne `$result.FailedCount) {
            `$result.testresult.Where({`$_.result -eq "Failed"}).Foreach({Write-Error `$_.Name})
            throw ("{0} failed tests" -f `$result.FailedCount)
        }
    }
    finally {
        Pop-Location
    }
"@
    #$script
    $bytes = [System.Text.Encoding]::Unicode.GetBytes($script)
    $encodedCommand = [Convert]::ToBase64String($bytes)
    pwsh -noprofile -encodedCommand $encodedCommand
}