https://github.com/jvdieten/playwright-mocha

Super lightweight playwright mocha test framework. CLI included and parallel test support.
https://github.com/jvdieten/playwright-mocha

automation-framework automation-test mocha playwright playwright-mocha test testing testing-tools

Last synced: 25 days ago
JSON representation

Super lightweight playwright mocha test framework. CLI included and parallel test support.

• Host: GitHub
• URL: https://github.com/jvdieten/playwright-mocha
• Owner: jvdieten
• License: mit
• Created: 2021-04-28T20:59:30.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-06-18T20:28:07.000Z (over 3 years ago)
• Last Synced: 2024-09-29T08:03:05.573Z (about 1 month ago)
• Topics: automation-framework, automation-test, mocha, playwright, playwright-mocha, test, testing, testing-tools
• Language: TypeScript
• Homepage:
• Size: 433 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# playwright-mocha

[![NPM](https://nodei.co/npm/playwright-mocha.png)](https://npmjs.org/package/playwright-mocha)

The aim of playwright-mocha is to deliver a lightweight test-framework that is combining the power of [mocha](https://mochajs.org/) and [playwright](https://playwright.dev/). You should be able to use all configuration options you can provide via mocha or playwright. If you miss something raise an issue or open a pull request.

## Installation and configuration via CLI




To install the framework:

`npm install playwright-mocha`




To run:

`npx playwright-mocha`

If no configuration file is found the CLI is automatically activated to setup the file via the CLI.

![](.images/cli.png)

## Create test 

Example

```javascript

const assert = require('assert');

const { PlaywrightMocha } = require('playwright-mocha/dist/pm');

it('checks the title of the page', async () => {

  const page = PlaywrightMocha.page();

  await page.goto('https://www.headlesstesting.com/');

  const title = await page.title();

  assert.strictEqual(title, 'Headless Testing with Puppeteer and Playwright in the Cloud.');

})

```

## Advanced configuration

The only thing you need now is a configuration file the paramaters browser and testFilesBaseDir are custom framework paramaters the rest of the paramaters are 1:1 mapped to specific playwright or mocha options.

| Name      | options |

| ----------- | ----------- |

| browser      | firefox/chromium/webkit       |

| testFilesBaseDir | relative path to your folder containing the test files |

| playwrightLaunchOptions   | https://playwright.dev/docs/api/class-browsertype?_highlight=launch#browsertypelaunchoptions        |

| playwrightContextOptions | https://playwright.dev/docs/api/class-browser?_highlight=context&_highlight=op#browsernewcontextoptions |

| mochaOptions | https://mochajs.org/api/mocha |




 

## Parallel execution

The framework supports parallel execution for each test/spec file. 

To enable this feature you can add the following lines to the "mochaOptions" in the configuration file.

```json

    "require": ["node_modules/playwright-mocha/dist/hooks.js"],

    "parallel": true

```

### example config with parallel execution

```json 

{

  "browser": "firefox",

  "testFilesBaseDir": "examples",

  "playwrightLaunchOptions": {

    "headless": false

  },

  "playwrightContextOptions": {

    "viewport": {

      "width": 1600,

      "height": 1000

    },

    "recordVideo": {

      "dir": "video"

    }

  },

  "mochaOptions": {

    "timeout": 30000,

    "require": ["node_modules/playwright-mocha/dist/hooks.js"],

    "parallel": true

  }

}

```