Skip to content

Commit

Permalink
docs: improve migration guide, android testing and component testing …
Browse files Browse the repository at this point in the history
…articles (#31)

* docs: advise to install latest 4 version instead of 4.0.0

* docs: fix broken list markdown

* docs: add brief info about testing android apps
  • Loading branch information
shadowusr authored Aug 19, 2024
1 parent 64bc132 commit 39c3bee
Show file tree
Hide file tree
Showing 6 changed files with 60 additions and 10 deletions.
20 changes: 20 additions & 0 deletions docs/guides/android-testing.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import Admonition from "@theme/Admonition";

# Тестирование Android Приложений

<Admonition type="warning">
Статья на данный момент содержит базовые сведения и будет улучшена в [testplane#1002](https://github.com/gemini-testing/testplane/issues/1002).

При возникновении вопросов обращайтесь в [discussions](https://github.com/gemini-testing/testplane/discussions) на GitHub.

</Admonition>

## Обзор

Testplane использует WebdriverIO для общения с браузерами и устройствами, поэтому из коробки есть поддержка тестирования нативных Android приложений на реальных устройствах или эмуляторах с помощью [Appium](https://appium.io/docs/en/latest/).

## Быстрый старт

- [Шаблонный проект](https://github.com/webdriverio/appium-boilerplate) для запуска тестов на Android/iOS с помощью WebdriverIO и Appium
- [Документация](https://webdriver.io/docs/api/appium) по взаимодействию с Appium с помощью WebdriverIO
- [Документация Appium](https://appium.io/docs/en/2.0/intro/)
11 changes: 8 additions & 3 deletions docs/guides/component-testing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -139,11 +139,16 @@ function Component() {
## Временные ограничения

<Admonition type="warning">
* поддерживаются только компоненты, написанные на React в файлах .jsx и .tsx. Возможность
- поддерживаются только компоненты, написанные на React в файлах .jsx и .tsx. Возможность
написания тестов в файлах .js будет реализована в ближайшем будущем. Мы также планируем
поддержку фреймворка Vue; * нет доступа к currentTest из it, beforeEach и afterEach. Это будет
добавлено в ближайшем будущем; * плагин [@testplane/global-hook][testplane-global-hook] в
поддержку фреймворка Vue;

- нет доступа к currentTest из it, beforeEach и afterEach. Это будет
добавлено в ближайшем будущем;

- плагин [@testplane/global-hook][testplane-global-hook] в
настоящее время временно не поддерживается.

</Admonition>

## Дополнительные возможности
Expand Down
4 changes: 2 additions & 2 deletions docs/migrations/how-to-upgrade-hermione-to-4.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -306,14 +306,14 @@ module.exports = {

А именно:

- обновите версию hermione до hermione@4.0.0;
- обновите версию hermione до hermione@4;
- установите плагин [hermione-wdio-migrator][hermione-wdio-migrator] для плавной миграции команд;
- установите пакет [hermione-codemod][hermione-codemod] для конвертации существующих тестов в новый синтаксис;

Всё это вы можете сделать одной командой:

```shell
npm install -D hermione@4.0.0 hermione-wdio-migrator hermione-codemod --save-exact
npm install -D hermione@4 hermione-wdio-migrator hermione-codemod --save-exact
```

Версии всех плагинов hermione (например, [html-reporter][html-reporter]) также необходимо обновить до последних версий, т. к. часть из них может работать неправильно с новой версией hermione.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import Admonition from "@theme/Admonition";

# Testing Android Applications

<Admonition type="warning">
The article currently contains basic information and will be improved in [testplane#1002](https://github.com/gemini-testing/testplane/issues/1002).

If you have any questions, please refer to the [discussions](https://github.com/gemini-testing/testplane/discussions) on GitHub.

</Admonition>

## Overview

Testplane uses WebdriverIO to communicate with browsers and devices, so out of the box, it supports testing native Android applications on real devices or emulators using [Appium](https://appium.io/docs/en/latest/).

## Quick Start

- [Template Project](https://github.com/webdriverio/appium-boilerplate) for running tests on Android/iOS using WebdriverIO and Appium
- [Documentation](https://webdriver.io/docs/api/appium) for interacting with Appium using WebdriverIO
- [Appium Documentation](https://appium.io/docs/en/2.0/intro/)
Original file line number Diff line number Diff line change
Expand Up @@ -143,11 +143,16 @@ A fully working examples can be found [here][testplane-examples-component-testin
## Temporary restrictions

<Admonition type="warning">
* only components written in React in files `.jsx` and `.tsx` are supported. Ability to write
- only components written in React in files `.jsx` and `.tsx` are supported. Ability to write
tests in `.js` files will be implemented soon. We will also support the Vue framework in the
near future; * there is no access to `currentTest` from `it`, `beforeEach` and `afterEach`. It
will appear in the near future; * the [@testplane/global-hook][testplane-global-hook] plugin is
near future;

- there is no access to `currentTest` from `it`, `beforeEach` and `afterEach`. It
will appear in the near future;

- the [@testplane/global-hook][testplane-global-hook] plugin is
temporarily not supported.

</Admonition>

## Additional features
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -306,14 +306,14 @@ We upgraded _webdriverio_ by three major versions at once, so simply updating th
Specifically:
- Update hermione to hermione@4.0.0.
- Update hermione to hermione@4.
- Install the [hermione-wdio-migrator][hermione-wdio-migrator] plugin for smooth command migration.
- Install the [hermione-codemod][hermione-codemod] package to convert existing tests to the new syntax.
You can do all this with one command:
```shell
npm install -D hermione@4.0.0 hermione-wdio-migrator hermione-codemod --save-exact
npm install -D hermione@4 hermione-wdio-migrator hermione-codemod --save-exact
```
The versions of all hermione plugins (e.g., [html-reporter][html-reporter]) also need to be updated to the latest versions, as some may not work correctly with the new hermione version.
Expand Down

0 comments on commit 39c3bee

Please sign in to comment.