https://github.com/yceruto/behat-extension

Set of Behat extensions
https://github.com/yceruto/behat-extension

bdd behat behat-extension php

Last synced: 4 months ago
JSON representation

Set of Behat extensions

• Host: GitHub
• URL: https://github.com/yceruto/behat-extension
• Owner: yceruto
• License: mit
• Created: 2024-06-26T14:42:34.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-06-26T18:56:23.000Z (7 months ago)
• Last Synced: 2024-06-27T16:07:05.952Z (7 months ago)
• Topics: bdd, behat, behat-extension, php
• Language: PHP
• Homepage:
• Size: 26.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Behat Extension

Set of [Behat](https://github.com/Behat/Behat) extensions to write better Behat tests.

## Exception Extension

This extension provides a way to catch exceptions thrown by your behaviors and check them in your tests.

### Installation

```bash

composer require --dev yceruto/behat-extension

```

### Configuration

Enable the extension in your `behat.yml`:

```yaml

default:

    extensions:

        Yceruto\BehatExtension\Extension\ExceptionExtension: ~

```

### Usage

Once the extension is enabled, you can use the `(!)` mark in any scenario title to indicate 

that all exceptions thrown in this scenario must be caught. By using some predefined Behat 

steps included in this package, you can then check the exception class and message.

Example:

```gherkin

Feature: Manage blog posts

  As a blog owner

  I want to manage my blog posts

  So I can keep my blog up to date

  Scenario: Edit a blog post with invalid date

    Given I get a blog post with id "1"

    And I set a published date "3024-01-01"

    Then an exception should be thrown with message "The published date must be in the past."

```

> [!NOTE]

> Note that the `(!)` mark is mandatory to catch exceptions. If you don't use it, the exception 

> will be thrown as usual.

These predefined steps can be found in the `ExceptionAssertionTrait`, which are activated 

once you add it to your Behat context class. Alternatively, you can create custom Behat 

steps and use the `ExceptionAssertion` class directly.

This is a sample of the `FeatureContext` class that implements the previous feature:

```php

class FeatureContext implements Context

{

    use ExceptionAssertionTrait;

    /**

     * @Given I get a blog post with id :id

     */

    public function iGetABlogPostWithId(int $id): void

    {

        // code that gets the blog post...

    }

    /**

     * @Given I set a published date :date

     */

    public function iSetAPublishedDate(string $date): void

    {

        // code that throws an exception...

    

        throw new DomainException('The published date must be in the past.');

    }

}

```

## License

This software is published under the [MIT License](LICENSE)