构建和测试 PowerShell

简介

本指南演示如何将 PowerShell 用于 CI。 它介绍了如何使用 Pester、安装依赖项、测试模块以及发布到 PowerShell Gallery。

GitHub 托管的运行器具有预安装了软件的工具缓存，包括 PowerShell 和 Pester。

有关最新版软件以及 PowerShell 和 Pester 预安装版本的完整列表，请参阅“GitHub 托管的运行器规范”。

先决条件

您应该熟悉 YAML 和 GitHub Actions 的语法。 有关详细信息，请参阅“了解 GitHub Actions”。

建议您对 PowerShell 和 Pester 有个基本的了解。 有关详细信息，请参阅：

• 开始使用 PowerShell
• Pester

在 GitHub Enterprise Server 上使用自托管的运行器

在包含自承载运行器的 GitHub Enterprise Server 上使用设置操作（例如 actions/setup-LANGUAGE）时，可能需要在� 法访问 Internet 的运行器上设置工具缓存。 有关详细信息，请参阅“在� 法访问 Internet 的自承载运行器上设置工具缓存”。

为 Pester 添� 工作流程

要使用 PowerShell 和 Pester 自动执行测试，您可以添� 在每次将更改推送到仓库时运行的工作流程。 在以下示例中，Test-Path 用于检查名为 resultsfile.log 的文件是否存在。

必须将此示例工作流文件添� 到存储库的 .github/workflows/ 目录：

name: Test PowerShell on Ubuntu on: push jobs: pester-test: name: Pester test runs-on: ubuntu-latest steps: - name: Check out repository code uses: actions/checkout@v2 - name: Perform a Pester test from the command-line shell: pwsh run: Test-Path resultsfile.log | Should -Be $true - name: Perform a Pester test from the Tests.ps1 file shell: pwsh run: | Invoke-Pester Unit.Tests.ps1 -Passthru 

• shell: pwsh - 将作业配置为在运行 run 命令时使用 PowerShell。

• run: Test-Path resultsfile.log - 检查存储库的� �目录中是否存在名为 resultsfile.log 的文件。

• Should -Be $true - 使用 Pester 定义预期结果。 如果结果是非预期的，则 GitHub Actions 会将此� �记为失败的测试。 例如：

  

• Invoke-Pester Unit.Tests.ps1 -Passthru - 使用 Pester 执行在名为 Unit.Tests.ps1 的文件中定义的测试。 例如，若要执行上述相同的测试，Unit.Tests.ps1 将包含以下命令：

  Describe "Check results file is present" { It "Check results file is present" { Test-Path resultsfile.log | Should -Be $true } } 

PowerShell 模块位置

下表描述了每个 GitHub 托管的运行器中各个 PowerShell 模块的位置。

	Ubuntu	macOS	Windows
PowerShell 系统模块	/opt/microsoft/powershell/7/Modules/*	/usr/local/microsoft/powershell/7/Modules/*	C:\program files\powershell\7\Modules\*
PowerShell � 载项模块	/usr/local/share/powershell/Modules/*	/usr/local/share/powershell/Modules/*	C:\Modules\*
用户安装的模块	/home/runner/.local/share/powershell/Modules/*	/Users/runner/.local/share/powershell/Modules/*	C:\Users\runneradmin\Documents\PowerShell\Modules\*

安装依赖关系

GitHub 托管的运行器安装了 PowerShell 7 和 Pester。 在生成和测试代� �之前，可使用 Install-Module 从 PowerShell 库安装其他依赖项。

例如，以下作业安装 SqlServer 和 PSScriptAnalyzer 模块：

jobs: install-dependencies: name: Install dependencies runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: Install from PSGallery shell: pwsh run: | Set-PSRepository PSGallery -InstallationPolicy Trusted Install-Module SqlServer, PSScriptAnalyzer 

测试代� �

您可以使用与本地相同的命令来构建和测试代� �。

使用 PSScriptAnalyzer 链接代� �

以下示例安装 PSScriptAnalyzer 并使用它对存储库中的所有 ps1 文件执行 lint 操作。 有关详细信息，请参阅 GitHub 上的 PSScriptAnalyzer。

 lint-with-PSScriptAnalyzer: name: Install and run PSScriptAnalyzer runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: Install PSScriptAnalyzer module shell: pwsh run: | Set-PSRepository PSGallery -InstallationPolicy Trusted Install-Module PSScriptAnalyzer -ErrorAction Stop  - name: Lint with PSScriptAnalyzer shell: pwsh run: | Invoke-ScriptAnalyzer -Path *.ps1 -Recurse -Outvariable issues $errors = $issues.Where({$_.Severity -eq 'Error'}) $warnings = $issues.Where({$_.Severity -eq 'Warning'}) if ($errors) { Write-Error "There were $($errors.Count) errors and $($warnings.Count) warnings total." -ErrorAction Stop } else { Write-Output "There were $($errors.Count) errors and $($warnings.Count) warnings total." } 

将工作流数据打包为构件

您可以在工作流程完成后上� 构件以查看。 例如，您可能需要保存日志文件、� �心转储、测试结果或屏幕截图。 有关详细信息，请参阅“使用项目持久保存工作流数据”。

以下示例演示如何使用 upload-artifact 操作来存档从 Invoke-Pester 收到的测试结果。 有关详细信息，请参阅 upload-artifact 操作。

name: Upload artifact from Ubuntu on: [push] jobs: upload-pester-results: name: Run Pester and upload results runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: Test with Pester shell: pwsh run: Invoke-Pester Unit.Tests.ps1 -Passthru | Export-CliXml -Path Unit.Tests.xml - name: Upload test results uses: actions/upload-artifact@v2 with: name: ubuntu-Unit-Tests path: Unit.Tests.xml if: ${{ always() }} 

always() 函数将作业配置为即使存在测试失败也要继续处理。 有关详细信息，请参阅“always”。

发布到 PowerShell Gallery

您可以配置工作流程在 CI 测试通过时将 PowerShell 模块发布到 PowerShell Gallery。 您可以使用机密来存储发布软件包所需的任何令牌或凭据。 有关详细信息，请参阅“创建和使用已� 密的机密”。

以下示例创建一个包并使用 Publish-Module 将其发布到 PowerShell 库：

name: Publish PowerShell Module on: release: types: [created] jobs: publish-to-gallery: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: Build and publish env: NUGET_KEY: ${{ secrets.NUGET_KEY }} shell: pwsh run: | ./build.ps1 -Path /tmp/samplemodule Publish-Module -Path /tmp/samplemodule -NuGetApiKey $env:NUGET_KEY -Verbose