FlaskTester 3.1__tar.gz → 3.2__tar.gz

{FlaskTester-3.1 → FlaskTester-3.2}/FlaskTester.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: FlaskTester
-Version: 3.1
+Version: 3.2
 Summary: Pytest fixtures for Flask internal and external authenticated tests
 Author-email: Fabien Coelho <flask.tester@coelho.net>
 License: CC0
@@ -46,7 +46,7 @@ Requires-Dist: myst_parser; extra == "doc"
 This package allows to run authenticated tests against a Flask application,
 either with internal Flask tests (aka `test_client`) or external tests (with
 `requests` which performs actual HTTP requests), including password and token
-authentication.
+authentication and per-user cookies.
 
 Only one set of tests is needed, switching from internal to external is
 achieved through environment variables.
@@ -109,7 +109,7 @@ def test_app_admin(app):
 This can be run against a (local) server:
 
 ```shell
-export TEST_SEED="some-random-data"              # shared seed
+export TEST_SEED="some-random-data"              # shared test seed
 flask --app app:app run &                        # start flask app
 pid=$!                                           # keep pid
 export FLASK_TESTER_URL="http://localhost:5000"  # set app local url
@@ -128,6 +128,11 @@ 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
+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
+translation service.
 
 ## Fixtures
 
@@ -155,11 +160,12 @@ The package provides two fixtures:
   - `FLASK_TESTER_LOG_LEVEL` log level for module,
     default is `NOTSET`.
 
-  The fixture has 3 main methods:
+  The fixture has 4 main methods:
   - `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` and `cookies`.
+  - `setAuth` to add authentication data to a request `kwargs` and `cookies`.  
+    This method is called automatically for adding credentials to a request.
 
 - `ft_client` for app testing, which depends on the previous fixture, plus
   environment variables which allow to find the application, at least one must
@@ -178,7 +184,7 @@ The package provides two fixtures:
 
   The fixture then provides test methods to issue test requests against a Flask application:
   - `request` generic request with `login`, `auth`, `status` end `content` extensions.
-  - `get post put patch delete` methods with `login`, `auth` and `status` extensions.
+  - `get post put patch delete` methods with `login`, `auth` and `status` extensions.  
   Moreover, `setPass`, `setToken` and `setCookie` are forwarded to the internal authenticator.
 
 Authenticator environment variables can be set from the pytest Python test file by
@@ -242,6 +248,11 @@ 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.2 on 2024-03-24
+
+Improved documentation.
+Simpler code and API documentation.
+
 ### 3.1 on 2024-03-24
 
 More consistent test and demo code.

{FlaskTester-3.1 → FlaskTester-3.2}/FlaskTester.py

@@ -293,7 +293,8 @@ class Client:
         """Run a request and return response."""
         raise NotImplementedError()
 
-    def request(self, method: str, path: str, status: int|None = None, auth: str|None = None, **kwargs):
+    def request(self, method: str, path: str, status: int|None = None, content: str|None = None,
+                auth: str|None = None, **kwargs):
         """Run a possibly authenticated HTTP request.
 
         Mandatory parameters:
@@ -304,6 +305,7 @@ class Client:
         Optional parameters:
 
         - ``status``: expected HTTP status, *None* to skip status check
+        - ``content``: regular expression for response body, *None* to skip content check
         - ``login``: authenticated user, use **explicit** *None* to skip
         - ``auth``: authentication scheme to use instead of default behavior
         - ``**kwargs``: more request parameters (headers, data, json…)
@@ -323,11 +325,18 @@ class Client:
         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
                 log.error(f"bad {status} result: {res.status_code} {res.text[:512]}")
             assert res.status_code == status, f"unexpected status {res.status_code}, expecting {status}"
 
+        # check content
+        if content is not None:
+            if not re.search(content, res.text, re.DOTALL):
+                log.error(f"cannot find {content} in {res.text}")
+                assert False, f"expected content {content} not found in {res.text}"
+
         return res
 
     def get(self, path, **kwargs):
@@ -350,32 +359,13 @@ class Client:
         """HTTP DELETE request."""
         return self.request("DELETE", path, **kwargs)
 
-    def check(self, method: str, path: str, status: int, content: str|None = None, **kwargs):
-        """Run a query and check the response.
-
-        Mandatory parameters:
-
-        - ``method``: HTTP method ("GET", "POST", "PATCH", "DELETE"…)
-        - ``path``: local path under the base URL
-        - ``status``: expected HTTP status
-
-        Optional parameters:
+    def check(self, method: str, path: str, status: int, **kwargs):
+        """Run a query and check the response status.
 
-        - ``content``: regular expression in response body
-        - ``login``: authenticated user, use explicit *None* to skip
-        - ``**kwargs``: more request parameters (headers, data, json…)
+        Same as ``request``, but ``status`` is mandatory.
         """
 
-        # get HTTP response
-        res = self.request(method, path, status=status, **kwargs)
-
-        # check contents
-        if content is not None:
-            if not re.search(content, res.text, re.DOTALL):
-                log.error(f"cannot find {content} in {res.text}")
-                assert False, f"expected content {content} not found in {res.text}"
-
-        return res
+        return self.request(method, path, status=status, **kwargs)
 
 
 class RequestClient(Client):
@@ -496,7 +486,7 @@ def ft_authenticator():
       Default is ``NOTSET``.
     - ``FLASK_TESTER_ALLOW``: allowed space-separated authentication schemes, in
       ``basic param bearer header cookie tparam fake none``.
-      Default is ``bearer basic param``.
+      Default is ``bearer basic param none``.
     - ``FLASK_TESTER_USER``: user login parameter for ``param`` authentication.
       Default is ``USER``.
     - ``FLASK_TESTER_PASS``: user password parameter for ``param`` authentication.

{FlaskTester-3.1 → FlaskTester-3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: FlaskTester
-Version: 3.1
+Version: 3.2
 Summary: Pytest fixtures for Flask internal and external authenticated tests
 Author-email: Fabien Coelho <flask.tester@coelho.net>
 License: CC0
@@ -46,7 +46,7 @@ Requires-Dist: myst_parser; extra == "doc"
 This package allows to run authenticated tests against a Flask application,
 either with internal Flask tests (aka `test_client`) or external tests (with
 `requests` which performs actual HTTP requests), including password and token
-authentication.
+authentication and per-user cookies.
 
 Only one set of tests is needed, switching from internal to external is
 achieved through environment variables.
@@ -109,7 +109,7 @@ def test_app_admin(app):
 This can be run against a (local) server:
 
 ```shell
-export TEST_SEED="some-random-data"              # shared seed
+export TEST_SEED="some-random-data"              # shared test seed
 flask --app app:app run &                        # start flask app
 pid=$!                                           # keep pid
 export FLASK_TESTER_URL="http://localhost:5000"  # set app local url
@@ -128,6 +128,11 @@ 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
+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
+translation service.
 
 ## Fixtures
 
@@ -155,11 +160,12 @@ The package provides two fixtures:
   - `FLASK_TESTER_LOG_LEVEL` log level for module,
     default is `NOTSET`.
 
-  The fixture has 3 main methods:
+  The fixture has 4 main methods:
   - `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` and `cookies`.
+  - `setAuth` to add authentication data to a request `kwargs` and `cookies`.  
+    This method is called automatically for adding credentials to a request.
 
 - `ft_client` for app testing, which depends on the previous fixture, plus
   environment variables which allow to find the application, at least one must
@@ -178,7 +184,7 @@ The package provides two fixtures:
 
   The fixture then provides test methods to issue test requests against a Flask application:
   - `request` generic request with `login`, `auth`, `status` end `content` extensions.
-  - `get post put patch delete` methods with `login`, `auth` and `status` extensions.
+  - `get post put patch delete` methods with `login`, `auth` and `status` extensions.  
   Moreover, `setPass`, `setToken` and `setCookie` are forwarded to the internal authenticator.
 
 Authenticator environment variables can be set from the pytest Python test file by
@@ -242,6 +248,11 @@ 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.2 on 2024-03-24
+
+Improved documentation.
+Simpler code and API documentation.
+
 ### 3.1 on 2024-03-24
 
 More consistent test and demo code.

{FlaskTester-3.1 → FlaskTester-3.2}/README.md

@@ -3,7 +3,7 @@
 This package allows to run authenticated tests against a Flask application,
 either with internal Flask tests (aka `test_client`) or external tests (with
 `requests` which performs actual HTTP requests), including password and token
-authentication.
+authentication and per-user cookies.
 
 Only one set of tests is needed, switching from internal to external is
 achieved through environment variables.
@@ -66,7 +66,7 @@ def test_app_admin(app):
 This can be run against a (local) server:
 
 ```shell
-export TEST_SEED="some-random-data"              # shared seed
+export TEST_SEED="some-random-data"              # shared test seed
 flask --app app:app run &                        # start flask app
 pid=$!                                           # keep pid
 export FLASK_TESTER_URL="http://localhost:5000"  # set app local url
@@ -85,6 +85,11 @@ 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
+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
+translation service.
 
 ## Fixtures
 
@@ -112,11 +117,12 @@ The package provides two fixtures:
   - `FLASK_TESTER_LOG_LEVEL` log level for module,
     default is `NOTSET`.
 
-  The fixture has 3 main methods:
+  The fixture has 4 main methods:
   - `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` and `cookies`.
+  - `setAuth` to add authentication data to a request `kwargs` and `cookies`.  
+    This method is called automatically for adding credentials to a request.
 
 - `ft_client` for app testing, which depends on the previous fixture, plus
   environment variables which allow to find the application, at least one must
@@ -135,7 +141,7 @@ The package provides two fixtures:
 
   The fixture then provides test methods to issue test requests against a Flask application:
   - `request` generic request with `login`, `auth`, `status` end `content` extensions.
-  - `get post put patch delete` methods with `login`, `auth` and `status` extensions.
+  - `get post put patch delete` methods with `login`, `auth` and `status` extensions.  
   Moreover, `setPass`, `setToken` and `setCookie` are forwarded to the internal authenticator.
 
 Authenticator environment variables can be set from the pytest Python test file by
@@ -199,6 +205,11 @@ 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.2 on 2024-03-24
+
+Improved documentation.
+Simpler code and API documentation.
+
 ### 3.1 on 2024-03-24
 
 More consistent test and demo code.

{FlaskTester-3.1 → FlaskTester-3.2}/pyproject.toml

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