An open API service indexing awesome lists of open source software.

https://github.com/hdorgeval/playwright-fluent-ts-cucumber7-starter

Starter project for e2e tests with playwright-fluent and cucumber-js
https://github.com/hdorgeval/playwright-fluent-ts-cucumber7-starter

bdd bdd-framework cucumber-js e2e e2e-tests gherkin html-report playwright playwright-fluent scenarios ts typescript

Last synced: about 1 month ago
JSON representation

Starter project for e2e tests with playwright-fluent and cucumber-js

Awesome Lists containing this project

README

        

# playwright-fluent-cucumber-ts-starter

[![Build Status](https://travis-ci.org/hdorgeval/playwright-fluent-ts-cucumber7-starter.svg?branch=main)](https://travis-ci.org/hdorgeval/playwright-fluent-ts-cucumber7-starter)
[![Build status](https://ci.appveyor.com/api/projects/status/r6ywuv0jhhdncpfo?svg=true)](https://ci.appveyor.com/project/hdorgeval/playwright-fluent-ts-cucumber7-starter)

Starter project to write E2E tests with `cucumber-js v7` and `playwright-fluent` in TypeScript language.

## After cloning the repo

- run the command `npm install`.

## To execute the tests locally

- run the command `npm test`.

## To choose a reporter

The last reporter/formatter found on the cucumber-js command-line wins:

```text
--format summary --format @cucumber/pretty-formatter --format cucumber-console-formatter
```

In [package.json](package.json) file, modify the `cucumber` script to keep only your preferred formatter.

## To debug a scenario in Visual Studio Code

- tag the scenario with `@debug`
- set the breakpoints in the typescript code
- Start debugging

## To run only specific scenarios

- tag the scenario(s) with `@only`
- run the command `npm run only`.

## To run scenarios in headfull/live mode

- tag the scenario(s) with `@live`
- run the command `npm run live`

The browser will stay opened at the end of the tests execution.

## To ignore a scenario

- tag the scenario with `@ignore`

## To check for typescript, linting and gherkin errors

- run the command `npm run build`.

## To view the steps usage

- run the command `npm run steps-usage`.

## To view the html report of the last run

- run the command `npm run report`.

## To create a new step

- first write the Given/When/Then sentence:

```gherkin
Given I push "foo" on "bar"
```

- run the npm script:

```sh
npm run snippets
```

- the script will report the missing step(s): you just need to copy and paste them in the step definitions file:

```sh
Given('I push {string} on {string}', async function (string, string2) {
// Write code here that turns the phrase above into concrete actions
return 'pending';
});
```

## To use a custom option on the CLI

With cucumber-js v7, you cannot have anymore custom options on the CLI.
This is a breaking change with cucumber-js v6.

You must instead use environment variables.

When running your tests localy, you can setup environment variables by customizing the file [set-environment-variables.ts](env/set-environment-variables.ts).

When running on a CI, you should setup your jobs with the expected environment variables.

## To use a custom World Objet

- cutomize the given Custom World Object : [custom-world](world/custom-world.ts)