tests1.exe の依存ライブラリに gmock.lib を追加する

[kengoide]

PR の目的

test1.exe で Google Mock を使用できるようにします。

カテゴリ

• ビルド関連
  • ビルド手順
  • Azure Pipelines
  • AppVeyor
  • GitHub Actions
  • ローカルビルド
• その他の問題

PR の背景

#1707 (CClipboard のテスト) の検討中、実行するとクリップボードを書き換えてしまうテストは不便であるとの指摘がありました。対策として OS のクリップボード関数を模擬するモックの導入を検討しています。

現在のサクラエディタのビルドシステムでは Google Test と同時に Google Mock のビルドを行っているため、成果物である gmock.lib と gmock_main.lib をリンクするように指定するだけで使えるようになる…ということではないかと思っていますが、個人的に経験の薄い分野ですので正しい方策が判断できません。紆余曲折 (#894, #899) もあったように見受けられますし、詳しい方の見解を伺いたいと考えています。

「このやり方だとあれが動きません」といったご指摘をお待ちしています。

PR のメリット

• 自動テストで Google Mock が使えるようになります。

PR のデメリット

[AppVeyorBot]

✅ Build sakura 1.0.4032 completed (commit 4216b92298 by @k-kagari)

[berryzplus]

gtest_main.libとgmock_main.libは排他関係にあるはずです。
記憶が確かなら、どちらも以下のような疑似コードが書かれているライブラリなはず。

int main(int argc, char* argv[]) {
return ライブラリ初期化関数(argc, argv);
}

上記の仕様的な部分からして、これらのライブラリは「独自に定義されたmain関数」とも競合します。
どれを使ったら効率がよいか？はプロジェクトによると思います。
サクラエディタの場合、既にgtest_main.libをリンクしてるので、gmock_main.libはリンクしなくていいんじゃないかと思います。。。

あとはこの辺を読んで分かった気になる感じだと思います。
http://opencv.jp/googlemockdocs/fordummies.html

[AppVeyorBot]

❌ Build sakura 1.0.4034 failed (commit 09a35f5409 by @k-kagari)

[kengoide]

サクラエディタの場合、既にgtest_main.libをリンクしてるので、gmock_main.libはリンクしなくていいんじゃないかと思います。。。

調べてみたところ gtest_main.lib すらも不要なのかもしれません。code-main.cpp で明示的に InitGoogleTest を呼んでいるため。

[AppVeyorBot]

✅ Build sakura 1.0.4036 completed (commit 45a09bf473 by @k-kagari)

[ghost]

サクラエディタの場合、既にgtest_main.libをリンクしてるので、gmock_main.libはリンクしなくていいんじゃないかと思います。。。

調べてみたところ gtest_main.lib すらも不要なのかもしれません。code-main.cpp で明示的に InitGoogleTest を呼んでいるため。

ファイル名に_mainが含まれるライブラリは、既定のmain関数を利用するときに使うものらしいので、独自にmain関数を書いているサクラエディタではgtest_main.libは不要だと思います。

よってリンクするのはgtest.libとgmock.libの二つで良いです。

※最新のGoogleTestのドキュメント：https://google.github.io/googletest/primer.html#writing-the-main-function

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

100.0% Coverage
0.0% Duplication

[kengoide]

CI が通ったのでドラフト外します。本 PR の変更点は以下の通りです。

• tests1.exe に gmock.lib をリンクする指定を追加した。
• 不要だった gtest_main.lib のリンクをやめた。
• InitGoogleTest の呼び出しを InitGoogleMock で置き換えた。

[ghost]

CIがまだ終わっていませんが、LGTMです。

[ghost]

InitGoogleTest の呼び出しを InitGoogleMock で置き換えた。

GoogleMockのソースを見たところ、InitGoogleMockの中のこのあたりでInitGoogleTestが呼ばれているので大丈夫だと思いました。
それでも「個別に呼び出すべきだ」という人はいるかもしれません。

[AppVeyorBot]

✅ Build sakura 1.0.4037 completed (commit 4893f484b2 by @k-kagari)

[kengoide]

それでも「個別に呼び出すべきだ」という人はいるかもしれません。

  // Since Google Mock depends on Google Test, InitGoogleMock() is
  // also responsible for initializing Google Test.  Therefore there's
  // no need for calling testing::InitGoogleTest() separately.
  testing::InitGoogleMock(&argc, argv);

gmock_main.cc のコメントで no need だと明言されているので問題にならないと判断しました。もし納得しない人がいたとしてもこのコメントを盾にして説得します。😎

[kengoide]

レビューありがとうございました。マージしてみて問題があれば適宜修正するか revert して対処します。

[AppVeyorBot]

❌ Build sakura 1.0.4038 failed (commit d87641c744 by @k-kagari)

[berryzplus]

InitGoogleTest の呼び出しを InitGoogleMock で置き換えた。

GoogleMockのソースを見たところ、InitGoogleMockの中のこのあたりでInitGoogleTestが呼ばれているので大丈夫だと思いました。 それでも「個別に呼び出すべきだ」という人はいるかもしれません。

ここが少し不安でしたが、ソースで確認できたなら安心です。

あとは CClipboard で使ってるクリップボード関数をモック化けるしてテスト書くぞ～！ですが、これまでやったことのない種類の変更なので、どうすすめるか考えないとあかん気がします。。。