Merge pull request #2020 from roland-ruedenauer/add-more-frontend-tests

Add two more test cases to moin.apps.frontend ...

Author: UlrichB22

src/moin/_tests/wikiconfig.py

@@ -18,12 +18,14 @@
 
 
 class Config(DefaultConfig):
-    """Default configuration for unit tests."""
-
-    _here = abspath(dirname(__file__))
-    _root = abspath(join(_here, "..", ".."))
-    data_dir = join(_here, "wiki", "data")  # needed for plugins package TODO
-    index_storage = "FileStorage", (join(_here, "wiki", "index"),), {}
+    """
+    Default configuration for unit tests.
+    """
+
+    wikiconfig_dir = abspath(dirname(__file__))
+    instance_dir = join(wikiconfig_dir, "wiki")
+    data_dir = join(instance_dir, "data")
+    index_storage = "FileStorage", (join(instance_dir, "index"),), {}
     default_acl = None
     default_root = "FrontPage"
     interwikiname = "MoinTest"

src/moin/apps/admin/_tests/test_admin.py

@@ -25,8 +25,8 @@
     ),
 )
 def test_admin(app, url_for_args, status, data):
-    with app.test_client() as c:
-        rv = c.get(url_for(**url_for_args))
+    with app.test_client() as client:
+        rv = client.get(url_for(**url_for_args))
         assert rv.status == status
         assert rv.headers["Content-Type"] == "text/html; charset=utf-8"
         for item in data:

src/moin/apps/feed/_tests/test_feed.py

@@ -13,8 +13,8 @@
 
 class TestFeeds:
     def test_global_atom(self, app):
-        with app.test_client() as c:
-            rv = c.get(url_for("feed.atom"))
+        with app.test_client() as client:
+            rv = client.get(url_for("feed.atom"))
             assert rv.status == "200 OK"
             assert rv.headers["Content-Type"] == "application/atom+xml"
             assert rv.data.startswith(b"<?xml")
@@ -24,17 +24,17 @@ def test_global_atom(self, app):
     def test_global_atom_with_an_item(self, app):
         basename = "Foo"
         update_item(basename, {COMMENT: "foo data for feed item"}, "")
-        with app.test_client() as c:
-            rv = c.get(url_for("feed.atom"))
+        with app.test_client() as client:
+            rv = client.get(url_for("feed.atom"))
             assert rv.status == "200 OK"
             assert rv.headers["Content-Type"] == "application/atom+xml"
             assert rv.data.startswith(b"<?xml")
             assert b"foo data for feed item" in rv.data
 
         # Test cache invalidation
         update_item(basename, {COMMENT: "checking if the cache invalidation works"}, "")
-        with app.test_client() as c:
-            rv = c.get(url_for("feed.atom"))
+        with app.test_client() as client:
+            rv = client.get(url_for("feed.atom"))
             assert rv.status == "200 OK"
             assert rv.headers["Content-Type"] == "application/atom+xml"
             assert rv.data.startswith(b"<?xml")

src/moin/apps/frontend/_tests/test_frontend.py

@@ -5,16 +5,51 @@
 MoinMoin - Tests for frontend
 """
 
+from __future__ import annotations
+
+from typing import Any, TYPE_CHECKING, Iterable
 from io import BytesIO
 
+import pytest
+
 from flask import url_for
 from flask import g as flaskg
 from werkzeug.datastructures import FileStorage
 
-from moin.apps.frontend import views
 from moin import user
+from moin.apps.frontend import views
+from moin.constants.keys import ITEMID
+
+if TYPE_CHECKING:
+    from flask.testing import FlaskClient
+    from werkzeug.test import TestResponse
+
+
+def create_user(name: str, password: str, pwencoded: bool = False, email: str | None = None) -> None:
+    """helper to create test user"""
+    if email is None:
+        email = "[email protected]"
+    user.create_user(name, password, email, is_encrypted=pwencoded)
 
-import pytest
+
+def set_user_in_client_session(client: FlaskClient, user: user.User) -> None:
+    # the test configuration has MoinAuth enabled
+    with client.session_transaction() as session:
+        session["user.itemid"] = user.profile[ITEMID]
+        session["user.trusted"] = False
+        session["user.auth_method"] = "moin"
+        session["user.auth_attribs"] = tuple()
+        session["user.session_token"] = user.get_session_token()
+
+
+def client_request(
+    client: FlaskClient, method: str, url: str, *, user: user.User | None = None, **kwargs: Any
+) -> TestResponse:
+    if user is not None:
+        set_user_in_client_session(client, user)
+    print(f"client request: {method} {url}")
+    response = client.open(url, method=method, **kwargs)
+    return response
 
 
 class TestFrontend:
@@ -26,51 +61,68 @@ def custom_setup(self, app):
     def _test_view(
         self,
         viewname,
-        status="200 OK",
-        data=("<html>", "</html>"),
-        content_types=("text/html; charset=utf-8",),
-        viewopts=None,
-        params=None,
-    ):
+        *,
+        status: str = "200 OK",
+        data: Iterable[str] = ("<html>", "</html>"),
+        content_types: Iterable[str] = ("text/html; charset=utf-8",),
+        viewopts: dict[str, Any] | None = None,
+        params: dict[str, Any] | None = None,
+        user: user.User | None = None,
+    ) -> TestResponse:
+
         if viewopts is None:
             viewopts = {}
         if params is None:
             params = {}
 
-        with self.app.test_client() as c:
-            for method in ["HEAD", "GET"]:
-                print("%s %s" % (method, url_for(viewname, **viewopts)))
-                rv = c.open(url_for(viewname, **viewopts), method=method, data=params)
-                rv_data = rv.data.decode()
-                assert rv.status == status
-                assert rv.headers["Content-Type"] in content_types
-                if method == "GET":
-                    for item in data:
-                        assert item in rv_data
-        return rv
+        with self.app.test_client() as client:
+
+            request_url = url_for(viewname, **viewopts)
+
+            response = client_request(client, "HEAD", request_url, user=user, data=params)
+            assert response.status == status
+            assert response.headers["Content-Type"] in content_types
+
+            response = client_request(client, "GET", request_url, user=user, data=params)
+            assert response.status == status
+            assert response.headers["Content-Type"] in content_types
+            rv_data = response.data.decode()
+            for item in data:
+                assert item in rv_data
+
+            return response
 
     def _test_view_post(
         self,
-        viewname,
-        status="302 FOUND",
-        content_types=("text/html; charset=utf-8",),
-        data=("<html>", "</html>"),
-        form=None,
-        viewopts=None,
-    ):
+        viewname: str,
+        *,
+        status: str = "302 FOUND",
+        content_types: Iterable[str] = ("text/html; charset=utf-8",),
+        data: Iterable[str] = ("<html>", "</html>"),
+        form: dict[str, Any] | None = None,
+        viewopts: dict[str, Any] | None = None,
+        params: dict[str, Any] | None = None,
+        user: user.User | None = None,
+    ) -> TestResponse:
+
+        if params is None:
+            params = {}
         if viewopts is None:
             viewopts = {}
         if form is None:
             form = {}
-        print("POST %s" % url_for(viewname, **viewopts))
-        with self.app.test_client() as c:
-            rv = c.post(url_for(viewname, **viewopts), data=form)
-            rv_data = rv.data.decode()
-            assert rv.status == status
-            assert rv.headers["Content-Type"] in content_types
+
+        request_url = url_for(viewname, **viewopts)
+        print("POST %s" % request_url)
+
+        with self.app.test_client() as client:
+            response = client_request(client, "POST", request_url, user=user, query_string=params, data=form)
+            assert response.status == status
+            assert response.headers["Content-Type"] in content_types
+            rv_data = response.get_data(as_text=True)
             for item in data:
                 assert item in rv_data
-            return rv
+            return response
 
     def test_ajaxdelete_item_name_route(self):
         self._test_view_post(
@@ -170,6 +222,31 @@ def test_convert_item(self):
     def test_modify_item(self):
         self._test_view("frontend.modify_item", status="200 OK", viewopts=dict(item_name="DoesntExist"))
 
+    def test_modify_item_show_preview(self):
+
+        create_user("björn", "Xiwejr622")
+        test_user = flaskg.user = user.User(name="björn", password="Xiwejr622")
+
+        content = "New item content."
+
+        self._test_view_post(
+            "frontend.modify_item",
+            status="200 OK",
+            viewopts=dict(item_name="quokka"),
+            params={"itemtype": "default", "contenttype": "text/x.moin.wiki;charset=utf-8", "template": ""},
+            form={
+                "comment": "",
+                "content_form_data_text": content,
+                "content_form_data_file": content.encode(encoding="utf-8"),
+                "preview": "Preview",
+                "meta_form_acl": "None",
+                "meta_form_name": "quokka",
+                "meta_form_summary": "",
+                "meta_form_tags": "",
+            },
+            user=test_user,
+        )
+
     def test_rename_item(self):
         self._test_view("frontend.rename_item", status="404 NOT FOUND", viewopts=dict(item_name="DoesntExist"))
 
@@ -253,6 +330,22 @@ def test_recoverpass(self):
     def test_login(self):
         self._test_view("frontend.login")
 
+    def test_login_post(self):
+        username = "moin"
+        password = "Xiwejr622"
+        create_user(username, password)
+        response = self._test_view_post(
+            "frontend.login",
+            form={
+                "login_username": username,
+                "login_password": password,
+                "login_nexturl": "http://localhost/Home",
+                "login_submit": "1",
+            },
+            data=("Redirecting...",),
+        )
+        assert response.location == "http://localhost/Home"
+
     def test_logout(self):
         self._test_view("frontend.logout", status="302 FOUND", data=["<!doctype html"])
 
@@ -284,7 +377,7 @@ def custom_setup(self, app):
         flaskg.user = saved_user
 
     def test_user_password_change(self):
-        self.createUser("moin", "Xiwejr622")
+        create_user("moin", "Xiwejr622")
         flaskg.user = user.User(name="moin", password="Xiwejr622")
         form = self.fillPasswordChangeForm("Xiwejr622", "Woodoo645", "Woodoo645")
         valid = form.validate()
@@ -294,7 +387,7 @@ def test_user_unicode_password_change(self):
         name = "moin"
         password = "__שם משתמש לא קיים__"  # Hebrew
 
-        self.createUser(name, password)
+        create_user(name, password)
         flaskg.user = user.User(name=name, password=password)
         form = self.fillPasswordChangeForm(password, "Woodoo645", "Woodoo645")
         valid = form.validate()
@@ -305,22 +398,22 @@ def test_user_password_change_to_unicode_pw(self):
         password = "Xiwejr622"
         new_password = "__שם משתמש לא קיים__"  # Hebrew
 
-        self.createUser(name, password)
+        create_user(name, password)
         flaskg.user = user.User(name=name, password=password)
         form = self.fillPasswordChangeForm(password, new_password, new_password)
         valid = form.validate()
         assert valid  # form data is valid
 
     def test_fail_user_password_change_pw_mismatch(self):
-        self.createUser("moin", "Xiwejr622")
+        create_user("moin", "Xiwejr622")
         flaskg.user = user.User(name="moin", password="Xiwejr622")
         form = self.fillPasswordChangeForm("Xiwejr622", "Piped33", "Woodoo645")
         valid = form.validate()
         # form data is invalid because password1 != password2
         assert not valid
 
     def test_fail_password_change(self):
-        self.createUser("moin", "Xiwejr622")
+        create_user("moin", "Xiwejr622")
         flaskg.user = user.User(name="moin", password="Xiwejr622")
         form = self.fillPasswordChangeForm("Xinetd33", "Woodoo645", "Woodoo645")
         valid = form.validate()
@@ -340,9 +433,3 @@ def fillPasswordChangeForm(self, current_password, password1, password2):
         )
         form = FormClass.from_flat(request_form)
         return form
-
-    def createUser(self, name, password, pwencoded=False, email=None):
-        """helper to create test user"""
-        if email is None:
-            email = "[email protected]"
-        user.create_user(name, password, email, is_encrypted=pwencoded)

src/moin/apps/misc/_tests/test_misc.py

@@ -10,16 +10,16 @@
 
 class TestMisc:
     def test_global_sitemap(self, app):
-        with app.test_client() as c:
-            rv = c.get(url_for("misc.sitemap"))
+        with app.test_client() as client:
+            rv = client.get(url_for("misc.sitemap"))
             assert rv.status == "200 OK"
             assert rv.headers["Content-Type"] == "text/xml; charset=utf-8"
             assert rv.data.startswith(b"<?xml")
             assert b'<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">' in rv.data
             assert b"</urlset>" in rv.data
 
     def test_urls_names(self, app):
-        with app.test_client() as c:
-            rv = c.get(url_for("misc.urls_names"))
+        with app.test_client() as client:
+            rv = client.get(url_for("misc.urls_names"))
             assert rv.status == "200 OK"
             assert rv.headers["Content-Type"] == "text/plain; charset=utf-8"

src/moin/apps/serve/_tests/test_serve.py

@@ -10,14 +10,14 @@
 
 class TestServe:
     def test_index(self, app):
-        with app.test_client() as c:
-            rv = c.get(url_for("serve.index"))
+        with app.test_client() as client:
+            rv = client.get(url_for("serve.index"))
             assert rv.status == "200 OK"
             assert rv.headers["Content-Type"] == "text/plain"
 
     def test_files(self, app):
-        with app.test_client() as c:
-            rv = c.get(url_for("serve.files", name="DoesntExist"))
+        with app.test_client() as client:
+            rv = client.get(url_for("serve.files", name="DoesntExist"))
             assert rv.status == "404 NOT FOUND"
             assert rv.headers["Content-Type"] == "text/html; charset=utf-8"
             assert rv.text.startswith("<!doctype html")

src/moin/items/_tests/test_Blog.py

@@ -27,8 +27,8 @@ def set_self_app(self, app):
         self.app = app
 
     def _test_view(self, item_name, req_args={}, data_tokens=[], exclude_data_tokens=[], regex=None):
-        with self.app.test_client() as c:
-            rv = c.get(url_for("frontend.show_item", item_name=item_name, **req_args))
+        with self.app.test_client() as client:
+            rv = client.get(url_for("frontend.show_item", item_name=item_name, **req_args))
             rv_data = rv.data.decode()
             for data in data_tokens:
                 assert data in rv_data