https://github.com/misterjimson/playrunner

A user flow testing tool for websites based on Playwright
https://github.com/misterjimson/playrunner

accessibility automation testing web

Last synced: about 1 year ago
JSON representation

A user flow testing tool for websites based on Playwright

• Host: GitHub
• URL: https://github.com/misterjimson/playrunner
• Owner: MisterJimson
• License: mit
• Created: 2022-11-18T20:49:16.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-01-17T03:24:57.000Z (over 3 years ago)
• Last Synced: 2025-05-06T18:19:11.332Z (about 1 year ago)
• Topics: accessibility, automation, testing, web
• Language: TypeScript
• Homepage:
• Size: 66.4 KB
• Stars: 9
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Playrunner

[![npm version](https://badge.fury.io/js/playrunner.svg)](https://badge.fury.io/js/playrunner)

![ci](https://github.com/MisterJimson/playrunner/actions/workflows/node.js.yml/badge.svg?branch=main)

A user flow testing tool for websites based on [Playwright](https://playwright.dev/).

Inspired by [fluttium](https://github.com/wolfenrain/fluttium)

## Usage

`npx playrunner run `

Here is an example flow file. You can see more examples in the [examples](https://github.com/MisterJimson/playrunner/tree/main/examples) folder.

```yaml

# This flow recreates the example test from the Playwright docs https://playwright.dev/docs/writing-tests#the-example-test

- description: homepage has Playwright in title and get started link linking to the intro page

- goTo: "https://playwright.dev/"       # Navigate to a URL

- expectTitle: Playwright               # Check the page title, supports RegEx

- expectAttribute:                      # Check an attribute of an element

    name: href

    value: /docs/intro

    locator:

      role: link

      name: Get started

- clickOn:                              # Click on an element

    locator:

      role: link

      name: Get started

- expectUrl: .*intro                    # Check the URL, supports RegEx

```

## Development

- Clone the repo and `cd` into it, then `npm i` to install dependencies.

- Run `npm run dev -- ` to execute your flow.

Try `npm run dev -- examples/playwright.yaml` to run the example flow.

## Notes

This project is in early development and most Playwright capabilities are not hooked up yet. The only enabled capabilities are those found used in the `examples` folder.