Download the PHP package salsadigitalauorg/scaffold-testing without Composer
On this page you can find all versions of the php package salsadigitalauorg/scaffold-testing. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download salsadigitalauorg/scaffold-testing
More information about salsadigitalauorg/scaffold-testing
Files in salsadigitalauorg/scaffold-testing
Package scaffold-testing
Short Description Testing framework for Vortex scaffold
License GPL-2.0-or-later
Informations about the package scaffold-testing
Scaffold Testing
A testing framework for Vortex scaffold that provides automated test setup and configuration.
Installation
Configuration
Add the following configuration to your project's composer.json
:
Configuration Options
target-dir
: The directory where test files will be installed (default:tests/behat/
)files
: Specific feature files to install and their override settings- Key: Feature file name
- Value: Boolean indicating whether to override if file exists
override_feature
: Global override setting for all feature files (default:false
)override_feature_context
: Whether to override the FeatureContext.php file (default:false
)
Examples
-
Default Setup:
-
Custom Directory:
-
Specific Features with Override:
- Override All Features:
Development
See README.developers.md for development setup and guidelines.
Overview
The Scaffold Testing Library provides a set of default Behat tests tailored for Drupal projects, aiming to ensure consistent testing across different deployments. This library helps streamline the testing process by providing ready-to-use Behat test scenarios that cover common functionalities within Drupal sites.
Jumpstart Features
- Home Page Test: Ensures the homepage loads successfully and contains specific keywords or phrases.
- Permissions Test: Checks different user roles for appropriate access rights to content in various states (published, draft, in review).
- Workflow Test: Tests the expected moderation states and transitions between them.
- Search Functionality Test: Verifies that search indexing works and returns expected results.
- Content Types Test: Verifies that content types can be created.
Usage
After installation, the Behat test files are placed in the tests/behat/features/
directory of your Drupal project. You can run these tests using Behat with a command similar to:
Make sure you have configured Behat properly in your Drupal project to recognize and execute these tests.
Configuration
To ensure the salsadigitalauorg/scaffold-testing
runs as you execute composer install
or composer update
,
add the following to the post-install-cmd
and post-update-cmd
sections of your project' composer.json:
Alternatively, add install-features
command only:
To customize the tests or the installation path, you can modify the extra
section in your project's composer.json
:
target-dir
: Specifies the base directory for test files (default: "tests/behat/").files
: An object where keys are feature file names and values are boolean flags indicating whether to override existing files. Whenfiles
key is omited, the existing files will be left untouched and missing files will be installed.override_feature_context
: Whether to overwrite the existing FeatureContext.php file (default: false).override_feature
: Whether to overwrite the existing feature file (default: false).
If the files
section is omitted, all available feature files will be installed only if they don't already exist in the target directory.
The installer will create the necessary subdirectories within the target-dir
:
Contributing
Contributions to the Scaffold Testing Library are welcome! Please feel free to submit pull requests or create issues for any bugs you discover or enhancements you suggest.
License
This library is provided under the MIT License. See the LICENSE file for more information.
Breaking Changes in Version 0.4.2
Important: Trait-based Step Definitions
Starting from version 0.4.2, we've moved to a trait-based approach for step definitions. This is a breaking change that requires manual intervention for existing projects.
For Existing Projects
If you're upgrading from a previous version, you'll need to:
- Remove the old step definitions from your
FeatureContext.php
- Add the trait to your
FeatureContext.php
:
For New Projects
The installer will automatically set up your FeatureContext.php
with the trait. You can add your custom step definitions alongside the trait.
Combining Custom Steps
You can add your own custom step definitions alongside the trait:
Requirements
- PHP 8.3 or higher
- Composer 2.x
- Behat 3.13 or higher
- PHPUnit 9.6.13 or higher (compatible with Drupal core)
Dependencies
This package requires the following dependencies which will be installed automatically:
All versions of scaffold-testing with dependencies
composer/installers Version ^2.0
phpunit/phpunit Version ^9.6
behat/behat Version ^3.13
drupal/drupal-extension Version ^5.0
symfony/process Version ^6.0|^7.0