add pkg:name support for application

Author: Fabien Coelho

FlaskTester.py

@@ -420,7 +420,7 @@ def ft_authenticator():
     if "FLASK_TESTER_AUTH" in os.environ:
         auth.setPasses(os.environ["FLASK_TESTER_AUTH"].split(","))
 
-    yield auth 
+    yield auth
 
 
 @pytest.fixture
@@ -431,19 +431,31 @@ def ft_client(ft_authenticator):
     client: Client
 
     if "FLASK_TESTER_URL" in os.environ:  # pragma: no cover
+
         app_url = os.environ["FLASK_TESTER_URL"]
         client = RequestClient(ft_authenticator, app_url, default_login)
+
     elif "FLASK_TESTER_APP" in os.environ:
-        pkg_name = os.environ["FLASK_TESTER_APP"]
+
+        # load app package
+        pkg_name, app = os.environ["FLASK_TESTER_APP"], None
+        app_names = ["app", "application", "create_app", "make_app"]
+        if ":" in pkg_name:  # override defaults
+            pkg_name, app_name = pkg_name.split(":", 1)
+            app_names = [app_name]
         pkg = importlib.import_module(pkg_name)
-        if hasattr(pkg, "app"):
-            app = getattr(pkg, "app")
-        elif hasattr(pkg, "create_app"):  # pragma: no cover
-            app = getattr(pkg, "create_app")()
-        else:  # pragma: no cover
+        # find app in package
+        for name in app_names:
+            if hasattr(pkg, name):
+                app = getattr(pkg, name)
+                if callable(app) and not hasattr(app, "test_client"):
+                    app = app()
+        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)
+
     else:  # pragma: no cover
+
         raise FlaskTesterError("no Flask application to test")
 
     yield client

README.md

@@ -8,7 +8,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-9%20✓-success)
+![Tests](https://img.shields.io/badge/tests-10%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)
@@ -48,18 +48,21 @@ def test_app(app):
     assert 'not in group "ADMIN"' in res.text
 ```
 
-This can be run against a server:
+This can be run against a (local) server:
 
 ```shell
-export FLASK_TESTER_URL="https://api.flask-tester.org"
-pytest test.py
+flask --app app:app run &                        # start flask app
+pid=$!                                           # keep pid
+export FLASK_TESTER_URL="http://localhost:5000"  # set app local url
+pytest test.py                                   # run external tests
+kill $pid                                        # stop app with pid
 ```
 
 Or locally with the Flask internal test infrastructure:
 
 ```shell
-export FLASK_TESTER_APP="app"
-pytest test.py
+export FLASK_TESTER_APP="app:app"                # set app module
+pytest test.py                                   # run internal tests
 ```
 
 See [`tests/app.py`](tests/app.py) for a sample
@@ -106,8 +109,9 @@ The package provides two fixtures:
     The application is expected to be already running when the test is started.
 
   - `FLASK_TESTER_APP` package (filename with `.py`) to be imported for the application.
-    - the application is expected to be named `app`
-    - if not available, look and call for `create_app`
+    - for `pkg:name`, `name` is the application in `pkg`.
+    - for `pkg`, look for app as `app`, `application`, `create_app`, `make_app`.
+    - in both cases, `name` is called if callable and not a Flask application.
 
   Moreover:
   - `FLASK_TESTER_DEFAULT` default login for authentication, default is _None_.
@@ -187,6 +191,7 @@ please report any [issues](https://github.com/zx80/flask-tester/issues).
 
 Improved documentation and tests.
 Raise an error when setting unusable passwords or tokens.
+Add support for `pkg:name` application syntax.
 
 ### 1.1 on 2024-03-13
 

tests/Makefile

@@ -17,7 +17,7 @@ PYTOPT  =
 .PHONY: check.external
 check.external:
 	source $(VENV)/bin/activate
-	flask run --port=$(PORT) &
+	flask --app app:app run --port=$(PORT) &
 	flask_pid=$$!
 	sleep $(SLEEP)
 	export FLASK_TESTER_URL="http://localhost:$(PORT)"
@@ -27,7 +27,7 @@ check.external:
 .PHONY: check.internal
 check.internal:
 	source $(VENV)/bin/activate
-	export FLASK_TESTER_APP=app
+	export FLASK_TESTER_APP="app:create_app"
 	$(PYTEST) $(PYTOPT) test.py
 
 .PHONY: check.coverage

tests/app.py

@@ -1,15 +1,19 @@
-# Simple Flask application with authn and authz
+# Simple Test Flask application with authn and authz
 
 import FlaskSimpleAuth as fsa
 
+TEST_PASSES: dict[str, str] = {"calvin": "clv-pass", "hobbes": "hbs-pass", "susie": "ss-pass", "moe": "m-pass"}
+
 app = fsa.Flask("app", FSA_MODE="dev", FSA_AUTH=["token", "param", "basic"])
 
-PASSES: dict[str, str] = {"calvin": "clv-pass", "hobbes": "hbs-pass", "susie": "ss-pass", "moe": "m-pass"}
+# authentication
+PASSDB = {login: app.hash_password(pwd) for login, pwd in TEST_PASSES.items()}
 
 @app.get_user_pass
 def get_user_pass(login: str) -> str|None:
-    return app.hash_password(PASSES[login]) if login in PASSES else None
+    return PASSDB[login] if login in PASSDB else None
 
+# authorization
 ADMINS: set[str] = {"calvin", "susie"}
 
 @app.group_check("ADMIN")
@@ -32,3 +36,7 @@ def get_who_am_i(user: fsa.CurrentUser):
 @app.get("/admin", authorize="ADMIN")
 def get_admin(user: fsa.CurrentUser):
     return {"user": user, "isadmin": True}, 200
+
+# for coverage
+def create_app():
+    return app

tests/test.py

@@ -14,7 +14,7 @@
 # set authn for ft_authenticator
 os.environ.update(
     FLASK_TESTER_ALLOW="bearer basic param",
-    FLASK_TESTER_AUTH=",".join(f"{l}:{p}" for l, p in app.PASSES.items()),
+    FLASK_TESTER_AUTH=",".join(f"{l}:{p}" for l, p in app.TEST_PASSES.items()),
 )
 
 def test_sanity():