文字幅キャッシュのテストを追加する

[kengoide]

PR の目的

charset/charcode.cpp にある文字幅キャッシュ機構の自動テストを追加します。

カテゴリ

• その他の問題

PR の背景

文字幅キャッシュとは、一度計算した文字の表示幅を保存して再利用する仕組みです。サクラエディタでは文字のレイアウト位置の計算に加え、半角と全角の区別や、文字種の判定にも利用しています。

用途が多いためコールグラフの奥深くでこれを呼んでいるコードパスが大量に存在しますが、この仕組みはグローバル変数に依存しており、間接的な依存関係を持つコードのテストが書きづらくなっています。なるべくグローバルな状態に依存しない形に書き換えていきたいため、作業の準備として現状をそのまま反映したテストを整備したい、というのが目的です。

PR のメリット

• コードカバレッジが向上します。
• リファクタリングが安全に行えるようになります。

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

• 自動テストが GDI に依存するようになります。
  • 環境次第では失敗するかもしれません。
  • 他のAPIに切り替える際には手当てが必要です。

PR の影響範囲

テストコードのみの追加です。既存のコードに影響することはありません。

[AppVeyorBot]

✅ Build sakura 1.0.3368 completed (commit e32e1549b2 by @k-kagari)

[AppVeyorBot]

✅ Build sakura 1.0.3369 completed (commit 5b26ac8c94 by @k-kagari)

[sanomari]

いいですね。

実装も見てみましたが変なところはなさそうです。
これでいいの？を証明できるものは何もありませんが、きっと合ってそうです。

[berryzplus]

PR のメリット

• コードカバレッジが向上します。

https://github.com/sakura-editor/sakura/pull/1514/checks?check_run_id=1754762623

カバレッジは向上していないように見えます。
11.2% ⇒ 11.2%

なぜ向上しないかというと、テスト対象コードがエディタの初期表示の際に実行されるものだからです。現在のtests1.exeは、本来の単体テストでは絶対に実行できないコードを動かすテストが存在しています。なので、実行結果はチェックしていないけどコード実行自体は既に行っていたことになり、カバレッジが上がらない結果になったわけです。

テストコードの正当性という意味では、
'a'とか'あ'ではなくて、
「半角文字」と「半角以外の文字」で可能な限りの総当たりテストをやっとくのがベターだと思います。

[kengoide]

レビューありがとうございました。

これでいいの？を証明できるものは何もありませんが、きっと合ってそうです。

「これで本当にいいの？」と問われると歯切れのいい回答はできません…。

テストコードの正当性という意味では、
'a'とか'あ'ではなくて、
「半角文字」と「半角以外の文字」で可能な限りの総当たりテストをやっとくのがベターだと思います。

思案しましたが、どこまでやるのかについて納得のいく案が浮かびませんでした。ローカルでカバレッジをとる作業を怠ったせいで今回のテストでは通らないままになってしまったパスがありまして、それらに対するテストを追補することで実効性を高めていきたいと思います。

[kengoide]

あ、conflict解消すると再レビュー要るんですね…。rebaseします。

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[AppVeyorBot]

✅ Build sakura 1.0.3375 completed (commit 274b8f8157 by @k-kagari)

[AppVeyorBot]

✅ Build sakura 1.0.3376 completed (commit 555b75689f by @k-kagari)

[kengoide]

tests1.vcxproj.filters のコンフリクトの解決を行いました。お手数ですが再レビューをお願いします。

[berryzplus]

問題ないと思います。

従来は実行はしても結果の確認はしてなかったので、入れる意味は十分にあると思っています。どうだったら正当なのか？は別な話かも知れません。

[kengoide]

マージしました。ありがとうございました。