FlaskTester 4.0__tar.gz → 4.2__tar.gz

{flasktester-4.0 → flasktester-4.2}/FlaskTester.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: FlaskTester
-Version: 4.0
+Version: 4.2
 Summary: Pytest fixtures for Flask internal and external authenticated tests
 Author-email: Fabien Coelho <flask.tester@coelho.net>
 License: CC0
@@ -34,6 +34,7 @@ Requires-Dist: types-flask; extra == "dev"
 Requires-Dist: types-requests; extra == "dev"
 Requires-Dist: FlaskSimpleAuth>=30.0; extra == "dev"
 Requires-Dist: passlib; extra == "dev"
+Requires-Dist: pydantic; extra == "dev"
 Provides-Extra: doc
 Requires-Dist: sphinx; extra == "doc"
 Requires-Dist: sphinx_rtd_theme; extra == "doc"
@@ -123,7 +124,7 @@ The above test runs with [`tests/app.py`](tests/app.py)
 [Flask](https://flask.palletsprojects.com/)
 REST application back-end with password and token authentication based on
 [FlaskSimpleAuth](https://pypi.org/project/FlaskSimpleAuth/).
-The code uses _25_ lines of Python for implementing
+The code uses _23_ lines of Python for implementing
 password (basic and parameters) and token authentications,
 admin group authorization, and routes for
 token generation (2), identity tests (2) and an incredible open cookie-based

{flasktester-4.0 → flasktester-4.2}/FlaskTester.egg-info/requires.txt

@@ -15,6 +15,7 @@ types-flask
 types-requests
 FlaskSimpleAuth>=30.0
 passlib
+pydantic
 
 [doc]
 sphinx

{flasktester-4.0 → flasktester-4.2}/FlaskTester.py

@@ -9,7 +9,9 @@ import re
 from typing import Any
 import importlib
 import logging
-import pytest
+import pytest  # for explicit fail calls, see _pytestFail
+import json
+import dataclasses
 
 log = logging.getLogger("flask_tester")
 
@@ -346,17 +348,59 @@ class Client:
             cookies.update(kwargs["cookies"])
             del kwargs["cookies"]
 
+        # FIXME allow or forbid?
+        # if "json" in kwargs and "data" in kwargs:
+        #     log.warning("mix of json and data parameters in request")
+
+        # convert json parameters
+        if "json" in kwargs:
+            json_param = kwargs["json"]
+            assert isinstance(json_param, dict)
+            for name in list(json_param.keys()):
+                val = json_param[name]
+                if val is None:
+                    pass
+                elif isinstance(val, (bool, int, float, str, tuple, list, dict)):
+                    pass
+                elif "model_dump" in val.__dir__() and callable(val.model_dump):
+                    # probably pydantic
+                    json_param[name] = val.model_dump()
+                else: # pydantic or standard dataclasses?
+                    json_param[name] = dataclasses.asdict(val)
+
+        # convert data parameters
+        if "data" in kwargs:
+            data_param = kwargs["data"]
+            assert isinstance(data_param, dict)
+            for name in list(data_param.keys()):
+                val = data_param[name]
+                if val is None:
+                    data_param[name] = "null"
+                elif isinstance(val, (io.IOBase, tuple)):
+                    pass  # file parameters?
+                elif isinstance(val, (bool, int, float, str)):
+                    # FIXME bool seems KO
+                    pass
+                elif isinstance(val, (list, dict)):
+                    data_param[name] = json.dumps(val)
+                elif "model_dump_json" in val.__dir__() and callable(val.model_dump_json):
+                    data_param[name] = val.model_dump_json()
+                else:
+                    data_param[name] = json.dumps(dataclasses.asdict(val))
+
         self._auth.setAuth(login, kwargs, cookies, auth=auth)
         res = self._request(method, path, cookies, **kwargs)  # type: ignore
 
         # check status
         if status is not None:
             if res.status_code != status:  # show error before aborting
+                # FIXME what if the useful part is at the end?
                 _pytestFail(f"bad {status} result: {res.status_code} {res.text[:512]}...")
 
         # check content
         if content is not None:
             if not re.search(content, res.text, re.DOTALL):
+                # FIXME what if the useful part is at the end?
                 _pytestFail(f"cannot find {content} in {res.text[:512]}...")
 
         return res

{flasktester-4.0 → flasktester-4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: FlaskTester
-Version: 4.0
+Version: 4.2
 Summary: Pytest fixtures for Flask internal and external authenticated tests
 Author-email: Fabien Coelho <flask.tester@coelho.net>
 License: CC0
@@ -34,6 +34,7 @@ Requires-Dist: types-flask; extra == "dev"
 Requires-Dist: types-requests; extra == "dev"
 Requires-Dist: FlaskSimpleAuth>=30.0; extra == "dev"
 Requires-Dist: passlib; extra == "dev"
+Requires-Dist: pydantic; extra == "dev"
 Provides-Extra: doc
 Requires-Dist: sphinx; extra == "doc"
 Requires-Dist: sphinx_rtd_theme; extra == "doc"
@@ -123,7 +124,7 @@ The above test runs with [`tests/app.py`](tests/app.py)
 [Flask](https://flask.palletsprojects.com/)
 REST application back-end with password and token authentication based on
 [FlaskSimpleAuth](https://pypi.org/project/FlaskSimpleAuth/).
-The code uses _25_ lines of Python for implementing
+The code uses _23_ lines of Python for implementing
 password (basic and parameters) and token authentications,
 admin group authorization, and routes for
 token generation (2), identity tests (2) and an incredible open cookie-based

{flasktester-4.0 → flasktester-4.2}/README.md

@@ -80,7 +80,7 @@ The above test runs with [`tests/app.py`](tests/app.py)
 [Flask](https://flask.palletsprojects.com/)
 REST application back-end with password and token authentication based on
 [FlaskSimpleAuth](https://pypi.org/project/FlaskSimpleAuth/).
-The code uses _25_ lines of Python for implementing
+The code uses _23_ lines of Python for implementing
 password (basic and parameters) and token authentications,
 admin group authorization, and routes for
 token generation (2), identity tests (2) and an incredible open cookie-based

{flasktester-4.0 → flasktester-4.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "FlaskTester"
-version = "4.0"
+version = "4.2"
 authors = [ { name = "Fabien Coelho", email = "flask.tester@coelho.net" } ]
 description = "Pytest fixtures for Flask internal and external authenticated tests"
 readme = "README.md"
@@ -33,7 +33,14 @@ package = "https://pypi.org/project/FlaskTester/"
 
 [project.optional-dependencies]
 # various dev tools
-dev = ["mypy", "pyright", "ruff", "coverage", "pymarkdownlnt!=0.9.5", "build", "twine", "wheel", "types-flask", "types-requests", "FlaskSimpleAuth>=30.0", "passlib"]
+dev = [
+  # static checks…
+  "mypy", "pyright", "ruff", "coverage", "pymarkdownlnt!=0.9.5",
+  # packaging
+  "build", "twine", "wheel",
+  # tests
+  "types-flask", "types-requests", "FlaskSimpleAuth>=30.0", "passlib", "pydantic"
+]
 # documentation generation
 doc = ["sphinx", "sphinx_rtd_theme", "sphinx-autoapi", "sphinx-lint", "myst_parser"]
 

{flasktester-4.0 → flasktester-4.2}/tests/test_app.py

@@ -8,6 +8,7 @@ import http.server as htsv
 import threading
 import io
 import logging
+import model
 
 logging.basicConfig(level=logging.INFO)
 # logging.basicConfig(level=logging.DEBUG)
@@ -338,3 +339,47 @@ def test_client_fixture():
     # reset env
     if app:
         os.environ["FLASK_TESTER_APP"] = app
+
+def test_classes(api):
+
+    def thing_eq(ta, tb):
+        tb = model.Thing1(**tb) if isinstance(tb, dict) else tb
+        return ta.tid == tb.tid and ta.name == tb.name and ta.owner == tb.owner
+
+    # Things
+    t0 = {"tid": 0, "name": "zero", "owner": "Rosalyn"}
+    t1 = model.Thing1(tid=1, name="one", owner="Susie")
+    t2 = model.Thing2(tid=2, name="two", owner="Calvin")
+    t3 = model.Thing3(tid=3, name="three", owner="Hobbes")
+
+    n = 0
+    # check all combinations
+    for path in ["/t0", "/t1", "/t2", "/t3"]:
+        for param in [t0, t1, t2, t3]:
+            for tclass in [model.Thing1, model.Thing2, model.Thing3]:
+                for method in ["GET", "POST"]:
+                    for mode in ["data", "json"]:
+                        n +=1
+                        parameter = {mode: {"t": param}}
+                        res = api.request(method, path, 200, **parameter)
+                        assert res.is_json
+                        json = res.json
+                        assert isinstance(json, dict)
+                        assert thing_eq(tclass(**json), param)
+    assert n == 192
+
+    # simple types translation
+    assert api.get("/t0", 200, json={"t": None}).json is None
+    assert api.get("/t0", 200, data={"t": None}).json is None
+    assert api.get("/t0", 200, json={"t": True}).json == True
+    assert api.get("/t0", 200, json={"t": False}).json == False
+    # non working, bad JsonData conversion
+    api.get("/t0", 400, data={"t": True})
+    api.get("/t0", 400, data={"t": False})
+    assert api.get("/t0", 200, json={"t": 2345}).json == 2345
+    assert api.get("/t0", 200, data={"t": 5432}).json == 5432
+    assert api.get("/t0", 200, json={"t": 23.45}).json == 23.45
+    assert api.get("/t0", 200, data={"t": 54.32}).json == 54.32
+    assert api.get("/t0", 200, json={"t": "Susie"}).json == "Susie"
+    api.get("/t0", 400, data={"t": "Susie"})  # raw str is not JSON
+    assert api.get("/t0", 200, data={"t": "\"Susie\""}).json == "Susie"