【実務・中級編】【上級者向け】VB.NETのWPFアプリにおけるUI自動テスト(FlaUI / TestStack.White)の導入とCI/CDパイプライン構築 – Visual Basic (VB / VB.NET)解析バイブル

スポンサーリンク
スポンサーリンク

WPF自動テストの罠を回避せよ:FlaUIを用いた堅牢なUI自動化とCI/CD統合の設計思想

業務効率化ツールの開発において、多くのエンジニアが陥る致命的なミスがある。それは、「アプリケーションが動くこと」をゴールにし、「アプリケーションを維持すること」を軽視することだ。

WPF(Windows Presentation Foundation)は、強力なデータバインディングと柔軟なレイアウトを持つ。しかし、その柔軟性は諸刃の剣だ。UIの構造が少し変わっただけで、既存のテストコードが全滅する。そんな「脆い(Fragile)テスト」を量産していては、自動テストは単なるメンテナンスコストの増大、すなわち技術的負債でしかない。

本稿では、VB.NETを用いたWPF開発において、単なる「ボタンクリックの自動化」を超えた、変更に強く、CI/CDパイプラインに組み込めるプロフェッショナルなUIテスト設計を伝授する。

1. 設計の要諦:なぜ君のUIテストはすぐに壊れるのか

多くの開発者が、テストコードを書く際に「ボタンのテキスト(Content)」や「コントロールのインデックス」を基準に要素を特定しようとする。これは最悪の設計だ。

「OK」というボタンのテキストをターゲットにしていれば、将来「確定」に文言が変わった瞬間にテストは失敗する。これはバグではなく、設計の敗北だ。

解決策:`AutomationId` の徹底活用

WPFにおけるUI自動化の鉄則は、「UIの見た目」と「自動テスト用の識別子」を完全に分離することだ。XAMLにおいて、`Name`プロパティ(コードビハインド用)とは別に、`AutomationProperties.AutomationId` を明示的に付与せよ。

<!-- ❌ 悪い例:見た目に依存している -->
<Button Content="保存" Click="SaveButton_Click" />

<!-- ✅ 良い例:テスト用の識別子を分離している -->
<Button Content="保存" 
        AutomationProperties.AutomationId="Btn_Save_Data" 
        Click="SaveButton_Click" />

このように設計することで、デザイナーがボタンのテキストを「Save」から「保存」に変更しても、テストコードは一切修正する必要がなくなる。

2. 戦略的パターン:Page Object Model (POM) の導入

テストコードの中に `FindElement` や `Click` を直接書き込むのは、素人の仕事だ。UIの構造が変わるたびに、数百箇所に散らばったテストコードを修正することになる。

我々プロフェッショナルは、Page Object Model (POM) を採用する。これは、各画面(Page)の要素と操作を一つのクラスにカプセル化する設計パターンだ。

FlaUIを用いた実装例 (VB.NET)

現在、`TestStack.White` はメンテナンスが停滞しており、モダンなWPF環境では FlaUI を使用するのが業界標準だ。以下に、保守性の高いPOMの構造を示す。

# Page Object クラス

Imports FlaUI.Core
Imports FlaUI.UIA3

''' <summary>
''' メイン画面の操作を抽象化するPage Object
''' </summary>
Public Class MainWindowPage
    Private ReadOnly _window As Window

    Public Sub New(window As Window)
        _window = window
    End Sub

    ' --- 要素の定義 (AutomationIdを使用) ---
    Private ReadOnly Property SaveButton As Button
        Get
            Return _window.FindFirstDescendant(Function(x) x.AutomationId = "Btn_Save_Data").AsButton()
        End Get
    End Property

    Private ReadOnly Property StatusLabel As Label
        Get
            Return _window.FindFirstDescendant(Function(x) x.AutomationId = "Lbl_Status").AsLabel()
        End Get
    End Property

    ' --- アクションの定義 ---
    Public Sub ClickSave()
        SaveButton.Click()
    End Sub

    Public ReadOnly Property StatusText As String
        Get
            Return StatusLabel.Text
        End Get
    End Property
End Class

# テストケース クラス

Imports NUnit.Framework
Imports FlaUI.UIA3

<TestFixture>
Public Class MainWindowTests
    Private _app As FlaUI.Core.Application
    Private _automation As UIA3Automation

    <SetUp>
    Public Sub Setup()
        ' アプリケーションの起動
        _app = FlaUI.Core.Application.Launch("YourApp.exe")
        _automation = New UIA3Automation()
    End Sub

    <TearDown>
    Public Sub Teardown()
        _automation.Dispose()
        _app.Close()
    End Sub

    <Test>
    Public Sub SaveButton_ShouldUpdateStatusLabel_WhenClicked()
        ' Arrange: Page Objectの初期化
        Dim mainWindow = _app.GetMainWindow(_automation)
        Dim mainPage = New MainWindowPage(mainWindow)

        ' Act: ユーザー操作を抽象化されたメソッドで実行
        mainPage.ClickSave()

        ' Assert: 結果の検証
        Assert.That(mainPage.StatusText, Is.EqualTo("保存完了"), "保存後のステータス表示が正しくありません。")
    End Sub
End Class

3. 外部リソース(DB・ファイル)との連携における「副作用」の制御

UIテストを実務に投入する際、最大の障壁となるのが「テストデータの汚染」だ。
テストがデータベースの値を書き換えてしまうと、次のテストが失敗する、あるいは本番環境を破壊するという恐怖が生まれる。

鉄則:Isolation(分離)

1. データベース: テスト実行ごとにトランザクションをロールバックするか、テスト専用の「隔離されたデータベース(またはSQLite等のインメモリDB)」を使用せよ。
2. ファイルシステム: テスト用のディレクトリを `Path.GetTempPath()` 配下に動的に生成し、テスト終了後に確実に削除(Cleanup)する設計にせよ。

' テスト環境のクリーンアップ例
Public Sub SetupTestEnvironment()
    ' テスト用一時ディレクトリの作成
    Dim testDir = IO.Path.Combine(IO.Path.GetTempPath(), "MyApp_Test_" & Guid.NewGuid().ToString())
    IO.Directory.CreateDirectory(testDir)
    
    ' このパスをアプリの構成ファイルに注入するか、環境変数で渡す
    Environment.SetEnvironmentVariable("APP_DATA_PATH", testDir)
End Sub

4. CI/CD パイプラインへの統合:ヘッドレス環境の壁

「自分のマシンでは動くのに、Azure DevOpsやGitHub Actionsのビルドサーバーでは落ちる」
これはUIテストにおける古典的な問題だ。なぜなら、UIテストは「デスクトップ・セッション(GUIが表示される環境)」を必要とするからだ。

CI/CD構築の戦略

1. Self-hosted Runnerの利用: クラウド上の共有エージェント(GitHub-hosted runner等)ではGUI操作が困難だ。自前のWindowsサーバー、あるいはAzure VMを「Self-hosted Runner」として登録し、そこでテストを実行せよ。
2. インタラクティブ・セッションの維持: RDP(リモートデスクトップ)をログアウト状態で切断すると、GUIがロックされテストが失敗する。セッションを維持するためのタスクスケジューラ設定や、自動ログイン設定を検討する必要がある。
3. Artifactsの活用: テストが失敗した際、「その時のスクリーンショット」を必ずビルド成果物(Artifacts)として保存するようにスクリプトを組め。これがないと、失敗原因の特定に膨大な時間が溶けることになる。

結論:品質を「コード」で担保する覚悟を持て

UI自動テストは、単なる「チェック作業の自動化」ではない。それは、「仕様変更に対して、システムが正しく振る舞うことを数学的に証明するプロセス」だ。

  • `AutomationId` による識別子の分離
  • `Page Object Model` による構造の抽象化
  • 外部リソースの隔離による副作用の排除
  • CI/CDへの組み込みによる継続的な検証

これらを疎かにして、真に「業務効率化」に貢献するツールを作ることは不可能だ。設計の段階から「どうテストするか」を問い続けろ。それが、一流のエンジニアと、単なるプログラマーを分かつ境界線である。

タイトルとURLをコピーしました