An open API service indexing awesome lists of open source software.

https://github.com/docksal/behat

A self-contained Docker image to run Behat with no external dependencies
https://github.com/docksal/behat

Last synced: 9 months ago
JSON representation

A self-contained Docker image to run Behat with no external dependencies

Awesome Lists containing this project

README

          

# Behat Docker Image

A self-contained Docker image to run Behat with no external dependencies.

This image is part of the [Docksal](http://docksal.io) project.

Features:

- PHP7, Composer 2
- Behat 3.8.x
- DrupalExtension 4.1.x
-

## Usage

Use this image as if you were using a binary.
Working directory is expected to be mounted at `/src` in the container.

```
$ docker run --rm -v $(pwd):/src docksal/behat --version
behat 3.8.1
```

You can also add a shell alias (in `.bashrc`, `.zshrc`, etc.) for convenience.

```
alias behat='docker run --rm -v $(pwd):/src docksal/behat --colors "$@"'
```

Restart your shell or open a new one, then

```
$ behat --version
behat 3.8.1
```

## Sample setup

Sample setup and tests can be found in the [example](example) folder.

Features:

- Sample tests
- Headless Selenium Chrome/Firefox support
- HTML report

### Using sample setup

```
git clone https://github.com/docksal/behat.git docksal-behat
cd docksal-behat/example
behat features/blackbox.feature
```

Note: if you did not add the shell alias, replace `behat` with `docker run --rm -v $(pwd):/src docksal/behat --colors`.

### Behat with Selenium

To run Behat tests that require a real browser (e.g. for JavaScript support) a headless Selenium Chrome/Firefox can be used.

There is a Docker Compose configuration in the example folder, that will get you up and running with a Selenium Chrome.

```
cd example
docker-compose up -d
./run-behat features/blackbox-javascript.feature
```

In this case, you get two containers - one running a built-in PHP server for access to HTML reports and one running Selenium.
Behat runs within the first container and talks to the Selenium container to run tests with a real browser (Chrome/Firefox).

### Switching between Chrome and Firefox

1. Uncomment a respective line in `docker-compose.yml`:

```
# Pick/uncomment one
image: selenium/standalone-chrome-debug:3.141.59
#image: selenium/standalone-firefox-debug:3.141.59
```

2. Update container configuration

```
docker-compose up -d
```

3. Update `behat.yml` as necessary
Chrome
```
browser_name: chrome
selenium2:
wd_host: http://browser:4444/wd/hub
capabilities: { "browser": "chrome", "version": "*" }
```

Firefox
```
browser_name: firefox
selenium2:
wd_host: http://browser:4444/wd/hub
capabilities: { "browser": "firefox", "version": "*" }
```

4. Run tests

### HTML report

HTML report will be generated into the `html_report` folder.
It can be accessed by navigating to `http://:8000/html_report` in your browser.
Replace `` as necessary (e.g. `localhost`).

### Bex Screenshot

The `Bex` extension will generate a screenshot when you have a failed step.

You can configure the folder that the screenshots are saved into through the `behat.yml` file. Check the example and look for `screenshot_directory` under `Bex\Behat\ScreenshotExtension`.

## Debugging

The following command will start a bash session in the container.

```
docker run --rm -v $(pwd):/src -it --entrypoint=bash docksal/behat
```