ruby_raider 3.8.0 → 3.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/workflows/release.yml +18 -29
- data/.github/workflows/security.yml +68 -0
- data/.rubocop.yml +28 -0
- data/README.md +22 -4
- data/docs/superpowers/plans/2026-10-25-failure-video-replay.md +400 -0
- data/docs/superpowers/plans/2026-10-26-parity-cleanup.md +233 -0
- data/docs/superpowers/plans/2026-10-28-failure-card.md +295 -0
- data/docs/superpowers/specs/2026-10-25-failure-video-replay-design.md +214 -0
- data/docs/superpowers/specs/2026-10-28-failure-card-design.md +210 -0
- data/lib/commands/scaffolding_commands.rb +3 -3
- data/lib/commands/utility_commands.rb +36 -6
- data/lib/generators/cucumber/templates/cucumber.tt +1 -1
- data/lib/generators/cucumber/templates/partials/appium_env.tt +6 -0
- data/lib/generators/cucumber/templates/partials/selenium_env.tt +6 -0
- data/lib/generators/cucumber/templates/partials/watir_env.tt +6 -0
- data/lib/generators/helper_generator.rb +5 -1
- data/lib/generators/infrastructure/azure_generator.rb +1 -0
- data/lib/generators/infrastructure/github_generator.rb +1 -0
- data/lib/generators/infrastructure/templates/azure_pipelines.tt +26 -2
- data/lib/generators/infrastructure/templates/github.tt +31 -1
- data/lib/generators/infrastructure/templates/github_appium.tt +50 -1
- data/lib/generators/invoke_generators.rb +20 -2
- data/lib/generators/rspec/rspec_generator.rb +0 -1
- data/lib/generators/templates/common/gemfile.tt +1 -1
- data/lib/generators/templates/common/git_ignore.tt +3 -0
- data/lib/generators/templates/common/partials/mobile_config.tt +5 -0
- data/lib/generators/templates/common/partials/web_config.tt +6 -1
- data/lib/generators/templates/common/read_me.tt +80 -2
- data/lib/generators/templates/helpers/browser_helper.tt +5 -1
- data/lib/generators/templates/helpers/driver_helper.tt +1 -0
- data/lib/generators/templates/helpers/partials/selenium_driver.tt +4 -1
- data/lib/generators/templates/helpers/spec_helper.tt +8 -0
- data/lib/generators/templates/helpers/video_helper.tt +338 -171
- data/lib/ruby_raider/ffmpeg.rb +280 -0
- data/lib/ruby_raider.rb +2 -3
- data/lib/scaffolding/project_detector.rb +1 -3
- data/lib/scaffolding/scaffolding.rb +0 -1
- data/lib/utilities/utilities.rb +15 -2
- data/lib/version +1 -1
- data/ruby_raider.gemspec +3 -1
- data/sig/commands/utility_commands.rbs +4 -1
- data/sig/generators/invoke_generators.rbs +2 -3
- data/sig/ruby_raider/ffmpeg.rbs +23 -0
- data/sig/utilities/utilities.rbs +1 -0
- data/spec/commands/raider_commands_spec.rb +56 -1
- data/spec/generators/fixtures/video_helper_stubs/selenium-webdriver.rb +28 -0
- data/spec/generators/video_helper_spec.rb +608 -0
- data/spec/integration/commands/browser_update_after_creation_spec.rb +7 -6
- data/spec/integration/commands/utility_commands_spec.rb +2 -2
- data/spec/integration/content/azure_content_spec.rb +48 -3
- data/spec/integration/content/ci_content_spec.rb +115 -5
- data/spec/integration/content/common_content_spec.rb +8 -0
- data/spec/integration/content/config_content_spec.rb +14 -0
- data/spec/integration/content/cucumber_reporter_content_spec.rb +22 -1
- data/spec/integration/content/gemfile_content_spec.rb +2 -3
- data/spec/integration/content/helper_content_spec.rb +146 -0
- data/spec/integration/content/page_content_spec.rb +0 -1
- data/spec/integration/content/readme_content_spec.rb +65 -0
- data/spec/integration/content/rspec_reporter_content_spec.rb +2 -2
- data/spec/integration/content/test_content_spec.rb +2 -3
- data/spec/integration/end_to_end_features_spec.rb +0 -2
- data/spec/integration/end_to_end_spec.rb +252 -26
- data/spec/integration/generators/azure_generator_spec.rb +7 -6
- data/spec/integration/generators/common_generator_spec.rb +1 -1
- data/spec/integration/generators/invoke_generators_spec.rb +52 -0
- data/spec/integration/scaffolding_e2e_spec.rb +13 -24
- data/spec/scaffolding/scaffold_project_detector_spec.rb +0 -1
- data/spec/scaffolding/scaffolding_features_spec.rb +0 -1
- data/spec/system/selenium_spec.rb +0 -1
- data/spec/system/watir_spec.rb +0 -1
- data/spec/utilities/ffmpeg_spec.rb +424 -0
- data/spec/utilities/utilities_spec.rb +19 -2
- data/spec/utilities/video_command_spec.rb +120 -0
- metadata +49 -11
- data/lib/commands/adopt_commands.rb +0 -42
- data/lib/commands/loaded_commands.rb +0 -9
- data/lib/commands/plugin_commands.rb +0 -32
- data/sig/commands/adopt_commands.rbs +0 -8
- data/sig/commands/loaded_commands.rbs +0 -5
- data/sig/commands/plugin_commands.rbs +0 -9
|
@@ -3,6 +3,57 @@
|
|
|
3
3
|
require_relative 'content_helper'
|
|
4
4
|
|
|
5
5
|
describe 'Generated Readme content' do
|
|
6
|
+
FRAMEWORKS.product(AUTOMATION_TYPES).each do |framework, automation|
|
|
7
|
+
context "with #{framework} and #{automation}, the Video replay section" do
|
|
8
|
+
subject(:section) { readme[/^### Video replay\n.*?(?=^##)/m]&.gsub(/\s+/, ' ') }
|
|
9
|
+
|
|
10
|
+
let(:readme) { read_generated("#{framework}_#{automation}", 'Readme.md') }
|
|
11
|
+
let(:web) { %w[selenium watir].include?(automation) }
|
|
12
|
+
|
|
13
|
+
it 'exists and covers the defaults, VIDEO=off, the install commands and the cache' do
|
|
14
|
+
expect(section).not_to be_nil
|
|
15
|
+
expect(section).to include('only for failing tests', 'VIDEO=off', 'raider u video install',
|
|
16
|
+
'raider u video status', '~/.cache/raider', 'RAIDER_FFMPEG_PATH',
|
|
17
|
+
'RAIDER_CACHE_DIR', 'raider-results/attachments/')
|
|
18
|
+
end
|
|
19
|
+
|
|
20
|
+
it 'says that video needs RAIDER_FFMPEG_PATH until the ffmpeg release is published' do
|
|
21
|
+
expect(section).to include('ffmpeg-7.1', 'not published yet')
|
|
22
|
+
end
|
|
23
|
+
|
|
24
|
+
it 'names the right video format and how to turn video off for this project' do
|
|
25
|
+
if web
|
|
26
|
+
expect(section).to include('video.webm', 'raider u video off', 'raider u video on', 'video:')
|
|
27
|
+
elsif %w[android ios].include?(automation)
|
|
28
|
+
expect(section).to include('video.mp4', 'raider u video off', 'creates `config/config.yml`')
|
|
29
|
+
expect(section).not_to include('no `config/config.yml`')
|
|
30
|
+
else
|
|
31
|
+
expect(section).to include('video.mp4', 'raider u video off')
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
it 'says where mobile recording needs ffmpeg and how long it records' do
|
|
36
|
+
limits = { 'ios' => ['1800 s'], 'android' => ['180 s'], 'cross_platform' => ['1800 s', '180 s'] }
|
|
37
|
+
if web
|
|
38
|
+
expect(section).not_to include('Appium server host')
|
|
39
|
+
else
|
|
40
|
+
expect(section).to include('`ffmpeg` on the Appium server host', 'iOS', 'longer than 180 s',
|
|
41
|
+
'time_limit', *limits.fetch(automation))
|
|
42
|
+
expect(section).not_to include('do not use ffmpeg')
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
it 'lists the known limits of web recording' do
|
|
47
|
+
if web
|
|
48
|
+
expect(section).to include('after each page load, click and text change', 'next frame',
|
|
49
|
+
'one recorded driver per process')
|
|
50
|
+
else
|
|
51
|
+
expect(section).not_to include('next frame')
|
|
52
|
+
end
|
|
53
|
+
end
|
|
54
|
+
end
|
|
55
|
+
end
|
|
56
|
+
|
|
6
57
|
AUTOMATION_TYPES.each do |automation|
|
|
7
58
|
context "with rspec and #{automation}" do
|
|
8
59
|
subject(:readme) { read_generated("#{FrameworkIndex::RSPEC}_#{automation}", 'Readme.md') }
|
|
@@ -20,6 +71,13 @@ describe 'Generated Readme content' do
|
|
|
20
71
|
expect(readme).to include('### Quarantine', 'RAIDER_QUARANTINE', 'raider-reporter exec')
|
|
21
72
|
end
|
|
22
73
|
|
|
74
|
+
it 'explains the quality gate' do
|
|
75
|
+
expect(readme).to include('### Quality gate', 'RAIDER_GATE=1', 'Gate page', 'raider/gate',
|
|
76
|
+
'raider-reporter gate', 'raider-gate', 'exits 1 when the gate fails',
|
|
77
|
+
'2 when it gets no verdict', 'RAIDER_GATE_TIMEOUT', 'RAIDER_SHARD_TOTAL',
|
|
78
|
+
'RAIDER_SHARD_INDEX')
|
|
79
|
+
end
|
|
80
|
+
|
|
23
81
|
it 'points to the local HTML report' do
|
|
24
82
|
expect(readme).to include('raider-results/index.html')
|
|
25
83
|
expect(readme).not_to match(/allure/i)
|
|
@@ -42,6 +100,13 @@ describe 'Generated Readme content' do
|
|
|
42
100
|
expect(readme).to include('### Quarantine', 'RAIDER_QUARANTINE', 'raider-reporter exec')
|
|
43
101
|
end
|
|
44
102
|
|
|
103
|
+
it 'explains the quality gate' do
|
|
104
|
+
expect(readme).to include('### Quality gate', 'RAIDER_GATE=1', 'Gate page', 'raider/gate',
|
|
105
|
+
'raider-reporter gate', 'raider-gate', 'exits 1 when the gate fails',
|
|
106
|
+
'2 when it gets no verdict', 'RAIDER_GATE_TIMEOUT', 'RAIDER_SHARD_TOTAL',
|
|
107
|
+
'RAIDER_SHARD_INDEX')
|
|
108
|
+
end
|
|
109
|
+
|
|
45
110
|
it 'does not mention Allure' do
|
|
46
111
|
expect(readme).not_to match(/allure/i)
|
|
47
112
|
end
|
|
@@ -18,8 +18,8 @@ describe 'RSpec projects without Allure' do
|
|
|
18
18
|
expect(File).not_to exist(File.join(project_name, 'allure-results'))
|
|
19
19
|
end
|
|
20
20
|
|
|
21
|
-
it 'pins raider_reporter 0.
|
|
22
|
-
expect(read_generated(project_name, 'Gemfile')).to include("gem 'raider_reporter', '~> 0.
|
|
21
|
+
it 'pins raider_reporter 0.10' do
|
|
22
|
+
expect(read_generated(project_name, 'Gemfile')).to include("gem 'raider_reporter', '~> 0.10'")
|
|
23
23
|
end
|
|
24
24
|
end
|
|
25
25
|
end
|
|
@@ -111,8 +111,8 @@ describe 'Test file content' do
|
|
|
111
111
|
expect(config).to include('default:')
|
|
112
112
|
end
|
|
113
113
|
|
|
114
|
-
it 'uses the pretty
|
|
115
|
-
expect(config.strip).to eq('default: --format pretty --publish-quiet --retry 0')
|
|
114
|
+
it 'uses the pretty and rerun formatters, with the reporter activated from env.rb' do
|
|
115
|
+
expect(config.strip).to eq('default: --format pretty --format rerun --out rerun.txt --publish-quiet --retry 0')
|
|
116
116
|
end
|
|
117
117
|
end
|
|
118
118
|
|
|
@@ -147,5 +147,4 @@ describe 'Test file content' do
|
|
|
147
147
|
include_examples 'valid cucumber world', name
|
|
148
148
|
include_examples 'valid cucumber config', name
|
|
149
149
|
end
|
|
150
|
-
|
|
151
150
|
end
|
|
@@ -242,7 +242,6 @@ describe 'End-to-End Feature Validation' do
|
|
|
242
242
|
end
|
|
243
243
|
end
|
|
244
244
|
end
|
|
245
|
-
|
|
246
245
|
end
|
|
247
246
|
|
|
248
247
|
# --- Feature: GitHub Actions CI ---
|
|
@@ -264,5 +263,4 @@ describe 'End-to-End Feature Validation' do
|
|
|
264
263
|
expect(content).to include('rspec')
|
|
265
264
|
end
|
|
266
265
|
end
|
|
267
|
-
|
|
268
266
|
end
|
|
@@ -4,6 +4,8 @@ require_relative 'spec_helper'
|
|
|
4
4
|
require 'timeout'
|
|
5
5
|
require 'open3'
|
|
6
6
|
require 'json'
|
|
7
|
+
require 'erb'
|
|
8
|
+
require 'tmpdir'
|
|
7
9
|
|
|
8
10
|
# End-to-end integration tests that verify generated projects actually work
|
|
9
11
|
# These tests:
|
|
@@ -15,7 +17,7 @@ require 'json'
|
|
|
15
17
|
# This ensures the template system produces working, executable test frameworks
|
|
16
18
|
describe 'End-to-End Project Generation and Execution' do
|
|
17
19
|
# Helper to run commands in a generated project directory
|
|
18
|
-
def run_in_project(project_name, command, timeout: 300)
|
|
20
|
+
def run_in_project(project_name, command, timeout: 300, env: {})
|
|
19
21
|
result = {
|
|
20
22
|
success: false,
|
|
21
23
|
stdout: '',
|
|
@@ -26,7 +28,7 @@ describe 'End-to-End Project Generation and Execution' do
|
|
|
26
28
|
Dir.chdir(project_name) do
|
|
27
29
|
Bundler.with_unbundled_env do
|
|
28
30
|
Timeout.timeout(timeout) do
|
|
29
|
-
stdout, stderr, status = Open3.capture3(command)
|
|
31
|
+
stdout, stderr, status = Open3.capture3(env, command)
|
|
30
32
|
result[:stdout] = stdout
|
|
31
33
|
result[:stderr] = stderr
|
|
32
34
|
result[:exit_code] = status.exitstatus
|
|
@@ -49,6 +51,15 @@ describe 'End-to-End Project Generation and Execution' do
|
|
|
49
51
|
gemfile = File.join(project_name, 'Gemfile')
|
|
50
52
|
root = File.expand_path('../..', __dir__)
|
|
51
53
|
File.write(gemfile, File.read(gemfile).sub(/^gem 'ruby_raider'.*$/, "gem 'ruby_raider', path: '#{root}'"))
|
|
54
|
+
use_local_raider_reporter(gemfile)
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# Set RAIDER_REPORTER_PATH to a raider_reporter checkout to resolve a release that is not on RubyGems yet.
|
|
58
|
+
def use_local_raider_reporter(gemfile)
|
|
59
|
+
path = ENV.fetch('RAIDER_REPORTER_PATH', nil)
|
|
60
|
+
return unless path
|
|
61
|
+
|
|
62
|
+
File.write(gemfile, File.read(gemfile).sub(/^gem 'raider_reporter'.*$/, "gem 'raider_reporter', path: '#{path}'"))
|
|
52
63
|
end
|
|
53
64
|
|
|
54
65
|
# Helper to install dependencies
|
|
@@ -104,10 +115,10 @@ describe 'End-to-End Project Generation and Execution' do
|
|
|
104
115
|
expect(bundle_install(project)).to be true
|
|
105
116
|
end
|
|
106
117
|
|
|
107
|
-
it 'resolves raider_reporter 0.
|
|
118
|
+
it 'resolves raider_reporter 0.10+ from RubyGems and ships the raider-reporter executable', :aggregate_failures do
|
|
108
119
|
skip 'Bundle install failed' unless bundle_install(project)
|
|
109
120
|
|
|
110
|
-
expect(File.read(File.join(project, 'Gemfile.lock'))).to match(/^ raider_reporter \(0\.
|
|
121
|
+
expect(File.read(File.join(project, 'Gemfile.lock'))).to match(/^ raider_reporter \(0\.1\d\.\d+\)$/)
|
|
111
122
|
result = run_in_project(project, 'bundle exec raider-reporter --help', timeout: 60)
|
|
112
123
|
expect(result[:exit_code]).to eq(0), "STDOUT: #{result[:stdout]}\nSTDERR: #{result[:stderr]}"
|
|
113
124
|
expect(result[:stdout] + result[:stderr]).to include('raider-reporter comment')
|
|
@@ -163,11 +174,11 @@ describe 'End-to-End Project Generation and Execution' do
|
|
|
163
174
|
"STDERR: #{result[:stderr]}"
|
|
164
175
|
end
|
|
165
176
|
|
|
166
|
-
it 'resolves raider_reporter 0.
|
|
177
|
+
it 'resolves raider_reporter 0.10+ from RubyGems and requires its Cucumber plugin', :aggregate_failures do
|
|
167
178
|
skip 'Bundle install failed' unless bundle_install(project)
|
|
168
179
|
|
|
169
180
|
lockfile = File.read(File.join(project, 'Gemfile.lock'))
|
|
170
|
-
expect(lockfile).to match(/^ raider_reporter \(0\.
|
|
181
|
+
expect(lockfile).to match(/^ raider_reporter \(0\.1\d\.\d+\)$/)
|
|
171
182
|
expect(File.read(File.join(project, 'features/support/env.rb'))).to include("require 'raider_reporter/cucumber'")
|
|
172
183
|
end
|
|
173
184
|
|
|
@@ -182,6 +193,17 @@ describe 'End-to-End Project Generation and Execution' do
|
|
|
182
193
|
expect(result[:exit_code]).to eq(1)
|
|
183
194
|
end
|
|
184
195
|
|
|
196
|
+
it 'writes rerun.txt listing only the failing scenario', :aggregate_failures, :slow do
|
|
197
|
+
skip 'Bundle install failed' unless bundle_install(project)
|
|
198
|
+
|
|
199
|
+
result = run_cucumber_with_failure(project)
|
|
200
|
+
|
|
201
|
+
expect(result[:exit_code]).to eq(1)
|
|
202
|
+
rerun = File.join(project, 'rerun.txt')
|
|
203
|
+
expect(File).to exist(rerun)
|
|
204
|
+
expect(File.read(rerun).strip).to eq('features/reporter_failure.feature:3')
|
|
205
|
+
end
|
|
206
|
+
|
|
185
207
|
it 'writes raider-results/run.json listing every scenario with a failing scenario screenshot',
|
|
186
208
|
:aggregate_failures, :slow do
|
|
187
209
|
skip 'Bundle install failed' unless bundle_install(project)
|
|
@@ -211,7 +233,7 @@ describe 'End-to-End Project Generation and Execution' do
|
|
|
211
233
|
# Runs the project's features plus a deliberately failing scenario, then removes that scenario again
|
|
212
234
|
def run_cucumber_with_failure(project)
|
|
213
235
|
add_failing_cucumber_scenario(project)
|
|
214
|
-
FileUtils.rm_rf(File.join(project, 'raider-results'))
|
|
236
|
+
FileUtils.rm_rf([File.join(project, 'raider-results'), File.join(project, 'rerun.txt')])
|
|
215
237
|
run_cucumber(project)
|
|
216
238
|
ensure
|
|
217
239
|
remove_failing_cucumber_scenario(project)
|
|
@@ -263,20 +285,22 @@ describe 'End-to-End Project Generation and Execution' do
|
|
|
263
285
|
end
|
|
264
286
|
|
|
265
287
|
# Recorded Azure Pipelines env of a push (IndividualCI) build, see raider_reporter's CiDetector specs
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
288
|
+
def azure_push_env
|
|
289
|
+
{
|
|
290
|
+
'TF_BUILD' => 'True',
|
|
291
|
+
'SYSTEM_COLLECTIONURI' => 'https://dev.azure.com/raider-test/',
|
|
292
|
+
'SYSTEM_TEAMPROJECT' => 'My Project',
|
|
293
|
+
'SYSTEM_TEAMPROJECTID' => '6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c',
|
|
294
|
+
'BUILD_REPOSITORY_NAME' => 'web tests',
|
|
295
|
+
'BUILD_REPOSITORY_ID' => '1c2bd1a0-3f63-4d93-9c3c-2b4f2b1d8f11',
|
|
296
|
+
'BUILD_REPOSITORY_PROVIDER' => 'TfsGit',
|
|
297
|
+
'BUILD_BUILDID' => '42',
|
|
298
|
+
'SYSTEM_JOBDISPLAYNAME' => 'tests',
|
|
299
|
+
'BUILD_REASON' => 'IndividualCI',
|
|
300
|
+
'BUILD_SOURCEBRANCH' => 'refs/heads/release/1.2',
|
|
301
|
+
'BUILD_SOURCEVERSION' => 'abc'
|
|
302
|
+
}.freeze
|
|
303
|
+
end
|
|
280
304
|
|
|
281
305
|
# Generates a ci: azure web project (the shared before(:all) only builds the default github ones)
|
|
282
306
|
def generate_azure_project(framework)
|
|
@@ -289,7 +313,7 @@ describe 'End-to-End Project Generation and Execution' do
|
|
|
289
313
|
end
|
|
290
314
|
|
|
291
315
|
def azure_env_prefix
|
|
292
|
-
"GITHUB_ACTIONS= HEADLESS=true #{
|
|
316
|
+
"GITHUB_ACTIONS= HEADLESS=true #{azure_push_env.map { |k, v| "#{k}='#{v}'" }.join(' ')}"
|
|
293
317
|
end
|
|
294
318
|
|
|
295
319
|
def expect_azure_ci_block(project)
|
|
@@ -310,12 +334,12 @@ describe 'End-to-End Project Generation and Execution' do
|
|
|
310
334
|
describe 'Selenium + RSpec' do
|
|
311
335
|
let(:project) { generate_azure_project('rspec') }
|
|
312
336
|
|
|
313
|
-
it 'ships azure-pipelines.yml and resolves raider_reporter 0.
|
|
337
|
+
it 'ships azure-pipelines.yml and resolves raider_reporter 0.10+', :aggregate_failures do
|
|
314
338
|
expect(File).to exist(File.join(project, 'azure-pipelines.yml'))
|
|
315
339
|
expect(File).not_to exist(File.join(project, '.github/workflows'))
|
|
316
340
|
skip 'Bundle install failed' unless bundle_install(project)
|
|
317
341
|
|
|
318
|
-
expect(File.read(File.join(project, 'Gemfile.lock'))).to match(/^ raider_reporter \(0\.
|
|
342
|
+
expect(File.read(File.join(project, 'Gemfile.lock'))).to match(/^ raider_reporter \(0\.1\d\.\d+\)$/)
|
|
319
343
|
end
|
|
320
344
|
|
|
321
345
|
it 'records provider azure_pipelines and an azure_pipelines: build key in run.json', :aggregate_failures, :slow do
|
|
@@ -332,11 +356,11 @@ describe 'End-to-End Project Generation and Execution' do
|
|
|
332
356
|
describe 'Selenium + Cucumber' do
|
|
333
357
|
let(:project) { generate_azure_project('cucumber') }
|
|
334
358
|
|
|
335
|
-
it 'ships azure-pipelines.yml and resolves raider_reporter 0.
|
|
359
|
+
it 'ships azure-pipelines.yml and resolves raider_reporter 0.10+', :aggregate_failures do
|
|
336
360
|
expect(File).to exist(File.join(project, 'azure-pipelines.yml'))
|
|
337
361
|
skip 'Bundle install failed' unless bundle_install(project)
|
|
338
362
|
|
|
339
|
-
expect(File.read(File.join(project, 'Gemfile.lock'))).to match(/^ raider_reporter \(0\.
|
|
363
|
+
expect(File.read(File.join(project, 'Gemfile.lock'))).to match(/^ raider_reporter \(0\.1\d\.\d+\)$/)
|
|
340
364
|
end
|
|
341
365
|
|
|
342
366
|
it 'records provider azure_pipelines and an azure_pipelines: build key in run.json', :aggregate_failures, :slow do
|
|
@@ -351,6 +375,208 @@ describe 'End-to-End Project Generation and Execution' do
|
|
|
351
375
|
end
|
|
352
376
|
end
|
|
353
377
|
|
|
378
|
+
# Failure video replay against real browsers. Needs an ffmpeg with libvpx (RAIDER_FFMPEG_PATH), because the
|
|
379
|
+
# RaiderHQ ffmpeg release has no checksums yet. Skipped when it, or the browser, is missing. Firefox can be
|
|
380
|
+
# pointed at a specific binary with FIREFOX_BINARY.
|
|
381
|
+
context 'Failure video replay', :slow, :video do
|
|
382
|
+
let(:ffmpeg_path) { ENV.fetch('RAIDER_FFMPEG_PATH', '') }
|
|
383
|
+
let(:cache_dir) { Dir.mktmpdir('raider-cache') }
|
|
384
|
+
|
|
385
|
+
after { FileUtils.rm_rf(cache_dir) }
|
|
386
|
+
|
|
387
|
+
def skip_unless_video_prerequisites(browser)
|
|
388
|
+
skip 'RAIDER_FFMPEG_PATH is not set to an executable ffmpeg with libvpx' unless
|
|
389
|
+
File.file?(ffmpeg_path) && File.executable?(ffmpeg_path)
|
|
390
|
+
skip "#{browser} is not installed" unless browser_installed?(browser)
|
|
391
|
+
end
|
|
392
|
+
|
|
393
|
+
def browser_installed?(browser)
|
|
394
|
+
if browser == 'firefox'
|
|
395
|
+
ENV['FIREFOX_BINARY'] ? File.executable?(ENV['FIREFOX_BINARY']) : app_or_command?('Firefox', 'firefox')
|
|
396
|
+
else
|
|
397
|
+
app_or_command?('Google Chrome', 'google-chrome') || app_or_command?('Chromium', 'chromium')
|
|
398
|
+
end
|
|
399
|
+
end
|
|
400
|
+
|
|
401
|
+
def app_or_command?(app, command)
|
|
402
|
+
File.directory?("/Applications/#{app}.app") || system("command -v #{command} > /dev/null 2>&1")
|
|
403
|
+
end
|
|
404
|
+
|
|
405
|
+
# A separate project, so the default projects keep resolving raider_reporter 0.10+ from RubyGems
|
|
406
|
+
def generate_video_project(framework, automation)
|
|
407
|
+
name = "video_#{framework}_#{automation}"
|
|
408
|
+
unless LazyProjectGenerator::GENERATED.include?(name)
|
|
409
|
+
generate_framework(framework:, automation:, name:)
|
|
410
|
+
LazyProjectGenerator::GENERATED.add(name)
|
|
411
|
+
use_local_ruby_raider(name)
|
|
412
|
+
expect(run_in_project(name, 'bundle install --quiet', timeout: 300)[:success]).to be(true)
|
|
413
|
+
end
|
|
414
|
+
FileUtils.rm_rf(File.join(name, 'raider-results'))
|
|
415
|
+
name
|
|
416
|
+
end
|
|
417
|
+
|
|
418
|
+
def video_env(overrides = {})
|
|
419
|
+
{ 'HEADLESS' => 'true', 'RAIDER_FFMPEG_PATH' => ffmpeg_path, 'RAIDER_CACHE_DIR' => cache_dir,
|
|
420
|
+
'RAIDER_TOKEN' => nil, 'RAIDER_ENDPOINT' => nil, 'VIDEO' => nil }.merge(overrides)
|
|
421
|
+
end
|
|
422
|
+
|
|
423
|
+
def page_url
|
|
424
|
+
"data:text/html,#{ERB::Util.url_encode('<h1 id="title">Video</h1><input id="name"><button id="go">Go</button>')}"
|
|
425
|
+
end
|
|
426
|
+
|
|
427
|
+
def add_rspec_video_spec(project)
|
|
428
|
+
File.write(File.join(project, 'spec/video_replay_spec.rb'), <<~SPEC)
|
|
429
|
+
# frozen_string_literal: true
|
|
430
|
+
|
|
431
|
+
require_relative '../helpers/spec_helper'
|
|
432
|
+
|
|
433
|
+
describe 'Video replay' do
|
|
434
|
+
it 'passes after driving the page' do
|
|
435
|
+
driver.navigate.to('#{page_url}')
|
|
436
|
+
driver.find_element(id: 'name').send_keys('ok')
|
|
437
|
+
expect(driver.find_element(id: 'title').text).to eq('Video')
|
|
438
|
+
end
|
|
439
|
+
|
|
440
|
+
it 'fails after driving the page' do
|
|
441
|
+
driver.navigate.to('#{page_url}')
|
|
442
|
+
driver.find_element(id: 'name').send_keys('broken')
|
|
443
|
+
driver.find_element(id: 'go').click
|
|
444
|
+
expect(driver.find_element(id: 'title').text).to eq('deliberate video failure')
|
|
445
|
+
end
|
|
446
|
+
end
|
|
447
|
+
SPEC
|
|
448
|
+
end
|
|
449
|
+
|
|
450
|
+
def add_cucumber_video_feature(project, firefox_binary)
|
|
451
|
+
File.write(File.join(project, 'features/video_replay.feature'), <<~FEATURE)
|
|
452
|
+
Feature: Video replay
|
|
453
|
+
|
|
454
|
+
Scenario: A passing scenario
|
|
455
|
+
Given the video page is open
|
|
456
|
+
Then the video page title is "Video"
|
|
457
|
+
|
|
458
|
+
Scenario: A failing scenario
|
|
459
|
+
Given the video page is open
|
|
460
|
+
Then the video page title is "deliberate video failure"
|
|
461
|
+
FEATURE
|
|
462
|
+
File.write(File.join(project, 'features/step_definitions/video_replay_steps.rb'), <<~STEPS)
|
|
463
|
+
# frozen_string_literal: true
|
|
464
|
+
|
|
465
|
+
Given('the video page is open') do
|
|
466
|
+
browser.goto('#{page_url}')
|
|
467
|
+
browser.text_field(id: 'name').set('typed')
|
|
468
|
+
browser.button(id: 'go').click
|
|
469
|
+
end
|
|
470
|
+
|
|
471
|
+
Then('the video page title is {string}') do |title|
|
|
472
|
+
raise "expected title \#{title}" unless browser.h1(id: 'title').text == title
|
|
473
|
+
end
|
|
474
|
+
STEPS
|
|
475
|
+
config = File.join(project, 'config/config.yml')
|
|
476
|
+
File.write(config, File.read(config).sub(/^browser: .*$/, 'browser: firefox'))
|
|
477
|
+
# Test setup only: the generated templates do not read FIREFOX_BINARY.
|
|
478
|
+
File.write(File.join(project, 'features/support/zz_firefox_binary.rb'), <<~RUBY) if firefox_binary
|
|
479
|
+
# frozen_string_literal: true
|
|
480
|
+
|
|
481
|
+
Selenium::WebDriver::Firefox.path = ENV['FIREFOX_BINARY'] if ENV['FIREFOX_BINARY']
|
|
482
|
+
RUBY
|
|
483
|
+
end
|
|
484
|
+
|
|
485
|
+
def results(project)
|
|
486
|
+
JSON.parse(File.read(File.join(project, 'raider-results', 'run.json')))['results']
|
|
487
|
+
end
|
|
488
|
+
|
|
489
|
+
def video_files(project)
|
|
490
|
+
Dir.glob(File.join(project, 'raider-results', '**', '*.{webm,mp4}'))
|
|
491
|
+
end
|
|
492
|
+
|
|
493
|
+
def video_attachments(result)
|
|
494
|
+
result['attachments'].select { |attachment| attachment['name'] == 'video' }
|
|
495
|
+
end
|
|
496
|
+
|
|
497
|
+
def expect_video_for_failure_only(project, failing_name, run)
|
|
498
|
+
by_status = results(project).group_by { |r| r['status'] }
|
|
499
|
+
expect(by_status.keys).to match_array(%w[passed failed]), "STDOUT: #{run[:stdout]}\nSTDERR: #{run[:stderr]}"
|
|
500
|
+
failing = by_status['failed'].find { |r| r['full_name'].include?(failing_name) }
|
|
501
|
+
expect(failing).not_to be_nil, "No failing result named #{failing_name}"
|
|
502
|
+
expect(video_attachments(failing).size).to eq(1)
|
|
503
|
+
expect(video_attachments(failing).first['content_type']).to eq('video/webm')
|
|
504
|
+
by_status.fetch('passed', []).each { |r| expect(video_attachments(r)).to be_empty }
|
|
505
|
+
videos = video_files(project)
|
|
506
|
+
expect(videos.size).to eq(1)
|
|
507
|
+
expect(videos.first).to end_with('video.webm')
|
|
508
|
+
expect(File.size(videos.first)).to be_positive
|
|
509
|
+
expect(File.read(File.join(project, 'raider-results', 'index.html'))).to include('<video')
|
|
510
|
+
end
|
|
511
|
+
|
|
512
|
+
describe 'Selenium + RSpec on headless Chrome' do
|
|
513
|
+
let(:project) { 'video_rspec_selenium' }
|
|
514
|
+
let(:command) { 'bundle exec rspec spec/video_replay_spec.rb' }
|
|
515
|
+
|
|
516
|
+
before do
|
|
517
|
+
skip_unless_video_prerequisites('chrome')
|
|
518
|
+
generate_video_project('rspec', 'selenium')
|
|
519
|
+
add_rspec_video_spec(project)
|
|
520
|
+
end
|
|
521
|
+
|
|
522
|
+
after { FileUtils.rm_f(File.join(project, 'spec/video_replay_spec.rb')) }
|
|
523
|
+
|
|
524
|
+
it 'attaches video.webm to the failing example only and plays it in index.html', :aggregate_failures do
|
|
525
|
+
result = run_in_project(project, command, env: video_env)
|
|
526
|
+
expect(result[:exit_code]).to eq(1), "STDOUT: #{result[:stdout]}\nSTDERR: #{result[:stderr]}"
|
|
527
|
+
expect(result[:stderr]).not_to include('[video]')
|
|
528
|
+
expect_video_for_failure_only(project, 'fails after driving the page', result)
|
|
529
|
+
end
|
|
530
|
+
|
|
531
|
+
it 'writes no video with VIDEO=off', :aggregate_failures do
|
|
532
|
+
result = run_in_project(project, command, env: video_env('VIDEO' => 'off'))
|
|
533
|
+
expect(result[:exit_code]).to eq(1), "STDOUT: #{result[:stdout]}\nSTDERR: #{result[:stderr]}"
|
|
534
|
+
expect(video_files(project)).to be_empty
|
|
535
|
+
expect(results(project).flat_map { |r| video_attachments(r) }).to be_empty
|
|
536
|
+
expect(result[:stderr]).not_to include('[video]')
|
|
537
|
+
end
|
|
538
|
+
|
|
539
|
+
it 'runs unchanged with one [video] line and no download when no ffmpeg is usable', :aggregate_failures do
|
|
540
|
+
off = run_in_project(project, command, env: video_env('VIDEO' => 'off'))
|
|
541
|
+
FileUtils.rm_rf(File.join(project, 'raider-results'))
|
|
542
|
+
result = run_in_project(project, command, env: video_env('RAIDER_FFMPEG_PATH' => nil))
|
|
543
|
+
|
|
544
|
+
expect(result[:exit_code]).to eq(off[:exit_code]), "STDOUT: #{result[:stdout]}\nSTDERR: #{result[:stderr]}"
|
|
545
|
+
video_lines = result[:stderr].lines.grep(/\[video\]/)
|
|
546
|
+
expect(video_lines.size).to eq(1), "STDERR: #{result[:stderr]}"
|
|
547
|
+
# Decided at the first driver/recorder call, before any capture or fetch: the placeholder
|
|
548
|
+
# manifest has no checksum, so nothing is captured or downloaded.
|
|
549
|
+
expect(video_lines.first).to include('no ffmpeg available for this platform yet')
|
|
550
|
+
expect(video_files(project)).to be_empty
|
|
551
|
+
expect(Dir.glob(File.join(cache_dir, '**', '*'))).to be_empty
|
|
552
|
+
end
|
|
553
|
+
end
|
|
554
|
+
|
|
555
|
+
describe 'Watir + Cucumber on headless Firefox' do
|
|
556
|
+
let(:project) { 'video_cucumber_watir' }
|
|
557
|
+
let(:firefox_binary) { ENV.fetch('FIREFOX_BINARY', nil) }
|
|
558
|
+
|
|
559
|
+
before do
|
|
560
|
+
skip_unless_video_prerequisites('firefox')
|
|
561
|
+
generate_video_project('cucumber', 'watir')
|
|
562
|
+
add_cucumber_video_feature(project, firefox_binary)
|
|
563
|
+
end
|
|
564
|
+
|
|
565
|
+
after do
|
|
566
|
+
FileUtils.rm_f(File.join(project, 'features/video_replay.feature'))
|
|
567
|
+
FileUtils.rm_f(File.join(project, 'features/step_definitions/video_replay_steps.rb'))
|
|
568
|
+
end
|
|
569
|
+
|
|
570
|
+
it 'attaches video.webm to the failing scenario only and plays it in index.html', :aggregate_failures do
|
|
571
|
+
result = run_in_project(project, 'bundle exec cucumber features/video_replay.feature',
|
|
572
|
+
env: video_env('FIREFOX_BINARY' => firefox_binary), timeout: 240)
|
|
573
|
+
expect(result[:exit_code]).to eq(1), "STDOUT: #{result[:stdout]}\nSTDERR: #{result[:stderr]}"
|
|
574
|
+
expect(result[:stderr]).not_to include('[video]')
|
|
575
|
+
expect_video_for_failure_only(project, 'A failing scenario', result)
|
|
576
|
+
end
|
|
577
|
+
end
|
|
578
|
+
end
|
|
579
|
+
|
|
354
580
|
# Mobile and Visual frameworks require external services, so we only verify structure
|
|
355
581
|
context 'Mobile Automation Frameworks (structure validation only)' do
|
|
356
582
|
describe 'iOS + RSpec' do
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
3
|
require 'fileutils'
|
|
4
|
+
require 'open3'
|
|
4
5
|
require 'yaml'
|
|
5
6
|
require_relative '../../../lib/generators/infrastructure/azure_generator'
|
|
6
7
|
require_relative '../spec_helper'
|
|
@@ -63,10 +64,10 @@ describe AzureGenerator do
|
|
|
63
64
|
end
|
|
64
65
|
|
|
65
66
|
context 'with an invalid ci' do
|
|
66
|
-
it 'raises
|
|
67
|
+
it 'raises a Thor::Error and generates nothing' do
|
|
67
68
|
expect do
|
|
68
69
|
InvokeGenerators.generate_framework(automation: 'selenium', framework: 'rspec', name: 'azure_bad', ci: 'gitlab')
|
|
69
|
-
end.to raise_error(
|
|
70
|
+
end.to raise_error(Thor::Error, 'ci must be github or azure')
|
|
70
71
|
expect(File).not_to exist('azure_bad')
|
|
71
72
|
end
|
|
72
73
|
end
|
|
@@ -74,10 +75,10 @@ describe AzureGenerator do
|
|
|
74
75
|
context 'with raider new and ci:gitlab' do
|
|
75
76
|
it 'prints the error, generates nothing and exits non-zero' do
|
|
76
77
|
root = File.expand_path('../../..', __dir__)
|
|
77
|
-
out =
|
|
78
|
-
|
|
79
|
-
expect(
|
|
80
|
-
expect(out).to include('
|
|
78
|
+
out, status = Open3.capture2e('ruby', "#{root}/bin/raider", 'new', 'azure_cli_bad', '-p', 'framework:rspec',
|
|
79
|
+
'automation:selenium', 'ci:gitlab')
|
|
80
|
+
expect(status.exitstatus).not_to eq(0)
|
|
81
|
+
expect(out).to include('ci must be github or azure')
|
|
81
82
|
expect(File).not_to exist('azure_cli_bad')
|
|
82
83
|
end
|
|
83
84
|
end
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require 'fileutils'
|
|
4
|
+
require 'open3'
|
|
5
|
+
require_relative '../spec_helper'
|
|
6
|
+
|
|
7
|
+
describe InvokeGenerators do
|
|
8
|
+
after { FileUtils.rm_rf(Dir.glob('case_*')) }
|
|
9
|
+
|
|
10
|
+
context 'with option values in a different case' do
|
|
11
|
+
it 'accepts framework:Cucumber and automation:Selenium' do
|
|
12
|
+
described_class.generate_framework(framework: 'Cucumber', automation: 'Selenium', name: 'case_mixed')
|
|
13
|
+
expect(File).to exist('case_mixed/cucumber.yml')
|
|
14
|
+
end
|
|
15
|
+
|
|
16
|
+
it 'accepts upper-case values' do
|
|
17
|
+
described_class.generate_framework(framework: 'RSPEC', automation: 'WATIR', name: 'case_upper')
|
|
18
|
+
expect(File).to exist('case_upper/.rspec')
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
it 'accepts symbols' do
|
|
22
|
+
described_class.generate_framework(framework: :rspec, automation: :selenium, name: 'case_symbol')
|
|
23
|
+
expect(File).to exist('case_symbol/.rspec')
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
context 'with raider new and capitalised options' do
|
|
28
|
+
it 'generates the project and exits zero' do
|
|
29
|
+
root = File.expand_path('../../..', __dir__)
|
|
30
|
+
_out, status = Open3.capture2e('ruby', "#{root}/bin/raider", 'new', 'case_cli', '-p', 'framework:Cucumber',
|
|
31
|
+
'automation:Selenium')
|
|
32
|
+
expect(status.exitstatus).to eq(0)
|
|
33
|
+
expect(File).to exist('case_cli/cucumber.yml')
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
context 'with invalid values' do
|
|
38
|
+
it 'raises a Thor::Error for an unknown framework' do
|
|
39
|
+
expect { described_class.generate_framework(framework: 'minitest', automation: 'selenium', name: 'case_bad') }
|
|
40
|
+
.to raise_error(Thor::Error, /Invalid framework "minitest"/)
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
it 'sends an invalid ci to stderr and exits non-zero' do
|
|
44
|
+
root = File.expand_path('../../..', __dir__)
|
|
45
|
+
_out, err, status = Open3.capture3('ruby', "#{root}/bin/raider", 'new', 'case_bad_ci', '-p',
|
|
46
|
+
'framework:rspec', 'automation:selenium', 'ci:gitlab')
|
|
47
|
+
expect(status.exitstatus).to eq(1)
|
|
48
|
+
expect(err).to include('ci must be github or azure')
|
|
49
|
+
expect(File).not_to exist('case_bad_ci')
|
|
50
|
+
end
|
|
51
|
+
end
|
|
52
|
+
end
|