Skip to content

Commit d38bcd5

Browse files
aguspechamiz
aguspe
authored and
chamiz
committed
Expand options documentation test and examples for Ruby (SeleniumHQ#1679)[deploy site]
* Expand options documentation test and examples * Update timeouts examples * Update all navigations * Update options after updating the tests * Update options after updating the tests * Fix documentation bug --------- Co-authored-by: aguspe <[email protected]>
1 parent b80ac4c commit d38bcd5

File tree

9 files changed

+137
-86
lines changed

9 files changed

+137
-86
lines changed

Diff for: ‎examples/ruby/spec/drivers/options_spec.rb

+77-4
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,14 @@
55
RSpec.describe 'Chrome' do
66
describe 'Driver Options' do
77
let(:chrome_location) { driver_finder && ENV.fetch('CHROME_BIN', nil) }
8+
let(:url) { 'https://www.selenium.dev/selenium/web/' }
89

910
it 'page load strategy normal' do
1011
options = Selenium::WebDriver::Options.chrome
1112
options.page_load_strategy = :normal
1213

1314
driver = Selenium::WebDriver.for :chrome, options: options
14-
driver.get('https://www.google.com')
15+
driver.get(url)
1516
driver.quit
1617
end
1718

@@ -20,7 +21,7 @@
2021
options.page_load_strategy = :eager
2122

2223
driver = Selenium::WebDriver.for :chrome, options: options
23-
driver.get('https://www.google.com')
24+
driver.get(url)
2425
driver.quit
2526
end
2627

@@ -29,7 +30,7 @@
2930
options.page_load_strategy = :none
3031

3132
driver = Selenium::WebDriver.for :chrome, options: options
32-
driver.get('https://www.google.com')
33+
driver.get(url)
3334
driver.quit
3435
end
3536

@@ -42,7 +43,79 @@
4243
cloud_options[:name] = my_test_name
4344
options.add_option('cloud:options', cloud_options)
4445
driver = Selenium::WebDriver.for :remote, capabilities: options
45-
driver.get('https://www.google.com')
46+
driver.get(url)
47+
driver.quit
48+
end
49+
50+
it 'accepts untrusted certificates' do
51+
options = Selenium::WebDriver::Options.chrome
52+
options.accept_insecure_certs = true
53+
54+
driver = Selenium::WebDriver.for :chrome, options: options
55+
driver.get(url)
56+
driver.quit
57+
end
58+
59+
it 'sets unhandled prompt behavior' do
60+
options = Selenium::WebDriver::Options.chrome
61+
options.unhandled_prompt_behavior = :accept
62+
63+
driver = Selenium::WebDriver.for :chrome, options: options
64+
driver.get(url)
65+
driver.quit
66+
end
67+
68+
it 'sets window rect' do
69+
options = Selenium::WebDriver::Options.firefox
70+
options.set_window_rect = true
71+
72+
driver = Selenium::WebDriver.for :firefox, options: options
73+
driver.get(url)
74+
driver.quit
75+
end
76+
77+
it 'sets strict file interactability' do
78+
options = Selenium::WebDriver::Options.chrome
79+
options.strict_file_interactability = true
80+
81+
driver = Selenium::WebDriver.for :chrome, options: options
82+
driver.get(url)
83+
driver.quit
84+
end
85+
86+
it 'sets the proxy' do
87+
options = Selenium::WebDriver::Options.chrome
88+
options.proxy = Selenium::WebDriver::Proxy.new(http: 'myproxy.com:8080')
89+
90+
driver = Selenium::WebDriver.for :chrome, options: options
91+
driver.get(url)
92+
driver.quit
93+
end
94+
95+
it 'sets the implicit timeout' do
96+
options = Selenium::WebDriver::Options.chrome
97+
options.timeouts = {implicit: 1}
98+
99+
driver = Selenium::WebDriver.for :chrome, options: options
100+
driver.get(url)
101+
driver.quit
102+
end
103+
104+
it 'sets the page load timeout' do
105+
options = Selenium::WebDriver::Options.chrome
106+
options.timeouts = {page_load: 400_000}
107+
108+
driver = Selenium::WebDriver.for :chrome, options: options
109+
driver.get(url)
110+
driver.quit
111+
end
112+
113+
it 'sets the script timeout' do
114+
options = Selenium::WebDriver::Options.chrome
115+
options.timeouts = {script: 40_000}
116+
117+
driver = Selenium::WebDriver.for :chrome, options: options
118+
driver.get(url)
46119
driver.quit
47120
end
48121
end

Diff for: ‎website_and_docs/content/documentation/webdriver/drivers/options.en.md

+14-19
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Browser name is set by default when using an Options class instance.
4040
{{< badge-code >}}
4141
{{< /tab >}}
4242
{{< tab header="Ruby" >}}
43-
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L10" >}}
43+
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L11" >}}
4444
{{< /tab >}}
4545
{{< tab header="JavaScript" >}}
4646
{{< badge-code >}}
@@ -67,7 +67,7 @@ it will be automatically downloaded by [Selenium Manager]({{< ref "../../seleniu
6767
{{< badge-code >}}
6868
{{< /tab >}}
6969
{{< tab header="Ruby" >}}
70-
{{< gh-codeblock path="examples/ruby/spec/drivers/service_spec.rb#L35" >}}
70+
{{< gh-codeblock path="examples/ruby/spec/drivers/service_spec.rb#L40" >}}
7171
{{< /tab >}}
7272
{{< tab header="JavaScript" >}}
7373
{{< badge-code >}}
@@ -139,7 +139,7 @@ namespace pageLoadStrategy {
139139
}
140140
{{< /tab >}}
141141
{{< tab header="Ruby" text=true >}}
142-
{{< gh-codeblock path="/examples/ruby/spec/drivers/options_spec.rb#L10-L11">}}
142+
{{< gh-codeblock path="/examples/ruby/spec/drivers/options_spec.rb#L11-L12">}}
143143
{{< /tab >}}
144144
{{< tab header="JavaScript" text=true >}}
145145
{{< gh-codeblock path="/examples/javascript/test/capabilities/pageLoading.spec.js#L28-L34">}}
@@ -196,7 +196,7 @@ namespace pageLoadStrategy {
196196
}
197197
{{< /tab >}}
198198
{{< tab header="Ruby" text=true >}}
199-
{{< gh-codeblock path="/examples/ruby/spec/drivers/options_spec.rb#L19-L20">}}
199+
{{< gh-codeblock path="/examples/ruby/spec/drivers/options_spec.rb#L20-L21">}}
200200
{{< /tab >}}
201201
{{< tab header="JavaScript" text=true >}}
202202
{{< gh-codeblock path="/examples/javascript/test/capabilities/pageLoading.spec.js#L8-L14">}}
@@ -252,7 +252,7 @@ namespace pageLoadStrategy {
252252
}
253253
{{< /tab >}}
254254
{{< tab header="Ruby" text=true >}}
255-
{{< gh-codeblock path="/examples/ruby/spec/drivers/options_spec.rb#L28-L29">}}
255+
{{< gh-codeblock path="/examples/ruby/spec/drivers/options_spec.rb#L29-L30">}}
256256
{{< /tab >}}
257257
{{< tab header="JavaScript" text=true >}}
258258
{{< gh-codeblock path="/examples/javascript/test/capabilities/pageLoading.spec.js#L18-L24">}}
@@ -296,7 +296,7 @@ setting `platformName` sets the OS at the remote-end.
296296
{{< badge-code >}}
297297
{{< /tab >}}
298298
{{< tab header="Ruby" >}}
299-
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L37-L38" >}}
299+
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L38-L39" >}}
300300
{{< /tab >}}
301301
{{< tab header="JavaScript" >}}
302302
{{< badge-code >}}
@@ -334,7 +334,7 @@ effect for the entire session.
334334
{{< badge-code >}}
335335
{{< /tab >}}
336336
{{< tab header="Ruby" >}}
337-
{{< badge-code >}}
337+
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L51-L52" >}}
338338
{{< /tab >}}
339339
{{< tab header="JavaScript" >}}
340340
{{< badge-code >}}
@@ -369,7 +369,7 @@ is imposed when a new session is created by WebDriver.
369369
{{< badge-code >}}
370370
{{< /tab >}}
371371
{{< tab header="Ruby" >}}
372-
{{< badge-code >}}
372+
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L114-L115" >}}
373373
{{< /tab >}}
374374
{{< tab header="JavaScript" >}}
375375
{{< badge-code >}}
@@ -398,7 +398,7 @@ _TimeoutException_.
398398
{{< badge-code >}}
399399
{{< /tab >}}
400400
{{< tab header="Ruby" >}}
401-
{{< badge-code >}}
401+
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L105-L106" >}}
402402
{{< /tab >}}
403403
{{< tab header="JavaScript" >}}
404404
{{< badge-code >}}
@@ -425,7 +425,7 @@ is imposed when a new session is created by WebDriver.
425425
{{< badge-code >}}
426426
{{< /tab >}}
427427
{{< tab header="Ruby" >}}
428-
{{< badge-code >}}
428+
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L96-L97" >}}
429429
{{< /tab >}}
430430
{{< tab header="JavaScript" >}}
431431
{{< badge-code >}}
@@ -463,7 +463,7 @@ user prompt encounters at the remote-end. This is defined by
463463
{{< badge-code >}}
464464
{{< /tab >}}
465465
{{< tab header="Ruby" >}}
466-
{{< badge-code >}}
466+
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L60-L61" >}}
467467
{{< /tab >}}
468468
{{< tab header="JavaScript" >}}
469469
{{< badge-code >}}
@@ -488,7 +488,7 @@ Indicates whether the remote end supports all of the [resizing and repositioning
488488
{{< badge-code >}}
489489
{{< /tab >}}
490490
{{< tab header="Ruby" >}}
491-
{{< badge-code >}}
491+
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L69-L70" >}}
492492
{{< /tab >}}
493493
{{< tab header="JavaScript" >}}
494494
{{< badge-code >}}
@@ -516,7 +516,7 @@ when using _Element Send Keys_ with hidden file upload controls.
516516
{{< badge-code >}}
517517
{{< /tab >}}
518518
{{< tab header="Ruby" >}}
519-
{{< badge-code >}}
519+
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L78-L79" >}}
520520
{{< /tab >}}
521521
{{< tab header="JavaScript" >}}
522522
{{< badge-code >}}
@@ -603,12 +603,7 @@ driver.Navigate().GoToUrl("https://www.selenium.dev/");
603603
}
604604
{{< /tab >}}
605605
{{< tab header="Ruby" >}}
606-
607-
proxy = Selenium::WebDriver::Proxy.new(http: '<HOST:PORT>')
608-
cap = Selenium::WebDriver::Remote::Capabilities.chrome(proxy: proxy)
609-
610-
driver = Selenium::WebDriver.for(:chrome, capabilities: cap)
611-
driver.get('http://google.com')
606+
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L87-L88" >}}
612607
{{< /tab >}}
613608
{{< tab header="JavaScript" >}}
614609
let webdriver = require('selenium-webdriver');

Diff for: ‎website_and_docs/content/documentation/webdriver/drivers/options.ja.md

+14-20
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Browser name is set by default when using an Options class instance.
4040
{{< badge-code >}}
4141
{{< /tab >}}
4242
{{< tab header="Ruby" >}}
43-
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L10" >}}
43+
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L11" >}}
4444
{{< /tab >}}
4545
{{< tab header="JavaScript" >}}
4646
{{< badge-code >}}
@@ -68,7 +68,7 @@ it will be automatically downloaded by [Selenium Manager]({{< ref "../../seleniu
6868
{{< badge-code >}}
6969
{{< /tab >}}
7070
{{< tab header="Ruby" >}}
71-
{{< gh-codeblock path="examples/ruby/spec/drivers/service_spec.rb#L35" >}}
71+
{{< gh-codeblock path="examples/ruby/spec/drivers/service_spec.rb#L40" >}}
7272
{{< /tab >}}
7373
{{< tab header="JavaScript" >}}
7474
{{< badge-code >}}
@@ -137,7 +137,7 @@ namespace pageLoadStrategy {
137137
}
138138
{{< /tab >}}
139139
{{< tab header="Ruby" text=true >}}
140-
{{< gh-codeblock path="/examples/ruby/spec/drivers/options_spec.rb#L10-L11">}}
140+
{{< gh-codeblock path="/examples/ruby/spec/drivers/options_spec.rb#L11-L12">}}
141141
{{< /tab >}}
142142
{{< tab header="JavaScript" text=true >}}
143143
{{< gh-codeblock path="/examples/javascript/test/capabilities/pageLoading.spec.js#L28-L34">}}
@@ -193,7 +193,7 @@ namespace pageLoadStrategy {
193193
}
194194
{{< /tab >}}
195195
{{< tab header="Ruby" text=true >}}
196-
{{< gh-codeblock path="/examples/ruby/spec/drivers/options_spec.rb#L19-L20">}}
196+
{{< gh-codeblock path="/examples/ruby/spec/drivers/options_spec.rb#L20-L21">}}
197197
{{< /tab >}}
198198
{{< tab header="JavaScript" text=true >}}
199199
{{< gh-codeblock path="/examples/javascript/test/capabilities/pageLoading.spec.js#L8-L14">}}
@@ -248,7 +248,7 @@ namespace pageLoadStrategy {
248248
}
249249
{{< /tab >}}
250250
{{< tab header="Ruby" text=true >}}
251-
{{< gh-codeblock path="/examples/ruby/spec/drivers/options_spec.rb#L28-L29">}}
251+
{{< gh-codeblock path="/examples/ruby/spec/drivers/options_spec.rb#L29-L30">}}
252252
{{< /tab >}}
253253
{{< tab header="JavaScript" text=true >}}
254254
{{< gh-codeblock path="/examples/javascript/test/capabilities/pageLoading.spec.js#L18-L24">}}
@@ -290,7 +290,7 @@ fun main() {
290290
{{< badge-code >}}
291291
{{< /tab >}}
292292
{{< tab header="Ruby" >}}
293-
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L37-L38" >}}
293+
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L38-L39" >}}
294294
{{< /tab >}}
295295
{{< tab header="JavaScript" >}}
296296
{{< badge-code >}}
@@ -322,7 +322,7 @@ fun main() {
322322
{{< badge-code >}}
323323
{{< /tab >}}
324324
{{< tab header="Ruby" >}}
325-
{{< badge-code >}}
325+
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L51-L52" >}}
326326
{{< /tab >}}
327327
{{< tab header="JavaScript" >}}
328328
{{< badge-code >}}
@@ -354,7 +354,7 @@ WebDriverの `セッション` には特定の `セッションタイムアウ
354354
{{< badge-code >}}
355355
{{< /tab >}}
356356
{{< tab header="Ruby" >}}
357-
{{< badge-code >}}
357+
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L114-L115" >}}
358358
{{< /tab >}}
359359
{{< tab header="JavaScript" >}}
360360
{{< badge-code >}}
@@ -380,7 +380,7 @@ WebDriverの `セッション` には特定の `セッションタイムアウ
380380
{{< badge-code >}}
381381
{{< /tab >}}
382382
{{< tab header="Ruby" >}}
383-
{{< badge-code >}}
383+
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L105-L106" >}}
384384
{{< /tab >}}
385385
{{< tab header="JavaScript" >}}
386386
{{< badge-code >}}
@@ -405,7 +405,7 @@ WebDriverの `セッション` には特定の `セッションタイムアウ
405405
{{< badge-code >}}
406406
{{< /tab >}}
407407
{{< tab header="Ruby" >}}
408-
{{< badge-code >}}
408+
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L96-L97" >}}
409409
{{< /tab >}}
410410
{{< tab header="JavaScript" >}}
411411
{{< badge-code >}}
@@ -442,7 +442,7 @@ WebDriverの `セッション` には特定の `セッションタイムアウ
442442
{{< badge-code >}}
443443
{{< /tab >}}
444444
{{< tab header="Ruby" >}}
445-
{{< badge-code >}}
445+
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L60-L61" >}}
446446
{{< /tab >}}
447447
{{< tab header="JavaScript" >}}
448448
{{< badge-code >}}
@@ -468,7 +468,7 @@ WebDriverの `セッション` には特定の `セッションタイムアウ
468468
{{< badge-code >}}
469469
{{< /tab >}}
470470
{{< tab header="Ruby" >}}
471-
{{< badge-code >}}
471+
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L69-L70" >}}
472472
{{< /tab >}}
473473
{{< tab header="JavaScript" >}}
474474
{{< badge-code >}}
@@ -495,7 +495,7 @@ WebDriverの `セッション` には特定の `セッションタイムアウ
495495
{{< badge-code >}}
496496
{{< /tab >}}
497497
{{< tab header="Ruby" >}}
498-
{{< badge-code >}}
498+
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L78-L79" >}}
499499
{{< /tab >}}
500500
{{< tab header="JavaScript" >}}
501501
{{< badge-code >}}
@@ -577,13 +577,7 @@ driver.Navigate().GoToUrl("https://www.selenium.dev/");
577577
}
578578
{{< /tab >}}
579579
{{< tab header="Ruby" >}}
580-
# this code was written with Selenium 4
581-
582-
proxy = Selenium::WebDriver::Proxy.new(http: '<HOST:PORT>')
583-
cap = Selenium::WebDriver::Remote::Capabilities.chrome(proxy: proxy)
584-
585-
driver = Selenium::WebDriver.for(:chrome, capabilities: cap)
586-
driver.get('http://google.com')
580+
{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L87-L88" >}}
587581
{{< /tab >}}
588582
{{< tab header="JavaScript" >}}
589583
let webdriver = require('selenium-webdriver');

0 commit comments

Comments
 (0)