探客时代
TestCafe
A Node.js tool to automate end-to-end web testing.
README
A Node.js tool to automate end-to-end web testing.
Write tests in JS or TypeScript, run them and view results.
Homepage • Documentation • FAQ • Support
Works on all popular environments: TestCafe runs on Windows, MacOS, and Linux. It supports desktop, mobile, remote and cloud browsers (UI or headless).
1 minute to set up: You do not need WebDriver or any other testing software. Install TestCafe with one command, and you are ready to test:npm install -g testcafe
Free and open source: TestCafe is free to use under the MIT license. Plugins provide custom reports, integration with other tools, launching tests from IDE, etc. You can use the plugins made by the GitHub community or make your own.
Running a sample test in Safari
Table of contents
Features
TestCafe automatically waits for page loads and XHRs before the test starts and after each action.
It also features smart test actions and assertions that wait for page elements to appear.
You can change the maximum wait time.
If elements load faster, tests skip the timeout and continue.
Changes in test code immediately restart the test, and you see the results instantly.
See how it works in the TestCafe Live repository.
TestCafe supports the latest JavaScript features, including ES2017 (for example, async/await).
You can also use TypeScript
if you prefer a strongly typed language.
TestCafe reports JS errors that it finds on the webpage.
Tests automatically fail because of that.
However, you can disable this.
TestCafe can open multiple instances of the same browser to run parallel
tests which decreases test execution time.
The TestCafe's Test API
includes a high-level selector library, assertions, etc.
You can combine them to implement readable tests with the PageObject pattern.
- ``` js
- const macOSInput = Selector('.column').find('label').withText('MacOS').child('input');
- ```
You can run TestCafe from a console, and its reports can be viewed in a CI system's interface
(TeamCity, Jenkins, Travis & etc.)
TestCafe Studio: IDE for End-to-End Web Testing
TestCafe works great for JavaScript developers, but at some point you will need to delegate testing tasks to your Q&A department. If that's the case and you are looking for a codeless way to record and maintain tests compatible with your existing infrastructure, check out TestCafe Studio - a testing IDE built on top of the open-source TestCafe.
Read the following article to learn how TestCafe Studio could fit into your workflow: What's Better than TestCafe? TestCafe Studio.
Record and Run a Test in TestCafe Studio
Getting Started
Installation
Ensure that Node.js (Current or Active LTS is recommended, version 12 at minimum) and npm are installed on your computer before running it:
- ```sh
- npm install -g testcafe
- ```
Creating the Test
As an example, we are going to test the https://devexpress.github.io/testcafe/example page.
Create a .js or .ts file on your computer.
Note that it needs to have a specific structure: tests must be organized into fixtures.
You can paste the following code to see the test in action:
- ``` js
- import { Selector } from 'testcafe'; // first import testcafe selectors
- fixture `Getting Started`// declare the fixture
- .page `https://devexpress.github.io/testcafe/example`; // specify the start page
- //then create a test and place your code there
- test('My first test', async t => {
- await t
- .typeText('#developer-name', 'John Smith')
- .click('#submit-button')
- // Use the assertion to check if the actual header text is equal to the expected one
- .expect(Selector('#article-header').innerText).eql('Thank you, John Smith!');
- });
- ```
Running the Test
Call the following command in a command shell.
Specify the target browser
and file path.
- ```sh
- testcafe chrome test1.js
- ```
TestCafe opens the browser and starts executing the test.
Important! Make sure the browser tab that runs tests stays active.
Do not minimize the browser window. Inactive tabs and minimized browser windows switch
to a lower resource consumption mode where tests are not guaranteed to execute correctly.
Viewing the Results
TestCafe outputs the results into a command shell by default. See Reporters
for more information. You can also use plugins to customize the reports.
Read the Getting Started page for a more detailed guide.
Documentation
Go to our website for full documentation on TestCafe.
Get Help
Join the TestCafe community on Stack Overflow to get help. Ask and answer questions with the TestCafe tag.
Issue Tracker
Use our GitHub issues page to report bugs and suggest improvements.
Stay in Touch
Follow us on Twitter. We post TestCafe news and updates, several times a week.
Contributing
Read our Contributing Guide to learn how to contribute to the project.
To create your own plugin for TestCafe, you can use these plugin generators:
to set up tests on your on-premises server farm, to use a cloud testing platform, or to start your local browsers in a special way. Use this Yeoman generator to write only a few lines of code.
with your formatting and style, check out this generator.
If you want your plugin to be listed below, send us a note in a Github issue.
Thank you to all the people who already contributed to TestCafe!
](https://github.com/aha-oretama) |[
](https://github.com/ai) |[
](https://github.com/aleks-pro) |[
](https://github.com/Aleksey28) |[
](https://github.com/AlexanderMoiseev) |[
](https://github.com/AlexanderMoskovkin) |:---: |:---: |:---: |:---: |:---: |:---: |
](https://github.com/alexey-lin) |[
](https://github.com/AlexKamaev) |[
](https://github.com/alexphilin) |[
](https://github.com/AlexSkorkin) |[
](https://github.com/alexwybraniec) |[
](https://github.com/AnastasiaIvanova8) |:---: |:---: |:---: |:---: |:---: |:---: |
](https://github.com/andrewbranch) |[
](https://github.com/AndreyBelym) |[
](https://github.com/AndyWendt) |[
](https://github.com/AnnaKondratova) |[
](https://github.com/anthophobiac) |[
](https://github.com/Artem-Babich) |:---: |:---: |:---: |:---: |:---: |:---: |
](https://github.com/Arthy000) |[
](https://github.com/augustomezencio-hotmart) |[
](https://github.com/bdwain) |[
](https://github.com/benmonro) |[
](https://github.com/beyondcompute) |[
](https://github.com/bill-looby-i) |:---: |:---: |:---: |:---: |:---: |:---: |
](https://github.com/bsmithb2) |[
](https://github.com/caseyWebb) |[
](https://github.com/cdrini) |[
](https://github.com/cgfarmer4) |[
](https://github.com/Chris-Greaves) |[
](https://github.com/churkin) |:---: |:---: |:---: |:---: |:---: |:---: |
](https://github.com/dej611) |[
](https://github.com/DIRECTcut) |[
](https://github.com/Dmitry-Ostashev) |[
](https://github.com/eignatyev) |[
](https://github.com/ericyd) |[
](https://github.com/Farfurix) |:---: |:---: |:---: |:---: |:---: |:---: |
](https://github.com/flora8984461) |[
](https://github.com/GeoffreyBooth) |[
](https://github.com/helen-dikareva) |[
](https://github.com/honsq90) |[
](https://github.com/infctr) |[
](https://github.com/inikulin) |:---: |:---: |:---: |:---: |:---: |:---: |
](https://github.com/Ivan-Katovich) |[
](https://github.com/jamesgeorge007) |[
](https://github.com/jaypea) |[
](https://github.com/josephmalam) |[
](https://github.com/kanhaiya15) |[
](https://github.com/karolnowinski) |:---: |:---: |:---: |:---: |:---: |:---: |
](https://github.com/kirovboris) |[
](https://github.com/kisrefod) |[
](https://github.com/LavrovArtem) |[
](https://github.com/link89) |[
](https://github.com/lzxb) |[
](https://github.com/macdonaldr93) |:---: |:---: |:---: |:---: |:---: |:---: |
](https://github.com/MargaritaLoseva) |[
](https://github.com/Marketionist) |[
](https://github.com/MatthewNielsen27) |[
](https://github.com/mattkubej) |[
](https://github.com/mattmanske) |[
](https://github.com/mcjim) |:---: |:---: |:---: |:---: |:---: |:---: |
](https://github.com/miherlosev) |[
](https://github.com/morfey13) |[
](https://github.com/mostlyfabulous) |[
](https://github.com/murajun1978) |[
](https://github.com/NickCis) |[
](https://github.com/Nuarat) |:---: |:---: |:---: |:---: |:---: |:---: |
](https://github.com/Ogurecher) |[
](https://github.com/PayBas) |[
](https://github.com/pgorny) |[
](https://github.com/pietrovich) |[
](https://github.com/radarhere) |[
](https://github.com/raspo) |:---: |:---: |:---: |:---: |:---: |:---: |
](https://github.com/rbardini) |[
](https://github.com/renancouto) |[
](https://github.com/rob4629) |[
](https://github.com/rueyaa332266) |[
](https://github.com/sgrillon14) |[
](https://github.com/smockle) |:---: |:---: |:---: |:---: |:---: |:---: |
](https://github.com/stefanschenk) |[
](https://github.com/superroma) |[
](https://github.com/sylbru) |[
](https://github.com/taiki-fw) |[
](https://github.com/testcafe-build-bot) |[
](https://github.com/theghostbel) |:---: |:---: |:---: |:---: |:---: |:---: |
](https://github.com/titerman) |[
](https://github.com/tobiasbueschel) |[
](https://github.com/varunkumar) |[
](https://github.com/VasilyStrelyaev) |[
](https://github.com/vitalics) |[
](https://github.com/Vla8islav) |:---: |:---: |:---: |:---: |:---: |:---: |
](https://github.com/wentwrong) |[
](https://github.com/b12031106) |[
](https://github.com/danielroe) |[
](https://github.com/danieltroger) |[
](https://github.com/DevSide) |[
](https://github.com/intermike) |:---: |:---: |:---: |:---: |:---: |:---: |
](https://github.com/kirillsalikhov) |[
](https://github.com/michaelficarra) |[
](https://github.com/rr13k) |[
](https://github.com/tomashanacek) |[
](https://github.com/TrevorKarjanis) |:---: |:---: |:---: |:---: |:---: |
Plugins
TestCafe developers and community members made these plugins:
Use TestCafe with cloud browser providers and emulators.
Electron (by @AndreyBelym)
Work with page elements in a way that is native to your framework.
React (by @kirovboris)
Angular (by @miherlosev)
Vue (by @miherlosev)
Aurelia (by @miherlosev)
Integrate TestCafe into your project's workflow.
View test results in different formats.
NUnit (by @AndreyBelym)
TimeCafe (by @jimthedev)
Run TestCafe tests in GitHub Actions workflows.
Find accessibility issues in your web app.
Run tests and view results from your favorite IDE.
TestCafe Test Runner for Visual Studio Code (by @romanresh)
SublimeText (by @churkin)
Use ESLint when writing and editing TestCafe tests.
ESLint plugin (by @miherlosev)
Create and run tests that use the Cucumber syntax.
gherkin-testcafe (by @kiwigrid, now maintained by @Arthy000) - run your Cucumber tests with TestCafe as a backend. Requires CucumberJS.
testcafe-cucumber-steps (by @Marketionist) - provides predefined Cucumber steps for gherkin-testcafe.
Different Versions of TestCafe
| [TestCafe](https://testcafe.io) | [TestCafe | |
|---|---|---|
| ------ | |:-------------------------------------------------:|:-----------------------------------------------------------------------:| | |
| No | ✓ | ✓ |
| Cross-platform | ✓ | ✓ |
| Write | ✓ | ✓ |
| Clear | ✓ | ✓ |
| Stable | ✓ | ✓ |
| Tests | ✓ | ✓ |
| Custom | ✓ | ✓ |
| Use | ✓ | ✓ |
| Integration | ✓ | ✓\* |
| Free | ✓ | |
| [Visual | ✓ | |
| [Interactive | ✓ | |
| [Automatic | ✓ | |
| [Run | ✓ | |
| [IDE-like | ✓ |
\* You can use open-source TestCafe to run TestCafe Studio tests in CI systems.
Badge
Show everyone you are using TestCafe: 
To display this badge, add the following code to your repository readme:
- ``` html
- <a href="https://github.com/DevExpress/testcafe">
- <img alt="Tested with TestCafe" src="https://img.shields.io/badge/tested%20with-TestCafe-2fa4cf.svg">
- </a>
- ```
Thanks to BrowserStack
We are grateful to BrowserStack for providing the infrastructure that we use to test code in this repository.
License
Code released under the MIT license.
Creators
Developer Express Inc. (https://devexpress.com)
