PowerShell TDD 起步走
VSCode as PowerShell TDD IDE
- 為了有一個乾淨＆快速的TDD開發環境，建議使用Portable 版本的 VSCode，以免同時安裝太多擴充套件消耗資源。
https://code.visualstudio.com/download
![]()
- 一定要安裝的套件其實只有三個(去掉 Vim 😆)：
(C# Dev Kit套件非免費且無法在封閉內網環境使用)![]()
Example VSCode Environment - Windows(x64)
除了要手動開啟Windows『開發者模式』設定以及將同捆的 .NET SDK 的執行檔路徑到環境變數之外，其他的都是使用 Portable 版本的開發環境：
- Windows 環境的 relative symbolic link 需要啟用開發者模式才能讓 PowerShell 以不需管理員權限的方式設定。
![]()
否則甚至連Windows內建的解壓縮功能都會被拒絕存取。![]()
- .NET SDK 的執行路徑建議以 DOTNET_ROOT 環境變數設定，以便於切換不同版本 dotnet 指令
（使用系統安裝的 .NET SDK 8.0 也👌🆗）。![]()
![]()
Example VSCode Environment - Windows(x64)
開發環境的檔案目錄架構:
使用獨立的 PowerShell Module 目錄避免因為不同專案需要的各種版本 PowerShell Module 互衝，或是和系統層級的 Module 混淆。
因此要在 PowerShell Module 目錄內下載並安裝 “ModuleFast” 這個工具型 PowerShell Module，用此命令列工具安裝 PowerShell Module 時可下指令指定安裝來源、安裝位置、模組版本。
例如以下範例，從 nuget.org 安裝 Pester v5.6.1 版本到 D:_portable_modules 目錄：
@{ModuleName='Pester';ModuleVersion='5.6.1'} | Install-ModuleFast -Source api.nuget.org/v3 -Destination D:\vscode_portable\pwsh_modules
另外還有一個好用的開發用 PowerShell 指令列工具模組 PowerShell.dumPS，可以用來在 VSCode 中斷點除錯時，使用 Debug Console 快速查看 PowerShell 物件的類別、屬性值資訊。
Reset 專案開發環境
如果當此 VSCode 開發環境因為一些手誤使得開啟某些專案時工作區(worksapce) UI 配置跑掉，或是有不正常的 debug 選項在 Run and Debug 頁籤出現，需要重置時，只需要將 vscode_data\user-data\User\workspaceStorage 中，workspace.json 檔案指到原本專案項目的整個子目錄刪除即可：
假如是正常安裝版本的 Visual Studio Code，則可在下列位置中找到相同檔案。
| OS | 路徑 |
|---|---|
| Windows | %APPDATA%\Code\User\workspaceStorage |
| macOS | ~/Library/Application Support/Code/User/workspaceStorage |
| Linux | ~/.config/Code/User/workspaceStorage |
Example VSCode Environment - Windows(x64)
在 pwsh-scripts 目錄的開發環境設定用 script 檔案：
PSScriptAnalyzerSettings.psd1
用來控制 VSCode 官方 PowerShell Extension 內建的 PSScriptAnalyzer(PowerShell Syntax Linter) 設定檔。Set-PwshTools.ps1
替代 PowerShell Profile 的設定檔，用來設定 VSCode 整合終端機中 PowerShell 命令列的自動完成功能相關設定以及添加一些類似 Unix 環境的檔案命令。"terminal.integrated.profiles.windows": { "PowerShell": { "title": "Bundled pwsh", "path": "D:\\vscode_portable\\PowerShell-x64\\pwsh.exe", "args": [ "-nol", 1 "-nop", "-noe", "-ex", "RemoteSigned", 2 "-Command", "Invoke-expression \". D:\\vscode_portable\\pwsh-scripts\\Set-PwshTools.ps1\"" ] } },- 1
-
使用
-nop參數避免執行目前系統/使用者等級的 PowerShell Profile 設定檔 - 2
-
執行
Invoke-Expression ". D:\vscode_portable\pwsh-scripts\Set-PwshTools.ps1"來替代。
Update-SymLinks.ps1
用來更新/恢復兩個 symbolic link 檔案－1. 根目錄的 VSCode 主程式啟動連結 2. VSCode 可攜模式設定的使用者資料檔案目錄連結。
(Windows 10 symbolic link 會因搬移到不同磁碟機/電腦而失效)![]()
(PowerShell + C# binary cmdlet) call gRPC API
Demo
- 使用 gRPC-web 的 C# Client Nuget 套件以便在不支援 HTTP/2 的 Windows PowerShell 環境中呼叫 gRPC 服務。
- 如何為 Windows PowerShell 的 C# binary cmdlet 撰寫 Assembly Resolver 以便成功載入 gRPC-Web client Library。
- 繼承
PSCmdlet類別所撰寫 PowerShell Advanced function 的 binary cmdlet 如何使用 xUnit 測試框架來撰寫測試案例。 - 使用混合 PowerShell module (.psd1 & .psm1) + C# binary cmdlet 的方式來撰寫混合型 PowerShell Module 專案。
- 如何於 Windows PowerShell v5.1 & PowerShell v7+ 跑偵錯。
- 如何針對 PowerShell + C# 程式碼的專案撰寫 PowerShell 的 Pester 測試案例。
此 PowerShell script 在先前的 Pester test case 範例專案中提供並且已有驗證行為的測試案例。
使用 PowerShell 來撰寫取得所有有特定副檔名的檔案邏輯，比單純使用 C# 簡單:
src\DemoWebApi\PwshScripts\DuplicateFilesFinder.psm1
也可用PowerShell 的 Get-FileHash Cmdlet 取得檔案的 Hash 值來快速判斷檔案內容是否相同:
src\DemoWebApi\PwshScripts\DuplicateFilesFinder.psm1
原本在 PowrShell script 裡用的是 PowerShell 定義自訂 Class 類別，因此在執行完畢回傳的結果值物件直接使用 dynamic keyword 寫法簡化取得 FilePath1 & FilePath2 屬性值程式碼。
src\DemoWebApi\Services\DuplicateFileFinderInvokeService.cs
var result =
ps.Invoke(input: null, settings: psInvocationSettings)
1 .FirstOrDefault()?.BaseObject as object[];
var duplicateFileResults = new List<DuplicateFileResult>(result.Length);
// use dynamic to make simpler coding style to avoid reflection
2foreach (dynamic duplicateFileInfo in result)
{
var duplicateFileResult = new DuplicateFileResult
{
3 SourceFilePath = duplicateFileInfo.FilePath1.ToString(),
CompareFilePath = duplicateFileInfo.FilePath2.ToString()
};
duplicateFileResults.Add(duplicateFileResult);
}
return duplicateFileResults;- 1
-
由於原本 PowerShell script function 的回傳值是單個物件陣列，所以取得回傳值順便先轉型成
object[]陣列。 - 2
-
使用
dynamic關鍵字來簡化原本 PowerShell 程式碼中定義的自訂 class 型別。 - 3
- 就可以直接使用物件的屬性值（C#編譯器不檢查，如果寫錯就會有 runtime exception）。
執行 Pester 測試的 xUnit 程式碼
在 xUnit Test method 中呼叫 PowerShell runtime 執行 Pester 測試案例，使用 Pester 框架提供的 Invoke-Pester Cmdlet 的 -PassThru 命令列參數，可使 Pester 將執行測試結果傳出，再於 C# 中驗證測試結果是否符合預期:
tests\DemoWebApi.Tests\PwshModuleTest.cs
[Fact]
public void TestDuplicateFileFinderPwshFunction()
{
// Arrange
using var runspace = RunspaceFactory.CreateRunspace();
runspace.Open();
using var ps = PowerShell.Create(runspace);
var psInvocationSettings = new PSInvocationSettings
{
AddToHistory = false,
ErrorActionPreference = ActionPreference.Stop,
};
#region TestScript
const string testScript =
"""
1 $tempModulePath = $env:TEMP + "\PwshModule$((Get-Date).Ticks)"
if(-not (Test-Path $tempModulePath)) {
New-Item -Path $tempModulePath -ItemType Directory -ErrorAction Stop | Out-Null
}
else {
Remove-Item -Path $tempModulePath -Recurse -Force -ErrorAction Stop | Out-Null
New-Item -Path $tempModulePath -ItemType Directory -ErrorAction Stop | Out-Null
}
2 Save-Module -Name Pester -Path $tempModulePath -ErrorAction Stop
Import-Module $tempModulePath\Pester -Force -ErrorAction Stop
3 $currentDir = [System.IO.Directory]::GetCurrentDirectory()
$TestScriptPath = "$currentDir\..\..\..\PwshScripts\DuplicateFilesFinder.Tests.ps1"
if(-not (Test-Path $TestScriptPath)) {
throw "Test script not found at $TestScriptPath"
}
4 $result = Invoke-Pester -Path $TestScriptPath -PassThru
return $result
""";
#endregion
ps.AddScript(testScript);
// Act
var psResult = ps.Invoke(input: null, settings: psInvocationSettings).FirstOrDefault();
// Assert
Assert.NotNull(psResult);
5 var testResult = psResult.Properties["Result"].Value as string;
var totalCount = psResult.Properties["TotalCount"].Value as int?;
var passedCount = psResult.Properties["PassedCount"].Value as int?;
var failedCount = psResult.Properties["FailedCount"].Value as int?;
Assert.NotNull(testResult);
Assert.NotNull(totalCount);
Assert.NotNull(passedCount);
Assert.NotNull(failedCount);
Assert.Equal("Passed", testResult);
Assert.True(passedCount > 0);
Assert.Equal(totalCount, passedCount);
Assert.Equal(0, failedCount);
}- 1
- 建立暫存目錄來在稍後步驟用來放最新版 Pester PowerShell module。
- 2
-
使用 PowerShellGet 的
Save-Module命令將最新版 Pester 從 PowerShell Gallery 下載至暫存目錄，然後用Import-Module載入該版本的 Pester 模組。(參考官方手動安裝說明文件) - 3
- 取得目前執行測試程式的目錄，並且設定要執行的 Pester 測試案例 script 檔案路徑。
- 4
- 執行 Pester 測試案例 script 檔案，並將測試結果回傳給 C# 程式碼。
- 5
-
由於 Pester 測試結果回傳的是 PowerShell PSCustomObject 型態物件，所以透過
Properties屬性來取得各個測試結果的屬性值。
如此我們就可以將 PowerShell 的 Pester 單元測試整合至 xUnit 測試專案中，讓 C＃ code & PowerShell script 一起執行測試驗證程式邏輯。👍
Q & A
Any Questions?
🙋♂️🙋♀️🙋
