new-features (#5)

* refactoring and rework: runner now has setups / tests / cleanups as lists
* add nextcloud runner
* add email testing prototype with imap fixture
* add dependency resolution (sort env files in input so that test order is correct)

Reviewed-on: local-it-infrastructure/e2e_tests#5
Co-authored-by: Daniel <d.brummerloh@gmail.com>
Co-committed-by: Daniel <d.brummerloh@gmail.com>

src/tests_wordpress/conftest.py

@@ -1 +1,34 @@
-from src.tests_authentik.fixtures_authentik import admin_context, authentik_admin_page, user_context
+import json
+
+import pytest
+from dotenv import dotenv_values
+from playwright.sync_api import BrowserContext, Page
+
+from src.dirmanager import DirManager
+
+# from src.tests_authentik.fixtures_authentik import (
+#     authentik_admin_context,
+#     authentik_admin_page,
+#     authentik_user_context,
+#     authentik_user_page,
+# )
+
+pytest_plugins = "src.tests_authentik.fixtures_authentik"
+
+
+@pytest.fixture
+def wordpress_admin_context(context: BrowserContext, DIR: DirManager) -> BrowserContext:
+    state_file = DIR.STATES / "wordpress_admin_state.json"
+    storage_state = json.loads(state_file.read_bytes())
+    context.add_cookies(storage_state["cookies"])
+    return context
+
+
+@pytest.fixture
+def wordpress_admin_page(wordpress_admin_context: BrowserContext, DIR: DirManager) -> Page:
+    page = wordpress_admin_context.new_page()
+    env_file = DIR.ENV_FILES / "wordpress"
+    config: dict[str, str] = dotenv_values(env_file)  # type: ignore
+    url = "https://" + config["DOMAIN"]
+    page.goto(url)
+    return page

src/tests_wordpress/runner_wordpress.py

@@ -1,4 +1,4 @@
-from src.runner import Runner, SubTest
+from src.runner import Runner, Test
 from src.tests_authentik.runner_authentik import RunnerAuthentik
 
 
@@ -20,9 +20,9 @@ def condition_has_locale(dotenv_config: dict[str, str]) -> bool:
 class RunnerWordpress(Runner):
     name = "wordpress"
     test_dir_name = "tests_wordpress"
-    main_test_name = "test_wordpress.py"
     dependencies: list[type[Runner]] = [RunnerAuthentik]
-    sub_tests = [
-        SubTest(condition=condition_has_locale, test_file="test_wordpress_localization.py"),
+    setups = [Test(test_file="setup_wordpress.py")]
+    tests = [
+        Test(test_file="test_wordpress.py"),
+        Test(condition=condition_has_locale, test_file="test_wordpress_localization.py"),
     ]
-    prevent_skip = True

src/tests_wordpress/setup_wordpress.py

@@ -0,0 +1,30 @@
+import pytest
+from playwright.sync_api import BrowserContext, Page, expect
+
+from src.dirmanager import DirManager
+
+
+@pytest.mark.xfail(reason="wordpress sso login has not been generated")
+def test_visit_from_domain(authentik_admin_context: BrowserContext, dotenv_config: dict[str, str]):
+    """visit wordpress directly with admin_session, expect not to be logged in"""
+    page = authentik_admin_context.new_page()
+    url = "https://" + dotenv_config["DOMAIN"]
+    page.goto(url)
+    # look for content wrapper
+    expect(page.locator("#wpcontent")).to_be_visible(timeout=3_000)
+    # look for admin bar
+    expect(page.locator("#wpadminbar")).to_be_visible(timeout=3_000)
+
+
+def setup_wordpress_admin_session(authentik_admin_page: Page, DIR: DirManager):
+    """visit wordpress from authentik with admin_session to create wordpress_admin_session"""
+    with authentik_admin_page.expect_popup() as event_context:
+        authentik_admin_page.get_by_role("link", name="Wordpress").click()
+    page_wordpress = event_context.value
+    # look for content wrapper
+    expect(page_wordpress.locator("#wpcontent")).to_be_visible()
+    # look for admin bar
+    expect(page_wordpress.locator("#wpadminbar")).to_be_visible()
+    # save session
+    context = page_wordpress.context
+    context.storage_state(path=f"{DIR.STATES}/wordpress_admin_state.json")

src/tests_wordpress/test_wordpress.py

@@ -1,13 +0,0 @@
-from playwright.sync_api import Page, expect
-
-
-def test_visit_from_authentik(authentik_admin_page: Page):
-    with authentik_admin_page.expect_popup() as event_context:
-        authentik_admin_page.get_by_role("link", name="Wordpress").click()
-    page_wordpress = event_context.value
-
-    # look for content wrapper
-    expect(page_wordpress.locator("#wpcontent")).to_be_visible()
-
-    # look for admin bar
-    expect(page_wordpress.locator("#wpadminbar")).to_be_visible()

src/tests_wordpress/test_wordpress_localization.py

@@ -5,11 +5,11 @@ from playwright.sync_api import BrowserContext, expect
 from src.dirmanager import DirManager
 
 
-def test_welcome_message(user_context: BrowserContext, dotenv_config: dict[str, str], DIR: DirManager):
-    page = user_context.new_page()
+def test_welcome_message(context: BrowserContext, dotenv_config: dict[str, str], DIR: DirManager):
+    page = context.new_page()
     url = "https://" + dotenv_config["DOMAIN"]
     page.goto(url)
 
-    expect(page.locator("#wpcontent")).to_be_visible()
+    expect(page.locator(".wp-block-heading")).to_be_visible()
     if "locale" in dotenv_config and "de" in dotenv_config["locale"]:
         expect(page.get_by_role("heading")).to_have_text("Willkommen bei WordPress!")