トレイウィンドウのメッセージ配送をテストする

[berryzplus]

PR対象

• アプリ(サクラエディタ本体)
• テストコード

カテゴリ

• 改善

PR の背景

• 先行 issue はとくに作成していません。

背景にあるのは「カバレッジ低過ぎ問題(#2526)」です。

仕様・動作説明

• メッセージ配送のテストを導入して「ウィンドウクラスは基本的にテストしづらい」に対策します。

ウィンドウクラスはメッセージハンドラをメンバーに持つため、本質的にテストしづらいです。
※メッセージハンドラはWindows APIの生構造体が引数となるため。

しかし、クラスの役割 ≒ メッセージ配送 と置けば、
メッセージ配送が正しく行われるか と
配送されたメッセージが正しく（？）処理されるか に評価観点を分離できます。

サクラエディタの場合、メッセージ配送が正しく行われることを保証できないコードが結構あったりするわけですが、これまでは「たたき台」にできる評価コードすら一本もない状態でした。

本件、勝手にやります。

PR の影響範囲

テスト内容

関連 issue, PR

• CIテストのカバレッジを改善したい #2526
• CIテストでカバレッジ60%を達成したい #2527

参考資料

[github-actions]

Test Results

1 139 tests  +23   1 139 ✅ +23   3m 49s ⏱️ +15s
  107 suites + 1       0 💤 ± 0 
    1 files   ± 0       0 ❌ ± 0 

Results for commit a01decc. ± Comparison against base commit 5d2d293.

♻️ This comment has been updated with latest results.

[berryzplus]

MinGWビルドの失敗について。

• ローカルでは通っている。
• 今回修正は「トレイクリックメニューでしか動かせないパス」を素直に「トレイクリックのメニュレート」で実現しているため、テスト成功率がそもそも高くない。
• 今回修正と関係ない実行時エラーなので、何度もリトライすればそのうち通る。

あと何回かリトライしてダメなようなら、「トレイクリックをエミュレートする」を最小限に抑える変更を含めてしまうことも考えようかと思ってる。

1本のPull Requestに複数の意図が入り込むと、どれだけアプリに対する理解が深くても「これなんだっけ？」になりがち。

無理な場合を除いて、できるだけソレは避けたい。

[berryzplus]

ぼくがサクラエディタに関わっている目的には、「先端技術のキャッチアップを怠らないよう、勉強の機会を得る」ということが含まれている。

• Fix SIGSEGV in CFileNameManager caused by stale share data pointer across test suites #2534

GitHub Actionsで発生したエラーを GitHub Copilot(≒AIアシスタント) に見て貰っている。
このエラーの原因は seg fault なので、「どこを修正すれば直ります。」を判断しづらいはず。

スパッと直せたら Copilot すげぇぇぇ！ になるよね。

ならんとは思うけど。

[berryzplus]

ん？ ExpandParameter_mixed の失敗が2回続けて再現しただと・・・？

[berryzplus]

OK。Copilot君正しい。　＞ #2534

Copilot すげぇぇぇ！ になった。

ただ、このまま入れるのは違う気がする。

[berryzplus]

さて。どうしたものか。

選択肢

• CFileNameManager が影響しない部分のみにして入れる
• CFileNameManager のシングルトンを解除してから入れる
• いったん取り下げる

最善は1つ目。
2つ目のシングルトン解除は現実的に無理。
3つ目をやるとこれまで通り、永遠に改善が完了しない。

[berryzplus]

テスト実行が完了しない不具合発生。（クリティカル。）

[berryzplus]

テストが完了しなかった理由は、以下。

トレイクリックメニューからGrepダイアログを表示し、OKボタンを押す
のテストから
共有メモリから履歴を読み込んでGrepダイアログにセットする
を削ったために、
OKボタンを押してもGrepダイアログが閉じられない
（検索条件を入力してくださいと表示される）
（Grepが実行されないので永遠に待機。）

仕方ないので、障害になってる部分を直す最低限の修正を入れてリトライ中。

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
96.2% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[berryzplus]

CFileNameManager以外の TSingleton も移行しておいたほうが良さげ。

[berryzplus]

トレイウィンドウのテストとしてはまだ問題が残っているけれど、メッセージ配送のテストはできているのでマージしてしまう。