GIMPにUIテストが導入されました
GIMP now has UI tests (gimp.org)
要約
GIMPは、インターフェースの変更によって発生するバグを早期に発見するため、新しいGUIテストプラットフォームを導入しました。これらのテストは、実際のGIMPを起動し、メニューやボタンを操作して結果を確認するもので、コントリビューターの変更がマージされるたびに自動的に実行されます。現在13のテストが存在し、Linux環境で動作しますが、将来的には他のOSへの対応も期待されています。
全文翻訳
グラフィカルユーザーインターフェースのテスト改善
GIMPには多くのメニュー、ダイアログ、ツールが絡み合っています。インターフェースの一部を変更すると、別の部分が動作しなくなる可能性があり、時にはユーザーが報告するまで問題が見過ごされることもあります。
これらの問題を早期に発見するために、新しいGUIテストプラットフォームが実装されました。典型的なGUIテストは、GIMPを起動し、メニューやボタンをクリックしてから、結果を確認します。これらのテストは、コントリビューターの変更がマージされるたびに自動的に実行されます。
なぜUIテストが必要なのか
GIMPにはすでに単体テストがあります。単体テストは、例えばGIMPがXCFファイルをどのように読み込むかといった、コードの小さな部分をチェックします。しかし、私たちの単体テストは実際のウィンドウを開くことはできませんでした。そのため、ダイアログが開くかどうか、あるいはメニュー項目がその役割を果たしたかどうかを知ることはできませんでした。
注意:GIMPにはすでにGUIコードのテストが存在していました。通常、これはコアコードに直接対話し、時には入力デバイスのイベント(ポインタの移動、クリック、ドラッグなど)をシミュレートすることさえありました。しかし、実際のインターフェースと対話することに勝るものはありません。さらに、このようなレガシーなテストはコアコードを直接ハイジャックするため、バグを検出するのではなく、しばしば壊れてしまうという独自の課題を抱えており、バグの全カテゴリを検出することができませんでした。
UIテストは、ユーザーがプログラムを使用するのと同じように、プログラム全体をチェックします。
テストの内容
各テストは実際のGIMPを起動し、1つの小さなタスクを実行します。その後、GIMPからの結果を読み取ります。結果が正しくない場合、テストは失敗し、何が問題だったかを通知します。
現時点では13のテストがあります。これらは以下のことを確認します:
- GIMPが起動し、メインウィンドウが表示されること。
- "起動時に表示" オプションをオフにした場合に、ウェルカムダイアログが正しいタブで開くこと。また、非表示のままであること。
- ファイル > 新規作成 で指定したサイズの画像が作成されること。
- ファイル > エクスポート で正しいPNGファイルが書き出されること。
- ツール > 色の交換 で前景と背景の色が交換されること。
- 色 ダイアログで新しい前景の色を入力できること。
- レイヤーを追加および削除できること。
- 元に戻す と やり直し が機能すること。
- ズームイン でズームレベルが変更されること。
- ツールボックスのツールボタンをクリックすると、そのツールが選択されること。その後、バケツ塗りつぶしツールがキャンバスで使用されること。
- 設定 での変更が OK をクリックしたときに保存されること。
- メニューアクション 画像 > 画像のフラット化 が機能すること。
仕組み
テストは画面を必要としません。各テストは小さく隠されたデスクトップを起動し、その中でGIMPを実行し、終了時にそれを削除します。このため、テストは画面がないCIサーバー上でも実行できます。
ボタンやメニューを見つけるために、テストは画面上のピクセルを見ているわけではありません。スクリーンリーダーのようなツールがGIMPから取得するアクセシビリティ情報を使用します。これにより、もう1つの良い結果が得られます。GIMPをテストしやすくすることで、スクリーンリーダーでの使用も容易になり、ソフトウェアのアクセシビリティが向上します。
テストには、UIテスト用のPythonツールである dogtail を使用しています。画面のないサーバーでGIMPを実行するために、dogtailには新しい機能が必要でした。私たちはこの機能を upstream に貢献し、他のプロジェクトでも利用できるようにしました。
現時点では、dogtail がWindowsやmacOSをサポートしていないため、テストはLinux(X11とWaylandの両方)でのみ実行されます。
これらの少数の簡単なテストを追加するだけで、GIMPのビルドが正常に機能したという信頼性が大幅に向上し、テストインフラストラクチャが機能的で有用であることが示されます。
謝辞
- Harsh Verma: UIテストと新しいdogtail機能を作成しました。
- Jehan: UIテストをレビューしました。
- Michal Odehnal: 新しいdogtail機能をレビューしました。
マージリクエスト !2909 で完全な変更内容を確認できます。
協力方法
13のテストは良いスタートですが、GIMPにはさらに多くのダイアログとツールがあります。協力したい場合は、あなたが最もよく使う部分のテストを作成できます。
新しいテストの作成方法と、テストが失敗した場合の原因の特定方法を示すガイドを作成しました:UIテスト on developer.gimp.org
この作業が、バグをより早期に発見し、GIMPがすべての人にとってうまく機能し続ける助けとなることを願っています。