Skip to content

Commit

Permalink
Updated license and readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
dmiseev committed Jan 31, 2024
1 parent 56e1bc5 commit b7ecff7
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 40 deletions.
26 changes: 9 additions & 17 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,21 +1,13 @@
MIT License
The MIT License (MIT)

Copyright (c) 2023 Dmitriy Aseev
Copyright (c) 2016-present Spryker Systems GmbH

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 2 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
{
"name": "cypress-spryker-poc",
"name": "cypress-tests",
"version": "0.1.0",
"description": "",
"description": "Automated e2e tests for the Cypress",
"main": "index.js",
"author": "[email protected]",
"license": "MIT",
"scripts": {
"lint": "eslint . --ext .ts",
Expand Down
48 changes: 30 additions & 18 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,47 @@
# Cypress Spryker [POC]
## Description

_This project serves as a proof of concept to evaluate Cypress as an effective tool for end-to-end (E2E) testing. It aims to demonstrate the capabilities, ease of use, and integration features of Cypress within a typical web application development workflow._
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.

_By implementing a variety of test cases, the project showcases how Cypress can be utilized for comprehensive E2E testing, highlighting its strengths in terms of readability, maintainability, and robustness in handling various testing scenarios._
## Setup

_The insights gained from this project will guide decisions on whether Cypress is the suitable choice for future web application testing needs._
To get started with these tests, follow these setup steps:

## Setup
1. **Install Dependencies:**

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

2. **Environment Configuration:**

- **Install Dependencies:** `npm install`
- **Environment Configuration:**
- Copy the `.env.example` file to a new file named `.env`.
- Open the `.env` file and fill in the necessary environment variables. These variables will be used by Cypress for various configurations.
- 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

Run Cypress tests with:
To run the Cypress tests, use the following command:

```bash
npm run cy:open
```

## Environment Variables

Ensure to specify the required environment variables in the `.env` file. For example:
This command opens the Cypress Test Runner, a powerful interface that allows you to see tests running in real time.

- `ENV_MAIL_CATCHER_URL`: URL for the mail catcher service.
- `E2E_BASE_URL`: The base URL for your E2E tests.
## Environment Variables

These variables will be loaded into Cypress's configuration as per the setup in the Cypress configuration file.
Ensure to specify the required environment variables in the `.env` file for the tests to run correctly. For instance:

## Contributing
- `ENV_MAIL_CATCHER_URL`: This is the URL for the mail catcher service. It's used to test email functionality within the
application.
- `E2E_BASE_URL`: The base URL for your end-to-end tests. This should be the URL of the Spryker application you are
testing against.

Feel free to fork and submit pull requests.
These variables are essential for configuring the Cypress environment to suit your specific testing requirements.

0 comments on commit b7ecff7

Please sign in to comment.