interactive-solutions / zf-behat
Interactive Solutions extension for Behat
Installs: 2 244
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 4
Forks: 0
Open Issues: 3
Type:behat-extension
Requires
- php: >=5.5.0
- behat/behat: ^3.4.0
- guzzlehttp/guzzle: ^6.3.0
Requires (Dev)
- phpunit/phpunit: ~4.8
- dev-master
- 1.4.0
- 1.3.3
- 1.3.2
- 1.3.1
- 1.3.0
- 1.2.0
- 1.1.4
- 1.1.3
- 1.1.2
- 1.1.1
- 1.1.0
- 1.0.13
- 1.0.12
- 1.0.11
- 1.0.10
- 1.0.9
- 1.0.8
- 1.0.7
- 1.0.6
- 1.0.5
- 1.0.4
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
- 0.3.1
- 0.0.2
- 0.0.1
- dev-develop
- dev-zf3
- dev-countable-check-type
- dev-refactor/api-client
- dev-increased-bernard-support
- dev-hydration-using-closure
- dev-additional-functionality
- dev-feature/bernard-task-assertions
- dev-add-entities-to-aliases
- dev-feature/allow-arrays-alias
- dev-feature/use-aliases
- dev-feature/existing-with-static
- dev-feature/aliases
This package is auto-updated.
Last update: 2024-11-27 21:33:57 UTC
README
Description
A set of predefined step definitions to handle the most common cases when testing a REST API through Zend Framework.
Setup
Add it to your behat.yml
file as follows:
default:
extensions:
InteractiveSolutions\ZfBehat:
# configurable parameters
The available configurable parameters for this module are:
config_file
- path to your autoload configuration file for your api (defaultconfig/application.config.php
).api_url
- base url of your api (defaulthttp://localhost
).mailcatcher_url
- the url to your mailcatcher server (defaulthttp://mailcatcher:1080
).
Enable the module InteractiveSolutions\ZfBehat
in your autoload config file.
Available contexts
The module contains a bunch of different steps for various types of testing, all of which can be seen below.
Please see each individual context for further reference.
ApiContext
This context contains all step definitions for various api calls.
BernardContext
Context containing basic steps for testing an application using bernard to run background tasks.
DatabaseContext
Manages the Doctrine entity manager. Contains a single step that should be
run as a background in each feature file (Given a clean database
). This step
drops and rebuilds the entire database, allowing a clean database before each scenario.
EntityFixtureContext
Contains various steps for setting up a scenario by creating entities.
MailcatcherContext
Manages mail testing using the specified mailcatcher_url
. Useful for testing
if activation emails (and similar) are sent.
ZfrOAuthContext
Contains steps needed for zfr-oauth authentication/authorization.
Configuring default parameters
Paste the interactive-solutions.zf-behat.global.php.dist
into your config.
UserOptions
are used to specify default parameters for users in the steps
defined in the ZfrOAuthContext.
UserOptions::class => [ //The user entity class to use 'userEntityClass' => UserEntity::class, 'defaultUserProperties' => [ 'firstName' => 'First', 'lastName' => 'Last', // password field is automatically bcrypted when entity is generated 'password' => '12345', 'createdAt' => new DateTime(), ], ],
EntityOptions
are used to specify default parameters for entities created
and manages through the EntityFixtureContext and ApiContext.
EntityOptions::class => [ // fill in the entity keys and their corresponding route/default values 'entities' => [ 'match' => [ // aliases are used to provide a better flow in your scenarios 'aliases' => [ 'matches', ], 'entity' => MatchEntity::class, 'route' => 'matches' 'defaultProperties' => [ 'type' => 'SinglePlayer', 'winner' => 1, 'winnerScore' => 1337, 'finishedAt' => new DateTime(), ] ] ] ]
Things to note with EntityOptions
- route is automatically prefixed with
/
, somatches
becomes/matches
- aliases are used to create an alias for a configured entity
- defaultProperties are also used as default parameters when sending api requests
Using aliases in TableNodes or PyStringNode
Given an existing "TYPE" created with static method "create" with alias "TYPE1" When I add a new "TYPE" with: """ { "clinicId": "%Alias:FieldName%" } """
If Alias does exist, %Alias:FieldName% is replaced with the FieldName of the Alias entity
You can also reference only the alias, if so, it will use the primary key of the entity.
License
Copyright (c) 2016 Interactive Solutions Bodama AB
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.