tests: add integration tests

Author: matthiasschaub

.gitignore

@@ -1,5 +1,6 @@
 # python
 venv/
+.venv/
 __pycache__/
 .pytest_cache/
 .hypothesis/

requirements.txt

@@ -0,0 +1,19 @@
+# This file was autogenerated by uv via the following command:
+#    uv pip compile - -o requirements.txt
+certifi==2024.2.2
+    # via requests
+charset-normalizer==3.3.2
+    # via requests
+idna==3.7
+    # via requests
+iniconfig==2.0.0
+    # via pytest
+packaging==24.0
+    # via pytest
+pip==23.2.1
+pluggy==1.4.0
+    # via pytest
+pytest==8.1.1
+requests==2.31.0
+urllib3==2.2.1
+    # via requests

tests/__init__.py

@@ -0,0 +1,61 @@
+import pytest
+from .utils import BaseUrlSession
+from uuid import uuid4
+
+
+@pytest.fixture(scope="session")
+def zod():
+    """Request session for ~zod which is authenticated"""
+    baseUrl = "http://localhost:8080"
+    data = {"password": "lidlut-tabwed-pillex-ridrup"}
+    with BaseUrlSession(baseUrl) as session:
+        session.post("/~/login", data=data)  # perform the login
+        yield session
+
+
+@pytest.fixture(scope="session")
+def nus():
+    """Request session for ~nus which is authenticated"""
+    baseUrl = "http://localhost:8081"
+    data = {"password": "bortem-pinwyl-macnyx-topdeg"}
+    with BaseUrlSession(baseUrl) as session:
+        session.post("/~/login", data=data)  # perform the login
+        yield session
+
+
+@pytest.fixture(scope="session")
+def lus():
+    """Request session for ~nus which is authenticated"""
+    baseUrl = "http://localhost:8082"
+    data = {"password": "macsyr-davfed-tanrux-linnec"}
+    with BaseUrlSession(baseUrl) as session:
+        session.post("/~/login", data=data)  # perform the login
+        yield session
+
+
+@pytest.fixture
+def uuid():
+    return str(uuid4())
+
+
+@pytest.fixture
+def eid():
+    return str(uuid4())
+
+
+@pytest.fixture
+def gid():
+    return str(uuid4())
+
+
+@pytest.fixture
+def list_(zod, gid) -> dict:
+    list_ = {
+        "gid": gid,
+        "title": "assembly",
+        "host": "~zod",
+        "public": False,
+    }
+    url = "/apps/tahuti/api/lists"
+    zod.put(url, json=list_)
+    return list_

tests/conftest.py

@@ -0,0 +1,154 @@
+from time import sleep
+from uuid import uuid4
+
+import pytest
+import requests
+from schema import Schema
+
+
+@pytest.fixture
+def list_schema():
+    """Response schema"""
+    return Schema(
+        {
+            "lid": str,
+            "title": str,
+            "host": str,
+            "public": bool,
+        },
+    )
+
+
+@pytest.fixture
+def lists_schema(list_schema):
+    """Response schema"""
+    return Schema([list_schema])
+
+
+@pytest.mark.parametrize("payload", (None, "", " ", {}, []))
+def test_lists_put_empty_payload(payload, zod):
+    url = "/apps/maat/api/lists"
+    response = zod.put(url, json=payload)
+    assert response.status_code in (418, 500)
+
+
+@pytest.mark.parametrize("title", (None, "", " "))
+def test_lists_put_invalid_title(title, zod):
+    list_ = {
+        "lid": str(uuid4()),
+        "title": title,
+        "public": False,
+    }
+    url = "/apps/maat/api/lists"
+
+    # PUT /lists
+    response = zod.put(url, json=list_)
+    assert response.status_code in (422, 500)
+
+    # GET /lists
+    response = zod.get(url)
+    assert response.status_code == 200
+    result = response.json()
+    assert list_ not in result
+
+
+def test_lists_get_all(zod, list_, lists_schema):
+    # GET /lists
+    url = "/apps/maat/api/lists"
+    response = zod.get(url)
+    assert response.status_code == 200
+    result = response.json()
+    assert lists_schema.is_valid(result)
+    assert list_ in result
+
+
+@pytest.mark.usefixtures("list_")
+def test_lists_get_all_unauthorized():
+    # GET /lists
+    url = "http://localhost:8080/apps/maat/api/lists"
+    response = requests.get(url)
+    assert response.status_code == 401
+
+
+def test_lists_get_single(zod, gid, list_, list_schema):
+    # GET /lists/{uuid}
+    url = f"/apps/maat/api/lists/{gid}"
+    response = zod.get(url)
+    assert response.status_code == 200
+    result = response.json()
+    assert list_schema.is_valid(result)
+    assert result == list_
+
+
+def test_lists_get_single_not_found(zod):
+    # GET /lists/{uuid}
+    url = f"/apps/maat/api/lists/{str(uuid4())}"
+    response = zod.get(url)
+    # TODO: should be 4xx
+    assert response.status_code == 500
+
+
+def test_lists_delete(zod, gid, list_):
+    # PUT
+    url = f"/apps/maat/api/lists/{gid}"
+    response = zod.delete(url)
+    assert response.status_code == 200
+
+    # GET /lists
+    url = "/apps/maat/api/lists"
+    response = zod.get(url)
+    assert response.status_code == 200
+    result = response.json()
+    assert list_ not in result
+
+
+# @pytest.mark.usefixtures("member")
+# def test_lists_delete_unauthorized(zod, nus, gid, list):
+#     # wait for join
+#     sleep(0.5)
+
+#     # PUT
+#     url = f"/apps/maat/api/lists/{gid}"
+#     response = nus.delete(url)
+#     assert response.status_code == 403
+
+#     # GET /lists
+#     url = "/apps/maat/api/lists"
+#     response = zod.get(url)
+#     assert response.status_code == 200
+#     result = response.json()
+#     assert list in result
+
+
+# @pytest.mark.usefixtures("list")
+# def test_lists_get_private(gid):
+#     # GET /lists/{uuid}
+#     url = f"http://localhost:8080/apps/maat/api/lists/{gid}"
+#     response = requests.get(url)
+#     assert response.status_code == 401
+
+
+# def test_lists_get_public(gid, list_public, list_schema):
+#     # GET /lists/{uuid}
+#     url = f"http://localhost:8080/apps/maat/api/lists/{gid}"
+#     response = requests.get(url)
+#     assert response.status_code == 200
+#     result = response.json()
+#     assert list_schema.is_valid(result)
+#     assert result == list_public
+
+
+# @pytest.mark.usefixtures("list")
+# def test_lists_delete_private(gid):
+#     # PUT
+#     url = f"http://localhost:8080/apps/maat/api/lists/{gid}"
+#     response = requests.delete(url)
+#     assert response.status_code == 401
+
+
+# @pytest.mark.usefixtures("list_public")
+# def test_lists_delete_public(gid):
+#     # PUT
+#     url = f"http://localhost:8080/apps/maat/api/lists/{gid}"
+#     response = requests.delete(url)
+#     assert response.status_code == 401

tests/integration/__init__.py

@@ -0,0 +1,32 @@
+"""Requests Session with Base URL support
+
+https://github.com/requests/toolbelt/blob/master/requests_toolbelt/sessions.py
+"""
+
+
+from urllib.parse import urljoin
+
+import requests
+
+
+class BaseUrlSession(requests.Session):
+    base_url = None
+
+    def __init__(self, base_url=None):
+        if base_url:
+            self.base_url = base_url
+        super(BaseUrlSession, self).__init__()
+
+    def request(self, method, url, *args, **kwargs):
+        """Send the request after generating the complete URL."""
+        url = self.create_url(url)
+        return super(BaseUrlSession, self).request(method, url, *args, **kwargs)
+
+    def prepare_request(self, request, *args, **kwargs):
+        """Prepare the request after generating the complete URL."""
+        request.url = self.create_url(request.url)
+        return super(BaseUrlSession, self).prepare_request(request, *args, **kwargs)
+
+    def create_url(self, url):
+        """Create the URL based off this partial path."""
+        return urljoin(self.base_url, url)