e2e README

The project's README from github.com/tester-army/e2e. As one markdown file: README.md.

e2e, the open source AI testing framework by TesterArmy

Made by TesterArmy npm version License: Apache-2.0 Join the community on Discord

e2e

e2e is an end-to-end testing framework for web and mobile apps. Describe a goal in natural language and an agent drives the app to reach it. Check the result with locators and assertions in the same test.

// tests/checkout.e2e.ts
import { test, expect } from 'e2e';

test('a member upgrades to Pro', async ({ app, agent, screen }) => {
  await app.open('/settings/billing');

  await agent.act('upgrade the workspace to the Pro plan');
  await agent.assert('the invoice preview shows a prorated amount');

  await expect(screen.getByRole('status')).toContainText('Pro');
});

An agent step that a later assertion verifies records its actions, and the next run replays them with no model calls until the app changes. Tests without agent steps need no model. Bring your own subscription, API key, or local model.

Quick start

npx e2e init

init asks for an engine, web or mobile, and a model provider, then writes a config and an example test. The quickstart covers the rest.

Packages

Package What it does
e2e The SDK, runner, and CLI.
@e2e-dev/web Browser engine: Chromium, Firefox, and WebKit through Playwright.
@e2e-dev/mobile iOS and Android engine: simulators and emulators through agent-device.
@e2e-dev/github Reporter that posts results as a pull request comment.
@e2e-dev/kernel Kernel hosted browsers for the web engine.
@e2e-dev/eas EAS Simulators hosted iOS simulators and Android emulators for the mobile engine.

Documentation

e2e.tester.army/docs. The e2e package ships every page, so coding agents can read them offline in node_modules/e2e/docs.

Contributing

See CONTRIBUTING.md. Questions go to Discord.

Security

Please don't open public issues for security vulnerabilities. Follow SECURITY.md and report them to [email protected].

Telemetry

The CLI sends anonymous usage data, such as which commands and engines run and where runs fail, but no test content, app content, or credentials. Opt out with npx e2e telemetry disable or E2E_TELEMETRY_DISABLED=1. Telemetry lists every field.

Status

[!NOTE] e2e is in active development on the way to 1.0. APIs and config can still change between minor releases.

Made by TesterArmy

e2e is built by TesterArmy, the agentic testing platform that runs natural language tests on web and mobile apps, on every pull request or on a schedule.

Apache-2.0.

e2e (tester-army/e2e)

Searching Database…

11.1K ·GitHub
Что это?e2e — это фреймворк end-to-end-тестирования веб- и мобильных приложений. Вы описываете цель на естественном языке, агент ведёт приложение к её достижению, а результат вы проверяете локаторами и ассертами в том же тесте.
Это один пакет или несколько, и это фреймворк или просто SDK?Он разбит на пакеты: основной пакет 'e2e' предоставляет SDK, test runner и CLI; отдельно идут пакеты движков для web (Chromium, Firefox, WebKit через Playwright) и mobile (iOS/Android через agent-device), плюс опциональные пакеты reporter и hosting.
Как написать свой первый тест?Запустите CLI-команду init: она спросит движок (web или mobile) и провайдера модели, а затем сгенерирует файл конфигурации и пример теста, от которого можно отталкиваться.
Нужен ли конкретный AI-провайдер для запуска тестов?Конкретный провайдер не требуется. Для агентных шагов используется своя подписка, API-ключ или локальная модель.
Каждый ли тест вызывает AI-модель при каждом запуске?Модель при первом прогоне вызывают только шаги под управлением агента; как только ассерт подтвердит такой шаг, его действия записываются, и последующие прогоны воспроизводят их без вызовов модели, пока приложение не изменится. Тесты без агентных шагов вообще обходятся без модели.
Какие браузеры и мобильные платформы он поддерживает?Веб-тесты идут на Chromium, Firefox и WebKit через Playwright; мобильные тесты — на симуляторах/эмуляторах iOS и Android через движок agent-device.
Отправляет ли CLI мои тестовые данные куда-либо?CLI отправляет анонимную телеметрию использования: какие команды и движки запускались и где прогоны падают, но никогда не отправляет содержимое тестов, приложений или учётные данные, и от этого можно отказаться.
Можно ли обойтись без самостоятельного запуска браузеров или эмуляторов?Да: @e2e-dev/kernel предлагает хостируемые браузеры для веб-движка, а @e2e-dev/eas — хостируемые симуляторы iOS и эмуляторы Android для мобильного.
Достаточно ли стабилен e2e для продакшена?Пока не полностью; проект активно развивается к релизу 1.0, и в README предупреждают, что API и конфигурация могут меняться между минорными релизами.
Size
90.7 MB
Stars
11.1K
Age
2mo
Commits · 90 Days