blob: a0203d26ae56ddcb99d1df7bd4f88c4983e96c1d (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
# frozen_string_literal: true
module ActionDispatch
module SystemTesting
module TestHelpers
# Screenshot helper for system testing.
module ScreenshotHelper
# 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.
#
# The screenshot will be displayed in your console, if supported.
#
# You can set the +RAILS_SYSTEM_TESTING_SCREENSHOT+ environment variable to
# control the output. Possible values are:
# * [+inline+ (default)] display the screenshot in the terminal using the
# iTerm image protocol (https://iterm2.com/documentation-images.html).
# * [+simple+] only display the screenshot path.
# This is the default value if the +CI+ environment variables
# is defined.
# * [+artifact+] display the screenshot in the terminal, using the terminal
# artifact format (https://buildkite.github.io/terminal/inline-images/).
def take_screenshot
save_image
puts display_image
end
# Takes a screenshot of the current page in the browser if the test
# failed.
#
# +take_failed_screenshot+ is included in <tt>application_system_test_case.rb</tt>
# that is generated with the application. To take screenshots when a test
# fails add +take_failed_screenshot+ to the teardown block before clearing
# sessions.
def take_failed_screenshot
take_screenshot if failed? && supports_screenshot?
end
private
def image_name
failed? ? "failures_#{method_name}" : method_name
end
def image_path
"tmp/screenshots/#{image_name}.png"
end
def save_image
page.save_screenshot(Rails.root.join(image_path))
end
def output_type
# Environment variables have priority
output_type = ENV["RAILS_SYSTEM_TESTING_SCREENSHOT"] || ENV["CAPYBARA_INLINE_SCREENSHOT"]
# If running in a CI environment, default to simple
output_type ||= "simple" if ENV["CI"]
# Default
output_type ||= "inline"
output_type
end
def display_image
message = "[Screenshot]: #{image_path}\n"
case output_type
when "artifact"
message << "\e]1338;url=artifact://#{image_path}\a\n"
when "inline"
name = inline_base64(File.basename(image_path))
image = inline_base64(File.read(image_path))
message << "\e]1337;File=name=#{name};height=400px;inline=1:#{image}\a\n"
end
message
end
def inline_base64(path)
Base64.encode64(path).gsub("\n", "")
end
def failed?
!passed? && !skipped?
end
def supports_screenshot?
Capybara.current_driver != :rack_test
end
end
end
end
end
|
