FlaskTester 3.4__tar.gz → 3.6__tar.gz

{FlaskTester-3.4 → FlaskTester-3.6}/FlaskTester.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: FlaskTester
-Version: 3.4
+Version: 3.6
 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-13%20✓-success)
+![Tests](https://img.shields.io/badge/tests-14%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)
@@ -107,7 +107,7 @@ This can be run against a (local) server:
 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
+export FLASK_TESTER_APP="http://localhost:5000"  # set app local url
 pytest test.py                                   # run external tests
 kill $pid                                        # stop app with pid
 ```
@@ -115,7 +115,7 @@ kill $pid                                        # stop app with pid
 Or locally with the Flask internal test infrastructure:
 
 ```shell
-export FLASK_TESTER_APP="app:app"                # set app module
+export FLASK_TESTER_APP="app:app"                # set app package
 pytest test.py                                   # run internal tests
 ```
 

{FlaskTester-3.4 → FlaskTester-3.6}/FlaskTester.egg-info/SOURCES.txt

@@ -8,4 +8,5 @@ FlaskTester.egg-info/SOURCES.txt
 FlaskTester.egg-info/dependency_links.txt
 FlaskTester.egg-info/requires.txt
 FlaskTester.egg-info/top_level.txt
-tests/test.py
+tests/test_app.py
+tests/test_app2.py

{FlaskTester-3.4 → FlaskTester-3.6}/FlaskTester.py

@@ -1,7 +1,6 @@
 """FlaskTester - Pytest fixtures for Flask authenticated internal and external tests.
 
-This is needed when testing this module, but may not be desirable when it is
-used depending on the ``assert``: PYTEST_DONT_REWRITE
+PYTEST_DONT_REWRITE: local assertions are really that, not pytest assertions.
 """
 
 import os
@@ -25,6 +24,20 @@ class AuthError(FlaskTesterError):
     pass
 
 
+class _AssertError(FlaskTesterError):
+    """User assertion Exception, only for internal testing."""
+    pass
+
+
+def _raiseError(msg: str):
+    """Undocumented switch for FlaskTester own tests."""
+    log.error(msg)
+    if "FLASK_TESTER_TESTING" in os.environ:
+        raise _AssertError(msg)
+    else:  # pragma: no cover  # cannot cover an expected pytest failure!
+        pytest.fail(msg)
+
+
 class Authenticator:
     """Manage HTTP request authentication.
 
@@ -336,14 +349,12 @@ class Client:
         # 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}"
+                _raiseError(f"bad {status} result: {res.status_code} {res.text[:512]}...")
 
         # 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}"
+                _raiseError(f"cannot find {content} in {res.text[:512]}...")
 
         return res
 
@@ -521,15 +532,14 @@ def _ft_client(authenticator):
     default_login = os.environ.get("FLASK_TESTER_DEFAULT", None)
     client: Client
 
-    if "FLASK_TESTER_URL" in os.environ:
-
-        app_url = os.environ["FLASK_TESTER_URL"]
-        client = RequestClient(authenticator, app_url, default_login)
-
-    elif "FLASK_TESTER_APP" in os.environ:
+    app_def = os.environ.get("FLASK_TESTER_URL", "app")
+    app_def = os.environ.get("FLASK_TESTER_APP", app_def)
 
+    if app_def.startswith("http://") or app_def.startswith("https://"):
+        client = RequestClient(authenticator, app_def, default_login)
+    else:
         # load app package
-        pkg_name, app = os.environ["FLASK_TESTER_APP"], None
+        pkg_name, app = app_def, None
         app_names = ["app", "application", "create_app", "make_app"]
         if ":" in pkg_name:  # override defaults
             pkg_name, app_name = pkg_name.split(":", 1)
@@ -546,20 +556,17 @@ def _ft_client(authenticator):
             raise FlaskTesterError(f"cannot find Flask app in {pkg_name}")
         client = FlaskClient(authenticator, app.test_client(), default_login)
 
-    else:
-
-        raise FlaskTesterError("no Flask application to test")
-
     return client
 
 @pytest.fixture
 def ft_client(ft_authenticator):
     """Pytest Fixture: ft_client.
 
-    Target environment variable, one **must** be defined:
+    Target environment variable:
 
-    - ``FLASK_TESTER_URL``: application HTTP base URL, eg ``http://localhost:5000``.
-    - ``FLASK_TESTER_APP``: Flask application, eg ``app:create_app``.
+    - ``FLASK_TESTER_APP``: find the Flask application, eg
+      ``app:create_app`` for an internal test, or
+      ``http://localhost:5000`` for an external test.
 
     Other environment variable:
 

{FlaskTester-3.4 → FlaskTester-3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: FlaskTester
-Version: 3.4
+Version: 3.6
 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-13%20✓-success)
+![Tests](https://img.shields.io/badge/tests-14%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)
@@ -107,7 +107,7 @@ This can be run against a (local) server:
 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
+export FLASK_TESTER_APP="http://localhost:5000"  # set app local url
 pytest test.py                                   # run external tests
 kill $pid                                        # stop app with pid
 ```
@@ -115,7 +115,7 @@ kill $pid                                        # stop app with pid
 Or locally with the Flask internal test infrastructure:
 
 ```shell
-export FLASK_TESTER_APP="app:app"                # set app module
+export FLASK_TESTER_APP="app:app"                # set app package
 pytest test.py                                   # run internal tests
 ```
 

{FlaskTester-3.4 → FlaskTester-3.6}/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-13%20✓-success)
+![Tests](https://img.shields.io/badge/tests-14%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)
@@ -64,7 +64,7 @@ This can be run against a (local) server:
 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
+export FLASK_TESTER_APP="http://localhost:5000"  # set app local url
 pytest test.py                                   # run external tests
 kill $pid                                        # stop app with pid
 ```
@@ -72,7 +72,7 @@ kill $pid                                        # stop app with pid
 Or locally with the Flask internal test infrastructure:
 
 ```shell
-export FLASK_TESTER_APP="app:app"                # set app module
+export FLASK_TESTER_APP="app:app"                # set app package
 pytest test.py                                   # run internal tests
 ```
 

{FlaskTester-3.4 → FlaskTester-3.6}/pyproject.toml

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

FlaskTester-3.4/tests/test.py → FlaskTester-3.6/tests/test_app.py

@@ -15,6 +15,7 @@ logging.basicConfig(level=logging.INFO)
 
 # set authn for ft_authenticator
 os.environ.update(
+    FLASK_TESTER_TESTING="*",
     FLASK_TESTER_ALLOW="bearer basic param none",
     FLASK_TESTER_AUTH=",".join(f"{l}:{p}" for l, p in secret.PASSES.items()),
 )
@@ -109,25 +110,32 @@ def test_admin(api):
         api.get("/admin", 403, login="hobbes", auth=auth)
         api.get("/admin", 401, login="moe", auth=auth)
         api.get("/admin", 401, login=None, auth=auth)
+        # test status error
         try:
             api.get("/admin", status=599, login="calvin", auth=auth)
             pytest.fail("assert on status must fail")  # pragma: no cover
-        except AssertionError as e:
+        except ft._AssertError as e:
             assert "200" in str(e)
+        # test content error
         try:
             api.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:
+        except ft._AssertError as e:
             assert "NOT THERE" in str(e)
 
 def test_errors(api):
     # these schemes are not allowed
-    for scheme in ("header", "cookie", "fake", "tparam", "unexpected"):
+    for scheme in ("header", "cookie", "fake", "tparam"):
         try:
             api.get("/login", login="calvin", auth=scheme)
             pytest.fail("must raise an exception")  # pragma: no cover
         except ft.AuthError as e:
-            assert True, "expected error"
+            assert "auth is not allowed" in str(e)
+    try:
+        api.get("/login", login="calvin", auth="foobla")
+        pytest.fail("must raise an exception")  # pragma: no cover
+    except ft.AuthError as e:
+        assert "unexpected auth" in str(e)
 
 def test_methods(api):
     res = api.get("/who-am-i", login="susie", status=200, cookies={"lang": "it"})
@@ -301,7 +309,6 @@ 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"]
@@ -310,12 +317,8 @@ def test_client_fixture():
     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"
+    # no url nor app, defaults to "app"
+    init = ft._ft_client(auth)
     # url
     os.environ["FLASK_TESTER_URL"] = "http://localhost:5000"
     init = ft._ft_client(auth)

FlaskTester-3.6/tests/test_app2.py

@@ -0,0 +1,28 @@
+import os
+import pytest
+from FlaskTester import ft_client, ft_authenticator
+
+os.environ.update(FLASK_TESTER_ALLOW="basic param none")
+
+@pytest.fixture
+def app(ft_client):
+    ft_client.setPass("calvin", "clv-pw")
+    ft_client.setCookie("calvin", "lang", "en")
+    ft_client.setPass("hobbes", "hbs-pw")
+    ft_client.setCookie("hobbes", "lang", "fr")
+    yield ft_client
+
+def test_something(app):
+    # requires an authentication
+    app.get("/authenticated", 401, login=None)
+    res = app.get("/authenticated", 200, login="calvin")
+    assert "Hello" in res.text
+    app.get("/authenticated", 200, "Bonjour", login="hobbes")
+    # only allowed to calvin
+    app.get("/only-calvin", 401, login=None)
+    app.get("/only-calvin", 200, login="calvin")
+    app.get("/only-calvin", 403, login="hobbes")
+    # no authentication required, but depends on lang
+    res = app.get("/no-auth", 200, login="calvin", auth="none")
+    assert "Hello" in res.text
+    app.get("/no-auth", 200, "Bonjour", login="hobbes", auth="none")