refactoring (#13)

* general project refactoring

* various small improvements

* improve imap fixture with helper functions and typing

* add wordpress send email setup

* add wordpress receive email test

* add various documentation

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

pytest_abra/pytest_abra.py

@@ -1,100 +0,0 @@
-# This file is registered as a pytest plugin, meaning it will automatically loaded.
-# All fixtures in this file will be available without manual loading.
-
-import os
-import re
-from imaplib import IMAP4_SSL
-from pathlib import Path
-
-import pytest
-from dotenv import dotenv_values
-from playwright.sync_api import BrowserContext, expect
-from pytest import Parser
-
-from pytest_abra.dir_manager import DirManager
-from pytest_abra.env_manager import EnvFile
-from pytest_abra.utils import BaseUrl
-
-
-def pytest_addoption(parser: Parser):
-    parser.addoption("--runner_index", action="store", type=int)
-    parser.addoption("--output_dir", action="store", type=Path)
-    parser.addoption("--session_id", action="store", type=str)
-    parser.addoption("--timeout", action="store", type=int, default=20_000)
-
-
-@pytest.fixture(autouse=True)
-def set_expect_timeout(request):
-    TIMEOUT = request.config.getoption("--timeout")
-    expect.set_options(timeout=TIMEOUT)
-
-
-@pytest.fixture
-def context(context: BrowserContext, request) -> BrowserContext:
-    # note: because this has the existing context fixture as an argument, it is ensured
-    # that the original fixture is called first and then overwritten by this custom one.
-
-    TIMEOUT = request.config.getoption("--timeout")
-    LOCALE = {"Accept-Language": "de_DE"}
-
-    context.set_default_timeout(TIMEOUT)
-    context.set_extra_http_headers(LOCALE)
-    return context
-
-
-@pytest.fixture(scope="session")
-def DIR(request) -> DirManager:
-    """Fixture holding test directories
-
-    DIR.OUTPUT
-    DIR.SESSION
-    DIR.RECORDS
-    DIR.STATES
-    DIR.RESULTS"""
-
-    output_dir = request.config.getoption("--output_dir")
-    assert output_dir, "pytest argument --output_dir not set"
-    session_id = request.config.getoption("--session_id")
-    assert session_id, "pytest argument --session_id not set"
-    dirmanager = DirManager(output_dir=output_dir, session_id=session_id)
-    dirmanager.create_all_dirs()
-    return dirmanager
-
-
-@pytest.fixture(scope="session")
-def ENV_FILES(DIR: DirManager) -> dict[int, EnvFile]:
-    out: dict[int, EnvFile] = dict()
-    for env_path in DIR.ENV_FILES.glob("*.env"):
-        config: dict[str, str] = dotenv_values(env_path)  # type: ignore
-        env_type = config["TYPE"]
-        result = re.search(r"(\d+)-*", env_path.name)
-        assert result
-        runner_index = int(result[1])
-        out[runner_index] = EnvFile(env_path=env_path, config=config, env_type=env_type)
-    return out
-
-
-@pytest.fixture(scope="session")
-def dotenv_config(request, ENV_FILES: dict[int, EnvFile]) -> dict[str, str]:
-    runner_index = request.config.getoption("--runner_index")
-    return ENV_FILES[runner_index].config
-
-
-@pytest.fixture(scope="session")
-def URL(dotenv_config: dict[str, str]) -> BaseUrl:
-    return BaseUrl(netloc=dotenv_config["DOMAIN"])
-
-
-@pytest.fixture(scope="session")
-def imap_ssl_email_client() -> None:
-    assert os.environ["IMAP_HOST"]
-    assert os.environ["IMAP_PORT"]
-    assert os.environ["IMAP_USER"]
-    assert os.environ["IMAP_PASS"]
-    port = int(os.environ["IMAP_PORT"])
-    imap_client = IMAP4_SSL(host=os.environ["IMAP_HOST"], port=port)
-    imap_client.login(os.environ["IMAP_USER"], os.environ["IMAP_PASS"])
-    imap_client.select("INBOX")
-    yield imap_client
-    imap_client.close()
-    imap_client.logout()