module ActionDispatch::SystemTesting::TestHelpers::ScreenshotHelper
Screenshot helper for system testing.
Attributes
Public Instance Methods
Takes a screenshot of the current page in the browser if the test failed.
take_failed_screenshot
is called during system test teardown.
# File lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb, line 43 def take_failed_screenshot take_screenshot if failed? && supports_screenshot? && Capybara::Session.instance_created? end
Takes a screenshot of the current page in the browser.
take_screenshot
can be used at any point in your system tests
to take a screenshot of the current state. This can be useful for debugging
or automating visual testing. You can take multiple screenshots per test to
investigate changes at different points during your test. These will be
named with a sequential prefix (or 'failed' for failing tests)
The screenshot will be displayed in your console, if supported.
The default screenshots directory is tmp/screenshots
but you
can set a different one with Capybara.save_path
You can set the RAILS_SYSTEM_TESTING_SCREENSHOT_HTML
environment variable to save the HTML from the page that is being
screenshotted so you can investigate the elements on the page at the time
of the screenshot
You can set the RAILS_SYSTEM_TESTING_SCREENSHOT
environment
variable to control the output. Possible values are:
simple
(default)-
Only displays the screenshot path. This is the default value.
inline
-
Display the screenshot in the terminal using the iTerm image protocol (iterm2.com/documentation-images.html).
artifact
-
Display the screenshot in the terminal, using the terminal artifact format (buildkite.github.io/terminal-to-html/inline-images/).
# File lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb, line 32 def take_screenshot increment_unique save_html if save_html? save_image puts display_image end
Private Instance Methods
# File lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb, line 89 def absolute_html_path "#{absolute_path}.html" end
# File lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb, line 85 def absolute_image_path "#{absolute_path}.png" end
# File lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb, line 77 def absolute_path Rails.root.join(screenshots_dir, image_name) end
# File lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb, line 111 def display_image message = +"[Screenshot Image]: #{image_path}\n" message << +"[Screenshot HTML]: #{html_path}\n" if save_html? case output_type when "artifact" message << "\e]1338;url=artifact://#{absolute_image_path}\a\n" when "inline" name = inline_base64(File.basename(absolute_image_path)) image = inline_base64(File.read(absolute_image_path)) message << "\e]1337;File=name=#{name};height=400px;inline=1:#{image}\a\n" end message end
# File lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb, line 131 def failed? !passed? && !skipped? end
# File lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb, line 73 def html_path absolute_html_path.to_s end
# File lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb, line 63 def image_name sanitized_method_name = method_name.tr("/\\", "--") name = "#{unique}_#{sanitized_method_name}" name[0...225] end
# File lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb, line 69 def image_path absolute_image_path.to_s end
# File lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb, line 54 def increment_unique @_screenshot_counter ||= 0 @_screenshot_counter += 1 end
# File lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb, line 127 def inline_base64(path) Base64.strict_encode64(path) end
# File lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb, line 101 def output_type # Environment variables have priority output_type = ENV["RAILS_SYSTEM_TESTING_SCREENSHOT"] || ENV["CAPYBARA_INLINE_SCREENSHOT"] # Default to outputting a path to the screenshot output_type ||= "simple" output_type end
# File lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb, line 93 def save_html page.save_page(absolute_html_path) end
# File lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb, line 50 def save_html? ENV["RAILS_SYSTEM_TESTING_SCREENSHOT_HTML"] == "1" end
# File lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb, line 97 def save_image page.save_screenshot(absolute_image_path) end
# File lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb, line 81 def screenshots_dir Capybara.save_path.presence || "tmp/screenshots" end
# File lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb, line 135 def supports_screenshot? Capybara.current_driver != :rack_test end
# File lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb, line 59 def unique failed? ? "failures" : (_screenshot_counter || 0).to_s end