|
| 1 | +# Компонентное тестирование (экспериментальное) |
| 2 | + |
| 3 | +## Введение |
| 4 | + |
| 5 | +Узнайте больше об этом в нашем блоге "[Компонентное тестирование][blog-component-testing]". |
| 6 | + |
| 7 | +## Пример |
| 8 | + |
| 9 | +```typescript |
| 10 | +import { render } from '@testing-library/react'; |
| 11 | +import Component from '../Component'; |
| 12 | + |
| 13 | +it('should render react component', async ({browser}) => { |
| 14 | + // Отрендерить компонент на изолированной странице |
| 15 | + render(<Component />); |
| 16 | + |
| 17 | + // Найти кнопку внутри компонента и кликнуть по ней |
| 18 | + const button = await browser.$("button"); |
| 19 | + await button.click(); |
| 20 | + |
| 21 | + // Проверить, что текст кнопки имеет ожидаемое значение |
| 22 | + await expect(button).toHaveText("count is 1"); |
| 23 | +}); |
| 24 | +``` |
| 25 | + |
| 26 | +## Как начать? |
| 27 | + |
| 28 | +Давайте настроим тестирование реакт компонентов, написанных на Typescript. |
| 29 | + |
| 30 | +### Шаг 1: Установка Testplane и необходимых зависимостей |
| 31 | + |
| 32 | +```bash |
| 33 | +npm init testplane@latest |
| 34 | +npm i vite @vitejs/plugin-react @testing-library/react --save-dev |
| 35 | +npm i react --save |
| 36 | +``` |
| 37 | + |
| 38 | +### Шаг 2: Создание конфигурации Vite и подключение плагина react |
| 39 | + |
| 40 | +```typescript title="vite.config.ts" |
| 41 | +import { defineConfig } from 'vite'; |
| 42 | +import react from '@vitejs/plugin-react'; |
| 43 | + |
| 44 | +export default defineConfig({ |
| 45 | + plugins: [ |
| 46 | + react(), |
| 47 | + ] |
| 48 | +}); |
| 49 | +``` |
| 50 | + |
| 51 | +### Шаг 3: Настройка запуска тестов в браузере (используя опцию testRunEnv) |
| 52 | + |
| 53 | +```typescript title=".testplane.conf.ts" |
| 54 | +export default { |
| 55 | + // ... |
| 56 | + system: { |
| 57 | + // ... |
| 58 | + testRunEnv: ['browser', { viteConfig: './vite.config.ts' }], |
| 59 | + }, |
| 60 | + sets: { |
| 61 | + linux: { |
| 62 | + files: [ |
| 63 | + 'src/tests/**/*.testplane.tsx' |
| 64 | + ], |
| 65 | + browsers: [ |
| 66 | + 'chrome' |
| 67 | + ] |
| 68 | + }, |
| 69 | + }, |
| 70 | +} |
| 71 | +``` |
| 72 | + |
| 73 | +### Шаг 4: Написание теста |
| 74 | + |
| 75 | +Чтобы проверить правильную конфигурацию, мы можем написать самый простой тест, в котором выводим значение document в консоль без использования команды [browser.execute][browser-execute]: |
| 76 | + |
| 77 | +```typescript title="src/tests/test.testplane.tsx" |
| 78 | +it('should log document', async () => { |
| 79 | + console.log(document); |
| 80 | +}); |
| 81 | +``` |
| 82 | + |
| 83 | +Если бы такой тест был выполнен в среде Node.js, то он упал бы с ошибкой: `ReferenceError: document is not defined`. Но в нашем случае он будет выполнен непосредственно в браузере, где глобальная переменная `document` доступна. Поэтому в консоли браузера и терминала мы увидим следующее: |
| 84 | + |
| 85 | +``` |
| 86 | +{ |
| 87 | + location: { |
| 88 | + ancestorOrigins: {}, |
| 89 | + href: 'http://localhost:56292/run-uuids/23d2af81-4259-425c-8214-c9e770d75ea4', |
| 90 | + origin: 'http://localhost:56292', |
| 91 | + protocol: 'http:', |
| 92 | + host: 'localhost:56292', |
| 93 | + hostname: 'localhost', |
| 94 | + port: '56292', |
| 95 | + pathname: '/run-uuids/23d2af81-4259-425c-8214-c9e770d75ea4', |
| 96 | + search: '', |
| 97 | + hash: '' |
| 98 | + } |
| 99 | +} |
| 100 | +``` |
| 101 | + |
| 102 | +Давайте напишем более сложный тест с рендером компонента: |
| 103 | + |
| 104 | +```typescript title="src/tests/test.testplane.tsx" |
| 105 | +import { render } from '@testing-library/react'; |
| 106 | +import Component from '../Component'; |
| 107 | + |
| 108 | +it('should render react component', async ({browser}) => { |
| 109 | + // Отрендерить компонент на изолированной странице |
| 110 | + render(<Component />); |
| 111 | + |
| 112 | + // Найти кнопку внутри компонента и кликнуть по ней |
| 113 | + const button = await browser.$("button"); |
| 114 | + await button.click(); |
| 115 | + |
| 116 | + // Проверить, что текст кнопки имеет ожидаемое значение |
| 117 | + await expect(button).toHaveText("count is 1"); |
| 118 | +}); |
| 119 | +``` |
| 120 | + |
| 121 | +И исходный код самого компонента: |
| 122 | + |
| 123 | +```typescript title="src/Component.tsx" |
| 124 | +import { useState } from 'react'; |
| 125 | + |
| 126 | +// A simple component with a title and a counter button |
| 127 | +function Component() { |
| 128 | + const [count, setCount] = useState(0); |
| 129 | + |
| 130 | + return ( |
| 131 | + <div id="root"> |
| 132 | + <h1>Testplane Component Testing</h1> |
| 133 | + <button onClick={() => setCount((count) => count + 1)}> |
| 134 | + count is {count} |
| 135 | + </button> |
| 136 | + </div> |
| 137 | + ); |
| 138 | +} |
| 139 | +``` |
| 140 | + |
| 141 | +Полностью работающие примеры можно найти [здесь][testplane-examples-component-testing]. |
| 142 | + |
| 143 | +## Временные ограничения |
| 144 | + |
| 145 | +<Admonition type="warning"> |
| 146 | +* поддерживаются только компоненты, написанные на React в файлах .jsx и .tsx. Возможность написания тестов в файлах .js будет реализована в ближайшем будущем. Мы также планируем поддержку фреймворка Vue; |
| 147 | +* нет доступа к currentTest из it, beforeEach и afterEach. Это будет добавлено в ближайшем будущем; |
| 148 | +* плагин [@testplane/global-hook][testplane-global-hook] в настоящее время временно не поддерживается. |
| 149 | +</Admonition> |
| 150 | + |
| 151 | +## Дополнительные возможности |
| 152 | + |
| 153 | +### Горячая замена модулей (HMR) |
| 154 | + |
| 155 | +[HMR][vite-hmr] поддерживается в Vite. Это означает, что если вы измените загруженный файл, либо компонент будет повторно монтироваться, либо страница будет полностью предварительно загружена. Если компонент описан в отдельном файле (т.е. не в том же файле, что и тест), произойдет повторная установка, но тест не будет перезапущен. А если вы измените файл теста, страница будет перезагружена, что заставит Testplane прервать выполнение текущего теста и запустить его заново. Благодаря этой функции вы можете быстро разрабатывать компоненты в Vite и писать для них тесты. Рекомендуется использовать ее вместе с [REPL режимом][repl-mode]. |
| 156 | + |
| 157 | +### Использование экземпляров browser и expect напрямую в средствах разработчика браузера |
| 158 | + |
| 159 | +Инстансы `browser` и `expect` доступны в глобальной области видимости браузера. Это довольно удобно использовать при отладке теста. |
| 160 | + |
| 161 | +### Логи из консоли браузера в терминале |
| 162 | + |
| 163 | +Вызов команд `log`, `info`, `warn`, `error`, `debug` и `table` на объекте `console` в браузере приводит к отображению информации не только в средствах разработчика браузера, но также в терминале, из которого был запущен Testplane. То есть, вы можете вызывать `console.log` в тесте/компоненте и увидеть результат его выполнения в терминале. Это особенно удобно при отладке тестов. |
| 164 | + |
| 165 | +[blog-component-testing]: ../../blog/component-testing.mdx |
| 166 | +[test-run-env-option]: ../../config/system.mdx#test_run_env |
| 167 | +[browser-execute]: ../../commands/browser/execute.mdx |
| 168 | +[testplane-examples-component-testing]: https://github.com/gemini-testing/testplane/tree/master/examples/component-testing |
| 169 | +[testplane-global-hook]: https://github.com/gemini-testing/testplane-global-hook |
| 170 | +[vite-hmr]: https://vitejs.dev/guide/api-hmr.html |
| 171 | +[repl-mode]: ../../command-line/index.mdx#repl |
0 commit comments