Add framework for UI testing via bs4

.pre-commit-config.yaml

@@ -25,7 +25,7 @@ repos:
     rev: v0.5.5
     hooks:
       - id: ruff
-        args: [ "--fix", "--exit-non-zero-on-fix" ]
+        args: [--exit-non-zero-on-fix]
         files: ^tin/.*
         name: ruff lint
       - id: ruff-format

Pipfile

@@ -34,6 +34,8 @@ furo = "*"
 myst-parser = "*"
 sphinx-copybutton = "*"
 sphinxcontrib-django = "*"
+beautifulsoup4 = "~=4.12"
+lxml = "~=5.2"
 
 [ci]
 pytest-cov = "*"

docs/source/reference_index/tests.rst

@@ -10,3 +10,4 @@ Tests
    ~tests.utils
    ~tests.assertions
    ~tests.fixtures
+   ~tests.ui_testing

pyproject.toml

@@ -24,8 +24,13 @@ DJANGO_SETTINGS_MODULE = "tin.settings"
 python_files = "tests.py test_*.py"
 norecursedirs = ["media", "migrations", "sandboxing"]
 testpaths = "tin"
-addopts = "--doctest-modules tin --import-mode=importlib -n 8"
+addopts = "--doctest-modules tin --import-mode=importlib -n auto"
 doctest_optionflags = "NORMALIZE_WHITESPACE NUMBER"
+filterwarnings = [
+    "error",
+    'ignore:.*Tin is using the dummy sandboxing module. This is insecure.:',
+    "ignore::DeprecationWarning:twisted.*:",
+]
 
 [tool.coverage.run]
 branch = true
@@ -82,6 +87,7 @@ extend-exclude = [
   "migrations",
 ]
 
+fix = true
 show-fixes = false
 
 line-length = 100

tin/apps/assignments/tests/test_html.py

@@ -0,0 +1,76 @@
+from __future__ import annotations
+
+import pytest
+from django.urls import reverse
+
+from tin.tests import Html, login
+
+from .. import views
+
+
+@login("student")
+@pytest.mark.parametrize(
+    ("course_perm", "is_archived", "is_visible"),
+    (
+        ("-", False, True),
+        ("r", False, True),
+        ("w", False, True),
+        ("-", True, False),
+        ("r", True, False),
+        ("w", True, True),
+    ),
+)
+def test_can_submit_assignment(
+    client,
+    course,
+    assignment,
+    course_perm: str,
+    is_archived: bool,
+    is_visible: bool,
+):
+    course.archived = is_archived
+    course.permission = course_perm
+    course.save()
+    response = client.get(
+        reverse("assignments:show", args=[assignment.id]),
+    )
+    html = Html.from_response(response)
+    assert html.has_button("Submit") is is_visible
+
+
+@pytest.mark.parametrize(
+    ("user", "is_visible"),
+    (
+        ("student", False),
+        ("teacher", True),
+    ),
+)
+def test_can_create_assignment(rf, course, student, teacher, user, is_visible):
+    user_map = {
+        "student": student,
+        "teacher": teacher,
+    }
+    request = rf.get(
+        reverse("assignments:add", args=[course.id]),
+    )
+    request.user = user_map[user]
+    response = views.create_view(request, course.id)
+    html = Html.from_response(response)
+    assert html.has_button("Create") is is_visible
+
+
+@login("student")
+def test_can_submit_assignment_from_form(client, assignment):
+    response = client.get(
+        reverse("assignments:submit", args=[assignment.id]),
+    )
+    html = Html.from_response(response)
+    # no grader has been added yet
+    assert not html.has_button("Submit")
+    assignment.save_grader_file("print('Instanced Rendering OP')")
+
+    response = client.get(
+        reverse("assignments:submit", args=[assignment.id]),
+    )
+    html = Html.from_response(response)
+    assert html.has_button("Submit")

tin/tests/__init__.py

@@ -1,4 +1,5 @@
 from __future__ import annotations
 
 from .assertions import *
+from .ui_testing import *
 from .utils import *

tin/tests/tests.py

@@ -0,0 +1,61 @@
+from __future__ import annotations
+
+import pytest
+
+from .ui_testing import Html
+
+
+def test_html_has_button_no_href():
+    raw_html = """
+    <button>Hi!</button>
+    <input type="submit" value="Blame the compiler">
+    """
+    html = Html(raw_html)
+    # with no arguments it should raise a ValueError
+    with pytest.raises(ValueError, match="At least one of text or href must be provided"):
+        html.has_button()
+    assert html.has_button("Hi!")
+    # has button is case insensitive
+    assert html.has_button("hi!")
+    assert html.has_button("Blame the compiler")
+
+    raw_html = """
+    <buttn></buttn>
+    <input type="list" value="Blame the compiler">
+    """
+    html = Html(raw_html)
+    assert not html.has_button("Blame the compiler")
+
+
+def test_html_has_button_with_href():
+    raw_html = """
+    <button><a href="https://example.com">Hi!</a></button>
+    <input type="submit" value="Blame the compiler">
+    <a href='https://google.com'><button>Google</button></a>
+    <a class="bob tin-btn" href="https://example.com">Bob</a>
+    """
+    html = Html(raw_html)
+    assert html.has_button(href="https://example.com")
+    assert not html.has_button(href="https://example.org")
+    assert html.has_button("Google", href="https://google.com")
+    # should also search for <a class="tin-btn"
+    assert html.has_button("Bob", href="https://example.com")
+    raw_html = """
+    <button>Hi!</button>
+    <input type="submit" value="Blame the compiler">
+    """
+    html = Html(raw_html)
+    assert not html.has_button(href="https://example.com")
+
+
+def test_has_text():
+    raw_html = '<p class="insideTag">This is a really long sentence</p>'
+    html = Html(raw_html)
+
+    # it should be case insensitive by default
+    assert html.has_text("REALLY long sentence")
+
+    assert not html.has_text("REALLY long sentence", case_sensitive=True)
+    assert html.has_text("really long sentence", case_sensitive=True)
+
+    assert not html.has_text("insideTag")