Feat(extension): Enable Async Gunicorn workers for Flask and Django e…

docs/reference/extensions/django-framework.rst

@@ -20,7 +20,8 @@ server metrics.
 The Django extension supports both synchronous and asynchronous
 Gunicorn workers. If you want asynchronous workers, you have to add
 the ``gevent`` package to the ``requirements.txt`` file.
-Read more :ref:`Using asynchronous Gunicorn workers <django-async-gunicorn-workers>`.
+Read more
+:ref:`Using asynchronous Gunicorn workers <django-async-gunicorn-workers>`.
 
 Project requirements
 ====================
@@ -60,14 +61,10 @@ updates the Pebble plan to use the asynchronous workers. If you have ``gevent``
 installed in your rock but decided to use ``sync`` workers instead you can do
 so by using the ``--args`` parameter of ``docker run``:
 
-.. code-block:: shell
-  :caption: Use sync workers instead of gevent
-   $ docker run \
-       --name django-container \
-       -d -p 8138:8000 \
-       django-image:1.0 \
-       --args django sync
+.. code-block:: bash
 
+   docker run --name django-container -d -p 8138:8000 django-image:1.0 \
+   --args django sync
 
 .. note::
     The Django extension is compatible with the ``bare``, ``[email protected]`` and

docs/reference/extensions/flask-framework.rst

@@ -19,7 +19,8 @@ server metrics.
 The Flask extension supports both synchronous and asynchronous
 Gunicorn workers. If you want asynchronous workers, you have to add
 ``gevent`` package to the ``requirements.txt`` file.
-Read more :ref:`Using asynchronous Gunicorn workers <flask-async-gunicorn-workers>`.
+Read more
+:ref:`Using asynchronous Gunicorn workers <flask-async-gunicorn-workers>`.
 
 Project requirements
 ====================
@@ -55,16 +56,13 @@ If you want to use asynchronous workers, you have to add ``gevent`` package to
 the ``requirements.txt`` file. Rockcraft automatically detects this and updates
 the pebble plan to use the asynchronous workers. If you have ``gevent``
 installed in your rock but decided to use ``sync`` workers instead you can use
-the ``--args`` parameter of ``docker run`` to use ``sync`` workers instead of the
-default ``gevent``:
-
-.. code-block:: shell
-  :caption: Use sync workers instead of gevent
-   $ docker run \
-       --name flask-container \
-       -d -p 8138:8000 \
-       flask-image:1.0 \
-       --args flask sync
+the ``--args`` parameter of ``docker run`` to use ``sync`` workers instead of
+the default ``gevent``:
+
+.. code-block:: bash
+
+   docker run --name flask-container -d -p 8138:8000 flask-image:1.0 \
+   --args flask sync
 
 ``parts`` > ``flask-framework/install-app`` > ``prime``
 =======================================================

tests/unit/extensions/test_gunicorn.py

@@ -51,85 +51,14 @@ def django_input_yaml_fixture():
 
 @pytest.mark.usefixtures("flask_extension")
 @pytest.mark.parametrize("packages", ["other\nflask", "flask", "Flask", " flask == 99"])
-def test_flask_extension_default(tmp_path, flask_input_yaml, packages):
-    (tmp_path / "requirements.txt").write_text(packages)
-    (tmp_path / "app.py").write_text("app = object()")
-    (tmp_path / "static").mkdir()
-    (tmp_path / "node_modules").mkdir()
-    (tmp_path / "test").write_text("test")
-    applied = extensions.apply_extensions(tmp_path, flask_input_yaml)
-    source = applied["parts"]["flask-framework/config-files"]["source"]
-    del applied["parts"]["flask-framework/config-files"]["source"]
-    suffix = "share/rockcraft/extensions/flask-framework"
-    assert source[-len(suffix) :].replace("\\", "/") == suffix
-
-    assert applied == {
-        "base": "[email protected]",
-        "parts": {
-            "flask-framework/config-files": {
-                "organize": {
-                    "gunicorn.conf.py": "flask/gunicorn.conf.py",
-                },
-                "plugin": "dump",
-            },
-            "flask-framework/dependencies": {
-                "plugin": "python",
-                "python-packages": ["gunicorn"],
-                "python-requirements": ["requirements.txt"],
-                "source": ".",
-                "stage-packages": ["python3-venv"],
-                "build-environment": [],
-            },
-            "flask-framework/install-app": {
-                "organize": {
-                    "app.py": "flask/app/app.py",
-                    "static": "flask/app/static",
-                },
-                "plugin": "dump",
-                "prime": ["flask/app/app.py", "flask/app/static"],
-                "source": ".",
-                "stage": ["flask/app/app.py", "flask/app/static"],
-            },
-            "flask-framework/runtime": {
-                "plugin": "nil",
-                "stage-packages": ["ca-certificates_data"],
-            },
-            "flask-framework/statsd-exporter": {
-                "build-snaps": ["go"],
-                "plugin": "go",
-                "source": "https://github.com/prometheus/statsd_exporter.git",
-                "source-tag": "v0.26.0",
-            },
-        },
-        "platforms": {"amd64": {}},
-        "run_user": "_daemon_",
-        "services": {
-            "flask": {
-                "after": ["statsd-exporter"],
-                "command": "/bin/python3 -m gunicorn -c "
-                "/flask/gunicorn.conf.py app:app -k [ sync ]",
-                "override": "replace",
-                "startup": "enabled",
-                "user": "_daemon_",
-            },
-            "statsd-exporter": {
-                "command": (
-                    "/bin/statsd_exporter --statsd.mapping-config=/statsd-mapping.conf "
-                    "--statsd.listen-udp=localhost:9125 "
-                    "--statsd.listen-tcp=localhost:9125"
-                ),
-                "override": "merge",
-                "startup": "enabled",
-                "summary": "statsd exporter service",
-                "user": "_daemon_",
-            },
-        },
-    }
-
-
-@pytest.mark.usefixtures("flask_extension")
-def test_flask_extension_async(tmp_path, flask_input_yaml):
-    (tmp_path / "requirements.txt").write_text("flask\ngevent")
+@pytest.mark.parametrize(
+    ("async_package", "expected_worker"), [("gevent", "gevent"), ("", "sync")]
+)
+def test_flask_extension_default(
+    tmp_path, flask_input_yaml, packages, async_package, expected_worker
+):
+    full_packages = "\n".join([packages, async_package])
+    (tmp_path / "requirements.txt").write_text(full_packages)
     (tmp_path / "app.py").write_text("app = object()")
     (tmp_path / "static").mkdir()
     (tmp_path / "node_modules").mkdir()
@@ -184,7 +113,7 @@ def test_flask_extension_async(tmp_path, flask_input_yaml):
             "flask": {
                 "after": ["statsd-exporter"],
                 "command": "/bin/python3 -m gunicorn -c "
-                "/flask/gunicorn.conf.py app:app -k [ gevent ]",
+                f"/flask/gunicorn.conf.py app:app -k [ {expected_worker} ]",
                 "override": "replace",
                 "startup": "enabled",
                 "user": "_daemon_",
@@ -524,80 +453,13 @@ def test_flask_extension_flask_service_override_disable_wsgi_path_check(tmp_path
 
 
 @pytest.mark.usefixtures("django_extension")
-def test_django_extension_default(tmp_path, django_input_yaml):
-    (tmp_path / "requirements.txt").write_text("django")
-    (tmp_path / "test").mkdir()
-    (tmp_path / "foo_bar" / "foo_bar").mkdir(parents=True)
-    (tmp_path / "foo_bar" / "foo_bar" / "wsgi.py").write_text("application = object()")
-
-    applied = extensions.apply_extensions(tmp_path, django_input_yaml)
-
-    source = applied["parts"]["django-framework/config-files"]["source"]
-    del applied["parts"]["django-framework/config-files"]["source"]
-    suffix = "share/rockcraft/extensions/django-framework"
-    assert source[-len(suffix) :].replace("\\", "/") == suffix
-
-    assert applied == {
-        "base": "[email protected]",
-        "name": "foo-bar",
-        "parts": {
-            "django-framework/config-files": {
-                "organize": {"gunicorn.conf.py": "django/gunicorn.conf.py"},
-                "plugin": "dump",
-            },
-            "django-framework/dependencies": {
-                "plugin": "python",
-                "python-packages": ["gunicorn"],
-                "python-requirements": ["requirements.txt"],
-                "source": ".",
-                "stage-packages": ["python3-venv"],
-                "build-environment": [],
-            },
-            "django-framework/install-app": {
-                "organize": {"*": "django/app/", ".*": "django/app/"},
-                "plugin": "dump",
-                "source": "foo_bar",
-                "stage": ["-django/app/db.sqlite3"],
-            },
-            "django-framework/runtime": {
-                "plugin": "nil",
-                "stage-packages": ["ca-certificates_data"],
-            },
-            "django-framework/statsd-exporter": {
-                "build-snaps": ["go"],
-                "plugin": "go",
-                "source": "https://github.com/prometheus/statsd_exporter.git",
-                "source-tag": "v0.26.0",
-            },
-        },
-        "platforms": {"amd64": {}},
-        "run_user": "_daemon_",
-        "services": {
-            "django": {
-                "after": ["statsd-exporter"],
-                "command": "/bin/python3 -m gunicorn -c /django/gunicorn.conf.py foo_bar.wsgi:application -k [ sync ]",
-                "override": "replace",
-                "startup": "enabled",
-                "user": "_daemon_",
-            },
-            "statsd-exporter": {
-                "command": (
-                    "/bin/statsd_exporter --statsd.mapping-config=/statsd-mapping.conf "
-                    "--statsd.listen-udp=localhost:9125 "
-                    "--statsd.listen-tcp=localhost:9125"
-                ),
-                "override": "merge",
-                "startup": "enabled",
-                "summary": "statsd exporter service",
-                "user": "_daemon_",
-            },
-        },
-    }
-
-
-@pytest.mark.usefixtures("django_extension")
-def test_django_extension_async(tmp_path, django_input_yaml):
-    (tmp_path / "requirements.txt").write_text("django\ngevent")
+@pytest.mark.parametrize(
+    ("packages", "expected_worker"), [("Django\ngevent", "gevent"), ("Django", "sync")]
+)
+def test_django_extension_default(
+    tmp_path, django_input_yaml, packages, expected_worker
+):
+    (tmp_path / "requirements.txt").write_text(packages)
     (tmp_path / "test").mkdir()
     (tmp_path / "foo_bar" / "foo_bar").mkdir(parents=True)
     (tmp_path / "foo_bar" / "foo_bar" / "wsgi.py").write_text("application = object()")
@@ -647,7 +509,7 @@ def test_django_extension_async(tmp_path, django_input_yaml):
         "services": {
             "django": {
                 "after": ["statsd-exporter"],
-                "command": "/bin/python3 -m gunicorn -c /django/gunicorn.conf.py foo_bar.wsgi:application -k [ gevent ]",
+                "command": f"/bin/python3 -m gunicorn -c /django/gunicorn.conf.py foo_bar.wsgi:application -k [ {expected_worker} ]",
                 "override": "replace",
                 "startup": "enabled",
                 "user": "_daemon_",