working app2

Author: Fabien Coelho

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)

docs/documentation.md

@@ -71,6 +71,7 @@ from FlaskTester import ft_client, ft_authenticator
 
 os.environ.update(
     FLASK_TESTER_ALLOW="basic param none",
+    FLASK_TESTER_APP="app2:create_app",
 )
 
 @pytest.fixture
@@ -83,14 +84,14 @@ def app(ft_client):
 
 def test_something(app):
     # requires an authentication
-    app.get("/authenticated-path", 401, login=None)
-    res = app.get("/authenticated-path", 200, login="calvin")
+    app.get("/authenticated", 401, login=None)
+    res = app.get("/authenticated", 200, login="calvin")
     assert "Hello" in res.text
-    app.get("/authenticated-path", 200, "Bonjour", login="hobbes")
+    app.get("/authenticated", 200, "Bonjour", login="hobbes")
     # only allowed to calvin
-    app.get("/only-for-calvin", 401, login=None)
-    app.get("/only-for-calvin", 200, login="calvin")
-    app.get("/only-for-calvin", 403, login="hobbes")
+    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

docs/versions.md

@@ -7,7 +7,7 @@ please report any [issues](https://github.com/zx80/flask-tester/issues).
 
 ## ? on ?
 
-Improved documentation.
+Improved documentation, including a working `app2`.
 
 ## 3.5 on 2024-03-30
 

tests/Makefile

@@ -25,18 +25,19 @@ check.external:
 	flask_pid=$$!
 	sleep $(SLEEP)
 	export FLASK_TESTER_URL="http://localhost:$(PORT)"
-	$(PYTEST) $(PYTOPT) test.py
+	$(PYTEST) $(PYTOPT) test_app.py
 	kill $$flask_pid
 
 .PHONY: check.internal
 check.internal:
 	source $(VENV)/bin/activate
-	export FLASK_TESTER_APP="app:create_app"
-	$(PYTEST) $(PYTOPT) test.py
+	$(PYTEST) $(PYTOPT) test_app2.py
+	export FLASK_TESTER_APP="app"
+	$(PYTEST) $(PYTOPT) test_app.py
 
 .PHONY: check.coverage
 check.coverage:
-	$(MAKE) PYTEST="coverage run -m $(PYTEST)" check.internal
+	$(MAKE) PYTEST="coverage run -a -m $(PYTEST)" check.internal
 	coverage html ../FlaskTester.py
 	coverage report --show-missing --precision=1 --fail-under=100.0
 

tests/app.py

@@ -42,7 +42,3 @@ def get_admin(user: fsa.CurrentUser):
 @app.get("/hello", authorize="OPEN")
 def get_hello(lang: fsa.Cookie = "en"):
     return {"lang": lang, "hello": HELLO.get(lang, "Hi")}, 200
-
-# only for coverage
-def create_app():
-    return app

tests/app2.py

@@ -0,0 +1,33 @@
+# application suitable for the documentation example
+
+import FlaskSimpleAuth as fsa
+
+def create_app():
+
+    app = fsa.Flask("app2", FSA_AUTH=["basic", "param"])
+
+    # authentication
+    PASSES = {"calvin": "clv-pw", "hobbes": "hbs-pw"}
+    PASSDB = {l: app.hash_password(p) for l, p in PASSES.items()}
+    app.get_user_pass(lambda l: PASSDB.get(l, None))
+
+    # authorization
+    CALVIN = {"calvin"}
+    app.group_check("CALVIN", lambda l: l in CALVIN)
+
+    HELLO = {"en": "Hello", "fr": "Bonjour", "de": "Guten Tag"}
+
+    # 3 routes
+    @app.get("/authenticated", authorize="AUTH")
+    def get_authenticated(user: fsa.CurrentUser, lang: fsa.Cookie = "de"):
+        return fsa.jsonify(HELLO.get(lang, "Hey") + " " + user), 200
+
+    @app.get("/only-calvin", authorize="CALVIN")
+    def get_only_calvin():
+        return "Salut Calvin!", 200
+
+    @app.get("/no-auth", authorize="OPEN")
+    def get_no_auth(lang: fsa.Cookie = "de"):
+        return fsa.jsonify(HELLO.get(lang, "Hey")), 200
+
+    return app

tests/test.py renamed to tests/test_app.py

@@ -0,0 +1,32 @@
+import os
+import pytest
+from FlaskTester import ft_client, ft_authenticator
+
+# hardwired local test
+os.environ.update(
+    FLASK_TESTER_ALLOW="basic param none",
+    FLASK_TESTER_APP="app2:create_app",
+)
+
+@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")