https://github.com/shellydcms/cypress-test-utils
Cypress test utilities
https://github.com/shellydcms/cypress-test-utils
cypress framework-agnostic hacktoberfest testing typescript utilities
Last synced: 9 months ago
JSON representation
Cypress test utilities
- Host: GitHub
- URL: https://github.com/shellydcms/cypress-test-utils
- Owner: ShellyDCMS
- License: mit
- Created: 2023-06-29T07:22:04.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-12T03:41:57.000Z (about 1 year ago)
- Last Synced: 2025-04-12T20:03:17.982Z (about 1 year ago)
- Topics: cypress, framework-agnostic, hacktoberfest, testing, typescript, utilities
- Language: TypeScript
- Homepage:
- Size: 3.32 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cypress-test-utils
[](https://www.npmjs.com/package/@shellygo/cypress-test-utils)
[](https://raw.githubusercontent.com/ShellyDCMS/cypress-test-utils/main/LICENSE)
Cypress helpers to control your UI components that work in all test levels. From component tests, through integration tests to e2e tests, for all frameworks: angular, lit, react.
Making TDD fun in the modular UI area.
CypressHelper makes it saner to write UI testing. It enables creating component drivers that will work on all testing levels (component, integration, e2e).
## Installation
This library provides an API to interact with UI elements - `CypressHelper` that combines the common features.
To add it to your repo use
`npm i -D @shellygo/cypress-test-utils cypress`
or
`yarn add -D @shellygo/cypress-test-utils cypress`
## Concept
Cypress Helpers can help you develop tests faster
CypressHelper is designed to be used in any test level, and holds common methods used in Cypress tests
CypressComponent helpers are designed to be used in component tests and are NOT framework agnostic, their sole purpose is to mount components into the browser.
## Component Drivers
Testing UI is hard. There are many reasons for that, but a big one relies in the fact that unlike functions or services, where the API is clearly defined,
when dealing with graphical user interfaces, it's up for the developer to transform it into an "API" for testing purposes.
Back in the days, [PageObjects](https://martinfowler.com/bliki/PageObject.html) helped mitigate this fact, but once the world moved to modular components,
our test code quality degraded and became bloated with repetition and lack of abstraction.
Component drivers are just like page objects, but for your components.
Just like page objects, this is merely a pattern, and is not coupled to a specific implementation.
However, using CypressHelper as the basis for your component drivers will help you leverage years of trial and error and be able to fully re-use your drivers across testing levels.
This allows you to confidently write tests that use your actual implementation and keep focusing on the _"what"_ and not the _"how"_
Component Drivers can be used as building blocks for integration and E2E test driver, using Driver Composition
## Philosophy
CypressHelper aims to provide a framework agnostic (angular, lit, react) API for what a manual tester can do.
This means that the API will not focus on implementation, but on the actual action a user would take.
For example, a user doesn't mouseUp, he/she hovers.
## [Documentation](https://shellydcms.github.io/cypress-test-utils)
## Examples
In the [examples](https://github.com/ShellyDCMS/cypress-test-utils-examples/tree/main) repo you can find 3 small apps; an angular app, a lit app and a react app.
Each app contains a driver that uses helpers, component tests, integration tests and e2e tests.
As you can see, all test levels use the _same_ driver, meaning that if the feature's implementation changes, you'll need to change the driver alone, not the tests.
## Framework Spesific Information
### Using Shadow DOM
When using elements with shadow dom, some things may not be where you expect them, fo example the text of this button is not directly inside the slot containing it.
CypressHelper will look for the assignedNode to retrieve the text, given that the selector of the slot has a '-slot' suffix.
You may change this behaviour by overriding the default values when creating CypressHelper.
### Angular
When mounting an angular component, autoSpyOutputs is set to true, meaning all event emitters are automatically spied on and may be accessed during a test using `helper.get.spy("")`
## Developing
1. Set up the repo - `yarn`
2. Build the project - `npm run build`
3. Running tests - `npm run cy:run`