Common support commands for Cypress when interacting with Drupal.
Table of Contents
- Cypress installed on your local or CI.
- @TODO Document how we have Cypress set up.
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"
]
}
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'
The Shrubs repository is available via Packagist.
Once you have completed the steps above, run the following command:
composer require kanopi/shrubs
@TODO (See what Paul did on Parks)
Will select the first match from an autocomplete field.
cy.autocomplete('input[data-drupal-selector="edit-field-episode-show-0-target-id"]', 'Term Name')
Gets the value of a ckeditor instance.
cy.ckeditorGet('#edit-body-wrapper').should('contain', 'hello world')
Set the value of a ckeditor instance.
cy.ckeditorSet('#field_body-wrapper', 'hello world');
Runs Drush commands in multiple environments
Support running commands against Pantheon multidev environments as well.
cy.drush('status');
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.
Logs out of the current session
cy.logout();
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');
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');
Upload a file through a file field
Files should be in the fixtures
folder.
cy.uploadFile('#file-field-wrapper', 'example.png');`
For issues and support, please use the issue queue at https://www.drupal.org/project/issues/shrubs?categories=All
Current maintainers:
This project is sponsored by: