整理: e2e single API テスト vol 7 (#1165)

* refactor: e2e single API スナップショットテストを追加 * fix: コメントフォーマット統一 * fix: format
VOICEVOX · Apr 30, 2024 · 05478f7 · 05478f7
1 parent c0305ff
commit 05478f7
Show file tree

Hide file tree

Showing 21 changed files with 210 additions and 18 deletions.
diff --git a/test/e2e/single_api/__snapshots__/test_core_versions/test_get_core_versions_200.json b/test/e2e/single_api/__snapshots__/test_core_versions/test_get_core_versions_200.json
diff --git a/...ngine_manifest/test_エンジンマニフェストを取得できる.json → ...anifest/test_get_engine_manifest_200.json b/...ngine_manifest/test_エンジンマニフェストを取得できる.json → ...anifest/test_get_engine_manifest_200.json
diff --git a/...le_api/__snapshots__/test_is_initialized_speaker/test_get_is_initialized_speaker_200.json b/...le_api/__snapshots__/test_is_initialized_speaker/test_get_is_initialized_speaker_200.json
diff --git a/test/e2e/single_api/__snapshots__/test_setting_api.ambr b/test/e2e/single_api/__snapshots__/test_setting_api.ambr
@@ -1,5 +1,5 @@
 # serializer version: 1
-# name: test_setting画面が取得できる
+# name: test_get_setting_200
   '''
   <!DOCTYPE html>
 

diff --git a/test/e2e/single_api/__snapshots__/test_singer_info/test_get_singer_info_200.json b/test/e2e/single_api/__snapshots__/test_singer_info/test_get_singer_info_200.json
diff --git a/test/e2e/single_api/__snapshots__/test_singers/test_get_singers_200.json b/test/e2e/single_api/__snapshots__/test_singers/test_get_singers_200.json
diff --git a/test/e2e/single_api/__snapshots__/test_speaker_info/test_get_speaker_info_200.json b/test/e2e/single_api/__snapshots__/test_speaker_info/test_get_speaker_info_200.json
diff --git a/test/e2e/single_api/__snapshots__/test_speakers/test_get_speakers_200.json b/test/e2e/single_api/__snapshots__/test_speakers/test_get_speakers_200.json
diff --git a/test/e2e/single_api/__snapshots__/test_supported_devices/test_get_supported_devices_200.json b/test/e2e/single_api/__snapshots__/test_supported_devices/test_get_supported_devices_200.json
diff --git a/test/e2e/single_api/__snapshots__/test_version/test_get_version_200.json b/test/e2e/single_api/__snapshots__/test_version/test_get_version_200.json
diff --git a/test/e2e/single_api/test_core_versions.py b/test/e2e/single_api/test_core_versions.py
@@ -3,8 +3,12 @@
 """
 
 from fastapi.testclient import TestClient
+from syrupy.assertion import SnapshotAssertion
 
 
-def test_get_core_versions_200(client: TestClient) -> None:
+def test_get_core_versions_200(
+    client: TestClient, snapshot_json: SnapshotAssertion
+) -> None:
     response = client.get("/core_versions", params={})
     assert response.status_code == 200
+    assert snapshot_json == response.json()
diff --git a/test/e2e/single_api/test_engine_manifest.py b/test/e2e/single_api/test_engine_manifest.py
@@ -1,5 +1,5 @@
 """
-/engine_manifest APIのテスト
+/engine_manifest API のテスト
 """
 
 from test.utility import hash_long_string
@@ -8,7 +8,7 @@
 from syrupy.assertion import SnapshotAssertion
 
 
-def test_エンジンマニフェストを取得できる(
+def test_get_engine_manifest_200(
     client: TestClient, snapshot_json: SnapshotAssertion
 ) -> None:
     response = client.get("/engine_manifest")

diff --git a/test/e2e/single_api/test_initialize_speaker.py b/test/e2e/single_api/test_initialize_speaker.py
@@ -8,3 +8,4 @@
 def test_post_initialize_speaker_204(client: TestClient) -> None:
     response = client.post("/initialize_speaker", params={"speaker": 0})
     assert response.status_code == 204
+    # `204 No Content` であるためスナップショットテストは不要
diff --git a/test/e2e/single_api/test_is_initialized_speaker.py b/test/e2e/single_api/test_is_initialized_speaker.py
@@ -3,8 +3,12 @@
 """
 
 from fastapi.testclient import TestClient
+from syrupy.assertion import SnapshotAssertion
 
 
-def test_get_is_initialized_speaker_200(client: TestClient) -> None:
+def test_get_is_initialized_speaker_200(
+    client: TestClient, snapshot_json: SnapshotAssertion
+) -> None:
     response = client.get("/is_initialized_speaker", params={"speaker": 0})
     assert response.status_code == 200
+    assert snapshot_json == response.json()
diff --git a/test/e2e/single_api/test_setting_api.py b/test/e2e/single_api/test_setting_api.py
@@ -1,14 +1,13 @@
 """
-setting APIのテスト
+/setting API のテスト
 """
 
 from fastapi.testclient import TestClient
 from syrupy.assertion import SnapshotAssertion
 
 
-def test_setting画面が取得できる(
-    client: TestClient, snapshot: SnapshotAssertion
-) -> None:
+def test_get_setting_200(client: TestClient, snapshot: SnapshotAssertion) -> None:
     response = client.get("/setting")
     assert response.status_code == 200
+    # HTML string をテスト
     assert snapshot == response.content.decode("utf-8")
diff --git a/test/e2e/single_api/test_singer_info.py b/test/e2e/single_api/test_singer_info.py
@@ -2,11 +2,17 @@
 /singer_info API のテスト
 """
 
+from test.utility import hash_long_string
+
 from fastapi.testclient import TestClient
+from syrupy.assertion import SnapshotAssertion
 
 
-def test_get_singer_info_200(client: TestClient) -> None:
+def test_get_singer_info_200(
+    client: TestClient, snapshot_json: SnapshotAssertion
+) -> None:
     response = client.get(
         "/singer_info", params={"speaker_uuid": "b1a81618-b27b-40d2-b0ea-27a9ad408c4b"}
     )
     assert response.status_code == 200
+    assert snapshot_json == hash_long_string(response.json())
diff --git a/test/e2e/single_api/test_singers.py b/test/e2e/single_api/test_singers.py
@@ -3,8 +3,10 @@
 """
 
 from fastapi.testclient import TestClient
+from syrupy.assertion import SnapshotAssertion
 
 
-def test_get_singers_200(client: TestClient) -> None:
+def test_get_singers_200(client: TestClient, snapshot_json: SnapshotAssertion) -> None:
     response = client.get("/singers", params={})
     assert response.status_code == 200
+    assert snapshot_json == response.json()
diff --git a/test/e2e/single_api/test_speaker_info.py b/test/e2e/single_api/test_speaker_info.py
@@ -2,11 +2,17 @@
 /speaker_info API のテスト
 """
 
+from test.utility import hash_long_string
+
 from fastapi.testclient import TestClient
+from syrupy.assertion import SnapshotAssertion
 
 
-def test_get_speaker_info_200(client: TestClient) -> None:
+def test_get_speaker_info_200(
+    client: TestClient, snapshot_json: SnapshotAssertion
+) -> None:
     response = client.get(
         "/speaker_info", params={"speaker_uuid": "388f246b-8c41-4ac1-8e2d-5d79f3ff56d9"}
     )
     assert response.status_code == 200
+    assert snapshot_json == hash_long_string(response.json())
diff --git a/test/e2e/single_api/test_speakers.py b/test/e2e/single_api/test_speakers.py
@@ -3,8 +3,10 @@
 """
 
 from fastapi.testclient import TestClient
+from syrupy.assertion import SnapshotAssertion
 
 
-def test_get_speakers_200(client: TestClient) -> None:
+def test_get_speakers_200(client: TestClient, snapshot_json: SnapshotAssertion) -> None:
     response = client.get("/speakers", params={})
     assert response.status_code == 200
+    assert snapshot_json == response.json()
diff --git a/test/e2e/single_api/test_supported_devices.py b/test/e2e/single_api/test_supported_devices.py
@@ -3,8 +3,12 @@
 """
 
 from fastapi.testclient import TestClient
+from syrupy.assertion import SnapshotAssertion
 
 
-def test_get_supported_devices_200(client: TestClient) -> None:
+def test_get_supported_devices_200(
+    client: TestClient, snapshot_json: SnapshotAssertion
+) -> None:
     response = client.get("/supported_devices", params={})
     assert response.status_code == 200
+    assert snapshot_json == response.json()
diff --git a/test/e2e/single_api/test_version.py b/test/e2e/single_api/test_version.py
@@ -3,11 +3,10 @@
 """
 
 from fastapi.testclient import TestClient
+from syrupy.assertion import SnapshotAssertion
 
-from voicevox_engine import __version__
 
-
-def test_get_version_200(client: TestClient) -> None:
+def test_get_version_200(client: TestClient, snapshot_json: SnapshotAssertion) -> None:
     response = client.get("/version", params={})
     assert response.status_code == 200
-    assert response.json() == __version__
+    assert snapshot_json == response.json()