0.1.1 ā€¢ Published 3 years ago

vue-cli-plugin-codeceptjs-playwright v0.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

vue-cli-plugin-e2e-codeceptjs-playwright

Hey, how about some end 2 end testing for your Vue apps? šŸ¤”

Let's do it together! Vue, CodeceptJS & Playwright and myself. šŸ¤—

Browser testing would be more fun. Just see it! šŸ˜

I.amOnPage('/');
I.click('My Component Button');
I.see('My Component');
I.say('I am happy!');
// that's right, this is a valid test! 

How to try it?

Requirements:

  • NodeJS >= 8.9.1
  • NPM / Yarn
  • Vue CLI installed globally

Note:

  • CodeceptJS requires Node.js version 8.9.1+ or later.
  • To use the parallel test execution, requiring Node.js version 11.7 or later.
npm i vue-cli-plugin-codeceptjs-playwright --save-dev

This will install CodeceptJS, CodeceptUI & Playwright.

To add CodeceptJS to your project, invoke the installer:

vue invoke vue-cli-plugin-codeceptjs-playwright

You will be asked about installing a demo component. If you start a fresh project it is recommended to agree and install a demo component, so you could see tests passing.

Running Tests

We added npm scripts:

  • test:e2e - will execute tests with an opened browser . If you installed test component, and started a test server, running this command will show you a browser window passed test.
    • Use --headless option to run browser with headless mode
    • Use --serve option to start a dev server before tests

Examples:

npm run test:e2e 
npm run test:e2e -- --headless
npm run test:e2e -- --serve 

This command is a wrapper for codecept run --steps. You can use the Run arguments and options here.

  • test:e2e:parallel - will execute tests headlessly in parallel processes (workers). By default, runs tests in 2 workers.
    • Use an argument to set number of workers
    • Use --serve option to start dev server before running

Examples:

npm run test:e2e:parallel
npm run test:e2e:parallel -- 3
npm run test:e2e:parallel -- 3 --serve

This command is a wrapper for codecept run-workers 2. You can use the Run arguments and options here.

  • test:e2e:open - this opens interactive web test runner. So you could see, review & run your tests from a browser.

npm.io

npm run test:e2e:open

Directory Structure

Generator has created these files:

codecept.conf.js          šŸ‘ˆ codeceptjs config
jsconfig.json             šŸ‘ˆ enabling type definitons
tests
ā”œā”€ā”€ e2e
ā”‚Ā Ā  ā”œā”€ā”€ app_test.js       šŸ‘ˆ demo test, edit it!
ā”‚Ā Ā  ā”œā”€ā”€ output            šŸ‘ˆ temp directory for screenshots, reports, etc
ā”‚Ā Ā  ā””ā”€ā”€ support
ā”‚Ā Ā      ā””ā”€ā”€ steps_file.js šŸ‘ˆ common steps
ā””ā”€ā”€ steps.d.ts            šŸ‘ˆ type definitions

If you agreed to create a demo component, you will also see TestMe component in src/components folder.

How to write tests?

Enjoy testing!

Testing is simple & fun, enjoy it!

With ā¤ CodeceptJS Team

vue-cli-plugin-codeceptjs-playwright