ノート: GitHubホストランナーは、現在GitHub Enterprise Serverでサポートされていません。 GitHubパブリックロードマップで、計画されている将来のサポートに関する詳しい情� �を見ることができます。
はじめに
このガイドでは、CIのためのPowerShellの使用方法を示します。 Pesterの使い方、依存関係のインストール、モジュールのテスト、PowerShell Galleryへの公開について説明します。
GitHubホストランナーは、PowerShell及びPesterを含むプリインストールされたソフトウェアを伴うツールキャッシュを持ちます。
最新のソフトウェアと、PowerShell および Pester のプレインストールされたバージョンの完全なリストについては、「GitHub ホストランナーの仕様」を参照してく� さい。
必要な環境
YAMLとGitHub Actionsの構文に馴染んでいる必要があります。 詳しい情� �については、「GitHub Actions を学ぶ」を参照してく� さい。
PowerShell及びPesterの基本的な理解をしておくことをおすすめします。 詳しい情� �については、以下を参照してく� さい。
GitHub Enterprise Server上でのセルフホストランナーの利用
GitHub Enterprise Server上でセルフホストランナーと合わせてセットアップアクション(actions/setup-LANGUAGE
のような)を使う� �合、インターネットアクセスを持たないランナー上にツールキャッシュをセットアップする必要があるかもしれません。 詳しい情� �については「インターネットアクセスを持たないセルフホストランナー上へのツールキャッシュのセットアップ」を参照してく� さい。
Pesterのワークフローの追�
PowerShellとPesterでテストを自動化するには、変更がリポジトリにプッシュされるたびに実行されるワークフローを追� できます。 以下の例では、resultsfile.log
というファイルがあるかをチェックするためにTest-Path
が使われます。
以下の例のワークフローファイルは、リポジトリの.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 Galleryからインストールできます。
ノート: GitHubホストランナーが使用するプリインストールされたパッケージ(Pesterなど)は定期的に更新され、重要な変更が行われることがあります。 そのため、Install-Module
で-MaximumVersion
を使って必要なパッケージのバージョンを常に指定しておくことをおすすめします。
たとえば以下のジョブは、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
ノート: デフォルトでは、PowerShellはどのリポジトリも信� �しません。 PowerShell Galleryからモジュールをインストールする際には、PSGallery
のインストールポリシーを明示的にTrusted
に設定しなければなりません。
コードのテスト
ローカルで使うのと同じコマンドを、コードのビルドとテストに使えます。
PSScriptAnalyzerを使ったコードの文法チェック
以下の例はPSScriptAnalyzer
をインストールし、それを使ってリポジトリ内のすべてのps1
ファイルの文法チェックを行います。 詳しい情� �については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 Galleryに公開します。
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