https://github.com/leafo/lapis-spec-screenshot
A busted screenshot handler that takes images of your pages when testing
https://github.com/leafo/lapis-spec-screenshot
Last synced: 8 months ago
JSON representation
A busted screenshot handler that takes images of your pages when testing
- Host: GitHub
- URL: https://github.com/leafo/lapis-spec-screenshot
- Owner: leafo
- Created: 2016-10-14T09:06:31.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-02-28T21:12:22.000Z (over 5 years ago)
- Last Synced: 2025-05-12T20:17:46.615Z (about 1 year ago)
- Language: Lua
- Size: 3.91 KB
- Stars: 8
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# lapis-spec-screenshot
`lapis-spec-screenshot` provides a
[busted](https://github.com/Olivine-Labs/busted) output handler that, in
addition to rendering the normal output, listens for special Lapis `screenshot`
events. Upon being notified, it will use `wkhtmltoimage` to screenshot the
current spec server at the specified URL.
This tool can be used to help discover visual regressions on your webpage by
giving you screenshots for each test request to view. (Further automation can
be done as you see fit)
> [wkhtmltoimage](http://wkhtmltopdf.org/) must be installed on your system for
> this library to work. Consult your package manager.
## Install
```bash
luarocks install
```
## Usage
When running `busted`, pass the module name for the screenshot output handler:
```bash
busted -o "lapis.spec.screenshot"
```
The tests will now listen to `screenshot` and `html` events.
* `screenshot` - takes a URL to request. Saves a snapshot to the screenshot directory (default `spec/screenshots`)
* `html` - takes HTML to render
The name of the image written is calculated by the full name of the test
(including any wrapping describes)
You can then provide an alternate implementation of `request`
```lua
-- spec/helpers.lua
local server = require "lapis.spec.server"
local function request(url, opts)
local out = { server.request url, opts, ... }
local opts = opts or {}
local busted = require "busted"
if out[1] == 200 and not opts.post and out[3].content_type == "text/html" then
busted.publish({"lapis", "screenshot"}, url, opts, ...)
end
return unpack(out)
end
return { request = request }
```
Use this in place of the regular request method to automatically take a
screenshot on every 200 request that returns HTML.