TestRecorder

Record a video automatically when tests failed. The videos are generated in tmp/videos directory.

This gem was inspired by Record video feature of Playwright.

Chrome 153 or later records the video by itself (using Page.startScreenRecording), so nothing else is needed.

With older Chrome versions, this gem falls back to the screencast, and depends on FFmpeg for that. Please install that package.

On Debian/Ubuntu:

sudo apt-get install ffmpeg

The videos are generated in tmp/videos directory.

• Chrome 153 or later: .mp4 (AV1)
• Older Chrome versions: .webm (VP8)

Rails system tests and RSpec(System Spec and Feature Spec).

Currently, this gem only supports a Headless Chrome.

Using Bundler, add the following to your Gemfile:

gem 'test-recorder', group: :test

require 'test_recorder/rails'

require 'test_recorder/rspec'

TestRecorder records all tests by default. But if you want to limit the tests, you can do it by specifying metadata.

Using Bundler, add the following to your Gemfile:

gem 'activesupport-testing-metadata', group: :test

# test/test_helper.rb
require 'test_recorder/rails'
require 'active_support/testing/metadata'

TestRecorder.disable!

test "test to something", test_recorder: true do
  # ...
end

You don't need to install other gems. Only disable TestRecorder, and specified tests with the tag.

# test/test_helper.rb
require 'test_recorder/rspec'

TestRecorder.disable!

it "test to something", test_recorder: true do
  # ...
end

You can change the max width/height (in pixels) and the frame rate. These apply to both recording methods.

TestRecorder.max_dimension = 1280 # default: 1000
TestRecorder.frame_rate = 30      # default: 25

The following settings only apply to the screencast fallback used with Chrome versions older than 153. They are ignored when Chrome records the screen by itself.

TestRecorder.jpeg_quality = 80 # default: 60

You can also record only every Nth frame. This lowers the recording overhead at the cost of a choppier video. The playback duration stays the same.

TestRecorder.every_nth_frame = 3 # default: 1