FlaskTester 3.0__tar.gz → 3.1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: FlaskTester
-Version: 3.0
+Version: 3.1
 Summary: Pytest fixtures for Flask internal and external authenticated tests
 Author-email: Fabien Coelho <flask.tester@coelho.net>
 License: CC0
@@ -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-11%20✓-success)
+![Tests](https://img.shields.io/badge/tests-12%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)
@@ -87,8 +87,8 @@ def app(ft_client):
     assert res.is_json
     ft_client.setToken("hobbes", res.json["token"])
     # also set a cookie
-    ft_client.setCookie("hobbes", "lang", "fr_FR")
-    ft_client.setCookie("calvin", "lang", "en_EN")
+    ft_client.setCookie("hobbes", "lang", "fr")
+    ft_client.setCookie("calvin", "lang", "en")
     # return working client
     yield ft_client
 
@@ -242,6 +242,12 @@ 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.1 on 2024-03-24
+
+More consistent test and demo code.
+Reach actual full coverage, without _any_ pragma.
+Fix default allowed authenticator schemes.
+
 ### 3.0 on 2024-03-23
 
 Add support for `none` authentication, with only cookies.

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

@@ -455,6 +455,35 @@ class FlaskClient(Client):
 
         return self._client.open(method=method, path=path, **kwargs)
 
+def _ft_authenticator():
+    """Fixture implementation separated for testing."""
+
+    level = os.environ.get("FLASK_TESTER_LOG_LEVEL", "NOTSET")
+    log.setLevel(logging.DEBUG if level == "DEBUG" else
+                 logging.INFO if level == "INFO" else
+                 logging.WARNING if level == "WARNING" else
+                 logging.ERROR if level == "ERROR" else
+                 logging.CRITICAL if level == "CRITICAL" else
+                 logging.NOTSET)
+
+    allow = os.environ.get("FLASK_TESTER_ALLOW", "bearer basic param none").split(" ")
+
+    # per-scheme parameters, must be consistent with FSA configuration
+    user = os.environ.get("FLASK_TESTER_USER", "USER")
+    pwd = os.environ.get("FLASK_TESTER_PASS", "PASS")
+    login = os.environ.get("FLASK_TESTER_LOGIN", "LOGIN")
+    bearer = os.environ.get("FLASK_TESTER_BEARER", "Bearer")
+    header = os.environ.get("FLASK_TESTER_HEADER", "Auth")
+    cookie = os.environ.get("FLASK_TESTER_COOKIE", "auth")
+    tparam = os.environ.get("FLASK_TESTER_TPARAM", "AUTH")
+
+    # create authenticator, possibly with initial credentials
+    auth = Authenticator(allow, user=user, pwd=pwd, login=login, bearer=bearer, header=header, cookie=cookie, tparam=tparam)
+
+    if "FLASK_TESTER_AUTH" in os.environ:
+        auth.setPasses(os.environ["FLASK_TESTER_AUTH"].split(","))
+
+    return auth
 
 @pytest.fixture
 def ft_authenticator():
@@ -486,56 +515,18 @@ def ft_authenticator():
       Default is not set.
     """
 
-    level = os.environ.get("FLASK_TESTER_LOG_LEVEL", "NOTSET")
-    log.setLevel(logging.DEBUG if level == "DEBUG" else
-                 logging.INFO if level == "INFO" else
-                 logging.WARNING if level == "WARNING" else
-                 logging.ERROR if level == "ERROR" else
-                 logging.CRITICAL if level == "CRITICAL" else
-                 logging.NOTSET)
-
-    allow = os.environ.get("FLASK_TESTER_ALLOW", "bearer basic param").split(" ")
-
-    # per-scheme parameters, must be consistent with FSA configuration
-    user = os.environ.get("FLASK_TESTER_USER", "USER")
-    pwd = os.environ.get("FLASK_TESTER_PASS", "PASS")
-    login = os.environ.get("FLASK_TESTER_LOGIN", "LOGIN")
-    bearer = os.environ.get("FLASK_TESTER_BEARER", "Bearer")
-    header = os.environ.get("FLASK_TESTER_HEADER", "Auth")
-    cookie = os.environ.get("FLASK_TESTER_COOKIE", "auth")
-    tparam = os.environ.get("FLASK_TESTER_TPARAM", "AUTH")
-
-    # create authenticator, possibly with initial credentials
-    auth = Authenticator(allow, user=user, pwd=pwd, login=login, bearer=bearer, header=header, cookie=cookie, tparam=tparam)
-
-    if "FLASK_TESTER_AUTH" in os.environ:
-        auth.setPasses(os.environ["FLASK_TESTER_AUTH"].split(","))
-
-    yield auth
-
-
-@pytest.fixture
-def ft_client(ft_authenticator):
-    """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:
+    yield _ft_authenticator()
 
-    - ``FLASK_TESTER_DEFAULT``: Default client login, default is *None* for no
-      default.
-    """
+def _ft_client(authenticator):
+    """Fixture implementation separated for testing."""
 
     default_login = os.environ.get("FLASK_TESTER_DEFAULT", None)
     client: Client
 
-    if "FLASK_TESTER_URL" in os.environ:  # pragma: no cover
+    if "FLASK_TESTER_URL" in os.environ:
 
         app_url = os.environ["FLASK_TESTER_URL"]
-        client = RequestClient(ft_authenticator, app_url, default_login)
+        client = RequestClient(authenticator, app_url, default_login)
 
     elif "FLASK_TESTER_APP" in os.environ:
 
@@ -553,12 +544,29 @@ def ft_client(ft_authenticator):
                 if callable(app) and not hasattr(app, "test_client"):
                     app = app()
                 break
-        if not app:  # pragma: no cover
+        if not app:
             raise FlaskTesterError(f"cannot find Flask app in {pkg_name}")
-        client = FlaskClient(ft_authenticator, app.test_client(), default_login)
+        client = FlaskClient(authenticator, app.test_client(), default_login)
 
-    else:  # pragma: no cover
+    else:
 
         raise FlaskTesterError("no Flask application to test")
 
-    yield client
+    return client
+
+@pytest.fixture
+def ft_client(ft_authenticator):
+    """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.
+    """
+
+    yield _ft_client(ft_authenticator)

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: FlaskTester
-Version: 3.0
+Version: 3.1
 Summary: Pytest fixtures for Flask internal and external authenticated tests
 Author-email: Fabien Coelho <flask.tester@coelho.net>
 License: CC0
@@ -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-11%20✓-success)
+![Tests](https://img.shields.io/badge/tests-12%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)
@@ -87,8 +87,8 @@ def app(ft_client):
     assert res.is_json
     ft_client.setToken("hobbes", res.json["token"])
     # also set a cookie
-    ft_client.setCookie("hobbes", "lang", "fr_FR")
-    ft_client.setCookie("calvin", "lang", "en_EN")
+    ft_client.setCookie("hobbes", "lang", "fr")
+    ft_client.setCookie("calvin", "lang", "en")
     # return working client
     yield ft_client
 
@@ -242,6 +242,12 @@ 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.1 on 2024-03-24
+
+More consistent test and demo code.
+Reach actual full coverage, without _any_ pragma.
+Fix default allowed authenticator schemes.
+
 ### 3.0 on 2024-03-23
 
 Add support for `none` authentication, with only cookies.

{FlaskTester-3.0 → FlaskTester-3.1}/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-11%20✓-success)
+![Tests](https://img.shields.io/badge/tests-12%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)
@@ -44,8 +44,8 @@ def app(ft_client):
     assert res.is_json
     ft_client.setToken("hobbes", res.json["token"])
     # also set a cookie
-    ft_client.setCookie("hobbes", "lang", "fr_FR")
-    ft_client.setCookie("calvin", "lang", "en_EN")
+    ft_client.setCookie("hobbes", "lang", "fr")
+    ft_client.setCookie("calvin", "lang", "en")
     # return working client
     yield ft_client
 
@@ -199,6 +199,12 @@ 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.1 on 2024-03-24
+
+More consistent test and demo code.
+Reach actual full coverage, without _any_ pragma.
+Fix default allowed authenticator schemes.
+
 ### 3.0 on 2024-03-23
 
 Add support for `none` authentication, with only cookies.

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

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

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

@@ -38,8 +38,8 @@ def app(ft_client):
     assert res.is_json
     ft_client.setToken("hobbes", res.json["token"])
     # also set a cookie
-    ft_client.setCookie("hobbes", "lang", "fr_FR")
-    ft_client.setCookie("calvin", "lang", "en_EN")
+    ft_client.setCookie("hobbes", "lang", "fr")
+    ft_client.setCookie("calvin", "lang", "en")
     # return working client
     yield ft_client
 
@@ -136,16 +136,16 @@ def test_methods(api):
 
 def test_hello(api):
     res = api.get("/hello", login="calvin", auth="none", status=200)
-    assert res.json["hello"] == "Hi"
+    assert res.json["lang"] == "en" and 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.json["lang"] == "fr" and 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.json["lang"] == "it" and 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.json["lang"] == "en" and res.json["hello"] == "Hi"
     assert res.headers["FSA-User"] == "None (None)"
 
 def test_authenticator_token():
@@ -269,6 +269,7 @@ def test_request_flask_response():
     assert not xres.is_json and xres.json is None
 
 def test_client():
+    # abstract class for coverage
     client = ft.Client(ft.Authenticator())
     try:
         client._request("GET", "/", {})
@@ -277,6 +278,7 @@ def test_client():
         assert True, "expected error raised"
 
 def test_request_client():
+    # start a tmp server on port 8888 for URL client coverage
     httpd = htsv.HTTPServer(("", 8888), htsv.SimpleHTTPRequestHandler)
     thread = threading.Thread(target = lambda: httpd.serve_forever())
     thread.start()
@@ -290,3 +292,48 @@ def test_request_client():
         client.post("/", status=501, data={"hello": "world!"})
     finally:
         httpd.shutdown()
+
+def test_client_fixture():
+    # ft_client coverage
+    auth = ft._ft_authenticator()
+    # check and save env
+    # assert "FLASK_TESTER_URL" not in os.environ
+    url = None
+    if "FLASK_TESTER_URL" in os.environ:  # pragma: no cover
+        url = os.environ["FLASK_TESTER_URL"]
+        del os.environ["FLASK_TESTER_URL"]
+    app = None
+    if "FLASK_TESTER_APP" in os.environ:
+        app = os.environ["FLASK_TESTER_APP"]
+        del os.environ["FLASK_TESTER_APP"]
+    # no url nor app
+    try:
+        init = ft._ft_client(auth)
+        pytest.fail("must fail without environment variables")  # pragma: no cover
+    except ft.FlaskTesterError:
+        assert True, "expected error raised"
+    # url
+    os.environ["FLASK_TESTER_URL"] = "http://localhost:5000"
+    init = ft._ft_client(auth)
+    assert isinstance(init, ft.RequestClient)
+    del os.environ["FLASK_TESTER_URL"]
+    # bad package
+    os.environ["FLASK_TESTER_APP"] = "no_such_package"
+    try:
+        init = ft._ft_client(auth)
+        pytest.fail("must fail on missing package")  # pragma: no cover
+    except ModuleNotFoundError:
+        assert True, "expected error raised"
+    # bad name
+    os.environ["FLASK_TESTER_APP"] = "app:no_such_app"
+    try:
+        init = ft._ft_client(auth)
+        pytest.fail("must fail on missing package")  # pragma: no cover
+    except ft.FlaskTesterError:
+        assert True, "expected error raised"
+    del os.environ["FLASK_TESTER_APP"]
+    # reset env
+    if url:  # pragma: no cover
+        os.environ["FLASK_TESTER_URL"] = url
+    if app:
+        os.environ["FLASK_TESTER_APP"] = app