Add end-to-end test cases for Flask

MaddyGuthridge · MaddyGuthridge · commit 0ff05554a89b · 2023-11-25T19:01:32.000+11:00
diff --git a/README.md b/README.md
@@ -235,10 +235,10 @@ Copyright (c) 2023 Miguel Guthridge, COMP1010 UNSW
 
 Source code for the library is open source, using the
 [MIT license](https://choosealicense.com/licenses/mit/). A copy of the license
-text is available in [`LICENSE.md`](https://github.com/COMP1010UNSW/pyhtml-enhanced/blob/main/LICENSE.md)
+text is available in [LICENSE.md](https://github.com/COMP1010UNSW/pyhtml-enhanced/blob/main/LICENSE.md)
 
 ### Documentation
 
 Documentation is copied from MDN Web Docs, and is license under
 [CC-BY-SA-2.5](https://creativecommons.org/licenses/by-sa/2.5/). A copy of the
-license text is available in [`LICENSE_DOCS.md`](https://github.com/COMP1010UNSW/pyhtml-enhanced/blob/main/LICENSE_DOCS.md)
+license text is available in [LICENSE_DOCS.md](https://github.com/COMP1010UNSW/pyhtml-enhanced/blob/main/LICENSE_DOCS.md)
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -48,6 +48,7 @@ types-requests = "^2.31.0.2"
 pyyaml = "^6.0.1"
 types-pyyaml = "^6.0.12.11"
 flake8-pyproject = "^1.2.3"
+flask = "^3.0.0"
 
 [build-system]
 requires = ["poetry-core"]
diff --git a/tests/end_to_end/__init__.py b/tests/end_to_end/__init__.py
@@ -0,0 +1,3 @@
+"""
+End-to-end tests to ensure that our library works nicely alongside other tools
+"""
diff --git a/tests/end_to_end/flask_test.py b/tests/end_to_end/flask_test.py
@@ -0,0 +1,71 @@
+"""
+Tests to ensure our code works nicely with Flask
+"""
+import pytest
+import pyhtml as p
+from flask import Flask
+from flask.testing import FlaskClient
+
+
+app = Flask(__name__)
+
+
+@app.get("/")
+def simple_route():
+    return str(p.html(
+        p.body("Hello, world!")
+    ))
+
+
+# This route intentionally returns the wrong type
+@app.get("/no_str")  # type: ignore
+def no_stringify():
+    """
+    This route intentionally returns an un-stringified PyHTML object. We use
+    it to test that a reasonable error message is given
+    """
+    return p.html(
+        p.body("Hello, world!")
+    )
+
+
+@pytest.fixture
+def get_app():
+    app.config.update({"TESTING": True})
+
+    yield app
+
+    app.config.pop("TESTING")
+
+
+@pytest.fixture
+def client(get_app: Flask):
+    return get_app.test_client()
+
+
+def test_simple_stringify(client: FlaskClient):
+    """Does requesting to the server give some nice HTML?"""
+    response = client.get("/")
+    assert response.status_code == 200
+
+    assert response.text == '\n'.join([
+        "<html>",
+        "  <body>",
+        "    Hello, world!",
+        "  </body>",
+        "</html>",
+    ])
+
+
+def test_failed_to_stringify(client: FlaskClient):
+    """
+    Does requesting to a route that returns un-stringified HTML give an
+    appropriate error message
+    """
+    with pytest.raises(TypeError) as exception_info:
+        client.get("/no_str")
+
+    expected_error = "HINT: try converting your PyHTML into a string using "\
+        "the `str` function"
+
+    assert expected_error in str(exception_info.value)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+"""`
	`2`	`+End-to-end tests to ensure that our library works nicely alongside other tools`
	`3`	`+"""`