Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/drevops/behat-steps
🧪 A collection of Behat step definitions for Drupal as traits for your behat extension
https://github.com/drevops/behat-steps
bdd behat behat-extension behavior-driven-development drupal quality-assurance test
Last synced: 3 days ago
JSON representation
🧪 A collection of Behat step definitions for Drupal as traits for your behat extension
- Host: GitHub
- URL: https://github.com/drevops/behat-steps
- Owner: drevops
- License: gpl-3.0
- Created: 2018-06-28T01:48:05.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-12-16T10:27:18.000Z (9 days ago)
- Last Synced: 2024-12-20T12:12:12.191Z (5 days ago)
- Topics: bdd, behat, behat-extension, behavior-driven-development, drupal, quality-assurance, test
- Language: PHP
- Homepage:
- Size: 844 KB
- Stars: 18
- Watchers: 4
- Forks: 13
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
A collection of Behat steps for Drupal
[](https://github.com/DrevOps/behat-steps/issues)
[](https://github.com/DrevOps/behat-steps/pulls)
[](https://circleci.com/gh/drevops/behat-steps)
[](https://codecov.io/gh/drevops/bats-helpers)
[](https://packagist.org/packages/drevops/behat-steps)
> [!IMPORTANT]
> Behat Steps version [3.0](https://github.com/drevops/behat-steps/tree/3.x) is on the way, featuring additional steps and refined, consistent language! Follow the progress in [this issue](https://github.com/drevops/behat-steps/issues/134).
---
## Installation
```bash
composer require --dev drevops/behat-steps:^2
```
## Usage
Add required traits to your `FeatureContext.php` ([example](tests/behat/bootstrap/FeatureContext.php)):
```php
[^"]*)" user is "(?P[^"]*)" with "(?P[^"]*)" content:$/` | Assert that an email message was sent or not sent to a user with the specified content. |
| `Then an email :field contains` | Assert that an email message field contains the specified value. |
| `Then an email :field contains exact` | Assert that an email message field contains the exact specified value. |
| `Then an email :field does not contain` | Assert that an email message field does not contain the specified value. |
| `Then an email :field does not contains exact` | Assert that an email message field does not contain the exact specified value. |
| `When I follow the link number :number in the email with the subject` | Visit a link from the email with the specified subject. |
| `Then file :name attached to the email with the subject` | Assert that a file is attached to an email message with the specified subject. |
| Â | |
| **[`FieldTrait`](src/FieldTrait.php) ([example](tests/behat/features/field.feature))** | |
| `Then I see field :name` | Assert that a field exists on the page using its id, name, label, or value. |
| `Then I don't see field :name` | Assert that a field does not exist on the page using its id, name, label, or value. |
| `Then field :name :exists on the page` | Assert whether the field exists on the page using its id, name, label, or value. |
| `Then field :name is :disabled on the page` | Assert whether the field is disabled on the page. |
| `Then field :name should be :presence on the page and have state :state` | Assert whether the field exists on the page and has a specified state. |
| `Then I fill color in :field for :value` | Fills value for color field. |
| `Then color field :field value is :value` | Asserts that a color field has a value. |
| Â | |
| **[`FileDownloadTrait`](src/FileDownloadTrait.php) ([example](tests/behat/features/file-download.feature))** | |
| `Then I download file from :url` | Download a file from the specified URL. |
| `Then I download file from link :link` | Download a file from the specified HTML link. |
| `Then I see download :link link :presence(on the page)` | Assert that an HTML link is present or absent on the page. |
| `Then downloaded file contains:` | Assert the contents of the downloaded file. |
| `Then downloaded file name is :name` | Assert the file name of the downloaded file. |
| `Then downloaded file is zip archive that contains files:` | Assert that the downloaded file is a ZIP archive containing specified files. |
| `Then downloaded file is zip archive that does not contain files:` | Assert that the downloaded file is a ZIP archive that does not contain specified files. |
| Â | |
| **[`FileTrait`](src/FileTrait.php) ([example](tests/behat/features/file.feature))** | |
| `Given managed file:` | Create a managed file with the properties provided in the table. |
| `Given no managed files:` | Delete managed files defined by the provided properties or fields. |
| `Given unmanaged file :uri created` | Create an unmanaged file. |
| `Given unmanaged file :uri created with content :content` | Create an unmanaged file with specified content. |
| `Then unmanaged file :uri exists` | Assert that an unmanaged file with the specified URI exists. |
| `Then unmanaged file :uri does not exist` | Assert that an unmanaged file with the specified URI does not exist. |
| `Then unmanaged file :uri has content :content` | Assert that an unmanaged file exists and has the specified content. |
| `Then unmanaged file :uri does not have content :content` | Assert that an unmanaged file exists and does not have the specified content. |
| Â | |
| **[`JsTrait`](src/JsTrait.php) ([example](tests/behat/features/js.feature))** | |
| `When I accept confirmation dialogs` | Accept confirmation dialogs appearing on the page. |
| `When I do not accept confirmation dialogs` | Do not accept confirmation dialogs appearing on the page. |
| `When /^(?:\|I )click (an?\|on) "(?P[^"]*)" element$/` | Click on the element defined by the selector. |
| `When I trigger JS :event event on :selector element` | Trigger an event on the specified element. |
| `Then /^I scroll to an? element with id "([^"]*)"$/` | Scroll to an element with ID. |
| `Then the element with id :id should be at the top of the page` | Assert the element with id at the top of page. |
| Â | |
| **[`KeyboardTrait`](src/KeyboardTrait.php) ([example](tests/behat/features/keyboard.feature))** | |
| `Given I press the :keys keys` | Press multiple keyboard keys. |
| `Given I press the :keys keys on :selector` | Press multiple keyboard keys on the specified element. |
| `Given I press the :char key` | Press the specified keyboard key. |
| `Given I press the :char key on :selector` | Press the specified keyboard key on the specified element. |
| Â | |
| **[`LinkTrait`](src/LinkTrait.php) ([example](tests/behat/features/link.feature))** | |
| `Then I should see the link :text with :href` | Assert the presence of a link with the specified href. |
| `Then I should see the link :text with :href in :locator` | Assert the presence of a link with the specified href in the specified locator. |
| `Then I should not see the link :text with :href` | Assert that a link with the specified href does not exist. |
| `Then I should not see the link :text with :href in :locator` | Assert that a link with the specified href does not exist in the specified locator. |
| `Then the link with title :title exists` | Assert that a link with the specified title exists. |
| `Then the link with title :title does not exist` | Assert that a link with the specified title does not exist. |
| `Then I click the link with title :title` | Click on the link with the specified title. |
| `Then the link( with title) :text is an absolute link` | Assert that the link with the specified text is absolute. |
| `Then the link( with title) :text is not an absolute link` | Assert that the link with the specified text is not absolute. |
| Â | |
| **[`MediaTrait`](src/MediaTrait.php) ([example](tests/behat/features/media.feature))** | |
| `Given no :type media type` | Remove the specified media type. |
| `Given :type media:` | Create media of the given type. |
| `Given /^no ([a-zA-z0-9_-]+) media:$/` | Remove media defined by the provided properties. |
| `Navigate to edit media with specified type and name.` | Navigate to the edit page for the specified media type and name. |
| Â | |
| **[`MenuTrait`](src/MenuTrait.php) ([example](tests/behat/features/menu.feature))** | |
| `Given no menus:` | Remove the specified menus. |
| `Given menus:` | Create a menu if one does not exist. |
| `Given no :menu_name menu_links:` | Remove menu links by title. |
| `Given :menu_name menu_links:` | Create menu links. |
| Â | |
| **[`MetaTagTrait`](src/MetaTagTrait.php) ([example](tests/behat/features/metatag.feature))** | |
| `Then I should see a meta tag with the following attributes:` | Assert that a meta tag with specific attributes and values exists. |
| `Then I should not see a meta tag with the following attributes:` | Assert that a meta tag with specific attributes and values does not exist. |
| Â | |
| **[`ParagraphsTrait`](src/ParagraphsTrait.php) ([example](tests/behat/features/paragraphs.feature))** | |
| `When :field_name in :bundle :entity_type with :entity_field_name of :entity_field_identifer has :paragraph_type paragraph:` | Create paragraphs of the given type with fields for the specified entity. |
| Â | |
| **[`PathTrait`](src/PathTrait.php) ([example](tests/behat/features/path.feature))** | |
| `Then I should be in the :path path` | Assert the current page is the specified path. |
| `Then I should not be in the :path path` | Assert the current page is not the specified path. |
| `Then I :can visit :path with HTTP credentials :user :pass` | Assert that the specified path can be visited with HTTP credentials. |
| `When I visit :path then the final URL should be :alias` | Visit the specified path and assert the final URL. |
| Â | |
| **[`ResponseTrait`](src/ResponseTrait.php) ([example](tests/behat/features/response.feature))** | |
| `Then response contains header :name` | Assert that the response contains a header with the specified name. |
| `Then response does not contain header :name` | Assert that the response does not contain a header with the specified name. |
| `Then response header :name contains :value` | Assert that the response header contains the specified value. |
| `Then response header :name does not contain :value` | Assert that the response header does not contain the specified value. |
| Â | |
| **[`RoleTrait`](src/RoleTrait.php) ([example](tests/behat/features/role.feature))** | |
| `Given role :name with permissions :permissions` | Create a single role with the specified permissions. |
| `Given roles:` | Create multiple roles from the specified table. |
| Â | |
| **[`SelectTrait`](src/SelectTrait.php) ([example](tests/behat/features/select.feature))** | |
| `Then select :select should have an option :option` | Assert that the specified select element has the specified option. |
| `Then select :select should not have an option :option` | Assert that the specified select element does not have the specified option. |
| `Then /^the option "([^"]*)" from select "([^"]*)" is selected$/` | Assert that the specified option is selected in the specified select element. |
| Â | |
| **[`SearchApiTrait`](src/SearchApiTrait.php) ([example](tests/behat/features/search.feature))** | |
| `When I index :type :title for search` | Index a node with all Search API indices. |
| `When I index :limit Search API items` | Index a specified number of items across all active Search API indices. |
| Â | |
| **[`TaxonomyTrait`](src/TaxonomyTrait.php) ([example](tests/behat/features/taxonomy.feature))** | |
| `Given vocabulary :vid with name :name exists` | Assert that the specified vocabulary exists. |
| `Given taxonomy term :name from vocabulary :vocabulary_id exists` | Assert that the specified taxonomy term exists by name. |
| `Given no :vocabulary terms:` | Remove terms from the specified vocabulary. |
| `When I visit :vocabulary vocabulary term :name` | Visit the specified vocabulary term page. |
| `When I edit :vocabulary vocabulary term :name` | Visit the specified vocabulary term edit page. |
| Â | |
| **[`UserTrait`](src/UserTrait.php) ([example](tests/behat/features/user.feature))** | |
| `When I visit user :name profile` | Visit the profile page of the specified user. |
| `When I go to my profile edit page` | Visit the edit page of the current user. |
| `When I edit user :name profile` | Visit the edit page of the specified user. |
| `Given no users:` | Remove users specified in the table. |
| `Then user :name has :roles role(s) assigned` | Assert that a user has the specified roles assigned. |
| `Then user :name does not have :roles role(s) assigned` | Assert that a user does not have the specified roles assigned. |
| `Then user :name has :status status` | Assert whether a user is active or not. |
| `Then I set user :user password to :password` | Set a password for a user. |
| `Then the last access time of user :name is :time` | Set last access time for user. |
| Â | |
| **[`VisibilityTrait`](src/VisibilityTrait.php) ([example](tests/behat/features/visibility.feature))** | |
| `Then /^(?:\|I )should see a visible "(?P[^"]*)" element$/` | Assert that the element with the specified CSS selector is visible on the page. |
| `Then /^(?:\|I )should not see a visible "(?P[^"]*)" element$/` | Assert that the element with the specified CSS selector is not visible on the page. |
| `Then /^(?:\|I )should see a visually visible "(?P[^"]*)" element(?: with top offset of "([^"]*)" pixels)?$/` | Assert that the element with the specified CSS selector is visually visible on the page. |
| `Then /^(?:\|I )should not see a visually hidden "(?P[^"]*)" element(?: with top offset of "([^"]*)" pixels)?$/` | Assert that the element with the specified CSS selector is visually hidden on the page. |
| Â | |
| **[`WaitTrait`](src/WaitTrait.php) ([example](tests/behat/features/wait.feature))** | |
| `Then /^(?:\|I )wait (\d+) second(s?)$/` | Wait for the specified number of seconds. |
| `Given I wait :timeout seconds for AJAX to finish` | Wait for AJAX to finish. |
| Â | |
| **[`WysiwygTrait`](src/WysiwygTrait.php) ([example](tests/behat/features/wysiwyg.feature))** | |
| `When I fill in WYSIWYG :field with :value` | Set the value for the WYSIWYG field. |
#### Skipping before scenario hooks
Some traits provide `beforeScenario` hook implementations. These can be disabled
by adding `behat-steps-skip:METHOD_NAME` tag to your test.
For example, to skip `beforeScenario` hook from `JsTrait`, add
`@behat-steps-skip:jsBeforeScenarioInit` tag to the feature.
## Development
### Local environment setup
- Install [Docker](https://www.docker.com/), [Pygmy](https://github.com/pygmystack/pygmy), [Ahoy](https://github.com/ahoy-cli/ahoy)
and shut down local web services (Apache/Nginx, MAMP etc)
- Checkout project repository in one of
the [supported Docker directories](https://docs.docker.com/docker-for-mac/osxfs/#access-control).
- `pygmy up`
- `ahoy build`
- Access built site at http://behat-steps.docker.amazee.io/
Use `ahoy --help` to see the list of available commands.
### Running tests
The source code of traits is tested by running Behat tests in the same way they
would be run in your project: traits are included into [FeatureContext.php](tests/behat/bootstrap/FeatureContext.php)
and then ran on the pre-configured [fixture Drupal site](tests/behat/fixtures/d10)
using [test features](tests/behat/features).
Run `ahoy build` to setup a fixture Drupal site in the `build` directory.
```bash
ahoy test-bdd # Run all tests
ahoy test-bdd path/to/file # Run all scenarios in specific feature file
ahoy test-bdd -- --tags=wip # Run all scenarios tagged with `@wip` tag
```
#### Debugging tests
- `ahoy debug`
- Set breakpoint
- Run tests with `ahoy test-bdd` - your IDE will pickup an incoming debug
connection
#### Updating fixture site
- Build the fixture site and make the required changes
- `ahoy drush cex -y`
- `ahoy update-fixtures` to copy configuration
changes from build directory to the fixtures directory
---
_Repository created using https://getscaffold.dev/ project scaffold template_