ruby_raider 3.9.0 → 3.11.0

data/lib/generators/helper_generator.rb

@@ -8,6 +8,8 @@ class HelpersGenerator < Generator
     generate_driver_helper
     generate_appium_helper
     generate_spec_helper
+    generate_video_helper
+    generate_session_state
   end
 
   private
@@ -30,10 +32,19 @@ class HelpersGenerator < Generator
     template('helpers/driver_helper.tt', "#{name}/helpers/driver_helper.rb")
   end
 
+  def generate_video_helper
+    template('helpers/video_helper.tt', "#{name}/helpers/video_helper.rb")
+  end
+
+  def generate_session_state
+    return if mobile?
+
+    template('helpers/session_state.tt', "#{name}/helpers/session_state.rb")
+  end
+
   def generate_appium_helper
     return unless cross_platform?
 
     template('helpers/appium_helper.tt', "#{name}/helpers/appium_helper.rb")
   end
-
 end

data/lib/generators/infrastructure/azure_generator.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../generator'
+require_relative '../../ruby_raider/ffmpeg'
 
 class AzureGenerator < Generator
   def generate_azure_pipeline

data/lib/generators/infrastructure/github_generator.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../generator'
+require_relative '../../ruby_raider/ffmpeg'
 
 class GithubGenerator < Generator
   def generate_actions_file

data/lib/generators/infrastructure/templates/azure_pipelines.tt

@@ -12,7 +12,9 @@ pool:
 
 variables:
   HEADLESS: 'true'
-  # Add RAIDER_TOKEN (secret) and RAIDER_ENDPOINT as pipeline variables.
+  # Where ffmpeg for failure videos is cached between runs.
+  RAIDER_CACHE_DIR: $(Pipeline.Workspace)/.cache/raider
+  # Add RAIDER_TOKEN (secret) and RAIDER_ENDPOINT (your Raider Hideout URL) as pipeline variables.
 
 jobs:
   - job: tests
@@ -21,6 +23,15 @@ jobs:
         inputs: { versionSpec: '3.4' }
       - script: bundle install
         displayName: Install gems
+      - task: Cache@2
+        displayName: Cache ffmpeg for failure videos
+        inputs:
+          key: 'raider-ffmpeg-<%= RubyRaider::Ffmpeg::MANIFEST[:version] %> | "$(Agent.OS)" | Gemfile.lock'
+          path: $(RAIDER_CACHE_DIR)
+      # Video is optional: a failed download is visible here but never fails the build.
+      - script: bundle exec raider u video install
+        displayName: Install ffmpeg for failure videos
+        continueOnError: true
       - script: <%- if cucumber? -%>bundle exec raider-reporter exec -- bundle exec cucumber features/ --format pretty<%- else -%>bundle exec raider-reporter exec -- bundle exec rspec spec/ --format documentation<%- end %>
         displayName: Run tests
         env:

data/lib/generators/infrastructure/templates/github.tt

@@ -33,8 +33,20 @@ jobs:
         with:
           chrome-version: stable
 
+      - name: Cache ffmpeg for failure videos
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/raider
+          key: raider-ffmpeg-<%= RubyRaider::Ffmpeg::MANIFEST[:version] %>-${{ runner.os }}-${{ hashFiles('**/Gemfile.lock') }}
+
+      - name: Install ffmpeg for failure videos
+        run: bundle exec raider u video install
+        # Video is optional: a failed download is visible here but never fails the build.
+        continue-on-error: true
+
       - name: Run tests
         run: <%- if framework == 'cucumber' -%>bundle exec raider-reporter exec -- bundle exec cucumber features --format pretty<%- else -%>bundle exec raider-reporter exec -- bundle exec rspec spec --format documentation<%- end %>
+        # RAIDER_ENDPOINT: your Raider Hideout URL (repository variable); RAIDER_TOKEN: a project token (secret).
         env:
           HEADLESS: true
           RAIDER_TOKEN: ${{ secrets.RAIDER_TOKEN }}

data/lib/generators/infrastructure/templates/github_appium.tt

@@ -44,12 +44,24 @@ jobs:
           appium &
           sleep 5
 
+      - name: Cache ffmpeg for failure videos
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/raider
+          key: raider-ffmpeg-<%= RubyRaider::Ffmpeg::MANIFEST[:version] %>-${{ runner.os }}-${{ hashFiles('**/Gemfile.lock') }}
+
+      - name: Install ffmpeg for failure videos
+        run: bundle exec raider u video install
+        # Video is optional: a failed download is visible here but never fails the build.
+        continue-on-error: true
+
       - name: Run tests
 <%- if cucumber? -%>
         run: bundle exec raider-reporter exec -- bundle exec cucumber features/ --format pretty
 <%- else -%>
         run: bundle exec raider-reporter exec -- bundle exec rspec spec/ --format documentation
 <%- end -%>
+        # RAIDER_ENDPOINT: your Raider Hideout URL (repository variable); RAIDER_TOKEN: a project token (secret).
         env:
           APP_PATH: ${{ github.workspace }}/apps/RaiderTestApp.app
           RAIDER_TOKEN: ${{ secrets.RAIDER_TOKEN }}
@@ -101,6 +113,17 @@ jobs:
           appium &
           sleep 5
 
+      - name: Cache ffmpeg for failure videos
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/raider
+          key: raider-ffmpeg-<%= RubyRaider::Ffmpeg::MANIFEST[:version] %>-${{ runner.os }}-${{ hashFiles('**/Gemfile.lock') }}
+
+      - name: Install ffmpeg for failure videos
+        run: bundle exec raider u video install
+        # Video is optional: a failed download is visible here but never fails the build.
+        continue-on-error: true
+
       - name: Run Android Emulator and Tests
         uses: reactivecircus/android-emulator-runner@v2
         with:

data/lib/generators/invoke_generators.rb

@@ -1,3 +1,4 @@
+require 'thor'
 require_relative 'infrastructure/github_generator'
 require_relative 'infrastructure/azure_generator'
 require_relative 'automation/automation_generator'
@@ -7,11 +8,15 @@ require_relative 'helper_generator'
 require_relative 'rspec/rspec_generator'
 
 module InvokeGenerators
-  class InvalidParameters < ArgumentError; end
+  FRAMEWORKS = %w[rspec cucumber].freeze
+  AUTOMATIONS = %w[selenium watir ios android cross_platform].freeze
 
   module_function
 
   def generate_framework(structure = {})
+    structure = normalise_options(structure)
+    validate_option(:framework, structure[:framework], FRAMEWORKS)
+    validate_option(:automation, structure[:automation], AUTOMATIONS)
     validate_ci(structure[:ci])
     generators = %w[Automation Common Helpers]
     framework = structure[:framework]
@@ -30,10 +35,23 @@ module InvokeGenerators
     print_mobile_azure_notice(structure)
   end
 
+  def normalise_options(structure)
+    structure.merge(
+      framework: structure[:framework].to_s.downcase,
+      automation: structure[:automation].to_s.downcase
+    )
+  end
+
+  def validate_option(key, value, allowed)
+    return if allowed.include?(value.to_s)
+
+    raise Thor::Error, "Invalid #{key} #{value.to_s.inspect}. Allowed values: #{allowed.join(', ')}"
+  end
+
   def validate_ci(provider)
     return if [nil, '', 'github', 'azure'].include?(provider&.to_s)
 
-    raise InvalidParameters, 'ci must be github or azure'
+    raise Thor::Error, 'ci must be github or azure'
   end
 
   def print_mobile_azure_notice(structure)

data/lib/generators/rspec/rspec_generator.rb

@@ -20,5 +20,4 @@ class RspecGenerator < Generator
 
     template('accessibility_spec.tt', "#{name}/spec/accessibility_spec.rb")
   end
-
 end

data/lib/generators/rspec/templates/spec.tt

@@ -6,6 +6,7 @@ require_relative '../models/model_factory'
 require_relative '../page_objects/pages/account'
 require_relative '../page_objects/pages/login'
 
+# rubocop:disable RSpec/MultipleDescribes
 describe 'Login' do
   subject(:header) { account_page.header.customer_name }
 
@@ -36,6 +37,17 @@ describe 'Login' do
     end
   end
 end
+
+describe 'Account', :logged_in do
+  let(:user) { ModelFactory.for('users')['registered user'] }
+  let(:account_page) { <% if watir? -%>Account.new(browser)<% else -%>Account.new(driver)<% end -%> }
+
+  it 'opens the account page with the saved login' do
+    account_page.visit
+    expect(account_page.header.customer_name).to eq "Welcome back #{user['name']}"
+  end
+end
+# rubocop:enable RSpec/MultipleDescribes
 <%- else -%>
 <% if cross_platform? -%>
 require_relative '../helpers/appium_helper'

data/lib/generators/templates/common/gemfile.tt

@@ -13,7 +13,7 @@ gem 'parallel_split_test'
 gem 'parallel_tests'
 gem 'rake'
 gem 'reek'
-gem 'raider_reporter', '~> 0.9'
+gem 'raider_reporter', '~> 0.10'
 <%- if rspec? -%>
 gem 'rspec-retry'
 <%- end -%>

data/lib/generators/templates/common/git_ignore.tt

@@ -1,4 +1,10 @@
 raider-results
 <%- if rspec? -%>
 spec/examples.txt
-<%- end -%>
+<%- end -%>
+<%- if cucumber? -%>
+rerun.txt
+<%- end -%>
+<%- if web? -%>
+.raider/auth/
+<%- end -%>

data/lib/generators/templates/common/partials/mobile_config.tt

@@ -1 +1,6 @@
 platform: :ios
+
+video:
+  enabled: true
+  fps: 5
+  max_width: 1280

data/lib/generators/templates/common/partials/web_config.tt

@@ -13,4 +13,12 @@ browser_arguments:
     - search-engine-choice-country
   firefox:
     - acceptInsecureCerts
-    - no-sandbox
+    - no-sandbox
+
+video:
+  enabled: true
+  fps: 5
+  max_width: 1280
+
+login_state:
+  max_age: 3600 # seconds a saved login is reused before logging in again

data/lib/generators/templates/common/read_me.tt

@@ -93,11 +93,13 @@ Every run writes machine-readable results to `raider-results/` (including `run.j
 `features/support/env.rb` requires `raider_reporter/cucumber`, so no extra Cucumber formatter flag is needed.
 <%- end -%>
 
-To upload runs to Raider, set these environment variables before running the suite:
+To upload runs to Raider, set these environment variables before running the suite.
+`RAIDER_TOKEN` and `RAIDER_ENDPOINT` come from your Raider Hideout server (its setup page, or `bin/rails hideout:setup` /
+`hideout:token`):
 
 ```bash
 export RAIDER_TOKEN=your-token
-export RAIDER_ENDPOINT=https://your-raider-endpoint
+export RAIDER_ENDPOINT=https://hideout.example.com
 ```
 
 <%- if rspec? -%>
@@ -108,6 +110,62 @@ Without `RAIDER_TOKEN`, nothing is uploaded and the suite output is unchanged. F
 report and to Raider. See the [raider_reporter README](https://github.com/RaiderHQ/raider_reporter) for details.
 <%- end -%>
 
+### Video replay
+
+Every test is recorded, and the video is kept only for failing tests<%= rspec? ? ' (on the last retry attempt)' : '' %>. It is attached
+to the report as `video` and saved under `raider-results/attachments/`, next to the failure screenshot.
+<%- if mobile? -%>
+Appium records the device screen and the video is attached as `video.mp4`.
+<%- else -%>
+The video is a `video.webm` built from page screenshots with ffmpeg.
+<%- end -%>
+
+<%- if single_platform? -%>
+- Turn video off for one run with `VIDEO=off bundle exec <%= rspec? ? 'rspec' : 'cucumber' %>`, or for the project with
+  `raider u video off`, which creates `config/config.yml` with a `video:` section (`raider u video on` turns it back
+  on).
+<%- else -%>
+- Video is on by default: `video:` in `config/config.yml` (`enabled: true`, `fps: 5`, `max_width: 1280`).
+- Turn it off for one run with `VIDEO=off bundle exec <%= rspec? ? 'rspec' : 'cucumber' %>`, or for the project with
+  `raider u video off` (`raider u video on` turns it back on).
+<%- end -%>
+<%- unless mobile? -%>
+- ffmpeg is downloaded on first use, checked against a pinned SHA-256 and cached in `~/.cache/raider`
+  (`%LOCALAPPDATA%\raider` on Windows). `raider u video install` downloads it ahead of time (CI does this before the
+  tests and caches the folder), and `raider u video status` prints the binary in use.
+- `RAIDER_FFMPEG_PATH` uses your own ffmpeg (it needs libvpx) instead of the download, and `RAIDER_CACHE_DIR` moves
+  the cache.
+<%- if azure? -%>
+- `azure-pipelines.yml` sets `RAIDER_CACHE_DIR` to `$(Pipeline.Workspace)/.cache/raider`, the folder its `Cache@2`
+  step keeps between runs.
+<%- end -%>
+- The RaiderHQ `ffmpeg-7.1` release that the download comes from is not published yet. Until it is, set
+  `RAIDER_FFMPEG_PATH` to get videos; without it the suite runs as usual and prints one `[video]` line.
+- If ffmpeg is missing or recording fails, the suite still runs and its exit code is unchanged; you get one `[video]`
+  line on stderr and no video.
+- Known limits: a frame is taken after each page load, click and text change, plus one at the end of a failing test,
+  so changes the page makes on its own between actions show up in the next frame. There is one recorded driver per
+  process.
+<%- else -%>
+- Appium's screen recording needs `ffmpeg` on the Appium server host's `PATH` (this machine only when Appium runs
+  here): always for iOS (XCUITest), and for Android when a recording is longer than 180 s. Without it, recording
+  fails with one `[video]` line and the tests run as usual.
+<%- if cross_platform? -%>
+- Each test records for at most 1800 s on iOS and 180 s on Android, so Android needs no ffmpeg on the Appium host.
+<%- elsif ios? -%>
+- Each test records for at most 1800 s.
+<%- else -%>
+- Each test records for at most 180 s, so the Appium host needs no ffmpeg; longer tests keep only their first 180 s.
+<%- end -%>
+  Set `time_limit` (seconds) under `video:` in `config/config.yml`<%= single_platform? ? ' (create it if it is missing)' : '' %> to change it; on Android, more
+  than 180 s needs ffmpeg on the Appium host.
+- `raider u video install` and `raider u video status` manage the ffmpeg that web projects use, cached in
+  `~/.cache/raider` (override with `RAIDER_FFMPEG_PATH` or `RAIDER_CACHE_DIR`); they do not install ffmpeg on the
+  Appium host. The RaiderHQ `ffmpeg-7.1` release it comes from is not published yet.
+- If recording fails, the suite still runs and its exit code is unchanged; you get one `[video]` line on stderr and
+  no video.
+<%- end -%>
+
 <%- unless azure? && mobile? -%>
 ### Quarantine
 
@@ -135,6 +193,30 @@ would exit 2 on every run.
 Parallel test jobs that upload to one build must each set `RAIDER_SHARD_TOTAL` (the number of jobs) and
 `RAIDER_SHARD_INDEX` (1 to that number), so the gate waits for all of them instead of judging the first one to finish.
 
+<%- end -%>
+<%- if web? -%>
+## Reusing the login
+
+Tag an example `:logged_in` (RSpec) or a scenario `@logged_in` (Cucumber) and the suite logs in once, saves the
+session, and restores it for the next tagged example or run instead of filling in the login form again. The generated
+account example shows it. If the saved session no longer works, the real login runs again and the state is saved anew.
+
+For another role, call it yourself with its own name:
+
+```ruby
+SessionState.new(driver, name: 'admin').reuse(valid: -> { dashboard.tap(&:visit).admin? }) do
+  # the real login for the admin
+end
+```
+
+With Watir, pass `browser.driver`, the Selenium driver underneath the browser.
+
+- `login_state: max_age:` in `config/config.yml` is how many seconds a saved login stays valid (default 3600).
+- `RAIDER_LOGIN_STATE=off` always does the real login and saves nothing; `RAIDER_LOGIN_STATE=refresh` ignores the saved
+  file, logs in and saves again.
+- The state lives in `.raider/auth/` and is git-ignored. It holds live session tokens, so it must not be committed,
+  cached or uploaded as a CI artifact. Nothing in it is ever printed.
+
 <%- end -%>
 <%- if azure? && mobile? -%>
 ## CI

data/lib/generators/templates/helpers/browser_helper.tt

@@ -3,6 +3,7 @@
 require 'active_support/core_ext/string/inflections'
 require 'yaml'
 require 'watir'
+require_relative 'video_helper'
 
 module BrowserHelper
 
@@ -23,6 +24,9 @@ module BrowserHelper
     args += ['--headless'] if (ENV['HEADLESS'] || config['headless']) && !args.include?('--headless')
     capitalized = browser_name == 'ie' ? browser_name.upcase : browser_name.capitalize
     browser_options = "Selenium::WebDriver::#{capitalized}::Options".constantize.new(args:)
-    Watir::Browser.new(browser_name.to_sym, options: browser_options)
+    arguments = { options: browser_options }
+    listener = VideoHelper.listener
+    arguments[:listener] = listener if listener
+    Watir::Browser.new(browser_name.to_sym, **arguments)
   end
 end

data/lib/generators/templates/helpers/driver_helper.tt

@@ -4,6 +4,7 @@ require 'yaml'
 <%- if selenium_based? -%>
 require 'active_support/inflector'
 require 'selenium-webdriver'
+require_relative 'video_helper'
 <%- else -%>
 require 'appium_lib'
 <%- end -%>

data/lib/generators/templates/helpers/partials/selenium_driver.tt

@@ -1,7 +1,10 @@
   def create_driver(*opts)
     @config = YAML.load_file('config/config.yml')
     browser = @config['browser']
-    driver = Selenium::WebDriver.for(browser.to_sym, options: create_webdriver_options(*opts))
+    arguments = { options: create_webdriver_options(*opts) }
+    listener = VideoHelper.listener
+    arguments[:listener] = listener if listener
+    driver = Selenium::WebDriver.for(browser.to_sym, **arguments)
     driver.manage.timeouts.implicit_wait = @config.fetch('timeout', 10)
     driver
   end

data/lib/generators/templates/helpers/session_state.tt

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'json'
+require 'time'
+require 'uri'
+require 'yaml'
+
+# Saves the browser login (cookies, localStorage, sessionStorage) to .raider/auth/<name>.json
+# and restores it into a new browser. The file holds live session tokens: it is git-ignored,
+# written 0600, and its values are never printed.
+#
+#   SessionState.new(driver, name: 'user').reuse(valid: -> { account.logged_in? }) { log_in }
+#
+# RAIDER_LOGIN_STATE=off always logs in and never saves; =refresh logs in and saves again.
+# Stale age is login_state.max_age (seconds) in config/config.yml.
+class SessionState
+  FORMAT = 1
+  DEFAULT_MAX_AGE = 3600
+  NAME_PATTERN = /\A[a-z0-9_-]+\z/.freeze
+  DIR = File.join('.raider', 'auth')
+  READ_STORAGE = 'return Object.assign({}, window[arguments[0]]);'
+  WRITE_STORAGE = 'var s = window[arguments[0]]; s.clear(); var d = arguments[1]; ' \
+                  'Object.keys(d).forEach(function (k) { s.setItem(k, d[k]); });'
+  STORAGES = { 'local_storage' => 'localStorage', 'session_storage' => 'sessionStorage' }.freeze
+  COOKIE_KEYS = %i[name value domain path secure http_only same_site].freeze
+
+  attr_reader :name
+
+  def initialize(driver, name: 'user')
+    raise ArgumentError, "name must match #{NAME_PATTERN.source}" unless name.to_s.match?(NAME_PATTERN)
+
+    @driver = driver
+    @name = name.to_s
+  end
+
+  def path
+    File.join(DIR, "#{name}.json")
+  end
+
+  def reuse(valid: nil, &login)
+    lock = open_lock unless ENV.fetch('RAIDER_LOGIN_STATE', nil) == 'off'
+    lock ? reuse_locked(lock, valid, &login) : login.call
+    true
+  end
+
+  def save
+    ensure_dir
+    visit_origin
+    state = { 'format' => FORMAT, 'name' => name, 'origin' => origin, 'saved_at' => Time.now.utc.iso8601,
+              'cookies' => @driver.manage.all_cookies.map { |cookie| dump_cookie(cookie) } }
+    STORAGES.each { |key, kind| state[key] = @driver.execute_script(READ_STORAGE, kind) || {} }
+    write_atomically(JSON.generate(state))
+    path
+  end
+
+  def restore
+    state = read_state
+    usable?(state) && apply(state)
+  rescue StandardError => e
+    fall_back("could not restore #{path} (#{e.class})")
+  end
+
+  def clear
+    FileUtils.rm_f(path)
+  end
+
+  def fresh?
+    state = read_state
+    usable?(state) && Time.now - Time.iso8601(state['saved_at']) < max_age
+  rescue ArgumentError, TypeError
+    false
+  end
+
+  private
+
+  def reuse_locked(lock, valid, &login)
+    lock.flock(File::LOCK_EX)
+    return if ENV.fetch('RAIDER_LOGIN_STATE', nil) != 'refresh' && fresh? && restore && still_valid?(valid)
+
+    clear
+    reset if @applied
+    login.call
+    save_after_login
+  ensure
+    lock.close
+  end
+
+  def open_lock
+    ensure_dir
+    File.open(File.join(DIR, "#{name}.lock"), File::RDWR | File::CREAT, 0o600)
+  rescue SystemCallError => e
+    fall_back("cannot write #{DIR} (#{e.class}), so nothing is saved")
+  end
+
+  def save_after_login
+    save
+  rescue StandardError => e
+    warn("[login_state] could not save #{path} (#{e.class}), the next run logs in again")
+  end
+
+  def reset
+    visit_origin
+    @driver.manage.delete_all_cookies
+    STORAGES.each_value { |kind| @driver.execute_script(WRITE_STORAGE, kind, {}) }
+  rescue StandardError
+    nil # a browser that cannot be reset fails the real login on its own
+  end
+
+  def visit_origin
+    @driver.navigate.to("#{origin}/") unless origin_of(URI.parse(@driver.current_url.to_s)) == origin
+  end
+
+  def still_valid?(valid)
+    valid.nil? || valid.call || fall_back("login restored from #{path} is no longer valid")
+  rescue StandardError => e
+    fall_back("validity check failed (#{e.class})")
+  end
+
+  def apply(state)
+    @driver.navigate.to("#{origin}/")
+    @applied = true
+    @driver.manage.delete_all_cookies
+    live, skipped = state['cookies'].partition { |cookie| live_for_origin?(cookie) }
+    live.each { |cookie| add_cookie(load_cookie(cookie)) }
+    warn("[login_state] #{skipped.size} cookies skipped (expired or another domain) from #{path}") if skipped.any?
+    STORAGES.each { |key, kind| @driver.execute_script(WRITE_STORAGE, kind, state[key] || {}) }
+    @driver.navigate.refresh
+    true
+  end
+
+  def add_cookie(attributes)
+    @driver.manage.add_cookie(attributes.dup) # Selenium's Manager rewrites the hash it is given
+  rescue StandardError
+    raise unless attributes.key?(:same_site)
+
+    @driver.manage.add_cookie(attributes.except(:same_site))
+  end
+
+  def live_for_origin?(cookie)
+    (cookie['expires'].nil? || Time.iso8601(cookie['expires']) > Time.now) && domain_matches?(cookie['domain'])
+  end
+
+  def domain_matches?(domain)
+    bare = domain.to_s.delete_prefix('.')
+    bare.empty? || base_uri.host == bare || base_uri.host.end_with?(".#{bare}")
+  end
+
+  def dump_cookie(cookie)
+    COOKIE_KEYS.to_h { |key| [key.to_s, cookie[key]] }.merge('expires' => cookie[:expires]&.to_time&.utc&.iso8601)
+  end
+
+  def load_cookie(cookie)
+    COOKIE_KEYS.to_h { |key| [key, cookie[key.to_s]] }
+               .merge(expires: cookie['expires'] && Time.iso8601(cookie['expires'])).compact
+  end
+
+  def read_state
+    JSON.parse(File.read(path)) if File.exist?(path)
+  rescue JSON::ParserError, SystemCallError
+    fall_back("#{path} is unreadable or corrupt")
+  end
+
+  def usable?(state)
+    return false unless state
+    return state['origin'] == origin if state.is_a?(Hash) && state['format'] == FORMAT
+
+    fall_back("#{path} has an unsupported format")
+  end
+
+  def write_atomically(json)
+    temp = "#{path}.#{Process.pid}.#{Thread.current.object_id}.tmp"
+    File.write(temp, json, perm: 0o600)
+    File.rename(temp, path)
+  end
+
+  def ensure_dir
+    FileUtils.chmod(0o700, FileUtils.mkdir_p(DIR))
+  end
+
+  def config
+    @config ||= YAML.load_file('config/config.yml') || {}
+  end
+
+  def max_age
+    Integer(config.dig('login_state', 'max_age') || DEFAULT_MAX_AGE)
+  end
+
+  def base_uri
+    @base_uri ||= URI.parse(config.fetch('url'))
+  end
+
+  def origin
+    @origin ||= origin_of(base_uri)
+  end
+
+  def origin_of(uri)
+    port = uri.port == uri.default_port ? '' : ":#{uri.port}"
+    "#{uri.scheme}://#{uri.host}#{port}"
+  end
+
+  def fall_back(reason)
+    warn("[login_state] #{reason}, logging in again")
+    false
+  end
+end

data/lib/generators/templates/helpers/spec_helper.tt

@@ -12,6 +12,13 @@ require_relative 'browser_helper'
 <%- else -%>
 require_relative 'driver_helper'
 <%- end -%>
+require_relative 'video_helper'
+<%- if web? -%>
+require_relative 'session_state'
+require_relative '../models/model_factory'
+require_relative '../page_objects/pages/login'
+require_relative '../page_objects/pages/account'
+<%- end -%>
 
 module SpecHelper
   RSpec.configure do |config|
@@ -45,10 +52,28 @@ module SpecHelper
         browser.window.maximize
       end
     <%- end -%>
+      @video_recorder = VideoHelper.recorder_for(<%= watir? ? 'browser' : 'driver' %>)
+      @video_recorder.start
     end
+<%- if web? -%>
+
+    config.before(:each, :logged_in) do
+      user = ModelFactory.for('users')['registered user']
+      account = Account.new(<%= watir? ? 'browser' : 'driver' %>)
+      SessionState.new(<%= watir? ? 'browser.driver' : 'driver' %>).reuse(
+        valid: -> { account.tap(&:visit).header.customer_name == "Welcome back #{user['name']}" }
+      ) do
+        login = Login.new(<%= watir? ? 'browser' : 'driver' %>)
+        login.visit
+        login.login(user['username'], user['password'])
+      end
+    end
+<%- end -%>
 
     config.after(:each) do |example|
       example_name = example.description
+      keep_video = example.exception ? VideoHelper.final_attempt?(example) : false
+      video_path = @video_recorder&.stop(keep: keep_video)
       if example.exception
         @_exception = example.exception
         Dir.mktmpdir do |temp_folder|
@@ -57,6 +82,9 @@ module SpecHelper
           RaiderReporter.attach('screenshot', screenshot_path, type: :png)
         end
       end
+      RaiderReporter.attach('video', video_path, type: <%= mobile? ? ':mp4' : ':webm' %>) if video_path
+    ensure
+      @video_recorder&.cleanup
       <%= partial('quit_driver', strip: true) %>
     end
   end