(test): added settings for browser tests, added a sample test

(test): added settings for browser tests, added a sample test

.github/workflows/test.yaml

@@ -29,6 +29,38 @@ jobs:
         pip install -r requirements.txt
         pip install pytest pytest-cov
 
-    - name: Test with pytest
+    - name: Run unit tests
       run: |
         pytest --cov=pinnwand
+
+  e2e-test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ "3.11" ]
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+        pip install pytest pytest-cov
+
+    - name: Install playwright
+      run: playwright install
+
+    - name: Install pinnwand
+      run: pip install pinnwand -e.
+
+    - name: Run e2e tests
+      run: |
+        pytest --e2e --log-cli-level=INFO

pyproject.toml

@@ -36,6 +36,7 @@ dev = [
     "isort>=5.12.0",
     "bandit>=1.7.5",
     "pip-audit>=2.5.6",
+    "pytest-playwright>=0.3.3",
 ]
 [build-system]
 requires = ["pdm-pep517>=1.0"]

test/conftest.py

@@ -0,0 +1,22 @@
+import pytest
+
+
+def pytest_addoption(parser):
+    parser.addoption(
+        "--e2e",
+        action="store_true",
+        help="run browser tests only if the option is passed",
+    )
+
+
+def pytest_runtest_setup(item):
+    if "e2e" in item.keywords and not item.config.getoption("--e2e"):
+        pytest.skip(
+            "browser tests are skipped because no --e2e option was given"
+        )
+    elif item.config.getoption("--e2e") and "e2e" not in item.keywords:
+        pytest.skip("only browser tests are run when --e2e option is given")
+
+
+def pytest_configure(config):
+    config.addinivalue_line("markers", "e2e: mark browser tests")

test/e2e/env_config.py

@@ -0,0 +1,32 @@
+from typing import Generator
+import pytest
+import subprocess
+import sys
+import logging
+import socket
+
+log = logging.getLogger(__name__)
+
+
+def select_port():
+    sock = socket.socket()
+    sock.bind(("", 0))
+    return sock.getsockname()[1]
+
+
+PORT = str(select_port())
+BASE_URL = f"http://localhost:{PORT}/"
+
+
+@pytest.mark.e2e
+@pytest.fixture(scope="session", autouse=True)
+def application() -> Generator[None, None, None]:
+    # Before All
+    log.info(f"Starting Pinnwand application on port {PORT}")
+    proc = subprocess.Popen(
+        [sys.executable, "-m", "pinnwand", "http", "--port", PORT]
+    )
+    yield
+    # After All
+    log.info("Terminating Pinnwand application")
+    proc.terminate()

test/e2e/pageobjects/base_page.py

@@ -0,0 +1,13 @@
+from playwright.sync_api import Locator, expect
+
+
+class BasePage:
+    def __init__(self, locator: Locator, name) -> None:
+        self.page_locator = locator
+        self.page_name = name
+
+    # Expectations
+    def should_be_opened(self):
+        expect(
+            self.page_locator, f"{self.page_name} was not opened"
+        ).to_be_visible()

test/e2e/pageobjects/create_paste_page.py

@@ -0,0 +1,41 @@
+from playwright.sync_api import Page, expect
+from test.e2e.env_config import BASE_URL
+from test.e2e.pageobjects.base_page import BasePage
+import logging
+
+log = logging.getLogger(__name__)
+
+
+class CreatePastePage(BasePage):
+    def __init__(self, page: Page) -> None:
+        super().__init__(
+            page.locator(".file-part textarea"), "Create Paste Page"
+        )
+        self.page = page
+        self.url = BASE_URL
+        self.paste_input = page.locator(".file-part textarea")
+        self.submit_button = page.locator(".paste-submit button[type=submit]")
+
+    def open(self):
+        log.info(f"Opening Pinnwand at {self.url}")
+        self.page.goto(self.url)
+
+    def type_paste(self, text):
+        log.info(f"Typing {text} in Paste Input")
+        self.paste_input.type(text)
+
+    def click_submit(self):
+        log.info("Clicking Submit Button")
+        self.submit_button.click()
+
+    # Expectations
+    def should_have_title(self, title):
+        expect(
+            self.page, f"{self.page_name} had incorrect title"
+        ).to_have_title(title)
+
+    def should_have_value_in_paste_input(self, value):
+        expect(
+            self.paste_input,
+            f"Paste Input had incorrect value on {self.page_name}",
+        ).to_have_value(value)

test/e2e/pageobjects/view_paste_page.py

@@ -0,0 +1,18 @@
+from playwright.sync_api import Page, expect
+from test.e2e.pageobjects.base_page import BasePage
+import logging
+
+log = logging.getLogger(__name__)
+
+
+class ViewPastePage(BasePage):
+    def __init__(self, page: Page) -> None:
+        super().__init__(page.locator(".files"), "View Paste Page")
+        self.page = page
+        self.source = page.locator(".source")
+
+    # Expectations
+    def should_have_pasted_text(self, text):
+        expect(
+            self.source, f"Pasted text was incorrect on {self.page_name}"
+        ).to_have_text(text)

test/e2e/testscenarios/test_create_paste.py

@@ -0,0 +1,23 @@
+from playwright.sync_api import Page
+import string
+from test.e2e.pageobjects.create_paste_page import CreatePastePage
+from test.e2e.pageobjects.view_paste_page import ViewPastePage
+import pytest
+from test.e2e.env_config import application
+
+
+@pytest.mark.e2e
+def test_create_paste(page: Page):
+    create_paste_page = CreatePastePage(page)
+    create_paste_page.open()
+    create_paste_page.should_be_opened()
+    create_paste_page.should_have_title("Create new paste")
+
+    paste_text = string.ascii_letters + string.digits
+    create_paste_page.type_paste(paste_text)
+    create_paste_page.should_have_value_in_paste_input(paste_text)
+    create_paste_page.click_submit()
+
+    view_paste_page = ViewPastePage(page)
+    view_paste_page.should_be_opened()
+    view_paste_page.should_have_pasted_text(paste_text)