Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: browser:e2eテストをモック用エンジンを使うように変更 #2442

Conversation

Hiroshiba
Copy link
Member

@Hiroshiba Hiroshiba commented Dec 27, 2024

内容

モック用エンジンを使ってブラウザe2eテストを書き換えます。
変更点は3つほどです。

  • エンジンURLをmock://mockとするとモック用エンジンが使えるように
  • .env.testでモック用エンジンを指定
  • ブラウザ版e2eで(Nemo)エンジンを起動しないように変更

関連 Issue

その他

が先に必要。

.github/workflows/test.ymlでやってるnemoエンジンダウンロードもなくせるかと思ったけど、まだelectron:e2e側が残ってるので難しそう。
electron:e2e側はエンジンプロセス起動もテストに含まれてるので、実際にプロセス起動できないといけなそう・・・。

@Hiroshiba Hiroshiba requested a review from a team as a code owner December 27, 2024 20:02
@Hiroshiba Hiroshiba requested a review from Copilot December 27, 2024 20:05

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 5 out of 7 changed files in this pull request and generated no comments.

Files not reviewed (2)
  • .env.test: Language not supported
  • tests/unit/backend/common/snapshots/configManager.spec.ts.snap: Language not supported
@voicevox-preview-pages
Copy link

voicevox-preview-pages bot commented Dec 27, 2024

🚀 プレビュー用ページを作成しました 🚀

更新時点でのコミットハッシュ:5ee1005

@Hiroshiba
Copy link
Member Author

ブラウザe2eテストを置き換えるにはmockの機能が足りなすぎたので、一旦draftにします。

"074fc39e-678b-4c13-8916-ffca8d505d1d": {
"00000000-0000-0000-0000-000000000000": {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

もともと.env.testを見ていたらしく、ついでに変わってしまった

playwright.config.ts Outdated Show resolved Hide resolved
Comment on lines -58 to +47
// テスト用にランダムな文字列を生成
const randomString = Math.random().toString(36).slice(-8);
const zenkakuRandomString = randomString.replace(/[\u0021-\u007e]/g, (s) => {
return String.fromCharCode(s.charCodeAt(0) + 0xfee0);
});
const targetString = "あいうえお";
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

未知語だと発音がなくなってしまうので、既知の言葉に

await textField.fill("1234");
await textField.fill("あれもこれもそれもどれも");
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

モックは助詞でアクセント句を区切るので、数字は正しくアクセントを区切れない。
ということで助詞だらけの言葉に置き換えました。

@Hiroshiba
Copy link
Member Author

全ブラウザテストがエンジンmockで通過 🎉

@Hiroshiba Hiroshiba marked this pull request as ready for review December 28, 2024 13:11
@Hiroshiba
Copy link
Member Author

Copy link
Member Author

@Hiroshiba Hiroshiba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

エンジンとモックそれぞれインスタンスがあって、それを URL に従ってスイッチするようになってます。
正確にはこんな感じ。

EngineFactory = EngineImpl()
MockFactory = MockImpl()

ConnectorFactory = () => {
  EngineFactory()
  MockFactory()
}

@Hiroshiba
Copy link
Member Author

ちょっと変更が多いので、run.exeの権限を変える部分のリファクタリングのPRと、.env.test-electronの切り出しのPRを別で投げたいと思います!

# CI環境でのe2eテスト用の.envファイル。CI時に値が上書きされる。
# CI環境でのelectronテスト用の.envファイル。CI時に値が上書きされる。
Copy link
Member Author

@Hiroshiba Hiroshiba Jan 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ブラウザe2eはエンジンモックにしたので、electron専用にしました。

@@ -50,17 +50,12 @@ async function validateInputTag(
test("「設定」→「読み方&アクセント辞書」で「読み方&アクセント辞書」ページが表示される", async ({
page,
}) => {
test.skip(!process.env.CI, "環境変数CIが未設定のためスキップします");
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mockになって辞書テストが環境を汚さなくなったのでローカルでも実行するように

@Hiroshiba Hiroshiba marked this pull request as ready for review January 4, 2025 13:03
@Hiroshiba
Copy link
Member Author

変更箇所で独立させれるものはできる限り別プルリクエストで出し、マージもされたのでレビュー可能になったと思います!!

@sevenc-nanashi すみません、もしよかったらレビューいただけると・・・! 🙇
モックエンジンを使う構造部分も変更に含まれているので、そこ周りとか見ていただきたみ。

Copy link
Member

@sevenc-nanashi sevenc-nanashi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

特に問題は無さそう。

@Hiroshiba
Copy link
Member Author

レビューありがとうございます!!! マージします!!!

@Hiroshiba Hiroshiba enabled auto-merge January 4, 2025 15:01
@Hiroshiba Hiroshiba added this pull request to the merge queue Jan 4, 2025
Merged via the queue into VOICEVOX:main with commit 11c2e16 Jan 4, 2025
11 checks passed
@Hiroshiba Hiroshiba deleted the モック用エンジンを使ったe2eテストに差し替え branch January 16, 2025 10:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants