README

Behat related tools

Set up

Add this to the repositories section of your composer.json

        {
            "type": "vcs",
            "url": "https://github.com/digitalist-se/behat-tools"
        },

Execute:

composer require --dev digitalist-se/behat-tools

Add to your behat.yml:

default:
  suites:
    default:
      contexts:
        - digitalistse\BehatTools\Context\CommonContext

Add more Contexts depending on your needs using the same structure.

Entity Context

You can set the format of the dates for each field in the behat.yml like this:

default:
  suites:
    default:
      parameters:
        entity_context:
          datetime_format:
            announcement:
              publish_date: 'Y-m-d'
              unpublish_date: 'Y-m-d'
            announcement_tracker:
              created_date: 'Y-m-d\TH:i:s'
              sent_date: 'Y-m-d\TH:i:s'
              read_date: 'Y-m-d\TH:i:s'

In that case you could use relative date in php format like:

Given a "license_tracker" entity exists with the properties:
      | label | status | uid:user:mail       | field_license:license:title | created     | activated   | expire  | first_notification | second_notification | service_requirement_expired |
      | TRK10 | 1      | license-01@test.com | Test license 1              | 6 month ago | 6 month ago | 91 days | tomorrow           | 61 days             | tomorrow                    |
      | TRK10 | 1      | license-02@test.com | Test license 1              | 6 month ago | 6 month ago | 90 days | today              | 60 days             | tomorrow                    |
      | TRK10 | 1      | license-03@test.com | Test license 1              | 6 month ago | 6 month ago | 89 days | yesterday          | 59 days             | tomorrow                    |

Entity fields support

Entity fields are supported like in the following example: (<field_type>) <field_name>.<field_property>

Field with simple structure (e.g.: boolean, textfield, etc.): field_archived.value
Field type with more complex structure: (daterange) field_date.value

NOTE: Only daterange type is supported at the moment. If you need to support more complex fields you can add processing to EntityContext::processEntityFields.

Example using entity fields and properties

Given a "license_tracker" entity exists with the properties:
      | label | status | uid:user:mail       | field_archived.value | (daterange) field_date.value | (daterange) field_date.end_value |
      | TRK10 | 1      | license-01@test.com | 1                    | 6 month ago                  | 6 month ago                      |
      | TRK10 | 1      | license-02@test.com | 0                    | 6 month ago                  | 6 month ago                      |
      | TRK10 | 1      | license-03@test.com | 1                    | 6 month ago                  | 6 month ago                      |

Screenshot Context

The ScreenshotContext needs display sizes declared in your behat.yml under the suite settings key screenshot_context. Define a desktop size and any number of named mobile devices to ensure predictable, comparable screenshots.

Recommended configuration:

default:
  suites:
    default:
      contexts:
        - digitalistse\BehatTools\Context\ScreenshotContext
      screenshot_context:
        screenshot_path: '%paths.base%/screenshots-build'   # required
        desktop_size:                                       # strongly recommended
          width: 1920
          height: 1080
        mobile_devices:                                     # optional, add any devices you want
          iphone8:
            width: 375
            height: 667
          ipad:
            width: 768
            height: 1024
        desktop_subfolder: 'desktop'                        # optional (default: desktop)
        mobile_subfolder: 'mobile'                          # optional (default: mobile)

Notes:

One desktop screenshot is always taken using desktop_size (defaults to 1920x1080 if not set).
One additional screenshot is taken per entry in mobile_devices, saved under the mobile_subfolder using the device name in the filename.
If no mobile_devices are configured, only the desktop screenshot is produced.

Legacy configuration (backwards compatibility):

default:
  suites:
    default:
      screenshot_context:
        screenshot_path: '%paths.base%/screenshots-build'
        display_sizes:
          desktop:
            width: 1920
            height: 1080
          mobile:
            width: 375
            height: 667

When using display_sizes, the desktop size is read from display_sizes.desktop, and a single mobile device named mobile is inferred from display_sizes.mobile. Other keys (e.g. tablet) are ignored by the current implementation. Prefer the recommended desktop_size + mobile_devices format for multiple devices.

digitalist-se / behat-tools

Maintainers

Details

README

Set up

Entity Context

Screenshot Context