Docs: How to test a htmx based application

[guettli]

There is a question on Stackoverflow about how to test htmx based applications.

I think there should be a small section about this in the docs.

[BoPeng]

That is framework dependent, for Django/Python, I use django-htmx to process htmx request to be processed by Django, and I do something like the following to create a fake request with HTMX header for testing:

from django_htmx.middleware import HtmxDetails

def htmx_request(user=None,
                     get_url=None,
                     post_url=None,
                     post_data={},
                     trigger=None,
                     **kwargs):
    headers = dict(HTTP_HX_Request="true", HTTP_HX_Trigger_Name=trigger)
    if get_url is not None:
        request = RequestFactory().get(
            get_url, {x: y for x, y in kwargs.items() if y is not None}, **headers)
    if post_url is not None:
        kwargs.update(headers)
        request = RequestFactory().post(post_url, data=post_data, **kwargs)
    request.htmx = HtmxDetails(request)
    request.user = user if user else AnonymousUser()
    return request

[guettli]

Every professional framework has at least one chapter in his docs about how to write tests.

I think there are three ways:

• use the test tools of you backend framework to test your backend.
• e2e tests with Playwright (or similar tool)
• maybe some JS based testing which does not need a full browser. But I have not done this yet.

This is just a gentle reminder that a chapter in the docs would be useful.