Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/acquia/drupal-spec-tool
A tool for specifying Drupal architecture details and generating automated tests for them.
https://github.com/acquia/drupal-spec-tool
Last synced: about 1 month ago
JSON representation
A tool for specifying Drupal architecture details and generating automated tests for them.
- Host: GitHub
- URL: https://github.com/acquia/drupal-spec-tool
- Owner: acquia
- License: gpl-2.0
- Created: 2018-04-19T01:44:49.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2024-08-06T13:07:14.000Z (3 months ago)
- Last Synced: 2024-09-27T10:41:21.474Z (about 1 month ago)
- Language: Gherkin
- Homepage:
- Size: 1.24 MB
- Stars: 147
- Watchers: 21
- Forks: 34
- Open Issues: 11
-
Metadata Files:
- Readme: docs/README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Drupal Spec Tool
[](https://packagist.org/packages/acquia/drupal-spec-tool)
[](https://github.com/acquia/drupal-spec-tool/actions/workflows/orca.yml)
This project provides a tool for specifying Drupal architecture details and generating automated tests for them. It consists of 1) [a Google Sheet](#google-sheet) for capturing specification and generating tests from it and 2) the Behat contexts that automate the generated tests ([examples](../features)).
## Getting started
### Google sheet
Copy [the current Google sheet](https://docs.google.com/spreadsheets/d/18MALDELw4E5WNFMKz6CUGmIkVde3O4LQC9Loda97XhU/edit?usp=sharing) to your Google Drive:
### Behat tests
Assuming you already have [Behat installed](http://behat.org/en/latest/quick_start.html#installation) via [Composer](https://getcomposer.org/)...
1. Install the Behat contexts:
```bash
composer require --dev acquia/drupal-spec-tool
```
1. Add the new contexts to your [Behat configuration](http://behat.org/en/latest/user_guide/configuration.html), e.g.:
```yaml
# behat.yml
default:
suites:
default:
contexts:
- Acquia\DrupalSpecTool\Context\AccessControlContext
- Acquia\DrupalSpecTool\Context\ContentModelContext
- Acquia\DrupalSpecTool\Context\MediaContext
- Acquia\DrupalSpecTool\Context\MenuContext
- Acquia\DrupalSpecTool\Context\ViewsContext
- Acquia\DrupalSpecTool\Context\WorkflowContext
```
1. Copy [the default feature files](../features) (representing the out-of-the-box configuration of Lightning) to your features directory. For example, given a [BLT](https://github.com/acquia/blt-behat)-based project:
```bash
mkdir -p tests/behat/features/drupal-spec-tool
cp vendor/acquia/drupal-spec-tool/features/*.feature tests/behat/features/drupal-spec-tool/
```
1. As you change the specification, update the features to match using the generated Gherkin on the "Behat" tab of the Google sheet. (See [Advanced](#advanced) below to automate this process.)
1. Run Behat! If the tests pass, your application matches the specification. If not, change one or the other according to your needs.
## Usage
Learn more about the features of the tool and best practices for using it in [the announcement blog post on the Acquia Developer Center](https://dev.acquia.com/blog/a-specification-tool-for-drupal-8-/30/05/2018/19606).
## Customization
You can supplement or override out-of-the-box behavior by extending and replacing the default context classes with your own, e.g.:
```php
namespace AcmeCorp;
class CustomContentModelContext extends Acquia\DrupalSpecTool\Context\ContentModelContext {
/**
* Override existing functionality.
*
* @Then exactly the following content entity type bundles should exist
*/
public function assertBundles(TableNode $expected) {
// ...
}
/**
* Add new functionality.
*
* @Then something new should be true
*/
public function assertSomethingNew(TableNode $expected) {
// ...
}
}
```
```diff
# behat.yml
default:
suites:
default:
contexts:
- - Acquia\DrupalSpecTool\Context\ContentModelContext
+ - AcmeCorp\CustomContentModelContext
```
## Supporting tools
The community has provided tools to build on the Drupal Spec Tool:
- [Drupal Spec Tool Commands](https://packagist.org/packages/nickwilde1990/drupal-spec-tool-commands) - Provides commands to automatically update the Google Sheet to match an existing Drupal site. This is helpful for adding the Drupal Spec Tool on a pre-existing project.
- [Drupal Entity Generator (DEG)](https://drupal-entity-generator.readthedocs.io/) - Automatically generates Drupal configuration based on the Google Sheet, i.e., goes "the other way" and updates your Drupal site to match your specification.
## Known issues
[See open bug reports in the issue queue.](https://github.com/acquia/drupal-spec-tool/labels/bug)
## Contribution
Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md).
## License
Copyright (C) 2018 Acquia, Inc.
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.