README

This repository is dedicated to housing an extensive collection of UI end-to-end tests, meticulously crafted using Cypress for Spryker applications. These tests are designed to thoroughly evaluate the user interface, ensuring that all interactions and visual elements function as intended in real-world scenarios. By leveraging Cypress's advanced browser automation capabilities, this suite provides an efficient and effective means of validating the user experience, confirming the seamless operation and aesthetic integrity of Spryker's front-end components. Our commitment to rigorous UI testing helps maintain the high standard of quality and reliability that Spryker users expect.

Setup

To get started with these tests, follow these setup steps:

Install Dependencies:

Install all necessary dependencies required for running the tests.
```
npm install
```

Environment Configuration:

Set up your environment variables for Cypress.
- Copy the .env.example file to a new file named .env.
- Open the .env file and fill in the necessary environment variables.
- These variables are crucial for Cypress to connect with your Spryker application and perform tests effectively.

Running Tests

To run the Cypress tests, use the following command:

npm run cy:open

This command opens the Cypress Test Runner, a powerful interface that allows you to see tests running in real time.

Note: to run tests against different demoshops automatically, use Multi-Store-Runner script.

Development workflow in the shop (suite-nonsplit or demoshop)

To use a different branch, modify the project composer.json

"require-dev": {
    "spryker/cypress-tests": "dev-YOUR_BRANCH_NAME"
}

and run composer update spryker/cypress-tests, then commit composer.json and composer.lock files.

Troubleshooting

URI malformed

The following error originated from your test code, not from Cypress.

> URI malformed

When Cypress detects uncaught errors originating from your test code it will automatically fail the current test.

Cypress could not associate this error to any specific test.

We dynamically generated a new test to display this failure.

When you encounter a "URI malformed" error in Cypress, it NOT always indicates that there is an issue with the URL used in your tests.

To resolve this error, you can try the following steps:

Ensure "Node.js" version is 22.16.0 or higher.
Ensue "npm" version is 11.6.0 or higher.
If you changed version of Node or npm, delete the node_modules folder and reinstall dependencies. (rm -rf node_modules/ && npm install)
Clear Cypress App Data following this guide.

Other issues

If you encounter other issues not described here, refer to the Troubleshooting for common problems and solutions.

Test Tagging

When adding a new test or extending the coverage of an existing test - add the tag for the covered feature. The tag should be named the same as the corresponding feature in the Release App. E.g. if you create a new test that touches Marketplace Agent Assist feature, you should add tags marketplace-agent-assist and marketplace-merchantportal-core. Please see the existing tests for the tag syntax.

spryker / cypress-tests

Maintainers

Details