FlaskTester 4.2__tar.gz → 5.0__tar.gz

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: FlaskTester
-Version: 4.2
+Version: 5.0
 Summary: Pytest fixtures for Flask internal and external authenticated tests
 Author-email: Fabien Coelho <flask.tester@coelho.net>
 License: CC0
@@ -19,7 +19,6 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests
-Requires-Dist: flask
 Requires-Dist: pytest
 Provides-Extra: dev
 Requires-Dist: mypy; extra == "dev"
@@ -27,13 +26,10 @@ Requires-Dist: pyright; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
 Requires-Dist: coverage; extra == "dev"
 Requires-Dist: pymarkdownlnt!=0.9.5; extra == "dev"
-Requires-Dist: build; extra == "dev"
-Requires-Dist: twine; extra == "dev"
-Requires-Dist: wheel; extra == "dev"
 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: FlaskSimpleAuth>=35.0; extra == "dev"
+Requires-Dist: bcrypt; extra == "dev"
 Requires-Dist: pydantic; extra == "dev"
 Provides-Extra: doc
 Requires-Dist: sphinx; extra == "doc"
@@ -41,6 +37,10 @@ Requires-Dist: sphinx_rtd_theme; extra == "doc"
 Requires-Dist: sphinx-autoapi; extra == "doc"
 Requires-Dist: sphinx-lint; extra == "doc"
 Requires-Dist: myst_parser; extra == "doc"
+Provides-Extra: pub
+Requires-Dist: build; extra == "pub"
+Requires-Dist: twine; extra == "pub"
+Requires-Dist: wheel; extra == "pub"
 
 # FlaskTester - Pytest fixtures for Flask internal and external authenticated tests
 
@@ -53,7 +53,7 @@ Only one set of tests is needed, switching from internal to external is
 achieved by setting an environment variable.
 
 ![Status](https://github.com/zx80/flask-tester/actions/workflows/package.yml/badge.svg?branch=main&style=flat)
-![Tests](https://img.shields.io/badge/tests-14%20✓-success)
+![Tests](https://img.shields.io/badge/tests-16%20✓-success)
 ![Coverage](https://img.shields.io/badge/coverage-100%25-success)
 ![Issues](https://img.shields.io/github/issues/zx80/flask-tester?style=flat)
 ![Python](https://img.shields.io/badge/python-3-informational)
@@ -75,18 +75,20 @@ import pytest
 from FlaskTester import ft_authenticator, ft_client
 import secret
 
+def authHook(api, user: str, pwd: str|None):
+    if pwd is not None:  # get a token when a login/password is provided
+        res = api.get("/login", login=user, auth="basic", status=200)
+        api.setToken(user, res.json["token"])
+    else:  # remove token
+        api.setToken(user, None)
+
 @pytest.fixture
 def app(ft_client):
+    # register authentication hook
+    ft_client.setHook(authHook)
     # add test passwords for Calvin and Hobbes (must be consistent with app!)
     ft_client.setPass("calvin", secret.PASSES["calvin"])
     ft_client.setPass("hobbes", secret.PASSES["hobbes"])
-    # get user tokens, assume json result {"token": "<token-value>"}
-    res = ft_client.get("/login", login="calvin", auth="basic", status=200)
-    assert res.is_json
-    ft_client.setToken("calvin", res.json["token"])
-    res = ft_client.post("/login", login="hobbes", auth="param", status=201)
-    assert res.is_json
-    ft_client.setToken("hobbes", res.json["token"])
     # also set a cookie
     ft_client.setCookie("hobbes", "lang", "fr")
     ft_client.setCookie("calvin", "lang", "en")
@@ -102,13 +104,13 @@ def test_app_admin(app):
         assert 'not in group "ADMIN"' in res.text
 ```
 
-This can be run against a (local) server:
+This can be run against a local or remote server:
 
 ```shell
 export TEST_SEED="some-random-data"              # shared test seed
 flask --app app:app run &                        # start flask app
 pid=$!                                           # keep pid
-export FLASK_TESTER_APP="http://localhost:5000"  # set app local url
+export FLASK_TESTER_APP="http://localhost:5000"  # set app url, local or remote
 pytest test.py                                   # run external tests
 kill $pid                                        # stop app with pid
 ```

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

@@ -1,5 +1,4 @@
 requests
-flask
 pytest
 
 [dev]
@@ -8,13 +7,10 @@ pyright
 ruff
 coverage
 pymarkdownlnt!=0.9.5
-build
-twine
-wheel
 types-flask
 types-requests
-FlaskSimpleAuth>=30.0
-passlib
+FlaskSimpleAuth>=35.0
+bcrypt
 pydantic
 
 [doc]
@@ -23,3 +19,8 @@ sphinx_rtd_theme
 sphinx-autoapi
 sphinx-lint
 myst_parser
+
+[pub]
+build
+twine
+wheel

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

@@ -6,7 +6,8 @@ PYTEST_DONT_REWRITE: local assertions are really that, not pytest assertions.
 import os
 import io
 import re
-from typing import Any
+# Python >= 3.11: Self
+from typing import Any, Callable
 import importlib
 import logging
 import pytest  # for explicit fail calls, see _pytestFail
@@ -89,6 +90,9 @@ class Authenticator:
     _AUTH_SCHEMES.update(_TOKEN_SCHEMES)
     _AUTH_SCHEMES.update(_PASS_SCHEMES)
 
+    # authenticator login/pass hook
+    _AuthHook = Callable[[str, str|None], None]
+
     def __init__(self,
              allow: list[str] = ["bearer", "basic", "param", "none"],
              # parameter names for "basic" and "param"
@@ -124,6 +128,9 @@ class Authenticator:
         assert ptype in ("json", "data")
         self._ptype = ptype
 
+        # _AuthHook|None, but python cannot stand it:-(
+        self._auth_hook: Any = None
+
         # password and token credentials, cookies
         self._passes: dict[str, str] = {}
         self._tokens: dict[str, str] = {}
@@ -138,6 +145,10 @@ class Authenticator:
             assert isinstance(val, str)
             store[key] = val
 
+    def setHook(self, hook: _AuthHook):
+        """Set on password hook."""
+        self._auth_hook = hook
+
     def setPass(self, login: str, pw: str|None):
         """Associate a password to a user.
 
@@ -146,6 +157,7 @@ class Authenticator:
         if not self._has_pass:
             raise AuthError("cannot set password, no password scheme allowed")
         self._set(login, pw, self._passes)
+        _ = self._auth_hook and self._auth_hook(login, pw)
 
     def setPasses(self, pws: list[str]):
         """Associate a list of *login:password*."""
@@ -298,11 +310,19 @@ class Client:
     :param default_login: When ``login`` is not set.
     """
 
+    # client login/pass hook (with mypy workaround)
+    # Python >= 3.11: Self
+    AuthHook = Callable[[Any, str, str|None], None]  # type: ignore
+
     def __init__(self, auth: Authenticator, default_login: str|None = None):
         self._auth = auth
         self._cookies: dict[str, dict[str, str]] = {}  # login -> name -> value
         self._default_login = default_login
 
+    def setHook(self, hook: AuthHook):
+        """Set on password hook."""
+        self._auth.setHook(lambda u, p: hook(self, u, p))
+
     def setToken(self, login: str, token: str|None):
         """Associate a token to a login, *None* to remove."""
         self._auth.setToken(login, token)
@@ -348,11 +368,13 @@ 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")
+        # this is forbidden by Flask client
+        if "json" in kwargs and "data" in kwargs:
+            # merge into data to possibly keep uploads
+            kwargs["data"].update(kwargs["json"])
+            del kwargs["json"]
 
-        # convert json parameters
+        # convert json parameters to json
         if "json" in kwargs:
             json_param = kwargs["json"]
             assert isinstance(json_param, dict)
@@ -368,7 +390,7 @@ class Client:
                 else: # pydantic or standard dataclasses?
                     json_param[name] = dataclasses.asdict(val)
 
-        # convert data parameters
+        # convert data parameters to simple strings
         if "data" in kwargs:
             data_param = kwargs["data"]
             assert isinstance(data_param, dict)
@@ -388,6 +410,7 @@ class Client:
                 else:
                     data_param[name] = json.dumps(dataclasses.asdict(val))
 
+        # now set authentication headers and do the query
         self._auth.setAuth(login, kwargs, cookies, auth=auth)
         res = self._request(method, path, cookies, **kwargs)  # type: ignore
 
@@ -530,6 +553,7 @@ def _ft_authenticator():
     auth = Authenticator(allow, user=user, pwd=pwd, login=login, bearer=bearer,
                          header=header, cookie=cookie, tparam=tparam, ptype=ptype)
 
+    # possibly load credentials from the environment
     if "FLASK_TESTER_AUTH" in os.environ:
         auth.setPasses(os.environ["FLASK_TESTER_AUTH"].split(","))
 
@@ -599,7 +623,7 @@ def _ft_client(authenticator):
         # none found
         if not app:
             raise FlaskTesterError(f"cannot find Flask app in {pkg_name} ({test_app})")
-        client = FlaskClient(authenticator, app.test_client(), default_login)
+        client = FlaskClient(authenticator, app.test_client(), default_login)  # type: ignore
 
     return client
 

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: FlaskTester
-Version: 4.2
+Version: 5.0
 Summary: Pytest fixtures for Flask internal and external authenticated tests
 Author-email: Fabien Coelho <flask.tester@coelho.net>
 License: CC0
@@ -19,7 +19,6 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests
-Requires-Dist: flask
 Requires-Dist: pytest
 Provides-Extra: dev
 Requires-Dist: mypy; extra == "dev"
@@ -27,13 +26,10 @@ Requires-Dist: pyright; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
 Requires-Dist: coverage; extra == "dev"
 Requires-Dist: pymarkdownlnt!=0.9.5; extra == "dev"
-Requires-Dist: build; extra == "dev"
-Requires-Dist: twine; extra == "dev"
-Requires-Dist: wheel; extra == "dev"
 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: FlaskSimpleAuth>=35.0; extra == "dev"
+Requires-Dist: bcrypt; extra == "dev"
 Requires-Dist: pydantic; extra == "dev"
 Provides-Extra: doc
 Requires-Dist: sphinx; extra == "doc"
@@ -41,6 +37,10 @@ Requires-Dist: sphinx_rtd_theme; extra == "doc"
 Requires-Dist: sphinx-autoapi; extra == "doc"
 Requires-Dist: sphinx-lint; extra == "doc"
 Requires-Dist: myst_parser; extra == "doc"
+Provides-Extra: pub
+Requires-Dist: build; extra == "pub"
+Requires-Dist: twine; extra == "pub"
+Requires-Dist: wheel; extra == "pub"
 
 # FlaskTester - Pytest fixtures for Flask internal and external authenticated tests
 
@@ -53,7 +53,7 @@ Only one set of tests is needed, switching from internal to external is
 achieved by setting an environment variable.
 
 ![Status](https://github.com/zx80/flask-tester/actions/workflows/package.yml/badge.svg?branch=main&style=flat)
-![Tests](https://img.shields.io/badge/tests-14%20✓-success)
+![Tests](https://img.shields.io/badge/tests-16%20✓-success)
 ![Coverage](https://img.shields.io/badge/coverage-100%25-success)
 ![Issues](https://img.shields.io/github/issues/zx80/flask-tester?style=flat)
 ![Python](https://img.shields.io/badge/python-3-informational)
@@ -75,18 +75,20 @@ import pytest
 from FlaskTester import ft_authenticator, ft_client
 import secret
 
+def authHook(api, user: str, pwd: str|None):
+    if pwd is not None:  # get a token when a login/password is provided
+        res = api.get("/login", login=user, auth="basic", status=200)
+        api.setToken(user, res.json["token"])
+    else:  # remove token
+        api.setToken(user, None)
+
 @pytest.fixture
 def app(ft_client):
+    # register authentication hook
+    ft_client.setHook(authHook)
     # add test passwords for Calvin and Hobbes (must be consistent with app!)
     ft_client.setPass("calvin", secret.PASSES["calvin"])
     ft_client.setPass("hobbes", secret.PASSES["hobbes"])
-    # get user tokens, assume json result {"token": "<token-value>"}
-    res = ft_client.get("/login", login="calvin", auth="basic", status=200)
-    assert res.is_json
-    ft_client.setToken("calvin", res.json["token"])
-    res = ft_client.post("/login", login="hobbes", auth="param", status=201)
-    assert res.is_json
-    ft_client.setToken("hobbes", res.json["token"])
     # also set a cookie
     ft_client.setCookie("hobbes", "lang", "fr")
     ft_client.setCookie("calvin", "lang", "en")
@@ -102,13 +104,13 @@ def test_app_admin(app):
         assert 'not in group "ADMIN"' in res.text
 ```
 
-This can be run against a (local) server:
+This can be run against a local or remote server:
 
 ```shell
 export TEST_SEED="some-random-data"              # shared test seed
 flask --app app:app run &                        # start flask app
 pid=$!                                           # keep pid
-export FLASK_TESTER_APP="http://localhost:5000"  # set app local url
+export FLASK_TESTER_APP="http://localhost:5000"  # set app url, local or remote
 pytest test.py                                   # run external tests
 kill $pid                                        # stop app with pid
 ```

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

@@ -9,7 +9,7 @@ Only one set of tests is needed, switching from internal to external is
 achieved by setting an environment variable.
 
 ![Status](https://github.com/zx80/flask-tester/actions/workflows/package.yml/badge.svg?branch=main&style=flat)
-![Tests](https://img.shields.io/badge/tests-14%20✓-success)
+![Tests](https://img.shields.io/badge/tests-16%20✓-success)
 ![Coverage](https://img.shields.io/badge/coverage-100%25-success)
 ![Issues](https://img.shields.io/github/issues/zx80/flask-tester?style=flat)
 ![Python](https://img.shields.io/badge/python-3-informational)
@@ -31,18 +31,20 @@ import pytest
 from FlaskTester import ft_authenticator, ft_client
 import secret
 
+def authHook(api, user: str, pwd: str|None):
+    if pwd is not None:  # get a token when a login/password is provided
+        res = api.get("/login", login=user, auth="basic", status=200)
+        api.setToken(user, res.json["token"])
+    else:  # remove token
+        api.setToken(user, None)
+
 @pytest.fixture
 def app(ft_client):
+    # register authentication hook
+    ft_client.setHook(authHook)
     # add test passwords for Calvin and Hobbes (must be consistent with app!)
     ft_client.setPass("calvin", secret.PASSES["calvin"])
     ft_client.setPass("hobbes", secret.PASSES["hobbes"])
-    # get user tokens, assume json result {"token": "<token-value>"}
-    res = ft_client.get("/login", login="calvin", auth="basic", status=200)
-    assert res.is_json
-    ft_client.setToken("calvin", res.json["token"])
-    res = ft_client.post("/login", login="hobbes", auth="param", status=201)
-    assert res.is_json
-    ft_client.setToken("hobbes", res.json["token"])
     # also set a cookie
     ft_client.setCookie("hobbes", "lang", "fr")
     ft_client.setCookie("calvin", "lang", "en")
@@ -58,13 +60,13 @@ def test_app_admin(app):
         assert 'not in group "ADMIN"' in res.text
 ```
 
-This can be run against a (local) server:
+This can be run against a local or remote server:
 
 ```shell
 export TEST_SEED="some-random-data"              # shared test seed
 flask --app app:app run &                        # start flask app
 pid=$!                                           # keep pid
-export FLASK_TESTER_APP="http://localhost:5000"  # set app local url
+export FLASK_TESTER_APP="http://localhost:5000"  # set app url, local or remote
 pytest test.py                                   # run external tests
 kill $pid                                        # stop app with pid
 ```

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

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "FlaskTester"
-version = "4.2"
+version = "5.0"
 authors = [ { name = "Fabien Coelho", email = "flask.tester@coelho.net" } ]
 description = "Pytest fixtures for Flask internal and external authenticated tests"
 readme = "README.md"
@@ -12,7 +12,6 @@ license = { text = "CC0" }
 requires-python = ">=3.10"
 dependencies = [
   "requests",
-  "flask",
   "pytest"
 ]
 classifiers = [
@@ -36,13 +35,12 @@ package = "https://pypi.org/project/FlaskTester/"
 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"
+  "types-flask", "types-requests", "FlaskSimpleAuth>=35.0", "bcrypt", "pydantic"
 ]
 # documentation generation
 doc = ["sphinx", "sphinx_rtd_theme", "sphinx-autoapi", "sphinx-lint", "myst_parser"]
+pub = ["build", "twine", "wheel"]
 
 [tool.setuptools]
 py-modules = [ "FlaskTester" ]

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

@@ -12,7 +12,7 @@ import model
 
 logging.basicConfig(level=logging.INFO)
 # logging.basicConfig(level=logging.DEBUG)
-# log = logging.getLogger("test")
+log = logging.getLogger("test")
 
 # set authn for ft_authenticator
 os.environ.update(
@@ -27,23 +27,31 @@ def test_sanity():
     # log.debug(f"TEST_SEED={os.environ.get('TEST_SEED')}")
 
 # example from README.md
+def authHook(api, user: str, pwd: str|None):
+    if pwd is not None:  # get token
+        try:
+            res = api.get("/login", login=user, auth="basic", status=200)
+            api.setToken(user, res.json["token"])
+        except ft.FlaskTesterError as e:  # pragma: no cover
+            log.warning(f"error: {e}")
+    else:  # cleanup
+        api.setToken(user, None)
+
 @pytest.fixture
 def app(ft_client):
-    # add test passwords for Calvin and Hobbes (must be consistent with app!)
+    # hook when adding login/passwords
+    ft_client.setHook(authHook)
+    # Calvin authentication
     ft_client.setPass("calvin", secret.PASSES["calvin"])
-    ft_client.setPass("hobbes", secret.PASSES["hobbes"])
-    # get user tokens, assume json result {"token": "<token-value>"}
-    res = ft_client.get("/login", login="calvin", auth="basic", status=200)
-    assert res.is_json
-    ft_client.setToken("calvin", res.json["token"])
-    res = ft_client.post("/login", login="hobbes", auth="param", status=201)
-    assert res.is_json
-    ft_client.setToken("hobbes", res.json["token"])
-    # also set a cookie
     ft_client.setCookie("hobbes", "lang", "fr")
+    # Hobbes authentication
+    ft_client.setPass("hobbes", secret.PASSES["hobbes"])
     ft_client.setCookie("calvin", "lang", "en")
     # return working client
     yield ft_client
+    # cleanup
+    ft_client.setPass("calvin", None)
+    ft_client.setPass("hobbes", None)
 
 def test_app_admin(app):  # GET /admin
     app.get("/admin", login=None, status=401)
@@ -65,15 +73,15 @@ def test_app_who_am_i(app):  # GET /who-am-i
 def api(ft_client):
     # set a default
     ft_client._default_login = "calvin"
-    # bad password / token
+    # bad password and token
     ft_client.setPass("moe", None)
     ft_client.setToken("moe", None)
     ft_client.setPass("moe", "bad password")
     ft_client.setToken("moe", "bad token")
-    # cookies
+    # set language cookies
     ft_client.setCookie("calvin", "lang", "en")
     ft_client.setCookie("hobbes", "lang", "fr")
-    # get valid tokens using password authn
+    # get valid tokens using password authn on /login
     res = ft_client.get("/login", login="calvin", auth="basic", status=200)
     assert res.json["user"] == "calvin"
     ft_client._auth.setToken("calvin", res.json["token"])
@@ -100,7 +108,7 @@ def api(ft_client):
     assert res.json["user"] == "calvin"
     res = ft_client.get("/who-am-i", status=200)
     assert res.json["user"] == "calvin"
-    # add a bad password
+    # ready for testing routes
     yield ft_client
 
 def test_admin(api):
@@ -343,6 +351,7 @@ def test_client_fixture():
 def test_classes(api):
 
     def thing_eq(ta, tb):
+        ta = model.Thing1(**ta) if isinstance(ta, dict) else ta
         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
 
@@ -356,17 +365,15 @@ def test_classes(api):
     # 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 tclass in [dict, 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
+                        assert res.is_json and isinstance(res.json, dict)
+                        assert thing_eq(tclass(**res.json), param)
+    assert n == 256
 
     # simple types translation
     assert api.get("/t0", 200, json={"t": None}).json is None

{flasktester-4.2 → flasktester-5.0}/tests/test_app2.py

@@ -26,3 +26,12 @@ def test_something(app):
     app.get("/open", 200, "Hello", login="calvin", auth="none")
     app.get("/open", 200, "Bonjour", login="hobbes", auth="none")
     app.get("/open", 200, "Guten Tag", login=None)
+
+def test_params(app):
+    res = app.get("/add", 200, data={"i": 39, "j": 3}, login=None)
+    assert res.is_json and res.json["sum"] == 42
+    res = app.get("/add", 200, json={"i": 35, "j": 7}, login=None)
+    assert res.is_json and res.json["sum"] == 42
+    # mixing data/json is okay for FlaskTester
+    res = app.get("/add", 200, data={"i": 30}, json={"j": 12}, login=None)
+    assert res.is_json and res.json["sum"] == 42