k0lmena Automation Framework

⚙️ Technologies

TypeScript
Playwright
Cucumber
Artillery
Appium

🛠️ Setting up development environment

Prerequisites

You will need the following to run this Framework:

NodeJs:

https://nodejs.org/en/download/

Visual Studio Code:

https://code.visualstudio.com/download

Open the project and run npm install or npm i to install de dependencies and then npx playwright install.

🚀 Run the project

Front:

Run tests with @Smoke tags:

npm run test

Run all tests:

npm run allTests

API Test:

npm run apiTest

Mobile Test:

npm run mobile

Performance test:

npm run load

📋 Reports

After each execution, you can generate two types of reports

Front Reports:

Complete report:

npm run report

Cucumber default report:

npm run report-default

API Reports:

npm run api-report

Mobile Reports:

npm run mobile-reports

Performance Reports:

Local Performance report:

npm run load-report

Performance report in the Cloud:

npm run load-report-cloud

Note: To use the reports in the Cloud, is necessary to register in https://artillery.io and generate a KEY. This key should be replaced in the file package.json

🛠️ Tools

We implemented some tools to simplify automation.

Crawler

Run crawler:

npm run crawler

Note: The output file is in /src/tools/crawler/output/locators-output.ts

Architecture

This project contains all the logic inside of the source folder. Some of the folder you will find:

-- Features: Gherkin feature files with all the scenarios and steps.

-- Steps: Communication between features and steps functions.

-- Locators: Elements of the site to test. It could be xpath, classes, test id, etc.

-- Config: Files with general configurations of the project. Now contains the use of environments.

-- Utils: Files with reusable general functions of playwright.

📖 Documentation

⭐ License

This framework is Open Source :)

🐞 Known Issues

None for now...

👥 Contributors

Gianella Vezzoni
Danilo Vezzoni
Maximiliano Pintos

K0lmena

Install / Use

README