Archive module preview 1 PR

.azdevops/CI.yml

@@ -27,51 +27,52 @@ stages:
     displayName: Build module
     steps:
 
+    - task: UseDotNet@2
+      displayName: 'Get .NET 7.0 SDK'
+      inputs:
+        packageType: sdk
+        version: 7.x
+        includePreviewVersions: true
+
     - pwsh: |
         & $(Build.SourcesDirectory)\SimpleBuild.ps1
       displayName: Build Microsoft.PowerShell.Archive module
-      condition: succeededOrFailed()
-
+
     - pwsh: |
-        dir "$(BuildOutDir)\*" -Recurse
+        dir "$(BuildOutDir)/*" -Recurse
       displayName: Show BuildOutDirectory
 
-    - template: Sbom.yml@ComplianceRepo
-      parameters:
-        BuildDropPath: "$(BuildOutDir)"
-        Build_Repository_Uri: 'https://github.com/PowerShell/Microsoft.PowerShell.Archive'
-        PackageName: $(PackageName)
-        PackageVersion: $(PackageVersion)
+    - task: CopyFiles@2
+      displayName: 'Copy build'
+      inputs:
+        sourceFolder: '$(BuildOutDir)'
+        contents: '**'
+        targetFolder: '$(Build.ArtifactStagingDirectory)/Microsoft.PowerShell.Archive'
 
     - pwsh: |
-        dir "$(BuildOutDir)\*" -Recurse
-      displayName: Show BuildOutDirectory
+        dir "$(Build.ArtifactStagingDirectory)/*" -Recurse
+    - publish: '$(Build.ArtifactStagingDirectory)/Microsoft.PowerShell.Archive'
+      displayName: 'Publish module build'
+      artifact: ModuleBuild
 
-    - pwsh: |
-        $signSrcPath = "$(BuildOutDir)"
-        # Set signing src path variable
-        $vstsCommandString = "vso[task.setvariable variable=signSrcPath]${signSrcPath}"
-        Write-Host "sending " + $vstsCommandString
-        Write-Host "##$vstsCommandString"
-        $signOutPath = "$(Build.SourcesDirectory)\signed\Microsoft.PowerShell.Archive"
-        $null = New-Item -ItemType Directory -Path $signOutPath
-        # Set signing out path variable
-        $vstsCommandString = "vso[task.setvariable variable=signOutPath]${signOutPath}"
-        Write-Host "sending " + $vstsCommandString
-        Write-Host "##$vstsCommandString"
-        # Set path variable for guardian codesign validation
-        $vstsCommandString = "vso[task.setvariable variable=GDN_CODESIGN_TARGETDIRECTORY]${signOutPath}"
-        Write-Host "sending " + $vstsCommandString
-        Write-Host "##$vstsCommandString"
-      displayName: Setup variables for signing
-
-    - pwsh: |
-        Copy-Item -Path "$(signSrcPath)\*" -Destination "$(signOutPath)"
-      displayName: Fake Signing
-
-    - pwsh: |
-        Compress-Archive -Path "$(signOutPath)\*" -DestinationPath "$(System.ArtifactsDirectory)\Microsoft.PowerShell.Archive.zip"
-      displayName: Create Microsoft.PowerShell.Archive.zip
+- stage: Test
+  dependsOn: Build
+  displayName: Run tests
+  jobs:
+    - template: runtest.yml
+      parameters:
+        vmImageName: windows-2019
+        jobName: run_test_windows
+        jobDisplayName: Run Windows tests
 
-    - publish: $(System.ArtifactsDirectory)\Microsoft.PowerShell.Archive.zip
-      artifact: SignedModule
+    - template: runtest.yml
+      parameters:
+        vmImageName: ubuntu-latest
+        jobName: run_test_linux
+        jobDisplayName: Run Linux tests
+
+    - template: runtest.yml
+      parameters:
+        vmImageName: macos-latest
+        jobName: run_test_macos
+        jobDisplayName: Run macOS tests

.azdevops/RunTests.ps1

@@ -0,0 +1,47 @@
+# Load the module
+$module = Get-Module -Name "Microsoft.PowerShell.Archive"
+if ($null -ne $module)
+{
+    Remove-Module $module
+}
+
+# Import the built module
+Import-Module "$env:PIPELINE_WORKSPACE/ModuleBuild/Microsoft.PowerShell.Archive.psd1"
+
+$pesterRequiredVersion = "5.3.3"
+
+# If Pester 5.3.3 is not installed, install it
+$shouldInstallPester = $true
+
+if ($pesterModules = Get-Module -Name "Pester" -ListAvailable) {
+    foreach ($module in $pesterModules) {
+        if ($module.Version.ToString() -eq $pesterRequiredVersion) {
+            $shouldInstallPester = $false
+            break
+        }
+    }
+}
+
+if ($shouldInstallPester) {
+    Install-Module -Name "Pester" -RequiredVersion $pesterRequiredVersion -Force
+}
+
+# Load Pester
+Import-Module -Name "Pester" -RequiredVersion $pesterRequiredVersion
+
+# Run tests
+$OutputFile = "$PWD/build-unit-tests.xml"
+$results = $null
+$results = Invoke-Pester -Script ./Tests/Compress-Archive.Tests.ps1 -OutputFile $OutputFile -PassThru -OutputFormat NUnitXml -Show Failed, Context, Describe, Fails
+Write-Host "##vso[artifact.upload containerfolder=testResults;artifactname=testResults]$OutputFile"
+if(!$results -or $results.FailedCount -gt 0 -or !$results.TotalCount)
+{
+    throw "Build or tests failed.  Passed: $($results.PassedCount) Failed: $($results.FailedCount) Total: $($results.TotalCount)"
+}
+
+# Unload module
+$module = Get-Module -Name "Microsoft.PowerShell.Archive"
+if ($null -ne $module)
+{
+    Remove-Module $module
+}

.azdevops/build.ps1

@@ -0,0 +1,105 @@
+[CmdletBinding(SupportsShouldProcess=$true)]
+param (
+    [switch]$test,
+    [switch]$build,
+    [switch]$publish,
+    [switch]$signed,
+    [switch]$package,
+    [switch]$coverage,
+    [switch]$CopySBOM,
+    [string]$SignedPath
+    )
+
+
+$root = (Resolve-Path -Path "${PSScriptRoot}/../")[0]
+$Name = "Microsoft.PowerShell.Archive"
+$BuildOutputDir = Join-Path $root "\src\bin\Release"
+$ManifestPath = "${BuildOutputDir}\${Name}.psd1"
+$ManifestData = Import-PowerShellDataFile -Path $ManifestPath
+$Version = $ManifestData.ModuleVersion
+
+$SignRoot = "${root}\signed\${Name}"
+$SignVersion = "$SignRoot\$Version"
+
+$PubBase  = "${root}\out"
+$PubRoot  = "${PubBase}\${Name}"
+$PubDir   = "${PubRoot}\${Version}"
+
+if (-not $test -and -not $build -and -not $publish -and -not $package) {
+    throw "must use 'build', 'test', 'publish', 'package'"
+}
+
+[bool]$verboseValue = $PSBoundParameters['Verbose'].IsPresent ? $PSBoundParameters['Verbose'].ToBool() : $false
+
+$FileManifest = @(
+    @{ SRC = "${$BuildOutputDir}"; NAME = "Microsoft.PowerShell.Archive.dll"; SIGN = $true ; DEST = "OUTDIR" }
+    @{ SRC = "${$BuildOutputDir}"; NAME = "Microsoft.PowerShell.Archive.psm1"; SIGN = $true ; DEST = "OUTDIR" }
+)
+
+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 = $SignedPath
+    }
+    else {
+        $packageRoot = $PubRoot
+    }
+
+    if ( -not (test-path $packageRoot)) {
+        throw "'$PubDir' 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
+    $nupkgName = "{0}.{1}-preview1.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"
+    }
+}
+
+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
+}

.azdevops/build.yml

@@ -0,0 +1,138 @@
+name: Microsoft.PowerShell.Archive-$(Build.BuildId)
+trigger: none
+
+pr: none
+
+variables:
+  DOTNET_CLI_TELEMETRY_OPTOUT: 1
+  POWERSHELL_TELEMETRY_OPTOUT: 1
+
+resources:
+  repositories:
+  - repository: ComplianceRepo
+    type: github
+    endpoint: ComplianceGHRepo
+    name: PowerShell/compliance
+    ref: master
+
+stages:
+- stage: Build
+  displayName: Build
+  pool:
+    name: 1ES
+    demands:
+      - ImageOverride -equals PSMMS2019-Secure
+  jobs:
+  - job: Build_Job
+    displayName: Build Microsoft.PowerShell.Archive
+    variables:
+    - group: ESRP
+    steps:
+    - checkout: self
+
+    - task: UseDotNet@2
+      displayName: 'Get .NET 7.0 SDK'
+      inputs:
+        packageType: sdk
+        version: 7.x
+        includePreviewVersions: true
+
+    - pwsh: |
+        & $(Build.SourcesDirectory)/Microsoft.PowerShell.Archive/SimpleBuild.ps1
+      displayName: Build Microsoft.PowerShell.Archive module
+
+    - pwsh: |
+        dir "$(BuildOutDir)\*" -Recurse
+      displayName: Show BuildOutDirectory
+
+    - pwsh: |
+        $signSrcPath = "$(BuildOutDir)"
+        # Set signing src path variable
+        $vstsCommandString = "vso[task.setvariable variable=signSrcPath]${signSrcPath}"
+        Write-Host "sending " + $vstsCommandString
+        Write-Host "##$vstsCommandString"
+        # Get the module version
+        $ManifestPath = Join-Path $(BuildOutDir) "Microsoft.PowerShell.Archive.psd1"
+        $ManifestData = Import-PowerShellDataFile -Path $ManifestPath
+        $Version = $ManifestData.ModuleVersion
+        $signOutPath = "$(Build.SourcesDirectory)\signed\Microsoft.PowerShell.Archive\${Version}"
+        $null = New-Item -ItemType Directory -Path $signOutPath
+        # Set signing out path variable
+        $vstsCommandString = "vso[task.setvariable variable=signOutPath]${signOutPath}"
+        Write-Host "sending " + $vstsCommandString
+        Write-Host "##$vstsCommandString"
+        # Set path variable for guardian codesign validation
+        $vstsCommandString = "vso[task.setvariable variable=GDN_CODESIGN_TARGETDIRECTORY]${signOutPath}"
+        Write-Host "sending " + $vstsCommandString
+        Write-Host "##$vstsCommandString"
+      displayName: Setup variables for signing
+
+    - checkout: ComplianceRepo
+
+    - task: UseDotNet@2
+      displayName: 'Get .NET 2.1 SDK'
+      inputs:
+        packageType: sdk
+        version: 2.x
+        includePreviewVersions: true
+
+    - template: EsrpSign.yml@ComplianceRepo
+      parameters:
+        # the folder which contains the binaries to sign
+        buildOutputPath: $(signSrcPath)
+        # the location to put the signed output
+        signOutputPath: $(signOutPath)
+        # the certificate ID to use
+        certificateId: "CP-230012"
+        # the file pattern to use, comma separated
+        pattern: '*.psd1,*.dll'
+
+    - template: Sbom.yml@ComplianceRepo
+      parameters:
+        BuildDropPath: $(signOutPath)
+        Build_Repository_Uri: 'https://github.com/PowerShell/Microsoft.PowerShell.Archive'
+
+    - pwsh: |
+        Get-ChildItem $(signOutPath) -Recurse | Write-Output
+
+    - pwsh: |
+        Set-Location "$(Build.SourcesDirectory)"
+        # signOutPath points to directory with version number -- we want to point to the parent of that directory
+        $ModulePath = Split-Path $(signOutPath) -Parent
+        $(Build.SourcesDirectory)/Microsoft.PowerShell.Archive/.azdevops/build.ps1 -package -CopySBOM -signed -SignedPath $ModulePath
+        Get-ChildItem -recurse -file -name | Write-Verbose -Verbose
+      displayName: package build
+
+    - publish: "$(signSrcPath)"
+      artifact: build
+      displayName: Publish build
+
+- stage: compliance
+  displayName: Compliance
+  dependsOn: Build
+  jobs:
+  - job: Compliance_Job
+    pool:
+      name: 1ES # Package ES CodeHub Lab E
+    steps:
+    - checkout: self
+    - checkout: ComplianceRepo
+    - download: current
+      artifact: build
+
+    - pwsh: |
+        Get-ChildItem -Path "$(Pipeline.Workspace)\build" -Recurse
+      displayName: Capture downloaded artifacts
+    - template: script-module-compliance.yml@ComplianceRepo
+      parameters:
+        # component-governance
+        sourceScanPath: '$(Build.SourcesDirectory)\Microsoft.PowerShell.Archive\src'
+        # credscan
+        suppressionsFile: ''
+        # TermCheck
+        optionsRulesDBPath: ''
+        optionsFTPath: ''
+        # tsa-upload
+        codeBaseName: 'PSNativeCommandProxy_2020'
+        # selections
+        APIScan: false # set to false when not using Windows APIs.