add downloadable library test

test/test_downloadable_library.py

@@ -0,0 +1,162 @@
+import glob
+from io import BytesIO
+import copy
+import json
+import os
+
+from pathlib import Path
+from tempfile import TemporaryDirectory
+from unittest import TestCase
+from zipfile import ZipFile
+
+from fastapi import HTTPException
+
+from voicevox_engine.downloadable_library import LibraryManager
+
+
+vvlib_manifest_name = "vvlib_manifest.json"
+
+class TestLibraryManager(TestCase):
+    def setUp(self):
+        super().setUp()
+        self.tmp_dir = TemporaryDirectory()
+        self.tmp_dir_path = Path(self.tmp_dir.name)
+        self.engine_name = "Test Engine"
+        self.library_manger = LibraryManager(
+            self.tmp_dir_path,
+            "0.15.0",
+            "Test",
+            self.engine_name,
+            "c7b58856-bd56-4aa1-afb7-b8415f824b06",
+        )
+        self.library_filename = "test/test.vvlib"
+        with open("test/vvlib_manifest.json") as f:
+            self.vvlib_manifest = json.loads(f.read())
+            self.library_uuid = self.vvlib_manifest["uuid"]
+        with ZipFile(self.library_filename, "w") as zf:
+            speaker_infos = glob.glob("speaker_info/**", recursive=True)
+            for info in speaker_infos:
+                zf.write(info)
+            zf.writestr(vvlib_manifest_name, json.dumps(self.vvlib_manifest))
+        self.library_file = open(self.library_filename, "br")
+
+    def tearDown(self):
+        self.tmp_dir.cleanup()
+        self.library_file.close()
+        os.remove(self.library_filename)
+
+    def reload_library_file(self):
+        self.library_file.close()
+        self.library_file = open(self.library_filename, "br")
+
+    def create_vvlib_without_manifest(self, filename: str):
+        with ZipFile(filename, "w") as zf_out,  ZipFile(self.library_filename, "r") as zf_in:
+            for file in zf_in.infolist():
+                buffer = zf_in.read(file.filename)
+                if file.filename != vvlib_manifest_name:
+                    zf_out.writestr(file, buffer)
+
+    def test_installed_libraries(self):
+        self.assertEqual(self.library_manger.installed_libraries(), {})
+
+        self.library_manger.install_library(
+            self.library_uuid,
+            self.library_file,
+        )
+        # 内容はdownloadable_library.jsonを元に生成されるので、内容は確認しない
+        self.assertEqual(list(self.library_manger.installed_libraries().keys())[0], self.library_uuid)
+
+        self.library_manger.uninstall_library(self.library_uuid)
+        self.assertEqual(self.library_manger.installed_libraries(), {})
+
+    def test_install_library(self):
+        with self.assertRaises(HTTPException) as e:
+            self.library_manger.install_library("52398bd5-3cc3-406c-a159-dfec5ace4bab", self.library_file)
+        self.assertEqual(e.exception.detail, "指定された音声ライブラリが見つかりません。")
+
+        with self.assertRaises(HTTPException) as e:
+            self.library_manger.install_library(self.library_uuid, BytesIO())
+        self.assertEqual(e.exception.detail, "不正なZIPファイルです。")
+
+        invalid_vvlib_name = "test/invalid.vvlib"
+        self.create_vvlib_without_manifest(invalid_vvlib_name)
+
+        with open(invalid_vvlib_name, "br") as f, self.assertRaises(HTTPException) as e:
+            self.library_manger.install_library(self.library_uuid, f)
+        self.assertEqual(e.exception.detail, "指定された音声ライブラリにvvlib_manifest.jsonが存在しません。")
+
+        self.create_vvlib_without_manifest(invalid_vvlib_name)
+        with ZipFile(invalid_vvlib_name, "a") as zf:
+            zf.writestr(vvlib_manifest_name, "test")
+
+        with open(invalid_vvlib_name, "br") as f, self.assertRaises(HTTPException) as e:
+            self.library_manger.install_library(self.library_uuid, f)
+        self.assertEqual(e.exception.detail, "指定された音声ライブラリのvvlib_manifest.jsonは不正です。")
+
+        invalud_vvlib_manifest = copy.deepcopy(self.vvlib_manifest)
+        invalud_vvlib_manifest["version"] = 10
+        # Duplicate name: 'vvlib_manifest.json'とWarningを吐かれるので、作り直す
+        self.create_vvlib_without_manifest(invalid_vvlib_name)
+        with ZipFile(invalid_vvlib_name, "a") as zf:
+            zf.writestr(vvlib_manifest_name, json.dumps(invalud_vvlib_manifest))
+
+        with open(invalid_vvlib_name, "br") as f, self.assertRaises(HTTPException) as e:
+            self.library_manger.install_library(self.library_uuid, f)
+        self.assertEqual(e.exception.detail, "指定された音声ライブラリのvvlib_manifest.jsonに不正なデータが含まれています。")
+
+        invalud_vvlib_manifest["version"] = "10"
+        # Duplicate name: 'vvlib_manifest.json'とWarningを吐かれるので、作り直す
+        self.create_vvlib_without_manifest(invalid_vvlib_name)
+        with ZipFile(invalid_vvlib_name, "a") as zf:
+            zf.writestr(vvlib_manifest_name, json.dumps(invalud_vvlib_manifest))
+
+        with open(invalid_vvlib_name, "br") as f, self.assertRaises(HTTPException) as e:
+            self.library_manger.install_library(self.library_uuid, f)
+        self.assertEqual(e.exception.detail, "指定された音声ライブラリのversionが不正です。")
+
+        invalud_vvlib_manifest["version"] = "0.0.1"
+        invalud_vvlib_manifest["manifest_version"] = "10"
+        # Duplicate name: 'vvlib_manifest.json'とWarningを吐かれるので、作り直す
+        self.create_vvlib_without_manifest(invalid_vvlib_name)
+        with ZipFile(invalid_vvlib_name, "a") as zf:
+            zf.writestr(vvlib_manifest_name, json.dumps(invalud_vvlib_manifest))
+
+        with open(invalid_vvlib_name, "br") as f, self.assertRaises(HTTPException) as e:
+            self.library_manger.install_library(self.library_uuid, f)
+        self.assertEqual(e.exception.detail, "指定された音声ライブラリのmanifest_versionが不正です。")
+
+        invalud_vvlib_manifest["manifest_version"] = "999.999.999"
+        self.create_vvlib_without_manifest(invalid_vvlib_name)
+        with ZipFile(invalid_vvlib_name, "a") as zf:
+            zf.writestr(vvlib_manifest_name, json.dumps(invalud_vvlib_manifest))
+
+        with open(invalid_vvlib_name, "br") as f, self.assertRaises(HTTPException) as e:
+            self.library_manger.install_library(self.library_uuid, f)
+        self.assertEqual(e.exception.detail, "指定された音声ライブラリは未対応です。")
+
+        invalud_vvlib_manifest["manifest_version"] = self.vvlib_manifest["manifest_version"]
+        invalud_vvlib_manifest["engine_uuid"] = "26f7823b-20c6-40c5-bf86-6dd5d9d45c18"
+        self.create_vvlib_without_manifest(invalid_vvlib_name)
+        with ZipFile(invalid_vvlib_name, "a") as zf:
+            zf.writestr(vvlib_manifest_name, json.dumps(invalud_vvlib_manifest))
+
+        with open(invalid_vvlib_name, "br") as f, self.assertRaises(HTTPException) as e:
+            self.library_manger.install_library(self.library_uuid, f)
+        self.assertEqual(e.exception.detail, f"指定された音声ライブラリは{self.engine_name}向けではありません。")
+
+        # 正しいライブラリをインストールして問題が起きないか
+        library_path = self.library_manger.install_library(self.library_uuid, self.library_file)
+        self.assertEqual(self.tmp_dir_path / self.library_uuid, library_path)
+
+        self.library_manger.uninstall_library(self.library_uuid)
+
+        os.remove(invalid_vvlib_name)
+
+    def test_uninstall_library(self):
+        # TODO: アンインストール出来ないライブラリをテストできるようにしたい
+        with self.assertRaises(HTTPException) as e:
+            self.library_manger.uninstall_library(self.library_uuid)
+        self.assertEqual(e.exception.detail, "指定された音声ライブラリはインストールされていません。")
+
+        self.library_manger.install_library(self.library_uuid, self.library_file)
+        self.library_manger.uninstall_library(self.library_uuid)

test/vvlib_manifest.json

@@ -0,0 +1,9 @@
+{
+    "manifest_version": "0.15.0",
+    "name": "Test vvlib",
+    "version": "0.0.1",
+    "uuid": "2bb8bccf-1c3f-4bc9-959a-f388e37af3ad",
+    "engine_name": "Test Engine",
+    "brand_name": "Test",
+    "engine_uuid": "c7b58856-bd56-4aa1-afb7-b8415f824b06"
+}