UI and API test framework

This test framework uses Cypress & Typescript for e2e testing the UI.

Docker & Docker compose 🐳 to run the tests locally in containers or via a build pipeline platform ( like circleci ... there are other flavours)🍦

Usage

If you just want to run the tests you only need docker. Install Docker Desktop 🐳

Run the UI tests in a Docker container

If you have an M1, you'll need to run this command docker compose run ui-tests-m1 npm run test 🏃🏿

If you are on the old school Mac or anything that isn't ARM64 then you'll need to run this

docker-compose run ui-tests npm run test 🏃‍♀️

Run the API tests in a Docker container

docker-compose run api-tests npm run test 🏃‍♀️

Local development

First, you'll need to install node.... 🤖

I like to use FNM 👨🏻‍💻 and the Node Version is 16.14.0

To setup the local development for this framework you can run 🐢 💨

npm run setup-local-dev

This will install dependencies for you to work on the UI and API tests locally.

Run the UI test in headless mode via Cypress 🏃🏻‍♂️

npm run ui-tests:run

Open the UI tests in the Cypress GUI 🏃‍♀️

npm run ui-tests:open

Feature File .. but no cucumber?! 🥒

You'll find a feature file in the root of the project that outlines the scenarios that have been tested.
This file is written in Gherkin but you'll find no cucmber 🥒 steps in the tests.

I've used the Gherkin syntax to outline the acceptance critera. I find that it can be a good tool for defining the requirements of a new feature ideally in
3 Amigos session 🧟‍♀️ 🧙🏻‍♀️ 🦹🏻‍♀️

Issues 👻

☠️ Running Cypress inside a Docker container using an Apple M1 ARM64 Processor has some issues ☠️

I've managed to solve the issue by creating a Docker image just for ARM64, as suggested on this github thread

The Docker image can be found here cookiescrumbs/cypress-m1:9.4.1

The image has Cypress v9.4.1 baked into it. 🎂