https://github.com/kanopi/shrubs
Common support commands for Cypress when interacting with Drupal. Install using Packagist. Issue queue on Drupal.org.
https://github.com/kanopi/shrubs
cypress do-not-archive drupal internal-tool
Last synced: 5 months ago
JSON representation
Common support commands for Cypress when interacting with Drupal. Install using Packagist. Issue queue on Drupal.org.
- Host: GitHub
- URL: https://github.com/kanopi/shrubs
- Owner: kanopi
- Created: 2023-07-26T14:31:17.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-30T13:44:40.000Z (about 1 year ago)
- Last Synced: 2025-01-30T14:33:08.474Z (about 1 year ago)
- Topics: cypress, do-not-archive, drupal, internal-tool
- Language: JavaScript
- Homepage: https://www.drupal.org/project/shrubs
- Size: 98.6 KB
- Stars: 4
- Watchers: 13
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Shrubs (Drupal Cypress Support Commands)
Common support commands for Cypress when interacting with Drupal.
*Table of Contents*
* [Requirements](#requirements)
* [Installation](#installation)
* [Available Commands](#available-commands)
* [Issues](#issues)
* [Maintainers](#maintainers)
## Requirements
* Cypress installed on your local or CI.
* @TODO Document how we have Cypress set up.
## Installation
### Install/update composer installers.
Add two entries in composer.json for an install-type and its path:
```
"installer-types": ["cypress-support"],
"installer-paths": {
// existing entries omitted...
"tests/cypress/cypress/support/{$name}": [
"type:cypress-support"
]
}
```
### Tell Cypress where to import the tests
In the `support` folder for where your Cypress tests are located, edit `commands.js` and add the
following:
```
// Import commands.js using ES2015 syntax:
import './shrubs/commands'
```
### Requiring Shrubs using Composer
The Shrubs repository is available via Packagist.
Once you have completed the steps above, run the following command:
`composer require kanopi/shrubs`
### Update your CI process to...
@TODO (See what Paul did on Parks)
## Available Commands
### Drupal Cypress autocomplete
Will select the first match from an autocomplete field.
```
cy.autocomplete('input[data-drupal-selector="edit-field-episode-show-0-target-id"]', 'Term Name')
```
### Drupal Cypress ckEditor get
Gets the value of a ckeditor instance.
```
cy.ckeditorGet('#edit-body-wrapper').should('contain', 'hello world')
```
### Drupal Cypress ckEditor type
Set the value of a ckeditor instance.
```
cy.ckeditorType('#field_body-wrapper', 'hello world');
```
### Drupal Cypress drush
Runs Drush commands in multiple environments.
With the correct configuration it can target the following:
* Docksal
* Lando
* DDEV
* Pantheon
* Tugboat
```
cy.drush('status');
```
#### Config examples
Set these as environment variables or in your cypress.env.json
**Docksal**
```json
{
"DRUSH_IS_DOCKSAL" : true
}
```
**Lando**
```json
{
"DRUSH_IS_LANDO" : true
}
```
**DDEV**
```json
{
"DRUSH_IS_DDEV" : true
}
```
**Pantheon**
In the format of `PANTHEON_SITE_ID.ENVIRONMENT_ID`
```json
{
"DRUSH_IS_PANTHEON" : "mysite.pr-123"
}
```
**Tugboat**
* `DRUSH_IS_TUGBOAT` is your [Tugboat token](https://docs.tugboatqa.com/tugboat-cli/set-an-access-token/index.html)
* `TUGBOAT_INSTANCE_ID` is the ID of the specific Tugboat instance that is targeted [$TUGBOAT_PREVIEW_ID](https://docs.tugboatqa.com/reference/environment-variables/index.html#image-specific-variables)
```json
{
"DRUSH_IS_TUGBOAT" : "12345abcdef",
"TUGBOAT_INSTANCE_ID" : "1234567890"
}
```
##### Tugboat CLI
The Tugboat CLI needs a little extra help being installed in AMD64 architecture. For example if you are install the CLI within a CI/CD system like CircleCI or GitHub Actions.
```bash
sudo dpkg --add-architecture amd64
sudo apt-get update
sudo apt-get install libc6:amd64 libstdc++6:amd64
wget https://dashboard.tugboatqa.com/cli/linux/tugboat.tar.gz
sudo tar -zxf tugboat.tar.gz -C /usr/local/bin/
```
### Drupal Cypress login
Login through the default Drupal login form.
Sets a default login but also passing custom login details
```
cy.login(); // login as a default user.
cy.login('user', 'password'); // as a specific user
```
Assuming there is some other process to create the user.
### Drupal Cypress login as a specific user
Uses a Drush one time login links to login as a specific user.
```
cy.loginOneTimeLink('myusername');
```
### Drupal Cypress logout
Logs out of the current session
```
cy.logout();
```
### Ajax Click
There a clicks that can generate a blocking ajax request. I.E. Opening modals or
slideouts that load content with an ajax request.
The function will wrap an intercept/wait combination around the click to make
sure the tests don't continue until the ajax request as completed.
It's also meant to deal with the anti-pattern of using [wait()](https://docs.cypress.io/guides/references/best-practices#Unnecessary-Waiting) for clicks that trigger ajax requests.
**Example**
```
cy.ajaxClick("a.product-name", '/jsonapi/*/**')
```
This replaces code that would look like this.
```
const jsonApiRequest5 = 'jsonApiRequest' + Math.random();
cy.intercept('GET', '/jsonapi/*/**').as(jsonApiRequest5)
cy.get('a.product-name').click();
cy.wait('@' + jsonApiRequest5).its('response.statusCode').should('eq', 200)
```
or
```
cy.get('a.product-name').click();
cy.wait(5000)
```
### Drupal Cypress add item to media library
Uploads a file to the media library and selects it in the field.
Can optionally set the type of media uploaded if there is more than one type available.
Files are expected to be in the `fixtures` folder at the same level as `support` and
`e2e`. In most cases, that will be `/tests/cypress/cypress/fixtures`.
```
cy.mediaLibraryAdd('#field_media_assets-media-library-wrapper', 'sample.png');
cy.mediaLibraryAdd('#field_media_assets-media-library-wrapper', 'sample.mp3', 'audio');
```
### Drupal Cypress select item in the media library
Open a media browser modal and selects an existing media item
Can optionally set the type of media uploaded if there is more than one type available.
Files are expected to be in the `fixtures` folder.
```
cy.mediaLibrarySelect('#field_media_assets-media-library-wrapper', 'sample.png');
cy.mediaLibrarySelect('#field_media_assets-media-library-wrapper', 'sample.png', 'image');
```
### Drupal Cypress upload file
Upload a file through a file field
Files should be in the `fixtures` folder.
```
cy.uploadFile('#file-field-wrapper', 'example.png');`
```
### logAndStore(message)
Logs a message and stores it in an internal array to be retrieved later using
`cy.logSummary();`
```
cy.logAndStore('This is a log message.');
```
### logSummary()
Outputs all stored log messages at the end of a test run.
```
cy.logSummary();
```
Example with after() Hook
```
describe('Example Test with log summary', () => {
beforeEach(() => {
cy.visit('/example-page');
});
it('should log multiple steps', () => {
cy.logAndStore('Step 1: Visiting the page.');
cy.logAndStore('Step 2: Clicking a button.');
cy.logAndStore('Step 3: Validating output.');
});
after(() => {
cy.logSummary();
});
});
```
## Pantheon interstitial page and Cypress tests
In May 2025 [Pantheon added an Interstitial page](https://docs.pantheon.io/release-notes/2025/05/interstitial-pages) to projects that are at the Sandbox level. Kanopi has the following work around of overwriting the `visit()` command.
In `e2e.js`
```js
/**
* Overwrite the visit() command to support setting headers globally.
*/
Cypress.Commands.overwrite("visit", (originalVisit, url, options = {}) => {
const globalHeaders = Cypress.env('visitHeaders') || {};
// Combine global and specific headers from the unique call of visit().
const headers = Object.assign({}, globalHeaders, options.headers);
// Call the real visit with the merged headers
return originalVisit(url, { ...options, headers });
});
```
In your `cypress.config.js` you can add the following environment variable.
```js
env: {
"visitHeaders" : {
"Deterrence-Bypass" : "1"
}
}
```
Now when the `visit()` command is done you dont have to worry about a cookie being set prior.
If you want to set the cookie to bypass the page later you can do so with.
```js
cy.setCookie("Deterrence-Bypass", "1");
```
## Issues
For issues and support, please use the issue queue at https://www.drupal.org/project/issues/shrubs?categories=All
## Maintainers
Current maintainers:
* [thejimbirch](https://www.drupal.org/u/thejimbirch)
* [paulsheldrake](https://www.drupal.org/u/paulsheldrake)
This project is sponsored by:
* [Kanopi studios](https://www.drupal.org/kanopi-studios)