Skip to main content

Installation

Introduction​

copilotbrowser was created specifically to accommodate the needs of end-to-end testing. copilotbrowser supports all modern rendering engines including Chromium, WebKit, and Firefox. Test on Windows, Linux, and macOS, locally or on CI, headless or headed with native mobile emulation.

The copilotbrowser library can be used as a general purpose browser automation tool, providing a powerful set of APIs to automate web applications, for both sync and async Python.

This introduction describes the copilotbrowser Pytest plugin, which is the recommended way to write end-to-end tests.

You will learn

Installing copilotbrowser Pytest​

copilotbrowser recommends using the official copilotbrowser Pytest plugin to write end-to-end tests. It provides context isolation, running it on multiple browser configurations out of the box.

Get started by installing copilotbrowser and running the example test to see it in action.

Install the Pytest plugin:

pip install pytest-copilotbrowser

Install the Pytest plugin:

conda config --add channels conda-forge
conda config --add channels microsoft
conda install pytest-copilotbrowser

Install the required browsers:

copilotbrowser install

Add Example Test​

Create a file that follows the test_ prefix convention, such as test_example.py, inside the current working directory or in a sub-directory with the code below. Make sure your test name also follows the test_ prefix convention.

test_example.py
import re
from copilotbrowser.sync_api import Page, expect

def test_has_title(page: Page):
    page.goto("https://dayour.github.io/copilotbrowser/")

    # Expect a title "to contain" a substring.
    expect(page).to_have_title(re.compile("copilotbrowser"))

def test_get_started_link(page: Page):
    page.goto("https://dayour.github.io/copilotbrowser/")

    # Click the get started link.
    page.get_by_role("link", name="Get started").click()

    # Expects page to have a heading with the name of Installation.
    expect(page.get_by_role("heading", name="Installation")).to_be_visible()

Running the Example Test​

By default tests will be run on chromium. This can be configured via the CLI options. Tests are run in headless mode meaning no browser UI will open up when running the tests. Results of the tests and test logs will be shown in the terminal.

pytest

Updating copilotbrowser​

To update copilotbrowser to the latest version run the following command:

pip install pytest-copilotbrowser copilotbrowser -U

System requirements​

  • Python 3.8 or higher.
  • Windows 11+, Windows Server 2019+ or Windows Subsystem for Linux (WSL).
  • macOS 14 Ventura, or later.
  • Debian 12, Debian 13, Ubuntu 22.04, Ubuntu 24.04, on x86-64 and arm64 architecture.

What's next​