Merge pull request #782 from keisuke-umezawa/feature/add-e2e-test-journal-storage

Add e2e test for loading journal storage in standalone app

.github/workflows/e2e-standalone-tests.yml

@@ -31,6 +31,12 @@ jobs:
         with:
           node-version: '18'
 
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.10'
+          architecture: x64
+
       - name: Setup Optuna ${{ matrix.optuna-version }}
         run: |
           python -m pip install --progress-bar off --upgrade pip setuptools

e2e_tests/test_standalone/test_study_list.py

@@ -1,10 +1,12 @@
 import os
 import tempfile
 
+import optuna
 from playwright.sync_api import Page
 import pytest
 
 from ..test_server import make_standalone_server
+from ..utils import count_components
 
 
 @pytest.fixture
@@ -25,31 +27,40 @@ def test_home(
     assert title == "Optuna Dashboard (Wasm ver.)"
 
 
+def create_storage_file(filename: str, study_name: str, storage_type: str):
+    if storage_type == "rdb":
+        storage = optuna.storages.RDBStorage(f"sqlite:///{filename}")
+    elif storage_type == "journal":
+        storage = optuna.storages.JournalStorage(
+            optuna.storages.JournalFileStorage(f"{filename}"),
+        )
+    else:
+        assert False, f"Got an unexpected storage_type={storage_type}."
+
+    study = optuna.create_study(study_name=study_name, storage=storage)
+
+    def objective(trial: optuna.Trial) -> float:
+        x1 = trial.suggest_float("x1", 0, 10)
+        x2 = trial.suggest_float("x2", 0, 10)
+        return (x1 - 2) ** 2 + (x2 - 5) ** 2
+
+    study.optimize(objective, n_trials=100)
+
+
+@pytest.mark.parametrize("storage_type", ["rdb", "journal"])
 def test_load_storage(
     page: Page,
     server_url: str,
+    storage_type: str,
 ) -> None:
     study_name = "single-objective"
     url = f"{server_url}"
 
-    def create_storage_file(filename: str):
-        import optuna
-
-        storage = optuna.storages.RDBStorage(f"sqlite:///{filename}")
-        study = optuna.create_study(study_name=study_name, storage=storage)
-
-        def objective(trial: optuna.Trial) -> float:
-            x1 = trial.suggest_float("x1", 0, 10)
-            x2 = trial.suggest_float("x2", 0, 10)
-            return (x1 - 2) ** 2 + (x2 - 5) ** 2
-
-        study.optimize(objective, n_trials=100)
-
     with tempfile.TemporaryDirectory() as dir:
         with tempfile.NamedTemporaryFile() as fp:
             filename = fp.name
             path = os.path.join(dir, filename)
-            create_storage_file(filename)
+            create_storage_file(filename, study_name, storage_type)
             page.goto(url)
             with page.expect_file_chooser() as fc_info:
                 page.get_by_role("button").filter(has_text="Storage").click()
@@ -58,14 +69,5 @@ def test_load_storage(
 
         page.get_by_role("link", name=study_name).click()
 
-        def count_components(page: Page, component_name: str):
-            component_count = page.evaluate(
-                f"""() => {{
-                const components = document.querySelectorAll('.{component_name}');
-                return components.length;
-            }}"""
-            )
-            return component_count
-
         count = count_components(page, "MuiCard-root")
         assert count == 4

e2e_tests/utils.py

@@ -1,9 +1,20 @@
 from optuna_dashboard._storage import trials_cache
 from optuna_dashboard._storage import trials_cache_lock
 from optuna_dashboard._storage import trials_last_fetched_at
+from playwright.sync_api import Page
 
 
 def clear_inmemory_cache() -> None:
     with trials_cache_lock:
         trials_cache.clear()
         trials_last_fetched_at.clear()
+
+
+def count_components(page: Page, component_name: str):
+    component_count = page.evaluate(
+        f"""() => {{
+        const components = document.querySelectorAll('.{component_name}');
+        return components.length;
+    }}"""
+    )
+    return component_count