https://github.com/lambdatest/smartui-jest-playwright-sample

This is a sample repository of Lambdatest - SmartUI Visual Regression testing tool for executing your visual comparison tests on cloud.
https://github.com/lambdatest/smartui-jest-playwright-sample

autoamtion cloud testing-tools visualregression

Last synced: 18 days ago
JSON representation

This is a sample repository of Lambdatest - SmartUI Visual Regression testing tool for executing your visual comparison tests on cloud.

• Host: GitHub
• URL: https://github.com/lambdatest/smartui-jest-playwright-sample
• Owner: LambdaTest
• Created: 2023-05-08T16:16:46.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-05-08T17:44:17.000Z (over 1 year ago)
• Last Synced: 2024-05-31T13:41:48.420Z (7 months ago)
• Topics: autoamtion, cloud, testing-tools, visualregression
• Language: JavaScript
• Homepage: https://www.lambdatest.com/visual-regression-testing
• Size: 2.93 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# LambdaTest SmartUI Playwright Jest Sample

This repository demonstrates how to use Jest and Playwright to run automated tests on LambdaTest's Selenium Grid, using the LambdaTest SmartUI - Visual Regression Testing.

## Prerequisites

Before getting started, make sure you have the following installed:

- [Node.js](https://nodejs.org/en/download/) (v12 or higher)

- [npm](https://www.npmjs.com/get-npm) (v6 or higher)

## Setup

1. Clone the repository:

```bash

git clone https://github.com/LambdaTest/smartui-jest-playwright-sample.git

cd smartui-jest-playwright-sample

```

2. Install the dependencies:

```bash

npm install

```

3. Configure your LambdaTest credentials:

Set the `LT_USERNAME` and `LT_ACCESS_KEY` environment variables with your LambdaTest username and access key, or directly replace `` and `` in the `credentials` object in the test file.

```javascript

const credentials = {

    user: process.env.LT_USERNAME || '',

    key: process.env.LT_ACCESS_KEY || '',

};

```

## Running the Test

To run the test, execute the following command:

```bash

npx jest

```

This will connect to the LambdaTest Selenium Grid using Playwright and run the test using Jest. The test checks the title of the LambdaTest homepage and takes a screenshot.

## Test Structure

The test file contains the following code snippet:

```javascript

const playwright = require('playwright');

const credentials = {...};

const capabilities = {...};

describe('LambdaTest SmartUI Playwright Jest Sample', () => {

    test('Check LambdaTest Homepage Title', async () => {

        ...

    });

});

```

- `playwright`: The required Playwright library.

- `credentials`: The object containing your LambdaTest username and access key.

- `capabilities`: The object containing the browser and platform configurations and LambdaTest specific options.

- `describe` and `test`: Jest functions to define the test suite and individual tests.

## SmartUI WebHook

Replace with your `Screenshot Name` according to your choice to capture on the SmartUI Dashboard for viewing the results [here](https://smartui.lambdatest.com)

```javascript

// Add a relevant screenshot name here

        await page.evaluate((_) => { },

            `lambdatest_action: ${JSON.stringify({ action: "smartui.takeScreenshot", arguments: { fullPage: true, screenshotName: "" } })}`);

```

## Troubleshooting

If you encounter any issues, try running the test with the `--detectOpenHandles` flag to identify any open handles or pending asynchronous operations that may prevent Jest from exiting properly:

```bash

npx jest --detectOpenHandles

```

## Contributing

If you have any suggestions, improvements, or bug fixes, feel free to submit a pull request or create an issue.