CPPA::stdErrorのテストを追加するにあたっての課題共有 #1812

berryzplus · 2022-02-27T06:03:11Z

PR の目的

タイトル通りです。

カテゴリ

実験 (master へのマージを目的としない)

PR の背景

CPPA::stdErrorの単体テストを作ろうとしたら課題にブチ当たったので共有します。

PR のメリット

PR のデメリット (トレードオフとかあれば)

仕様・動作説明

CPPA::stdError は PPA.DLL がエラー時に呼び出す「コールバック関数」です。

エラーコードとエラーメッセージを受け取り、
適切なメッセージを組み立てて「メッセージボックスに表示する」という仕様です。

「メッセージボックスに表示する」という処理は通常は「テスト不可」です。
メッセージボックスを表示するとスレッドがブロックされて先に進まなくなるためです。
実装した処理の正当性を確認できるようにするには、メッセージボックスを入れるべきでないです。
とは言え、既存コードのメッセージボックス表示を削って回るわけにもいかないので、
以前「メッセージボックスを表示するパスがあっても自動テストができる仕組み」を作り込みました。(#1362)

単体テストの一部として動く場合（正確には標準エラー出力が存在する場合）、
メッセージボックスに標準エラー出力(STDERR)に吐かれるようになっています。

CPPA::stdError は「Err_CD=0：PPAのエラー」時に「Err_Msg」をそのままメッセージボックスに表示します。
gtestは標準エラー出力(std::cerr)に吐かれた文字列をキャプチャできます。
#1362 の機構がちゃんと動いていれば、単体テストを作れるはずです。。。（要するに、動いてないんです。）

PR の影響範囲

テスト内容

テスト1

手順

参考資料

https://gongo.hatenablog.com/entry/20110516/1305548031

AppVeyorBot · 2022-02-27T06:37:15Z

❌ Build sakura 1.0.4065 failed (commit 866dfb2c3c by @berryzplus)

AppVeyorBot · 2022-02-27T07:08:59Z

❌ Build sakura 1.0.4066 failed (commit ec4704f66f by @berryzplus)

berryzplus · 2022-02-27T07:13:00Z

少し先走ってコミット積んでしまいました。
最初のコミットでは、テストが失敗します。
2つ目のコミットもテストは失敗するのですが「ハンドルが無効です。」という出力を得られます。

問題箇所はココです。

sakura/sakura_core/util/MessageBoxF.cpp

Lines 59 to 61 in 90d6766

    
           // lpText を標準エラー出力に書き出す 
        
           DWORD dwWritten = 0; 
        
           ::WriteConsoleW( hStdErr, lpText, dwTextLen, &dwWritten, NULL );

Windows API WriteConsoleW関数はコンソール専用なので、hStdErr がコンソールハンドルでなかった場合「ハンドルが無効です。」というエラーを出します。gtestは標準エラー出力をキャプチャする際、プロセスのエラー出力をファイルハンドルに差し替えているため、ここの記述が「絶対に正しい」と仮定すれば「gtestは使えない」になります。「gtestを使って標準エラー出力をキャプチャするんだ！」を仕様と捉えると「コードが誤っている（≒バグじゃ～～～）」になります。

個人的に「テストがしづらいコード」はそれ自体不具合だと思うので「#1362 の不備」として修正したらよい気がします。アプリの挙動には影響しない不具合なので「不具合修正」にはならんのですが。。。