Skip to main content

Integrating with Testing Frameworks

Overview​

Copilot by Detox is a versatile tool that allows developers to write app tests using natural language commands. Whether you're working with Detox or other testing frameworks, Copilot streamlines the testing process by converting human-readable instructions into actionable test steps.

This integration is powered by a specialized driver, which connects Copilot with the testing framework’s API. This driver allows Copilot to perform various testing actions—such as matching elements or performing interactions—while preserving a natural language interface. By doing so, Copilot enhances both the readability and maintainability of test scripts.

Key Capabilities and Integration Process​

To integrate Copilot with a testing framework, there are a few core components involved:

1. Framework Driver​

The framework driver acts as the bridge between Copilot and your chosen testing framework. It defines matchers, actions, and behaviors that align with the framework's API, enabling Copilot to translate natural language commands into executable code. For more detailed information about defining and using framework drivers, including an example, please refer to the Framework Driver API page.

2. Implement a PromptHandler​

In addition to the driver, Copilot needs a PromptHandler to interact with the AI service. A prompt handler can be tailored to support specific needs, such as image uploading or generating text based on complex inputs. For more information on creating a custom PromptHandler, please refer to the PromptHandler API page.

3. Build an Instance of Copilot Using init​

After defining the driver and the PromptHandler, you can initialize Copilot by calling the init method. This method requires both the custom frameworkDriver and the promptHandler to be passed in. For more detailed information, refer to the Basic Interface Overview - init, start, perform, end page.