Detox README

The project's README from github.com/wix/Detox. As one markdown file: README.md.

SWUbanner

Detox

Detox

Gray box end-to-end testing and automation framework for mobile apps.

Demo

NPM Version NPM Downloads Build status Coverage Status Detox is released under the MIT license PR's welcome! Discord Twitter Follow

What Does a Detox Test Look Like?

This is a test for a login screen, it runs on a device/simulator like an actual user:

describe('Login flow', () => {
  beforeEach(async () => {
    await device.reloadReactNative();
  });

  it('should login successfully', async () => {
    await element(by.id('email')).typeText('[email protected]');
    await element(by.id('password')).typeText('123456');

    const loginButton = element(by.text('Login'));
    await loginButton.tap();

    await expect(loginButton).not.toExist();
    await expect(element(by.label('Welcome'))).toBeVisible();
  });
});

Get started with Detox now!

About

High velocity native mobile development requires us to adopt continuous integration workflows, which means our reliance on manual QA has to drop significantly. Detox tests your mobile app while it’s running in a real device/simulator, interacting with it just like a real user.

The most difficult part of automated testing on mobile is the tip of the testing pyramid - E2E. The core problem with E2E tests is flakiness - tests are usually not deterministic. We believe the only way to tackle flakiness head on is by moving from black box testing to gray box testing. That’s where Detox comes into play.

Supported React Native Versions

Detox was built from the ground up to support React Native projects.

While Detox should work out of the box with any React Native version of the latest minor releases, the official versions compatibility is provided according to the following:

Although we do not officially support older React Native versions, we do our best to keep Detox compatible with them.

In case of a problem with an unsupported version of React Native, please submit an issue or write us in our Discord server and we will do our best to help out.

Known Issues with React Native

Get Started with Detox

Read the Getting Started Guide to get Detox running on your app in less than 10 minutes.

Documents Site

Explore further about using Detox from our new website.

Core Principles

We believe that the only way to address the core difficulties with mobile end-to-end testing is by rethinking some of the principles of the entire approach. See what Detox does differently.

Contributing to Detox

Detox has been open-source from the first commit. If you’re interested in helping out with our roadmap, please see issues tagged with the label. If you have encountered a bug or would like to suggest a new feature, please open an issue.

Dive into Detox core by reading the Detox Contribution Guide.

License

Non-English Resources (Community)

Detox (wix/Detox)

Searching Database…

12K ·GitHub
Detox
Что это такое?Detox — фреймворк для сквозного тестирования и автоматизации мобильных приложений на React Native по принципу «серого ящика». Он запускает тесты на реальном устройстве или симуляторе и взаимодействует с приложением так, как это делал бы настоящий пользователь.
Это отдельное приложение для тестирования или то, что я добавляю в свой проект?Это библиотека для тестирования на JavaScript, которую вы добавляете в свой проект React Native и используете вместе с тест-раннером (Jest уже встроен по умолчанию).
Как запустить Detox в моём приложении?Следуйте официальному руководству Getting Started Guide: оно проведёт вас через добавление Detox в проект React Native и запуск первого теста меньше чем за 10 минут.
Работает ли это только с приложениями на React Native?Да, Detox создавался с нуля именно для React Native и официально тестируется на версиях RN v0.77.x–v0.84.x, включая полную совместимость с New Architecture.
Могу ли я запускать тесты на реальном устройстве с iOS или только на симуляторе?Запуск на реальном устройстве работает для Android, а запуск на реальном устройстве или симуляторе для iOS пока не поддерживается. Также есть известный баг на Android, связанный с видимостью элементов.
Для кого это создано?Это инструмент для команд, которые разрабатывают на React Native и нуждаются в надёжных автоматических сквозных тестах в рамках процесса непрерывной интеграции, вместо ручного тестирования.
Для каких мобильных платформ предназначен Detox?Detox тестирует приложения на Android и iOS, а сам тестовый код пишется на JavaScript.
Чем Detox отличается от инструментов тестирования «чёрного ящика»?Detox использует подход «серого ящика»: он отслеживает асинхронные операции приложения напрямую, а не угадывает момент готовности с помощью таймаутов и задержек. В README утверждается, что это единственный способ устранить нестабильность тестов в корне, а именно эта проблема чаще всего мешает мобильным сквозным тестам.
Могу ли я запускать тесты Detox в системах непрерывной интеграции?Да, Detox специально создан для работы в сервисах непрерывной интеграции, таких как Travis CI, Circle CI или Jenkins, без лишних хлопот.
Нужно ли использовать Jest в качестве тест-раннера?Нет, Detox предоставляет свои API для работы с любым тест-раннером, но для удобства в комплекте уже есть готовая интеграция с Jest.
Будет ли Detox работать, если в моём приложении старая версия React Native?Detox официально не тестируется на старых версиях React Native, но мейнтейнеры стараются сохранять совместимость и просят открывать issue или писать в Discord, если что-то сломалось.
What are similar projects?Maestro, midscene, ignite, e2e, assay, agentic-playwright, Roam-Control, ng-native
Which topics is it in?qa, jest, testing-tools, test-automation, react-native, ci, mobile-app, testing, hacktoberfest, mobile, ios, android
Creator
wix
Size
75.5 MB
Stars
12K
Updated
CommitJun 16Release20.51.3May 30
Age
10y
Commits · 90 Days