FlaskTester 1.3__tar.gz → 1.4__tar.gz

{FlaskTester-1.3 → FlaskTester-1.4}/FlaskTester.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: FlaskTester
-Version: 1.3
+Version: 1.4
 Summary: Pytest fixtures for Flask internal and external authenticated tests
 Author-email: Fabien Coelho <flask.tester@coelho.net>
 License: CC0
@@ -65,7 +65,7 @@ achieved through environment variables.
 Install package with `pip install FlaskTester` or equivalent.
 
 The following test creates a local fixture with 2 users identified by a
-password, and retrieves a token for the first user using a `/login` route
+password, and retrieves tokens for both users using a `/login` route
 provided by the application.
 It then proceeds to run authenticated requests against the `/admin` route.
 
@@ -225,14 +225,24 @@ The implementation of these fixtures is based on five classes plus exceptions:
 
 ## License
 
-This code is public domain.
+This code is [Public Domain](https://creativecommons.org/publicdomain/zero/1.0/).
+
+All software has bug, this is software, hence… Beware that you may lose your
+hairs or your friends because of it. If you like it, feel free to send a
+postcard to the author.
+
+## Versions
 
 Packages are distributed from [PyPI](https://pypi.org/project/FlaskTester/),
 [sources](https://github.com/zx80/flask-tester) are available on GitHub,
 see also the [documentation](https://zx80.github.io/flask-tester/),
 please report any [issues](https://github.com/zx80/flask-tester/issues).
 
-## Versions
+### 1.4 on 2024-03-19
+
+Test expected assert failures.
+Improved API documentation.
+Keep first found app.
 
 ### 1.3 on 2024-03-16
 

{FlaskTester-1.3 → FlaskTester-1.4}/FlaskTester.py

@@ -1,3 +1,8 @@
+"""FlaskTester - Pytest fixtures for Flask authenticated internal and external tests.
+
+Pytest: PYTEST_DONT_REWRITE
+"""
+
 import os
 import io
 import re
@@ -283,9 +288,9 @@ class Client:
         res = self._request(method, path, **kwargs)  # type: ignore
 
         if status is not None:
-            if res.status_code != status:  # pragma: no cover  # show error before aborting
+            if res.status_code != status:  # show error before aborting
                 log.error(f"bad {status} result: {res.status_code} {res.text[:512]}")
-            assert res.status_code == status
+            assert res.status_code == status, f"unexpected status {res.status_code}, expecting {status}"
 
         return res
 
@@ -330,9 +335,9 @@ class Client:
 
         # check contents
         if content is not None:
-            if not re.search(content, res.text, re.DOTALL):  # pragma: no cover
+            if not re.search(content, res.text, re.DOTALL):
                 log.error(f"cannot find {content} in {res.text}")
-                assert False, "content not found"
+                assert False, f"expected content {content} not found in {res.text}"
 
         return res
 
@@ -404,7 +409,31 @@ class FlaskClient(Client):
 
 @pytest.fixture
 def ft_authenticator():
-    """Pytest Fixture: ft_authenticator."""
+    """Pytest Fixture: ft_authenticator.
+
+    Environment variables:
+
+    - ``FLASK_TESTER_LOG_LEVEL``: package log level in
+      ``DEBUG INFO WARNING ERROR CRITICAL NOSET``.
+    - ``FLASK_TESTER_ALLOW``: allowed space-separated authentication schemes, in
+      ``basic param bearer header cookie tparam fake``.
+      Default is ``bearer basic param``.
+    - ``FLASK_TESTER_USER``: user login parameter for ``param`` authentication.
+      Default is ``USER``.
+    - ``FLASK_TESTER_PASS``: user password parameter for ``param`` authentication.
+      Default is ``PASS``.
+    - ``FLASK_TESTER_LOGIN``: user login parameter for ``fake`` authentication.
+      Default is ``LOGIN``.
+    - ``FLASK_TESTER_BEARER``: bearer name for *token* authentication.
+      Default is ``Bearer``.
+    - ``FLASK_TESTER_HEADER``: header name for *token* authentication.
+      Default is ``Auth``.
+    - ``FLASK_TESTER_COOKIE``: cookie name for *token* authentication.
+      Default is ``auth``.
+    - ``FLASK_TESTER_TPARAM``: parameter for *token* authentication.
+      Default is ``AUTH``.
+    - ``FLASK_TESTER_AUTH``: initial comma-separated list of *login:password*.
+    """
 
     level = os.environ.get("FLASK_TESTER_LOG_LEVEL", "NOTSET")
     log.setLevel(logging.DEBUG if level == "DEBUG" else
@@ -436,7 +465,18 @@ def ft_authenticator():
 
 @pytest.fixture
 def ft_client(ft_authenticator):
-    """Pytest Fixture: ft_client."""
+    """Pytest Fixture: ft_client.
+
+    Target environment variable, one **must** be defined:
+
+    - ``FLASK_TESTER_URL``: application HTTP base URL.
+    - ``FLASK_TESTER_APP``: Flask application, eg ``app:create_app``.
+
+    Other environment variable:
+
+    - ``FLASK_TESTER_DEFAULT``: Default client login, default is *None* for no
+      default.
+    """
 
     default_login = os.environ.get("FLASK_TESTER_DEFAULT", None)
     client: Client
@@ -461,6 +501,7 @@ def ft_client(ft_authenticator):
                 app = getattr(pkg, name)
                 if callable(app) and not hasattr(app, "test_client"):
                     app = app()
+                break
         if not app:  # pragma: no cover
             raise FlaskTesterError(f"cannot find Flask app in {pkg_name}")
         client = FlaskClient(ft_authenticator, app.test_client(), default_login)

{FlaskTester-1.3 → FlaskTester-1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: FlaskTester
-Version: 1.3
+Version: 1.4
 Summary: Pytest fixtures for Flask internal and external authenticated tests
 Author-email: Fabien Coelho <flask.tester@coelho.net>
 License: CC0
@@ -65,7 +65,7 @@ achieved through environment variables.
 Install package with `pip install FlaskTester` or equivalent.
 
 The following test creates a local fixture with 2 users identified by a
-password, and retrieves a token for the first user using a `/login` route
+password, and retrieves tokens for both users using a `/login` route
 provided by the application.
 It then proceeds to run authenticated requests against the `/admin` route.
 
@@ -225,14 +225,24 @@ The implementation of these fixtures is based on five classes plus exceptions:
 
 ## License
 
-This code is public domain.
+This code is [Public Domain](https://creativecommons.org/publicdomain/zero/1.0/).
+
+All software has bug, this is software, hence… Beware that you may lose your
+hairs or your friends because of it. If you like it, feel free to send a
+postcard to the author.
+
+## Versions
 
 Packages are distributed from [PyPI](https://pypi.org/project/FlaskTester/),
 [sources](https://github.com/zx80/flask-tester) are available on GitHub,
 see also the [documentation](https://zx80.github.io/flask-tester/),
 please report any [issues](https://github.com/zx80/flask-tester/issues).
 
-## Versions
+### 1.4 on 2024-03-19
+
+Test expected assert failures.
+Improved API documentation.
+Keep first found app.
 
 ### 1.3 on 2024-03-16
 

{FlaskTester-1.3 → FlaskTester-1.4}/README.md

@@ -22,7 +22,7 @@ achieved through environment variables.
 Install package with `pip install FlaskTester` or equivalent.
 
 The following test creates a local fixture with 2 users identified by a
-password, and retrieves a token for the first user using a `/login` route
+password, and retrieves tokens for both users using a `/login` route
 provided by the application.
 It then proceeds to run authenticated requests against the `/admin` route.
 
@@ -182,14 +182,24 @@ The implementation of these fixtures is based on five classes plus exceptions:
 
 ## License
 
-This code is public domain.
+This code is [Public Domain](https://creativecommons.org/publicdomain/zero/1.0/).
+
+All software has bug, this is software, hence… Beware that you may lose your
+hairs or your friends because of it. If you like it, feel free to send a
+postcard to the author.
+
+## Versions
 
 Packages are distributed from [PyPI](https://pypi.org/project/FlaskTester/),
 [sources](https://github.com/zx80/flask-tester) are available on GitHub,
 see also the [documentation](https://zx80.github.io/flask-tester/),
 please report any [issues](https://github.com/zx80/flask-tester/issues).
 
-## Versions
+### 1.4 on 2024-03-19
+
+Test expected assert failures.
+Improved API documentation.
+Keep first found app.
 
 ### 1.3 on 2024-03-16
 

{FlaskTester-1.3 → FlaskTester-1.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "FlaskTester"
-version = "1.3"
+version = "1.4"
 authors = [ { name = "Fabien Coelho", email = "flask.tester@coelho.net" } ]
 description = "Pytest fixtures for Flask internal and external authenticated tests"
 readme = "README.md"

{FlaskTester-1.3 → FlaskTester-1.4}/tests/test.py

@@ -96,12 +96,22 @@ def test_admin(api):
         api.check("GET", "/admin", 403, login="hobbes", auth=auth)
         api.check("GET", "/admin", 401, login="moe", auth=auth)
         api.check("GET", "/admin", 401, login=None, auth=auth)
+        try:
+            api.check("GET", "/admin", status=599, login="calvin", auth=auth)
+            pytest.fail("assert on status must fail")  # pragma: no cover
+        except AssertionError as e:
+            assert "200" in str(e)
+        try:
+            api.check("GET", "/admin", status=200, login="calvin", auth=auth, content="NOT THERE")
+            pytest.fail("assert on content must fail")  # pragma: no cover
+        except AssertionError as e:
+            assert "NOT THERE" in str(e)
 
 def test_errors(api):
     for scheme in ("header", "cookie", "fake", "tparam", "unexpected"):
         try:
             api.get("/login", login="calvin", auth=scheme)
-            assert False, "must raise an exception"  # pragma: no cover
+            pytest.fail("must raise an exception")  # pragma: no cover
         except ft.AuthError as e:
             assert True, "expected error"
 
@@ -138,13 +148,13 @@ def test_authenticator_token():
     try:
         kwargs = {}
         auth.setAuth("dad", kwargs)
-        assert False, "must raise an error"  # pragma: no cover
+        pytest.fail("must raise an error")  # pragma: no cover
     except ft.FlaskTesterError:
         assert True, "error raised"
     # rosalyn as a password, but no password carrier is allowed
     try:
         auth.setPass("rosalyn", "rsln-pass")
-        assert False, "must raise an error"  # pragma: no cover
+        pytest.fail("must raise an error")  # pragma: no cover
     except ft.AuthError:
         assert True, "error raised"
     # force to trigger later errors
@@ -153,7 +163,7 @@ def test_authenticator_token():
     try:
         kwargs={}
         auth.setAuth("rosalyn", kwargs)
-        assert False, "must raise an error"  # pragma: no cover
+        pytest.fail("must raise an error")  # pragma: no cover
     except ft.FlaskTesterError:
         assert True, "error raised"
 
@@ -182,7 +192,7 @@ def test_authenticator_password():
     # susie as a token, but no token carrier is allowed
     try:
         auth.setToken("susie", "ss-token")
-        assert False, "must raise an error"  # pragma: no cover
+        pytest.fail("must raise an error")  # pragma: no cover
     except ft.FlaskTesterError:
         assert True, "error raised"
     # force to trigger later error
@@ -191,7 +201,7 @@ def test_authenticator_password():
     try:
         kwargs={}
         auth.setAuth("susie", kwargs)
-        assert False, "must raise an error"  # pragma: no cover
+        pytest.fail("must raise an error")  # pragma: no cover
     except ft.FlaskTesterError:
         assert True, "error raised"
 
@@ -224,9 +234,9 @@ def test_client():
     client = ft.Client(ft.Authenticator())
     try:
         client._request("GET", "/")
-        assert False, "must raise an error"  # pragma: no cover
+        pytest.fail("must raise an error")  # pragma: no cover
     except NotImplementedError:
-        assert True, "error raised"
+        assert True, "expected error raised"
 
 def test_request_client():
     httpd = htsv.HTTPServer(("", 8888), htsv.SimpleHTTPRequestHandler)