Refactored test plugins into tests/plugins, closes #775

tests/plugins/my_plugin.py

@@ -0,0 +1,89 @@
+from datasette import hookimpl
+import base64
+import pint
+import json
+
+ureg = pint.UnitRegistry()
+
+
+@hookimpl
+def prepare_connection(conn, database, datasette):
+    def convert_units(amount, from_, to_):
+        "select convert_units(100, 'm', 'ft');"
+        return (amount * ureg(from_)).to(to_).to_tuple()[0]
+
+    conn.create_function("convert_units", 3, convert_units)
+
+    def prepare_connection_args():
+        return 'database={}, datasette.plugin_config("name-of-plugin")={}'.format(
+            database, datasette.plugin_config("name-of-plugin")
+        )
+
+    conn.create_function("prepare_connection_args", 0, prepare_connection_args)
+
+
+@hookimpl
+def extra_css_urls(template, database, table, datasette):
+    return [
+        "https://plugin-example.com/{}/extra-css-urls-demo.css".format(
+            base64.b64encode(
+                json.dumps(
+                    {"template": template, "database": database, "table": table,}
+                ).encode("utf8")
+            ).decode("utf8")
+        )
+    ]
+
+
+@hookimpl
+def extra_js_urls():
+    return [
+        {"url": "https://plugin-example.com/jquery.js", "sri": "SRIHASH",},
+        "https://plugin-example.com/plugin1.js",
+    ]
+
+
+@hookimpl
+def extra_body_script(template, database, table, datasette):
+    return "var extra_body_script = {};".format(
+        json.dumps(
+            {
+                "template": template,
+                "database": database,
+                "table": table,
+                "config": datasette.plugin_config(
+                    "name-of-plugin", database=database, table=table,
+                ),
+            }
+        )
+    )
+
+
+@hookimpl
+def render_cell(value, column, table, database, datasette):
+    # Render some debug output in cell with value RENDER_CELL_DEMO
+    if value != "RENDER_CELL_DEMO":
+        return None
+    return json.dumps(
+        {
+            "column": column,
+            "table": table,
+            "database": database,
+            "config": datasette.plugin_config(
+                "name-of-plugin", database=database, table=table,
+            ),
+        }
+    )
+
+
+@hookimpl
+def extra_template_vars(template, database, table, view_name, request, datasette):
+    return {
+        "extra_template_vars": json.dumps(
+            {
+                "template": template,
+                "scope_path": request.scope["path"] if request else None,
+            },
+            default=lambda b: b.decode("utf8"),
+        )
+    }

tests/plugins/my_plugin_2.py

@@ -0,0 +1,94 @@
+from datasette import hookimpl
+from functools import wraps
+import jinja2
+import json
+
+
+@hookimpl
+def extra_js_urls():
+    return [
+        {"url": "https://plugin-example.com/jquery.js", "sri": "SRIHASH",},
+        "https://plugin-example.com/plugin2.js",
+    ]
+
+
+@hookimpl
+def render_cell(value, database):
+    # Render {"href": "...", "label": "..."} as link
+    if not isinstance(value, str):
+        return None
+    stripped = value.strip()
+    if not stripped.startswith("{") and stripped.endswith("}"):
+        return None
+    try:
+        data = json.loads(value)
+    except ValueError:
+        return None
+    if not isinstance(data, dict):
+        return None
+    if set(data.keys()) != {"href", "label"}:
+        return None
+    href = data["href"]
+    if not (
+        href.startswith("/")
+        or href.startswith("http://")
+        or href.startswith("https://")
+    ):
+        return None
+    return jinja2.Markup(
+        '<a data-database="{database}" href="{href}">{label}</a>'.format(
+            database=database,
+            href=jinja2.escape(data["href"]),
+            label=jinja2.escape(data["label"] or "") or "&nbsp;",
+        )
+    )
+
+
+@hookimpl
+def extra_template_vars(template, database, table, view_name, request, datasette):
+    async def query_database(sql):
+        first_db = list(datasette.databases.keys())[0]
+        return (await datasette.execute(first_db, sql)).rows[0][0]
+
+    async def inner():
+        return {
+            "extra_template_vars_from_awaitable": json.dumps(
+                {
+                    "template": template,
+                    "scope_path": request.scope["path"] if request else None,
+                    "awaitable": True,
+                },
+                default=lambda b: b.decode("utf8"),
+            ),
+            "query_database": query_database,
+        }
+
+    return inner
+
+
+@hookimpl
+def asgi_wrapper(datasette):
+    def wrap_with_databases_header(app):
+        @wraps(app)
+        async def add_x_databases_header(scope, recieve, send):
+            async def wrapped_send(event):
+                if event["type"] == "http.response.start":
+                    original_headers = event.get("headers") or []
+                    event = {
+                        "type": event["type"],
+                        "status": event["status"],
+                        "headers": original_headers
+                        + [
+                            [
+                                b"x-databases",
+                                ", ".join(datasette.databases.keys()).encode("utf-8"),
+                            ]
+                        ],
+                    }
+                await send(event)
+
+            await app(scope, recieve, wrapped_send)
+
+        return add_x_databases_header
+
+    return wrap_with_databases_header

tests/plugins/view_name.py

@@ -0,0 +1,9 @@
+from datasette import hookimpl
+
+
+@hookimpl
+def extra_template_vars(view_name, request):
+    return {
+        "view_name": view_name,
+        "request": request,
+    }