FlaskTester 2.0__tar.gz → 3.0__tar.gz

{FlaskTester-2.0 → FlaskTester-3.0}/FlaskTester.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: FlaskTester
-Version: 2.0
+Version: 3.0
 Summary: Pytest fixtures for Flask internal and external authenticated tests
 Author-email: Fabien Coelho <flask.tester@coelho.net>
 License: CC0
@@ -32,7 +32,7 @@ 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>=29.4; extra == "dev"
+Requires-Dist: FlaskSimpleAuth>=29.5; extra == "dev"
 Requires-Dist: passlib; extra == "dev"
 Provides-Extra: doc
 Requires-Dist: sphinx; extra == "doc"
@@ -52,7 +52,7 @@ Only one set of tests is needed, switching from internal to external is
 achieved through environment variables.
 
 ![Status](https://github.com/zx80/flask-tester/actions/workflows/package.yml/badge.svg?branch=main&style=flat)
-![Tests](https://img.shields.io/badge/tests-10%20✓-success)
+![Tests](https://img.shields.io/badge/tests-11%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)
@@ -136,7 +136,7 @@ The package provides two fixtures:
 - `ft_authenticator` for app authentication, which depends on environment variables:
 
   - `FLASK_TESTER_ALLOW` space-separated list of allowed authentication schemes,
-    default is `["bearer", "basic", "param"]`.
+    default is `["bearer", "basic", "param", "none"]`.
   - `FLASK_TESTER_AUTH` comma-separated list of _login:password_ credentials.
   - `FLASK_TESTER_USER` user login parameter for `param` password authentication,
     default is `USER`.
@@ -159,7 +159,7 @@ The package provides two fixtures:
   - `setPass` to associate a password to a user, set to _None_ to remove credential.
   - `setToken` to associate a token to a user, set to _None_ to remove credential.
   - `setCookie` to add a cookie to a user, set value to _None_ to remove cookie.
-  - `setAuth` to add authentication data to a request `kwargs`.
+  - `setAuth` to add authentication data to a request `kwargs` and `cookies`.
 
 - `ft_client` for app testing, which depends on the previous fixture, plus
   environment variables which allow to find the application, at least one must
@@ -242,6 +242,10 @@ Packages are distributed from [PyPI](https://pypi.org/project/FlaskTester/),
 see also the [documentation](https://zx80.github.io/flask-tester/),
 please report any [issues](https://github.com/zx80/flask-tester/issues).
 
+### 3.0 on 2024-03-23
+
+Add support for `none` authentication, with only cookies.
+
 ### 2.0 on 2024-03-23
 
 Add support for cookies.

{FlaskTester-2.0 → FlaskTester-3.0}/FlaskTester.egg-info/requires.txt

@@ -13,7 +13,7 @@ twine
 wheel
 types-flask
 types-requests
-FlaskSimpleAuth>=29.4
+FlaskSimpleAuth>=29.5
 passlib
 
 [doc]

{FlaskTester-2.0 → FlaskTester-3.0}/FlaskTester.py

@@ -36,11 +36,12 @@ class Authenticator:
     - ``cookie``: token in a cookie
     - ``tparam``: token in a parameter
     - ``fake``: fake scheme, login directly passed as a parameter
+    - ``none``: no authentication, only cookies
 
     Constructor parameters:
 
     - ``allow``: list of allowed schemes.
-      default is ``["bearer", "basic", "param"]``
+      default is ``["bearer", "basic", "param", "none"]``
     - ``user``: parameter for user on ``param`` password authentication,
       default is ``USER``
     - ``pwd``: parameter for password on ``param`` password authentication,
@@ -61,12 +62,12 @@ class Authenticator:
     _PASS_SCHEMES = {"basic", "param"}
 
     # all supported authentication schemes
-    _AUTH_SCHEMES = {"fake"}
+    _AUTH_SCHEMES = {"fake", "none"}
     _AUTH_SCHEMES.update(_TOKEN_SCHEMES)
     _AUTH_SCHEMES.update(_PASS_SCHEMES)
 
     def __init__(self,
-             allow: list[str] = ["bearer", "basic", "param"],
+             allow: list[str] = ["bearer", "basic", "param", "none"],
              # parameter names for "basic" and "param"
              user: str = "USER",
              pwd: str = "PASS",
@@ -214,6 +215,10 @@ class Authenticator:
 
             self._param(kwargs, self._login, login)
 
+        elif self._try_auth(auth, "none"):
+
+            pass
+
         else:
 
             raise AuthError(f"no authentication for login={login} auth={auth} allow={self._allow}")
@@ -461,7 +466,7 @@ def ft_authenticator():
       ``DEBUG INFO WARNING ERROR CRITICAL NOSET``.
       Default is ``NOTSET``.
     - ``FLASK_TESTER_ALLOW``: allowed space-separated authentication schemes, in
-      ``basic param bearer header cookie tparam fake``.
+      ``basic param bearer header cookie tparam fake none``.
       Default is ``bearer basic param``.
     - ``FLASK_TESTER_USER``: user login parameter for ``param`` authentication.
       Default is ``USER``.

{FlaskTester-2.0 → FlaskTester-3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: FlaskTester
-Version: 2.0
+Version: 3.0
 Summary: Pytest fixtures for Flask internal and external authenticated tests
 Author-email: Fabien Coelho <flask.tester@coelho.net>
 License: CC0
@@ -32,7 +32,7 @@ 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>=29.4; extra == "dev"
+Requires-Dist: FlaskSimpleAuth>=29.5; extra == "dev"
 Requires-Dist: passlib; extra == "dev"
 Provides-Extra: doc
 Requires-Dist: sphinx; extra == "doc"
@@ -52,7 +52,7 @@ Only one set of tests is needed, switching from internal to external is
 achieved through environment variables.
 
 ![Status](https://github.com/zx80/flask-tester/actions/workflows/package.yml/badge.svg?branch=main&style=flat)
-![Tests](https://img.shields.io/badge/tests-10%20✓-success)
+![Tests](https://img.shields.io/badge/tests-11%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)
@@ -136,7 +136,7 @@ The package provides two fixtures:
 - `ft_authenticator` for app authentication, which depends on environment variables:
 
   - `FLASK_TESTER_ALLOW` space-separated list of allowed authentication schemes,
-    default is `["bearer", "basic", "param"]`.
+    default is `["bearer", "basic", "param", "none"]`.
   - `FLASK_TESTER_AUTH` comma-separated list of _login:password_ credentials.
   - `FLASK_TESTER_USER` user login parameter for `param` password authentication,
     default is `USER`.
@@ -159,7 +159,7 @@ The package provides two fixtures:
   - `setPass` to associate a password to a user, set to _None_ to remove credential.
   - `setToken` to associate a token to a user, set to _None_ to remove credential.
   - `setCookie` to add a cookie to a user, set value to _None_ to remove cookie.
-  - `setAuth` to add authentication data to a request `kwargs`.
+  - `setAuth` to add authentication data to a request `kwargs` and `cookies`.
 
 - `ft_client` for app testing, which depends on the previous fixture, plus
   environment variables which allow to find the application, at least one must
@@ -242,6 +242,10 @@ Packages are distributed from [PyPI](https://pypi.org/project/FlaskTester/),
 see also the [documentation](https://zx80.github.io/flask-tester/),
 please report any [issues](https://github.com/zx80/flask-tester/issues).
 
+### 3.0 on 2024-03-23
+
+Add support for `none` authentication, with only cookies.
+
 ### 2.0 on 2024-03-23
 
 Add support for cookies.

{FlaskTester-2.0 → FlaskTester-3.0}/README.md

@@ -9,7 +9,7 @@ Only one set of tests is needed, switching from internal to external is
 achieved through environment variables.
 
 ![Status](https://github.com/zx80/flask-tester/actions/workflows/package.yml/badge.svg?branch=main&style=flat)
-![Tests](https://img.shields.io/badge/tests-10%20✓-success)
+![Tests](https://img.shields.io/badge/tests-11%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)
@@ -93,7 +93,7 @@ The package provides two fixtures:
 - `ft_authenticator` for app authentication, which depends on environment variables:
 
   - `FLASK_TESTER_ALLOW` space-separated list of allowed authentication schemes,
-    default is `["bearer", "basic", "param"]`.
+    default is `["bearer", "basic", "param", "none"]`.
   - `FLASK_TESTER_AUTH` comma-separated list of _login:password_ credentials.
   - `FLASK_TESTER_USER` user login parameter for `param` password authentication,
     default is `USER`.
@@ -116,7 +116,7 @@ The package provides two fixtures:
   - `setPass` to associate a password to a user, set to _None_ to remove credential.
   - `setToken` to associate a token to a user, set to _None_ to remove credential.
   - `setCookie` to add a cookie to a user, set value to _None_ to remove cookie.
-  - `setAuth` to add authentication data to a request `kwargs`.
+  - `setAuth` to add authentication data to a request `kwargs` and `cookies`.
 
 - `ft_client` for app testing, which depends on the previous fixture, plus
   environment variables which allow to find the application, at least one must
@@ -199,6 +199,10 @@ Packages are distributed from [PyPI](https://pypi.org/project/FlaskTester/),
 see also the [documentation](https://zx80.github.io/flask-tester/),
 please report any [issues](https://github.com/zx80/flask-tester/issues).
 
+### 3.0 on 2024-03-23
+
+Add support for `none` authentication, with only cookies.
+
 ### 2.0 on 2024-03-23
 
 Add support for cookies.

{FlaskTester-2.0 → FlaskTester-3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "FlaskTester"
-version = "2.0"
+version = "3.0"
 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,7 @@ 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>=29.4", "passlib"]
+dev = ["mypy", "pyright", "ruff", "coverage", "pymarkdownlnt!=0.9.5", "build", "twine", "wheel", "types-flask", "types-requests", "FlaskSimpleAuth>=29.5", "passlib"]
 # documentation generation
 doc = ["sphinx", "sphinx_rtd_theme", "sphinx-autoapi", "sphinx-lint", "myst_parser"]
 

{FlaskTester-2.0 → FlaskTester-3.0}/tests/test.py

@@ -15,7 +15,7 @@ logging.basicConfig(level=logging.INFO)
 
 # set authn for ft_authenticator
 os.environ.update(
-    FLASK_TESTER_ALLOW="bearer basic param",
+    FLASK_TESTER_ALLOW="bearer basic param none",
     FLASK_TESTER_AUTH=",".join(f"{l}:{p}" for l, p in secret.PASSES.items()),
 )
 
@@ -66,8 +66,8 @@ def api(ft_client):
     ft_client.setPass("moe", "bad password")
     ft_client.setToken("moe", "bad token")
     # cookies
-    ft_client.setCookie("calvin", "lang", "en_EN")
-    ft_client.setCookie("hobbes", "lang", "fr_FR")
+    ft_client.setCookie("calvin", "lang", "en")
+    ft_client.setCookie("hobbes", "lang", "fr")
     # get valid tokens using password authn
     res = ft_client.get("/login", login="calvin", auth="basic", status=200)
     assert res.json["user"] == "calvin"
@@ -78,11 +78,12 @@ def api(ft_client):
     res = ft_client.post("/login", login="susie", auth="param", status=201, json={})
     assert res.json["user"] == "susie"
     ft_client._auth.setToken("susie", res.json["token"])
+    ft_client.get("/login", login="calvin", auth="none", status=401)
     # check that token auth and cookie is ok
     res = ft_client.get("/who-am-i", login="calvin", status=200, auth="bearer")
-    assert res.json["user"] == "calvin" and res.json["lang"] == "en_EN"
+    assert res.json["user"] == "calvin" and res.json["lang"] == "en"
     res = ft_client.get("/who-am-i", login="hobbes", status=200, auth="bearer")
-    assert res.json["user"] == "hobbes" and res.json["lang"] == "fr_FR"
+    assert res.json["user"] == "hobbes" and res.json["lang"] == "fr"
     res = ft_client.get("/who-am-i", login="susie", status=200, auth="bearer")
     assert res.json["user"] == "susie" and res.json["lang"] is None
     # with defaults
@@ -117,6 +118,7 @@ def test_admin(api):
             assert "NOT THERE" in str(e)
 
 def test_errors(api):
+    # these schemes are not allowed
     for scheme in ("header", "cookie", "fake", "tparam", "unexpected"):
         try:
             api.get("/login", login="calvin", auth=scheme)
@@ -125,13 +127,27 @@ def test_errors(api):
             assert True, "expected error"
 
 def test_methods(api):
-    res = api.get("/who-am-i", login="susie", status=200, cookies={"lang": "python"})
-    assert res.json["lang"] == "python"
+    res = api.get("/who-am-i", login="susie", status=200, cookies={"lang": "it"})
+    assert res.json["lang"] == "it"
     api.post("/who-am-i", login="hobbes", status=405)
     api.put("/who-am-i", login="hobbes", status=405)
     api.patch("/who-am-i", login="hobbes", status=405)
     api.delete("/who-am-i", login="hobbes", status=405)
 
+def test_hello(api):
+    res = api.get("/hello", login="calvin", auth="none", status=200)
+    assert res.json["hello"] == "Hi"
+    assert res.headers["FSA-User"] == "None (None)"
+    res = api.get("/hello", login="hobbes", auth="none", status=200)
+    assert res.json["hello"] == "Salut"
+    assert res.headers["FSA-User"] == "None (None)"
+    res = api.get("/hello", login="susie", auth="none", status=200, cookies={"lang": "it"})
+    assert res.json["hello"] == "Ciao"
+    assert res.headers["FSA-User"] == "None (None)"
+    res = api.get("/hello", login="moe", auth="none", status=200)
+    assert res.json["hello"] == "Hi"
+    assert res.headers["FSA-User"] == "None (None)"
+
 def test_authenticator_token():
     # all token carriers
     auth = ft.Authenticator(allow=["bearer", "header", "tparam", "cookie"])