Browser testing with Splinter

[oTree-org]

Hi all, one of my favorite tools for testing websites is Splinter, which provides a high-level API to test a website as a user would (following links, filling forms, etc), rather than making raw HTTP requests.

They have drivers for various clients (Django test client, Chrome, etc) but not Starlette yet. So here is an implementation of a driver allowing Splinter to be used in your Starlette tests. You can instantiate it as StarletteSplinter(client), where client is your Starlette test client.

from splinter.driver.lxmldriver import LxmlDriver
from splinter.request_handler.status_code import StatusCode


class StarletteSplinter(LxmlDriver):

    driver_name = "starlette"

    def __init__(self, starlette_client, user_agent=None, wait_time=2, **kwargs):
        self._browser = starlette_client
        self._user_agent = user_agent
        super().__init__(wait_time=wait_time)

    def __enter__(self):
        return self

    def __exit__(self, exc_type, exc_value, traceback):
        pass

    def _post_load(self):
        self._forms = {}
        try:
            del self._html
        except AttributeError:
            pass
        self.status_code = StatusCode(self._response.status_code, "")

    def _do_method(self, method, url, data=None):

        url = url.rstrip('\\')
        is_post = method.lower() == 'post'
        if is_post:
            resp = self._browser.post(url, data=data)
        else:
            resp = self._browser.get(url, params=data)
        url = resp.url
        self._response = resp
        self._last_urls.append(url)
        self._url = url
        self._post_load()

    def submit_data(self, form):
        return super().submit(form).text

    @property
    def html(self):
        return self._response.text