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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
# frozen_string_literal: true
require "abstract_unit"
require "action_dispatch/system_testing/test_helpers/screenshot_helper"
require "capybara/dsl"
require "selenium/webdriver"
class ScreenshotHelperTest < ActiveSupport::TestCase
def setup
@new_test = DrivenBySeleniumWithChrome.new("x")
@new_test.send("_screenshot_counter=", nil)
end
test "image path is saved in tmp directory" do
Rails.stub :root, Pathname.getwd do
assert_equal Rails.root.join("tmp/screenshots/0_x.png").to_s, @new_test.send(:image_path)
end
end
test "image path unique counter is changed when incremented" do
@new_test.send(:increment_unique)
Rails.stub :root, Pathname.getwd do
assert_equal Rails.root.join("tmp/screenshots/1_x.png").to_s, @new_test.send(:image_path)
end
end
# To allow multiple screenshots in same test
test "image path unique counter generates different path in same test" do
Rails.stub :root, Pathname.getwd do
@new_test.send(:increment_unique)
assert_equal Rails.root.join("tmp/screenshots/1_x.png").to_s, @new_test.send(:image_path)
@new_test.send(:increment_unique)
assert_equal Rails.root.join("tmp/screenshots/2_x.png").to_s, @new_test.send(:image_path)
end
end
test "image path uses the Capybara.save_path to set a custom directory" do
original_save_path = Capybara.save_path
Capybara.save_path = "custom_dir"
Rails.stub :root, Pathname.getwd do
assert_equal Rails.root.join("custom_dir/0_x.png").to_s, @new_test.send(:image_path)
end
ensure
Capybara.save_path = original_save_path
end
test "image path includes failures text if test did not pass" do
Rails.stub :root, Pathname.getwd do
@new_test.stub :passed?, false do
assert_equal Rails.root.join("tmp/screenshots/failures_x.png").to_s, @new_test.send(:image_path)
assert_equal Rails.root.join("tmp/screenshots/failures_x.html").to_s, @new_test.send(:html_path)
end
end
end
test "image path does not include failures text if test skipped" do
Rails.stub :root, Pathname.getwd do
@new_test.stub :passed?, false do
@new_test.stub :skipped?, true do
assert_equal Rails.root.join("tmp/screenshots/0_x.png").to_s, @new_test.send(:image_path)
assert_equal Rails.root.join("tmp/screenshots/0_x.html").to_s, @new_test.send(:html_path)
end
end
end
end
test "image name truncates names over 225 characters including counter" do
long_test = DrivenBySeleniumWithChrome.new("x" * 400)
Rails.stub :root, Pathname.getwd do
assert_equal Rails.root.join("tmp/screenshots/0_#{"x" * 223}.png").to_s, long_test.send(:image_path)
assert_equal Rails.root.join("tmp/screenshots/0_#{"x" * 223}.html").to_s, long_test.send(:html_path)
end
end
test "defaults to simple output for the screenshot" do
assert_equal "simple", @new_test.send(:output_type)
end
test "take_screenshot saves HTML and shows link to it when using RAILS_SYSTEM_TESTING_SCREENSHOT_HTML env" do
original_html_setting = ENV["RAILS_SYSTEM_TESTING_SCREENSHOT_HTML"]
ENV["RAILS_SYSTEM_TESTING_SCREENSHOT_HTML"] = "1"
display_image_actual = nil
called_save_html = false
Rails.stub :root, Pathname.getwd do
@new_test.stub :save_image, nil do
@new_test.stub :show, -> (img) { display_image_actual = img } do
@new_test.stub :save_html, -> { called_save_html = true } do
@new_test.take_screenshot
end
end
end
end
assert called_save_html
assert_match %r|\[Screenshot HTML\].+?tmp/screenshots/1_x\.html|, display_image_actual
ensure
ENV["RAILS_SYSTEM_TESTING_SCREENSHOT_HTML"] = original_html_setting
end
test "take_screenshot saves HTML and shows link to it when using html: kwarg" do
display_image_actual = nil
called_save_html = false
Rails.stub :root, Pathname.getwd do
@new_test.stub :save_image, nil do
@new_test.stub :show, -> (img) { display_image_actual = img } do
@new_test.stub :save_html, -> { called_save_html = true } do
@new_test.take_screenshot(html: true)
end
end
end
end
assert called_save_html
assert_match %r|\[Screenshot HTML\].+?tmp/screenshots/1_x\.html|, display_image_actual
end
test "take_screenshot allows changing screenshot display format via RAILS_SYSTEM_TESTING_SCREENSHOT env" do
original_output_type = ENV["RAILS_SYSTEM_TESTING_SCREENSHOT"]
ENV["RAILS_SYSTEM_TESTING_SCREENSHOT"] = "artifact"
display_image_actual = nil
Rails.stub :root, Pathname.getwd do
@new_test.stub :save_image, nil do
@new_test.stub :show, -> (img) { display_image_actual = img } do
@new_test.take_screenshot
end
end
end
assert_match %r|url=artifact://.+?tmp/screenshots/1_x\.png|, display_image_actual
ensure
ENV["RAILS_SYSTEM_TESTING_SCREENSHOT"] = original_output_type
end
test "take_screenshot allows changing screenshot display format via screenshot: kwarg" do
display_image_actual = nil
Rails.stub :root, Pathname.getwd do
@new_test.stub :save_image, nil do
@new_test.stub :show, -> (img) { display_image_actual = img } do
@new_test.take_screenshot(screenshot: "artifact")
end
end
end
assert_match %r|url=artifact://.+?tmp/screenshots/1_x\.png|, display_image_actual
end
test "take_failed_screenshot persists the image path in the test metadata" do
Rails.stub :root, Pathname.getwd do
@new_test.stub :passed?, false do
Capybara::Session.stub :instance_created?, true do
@new_test.stub :save_image, nil do
@new_test.stub :show, -> (_) { } do
@new_test.take_failed_screenshot
assert_equal @new_test.send(:relative_image_path), @new_test.metadata[:failure_screenshot_path]
end
end
end
end
end
end
test "image path returns the absolute path from root" do
Rails.stub :root, Pathname.getwd.join("..") do
assert_equal Rails.root.join("tmp/screenshots/0_x.png").to_s, @new_test.send(:image_path)
end
end
test "Non word characters are replaced with dashes in paths" do
non_word_chars_test = DrivenBySeleniumWithChrome.new("x/y\\z?<br>-span")
Rails.stub :root, Pathname.getwd do
assert_equal Rails.root.join("tmp/screenshots/0_x-y-z-br-span.png").to_s, non_word_chars_test.send(:image_path)
assert_equal Rails.root.join("tmp/screenshots/0_x-y-z-br-span.html").to_s, non_word_chars_test.send(:html_path)
end
end
end
class RackTestScreenshotsTest < DrivenByRackTest
test "rack_test driver does not support screenshot" do
assert_not self.send(:supports_screenshot?)
end
end
class SeleniumScreenshotsTest < DrivenBySeleniumWithChrome
test "selenium driver supports screenshot" do
assert self.send(:supports_screenshot?)
end
end
|
