Skip to content

Commit 7602371

Browse files
aguspeaguspe
authored
[rb] Allow driver path to be set using ENV variables (#14287)
1 parent 39c38e4 commit 7602371

File tree

19 files changed

+221
-6
lines changed

19 files changed

+221
-6
lines changed

‎rb/lib/selenium/webdriver/chrome/service.rb

+1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ class Service < WebDriver::Service
2424
DEFAULT_PORT = 9515
2525
EXECUTABLE = 'chromedriver'
2626
SHUTDOWN_SUPPORTED = true
27+
DRIVER_PATH_ENV_KEY = 'SE_CHROMEDRIVER'
2728

2829
def log
2930
return @log unless @log.is_a? String

‎rb/lib/selenium/webdriver/common/service.rb

+11-4
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ def driver_path=(path)
6969
def initialize(path: nil, port: nil, log: nil, args: nil)
7070
port ||= self.class::DEFAULT_PORT
7171
args ||= []
72+
path ||= env_path
7273

7374
@executable_path = path
7475
@host = Platform.localhost
@@ -87,16 +88,22 @@ def initialize(path: nil, port: nil, log: nil, args: nil)
8788
end
8889

8990
def launch
90-
@executable_path ||= begin
91-
default_options = WebDriver.const_get("#{self.class.name&.split('::')&.[](2)}::Options").new
92-
DriverFinder.new(default_options, self).driver_path
93-
end
91+
@executable_path ||= env_path || find_driver_path
9492
ServiceManager.new(self).tap(&:start)
9593
end
9694

9795
def shutdown_supported
9896
self.class::SHUTDOWN_SUPPORTED
9997
end
98+
99+
def find_driver_path
100+
default_options = WebDriver.const_get("#{self.class.name&.split('::')&.[](2)}::Options").new
101+
DriverFinder.new(default_options, self).driver_path
102+
end
103+
104+
def env_path
105+
ENV.fetch(self.class::DRIVER_PATH_ENV_KEY, nil)
106+
end
100107
end # Service
101108
end # WebDriver
102109
end # Selenium

‎rb/lib/selenium/webdriver/edge/service.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class Service < WebDriver::Service
2424
DEFAULT_PORT = 9515
2525
EXECUTABLE = 'msedgedriver'
2626
SHUTDOWN_SUPPORTED = true
27-
27+
DRIVER_PATH_ENV_KEY = 'SE_EDGEDRIVER'
2828
def log
2929
return @log unless @log.is_a? String
3030

‎rb/lib/selenium/webdriver/firefox/service.rb

+1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ class Service < WebDriver::Service
2424
DEFAULT_PORT = 4444
2525
EXECUTABLE = 'geckodriver'
2626
SHUTDOWN_SUPPORTED = false
27+
DRIVER_PATH_ENV_KEY = 'SE_GECKODRIVER'
2728
end # Service
2829
end # Firefox
2930
end # WebDriver

‎rb/lib/selenium/webdriver/ie/service.rb

+1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ class Service < WebDriver::Service
2424
DEFAULT_PORT = 5555
2525
EXECUTABLE = 'IEDriverServer'
2626
SHUTDOWN_SUPPORTED = true
27+
DRIVER_PATH_ENV_KEY = 'SE_IEDRIVER'
2728
end # Server
2829
end # IE
2930
end # WebDriver

‎rb/lib/selenium/webdriver/safari/service.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class Service < WebDriver::Service
2424
DEFAULT_PORT = 7050
2525
EXECUTABLE = 'safaridriver'
2626
SHUTDOWN_SUPPORTED = false
27-
27+
DRIVER_PATH_ENV_KEY = 'SE_SAFARIDRIVER'
2828
def initialize(path: nil, port: nil, log: nil, args: nil)
2929
raise Error::WebDriverError, 'Safari Service does not support setting log output' if log
3030

‎rb/sig/lib/selenium/webdriver/chrome/service.rbs

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ module Selenium
22
module WebDriver
33
module Chrome
44
class Service < WebDriver::Service
5+
DRIVER_PATH_ENV_KEY: String
6+
57
@log: untyped
68

79
DEFAULT_PORT: Integer

‎rb/sig/lib/selenium/webdriver/common/service.rbs

+2
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ module Selenium
4747

4848
attr_accessor args: untyped
4949

50+
def env_path: -> String
51+
5052
alias extra_args args
5153

5254
def initialize: (?path: untyped?, ?port: untyped?, ?log: untyped?, ?args: untyped?) -> void

‎rb/sig/lib/selenium/webdriver/edge/service.rbs

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ module Selenium
22
module WebDriver
33
module Edge
44
class Service < WebDriver::Service
5+
DRIVER_PATH_ENV_KEY: String
6+
57
@log: untyped
68

79
DEFAULT_PORT: Integer

‎rb/sig/lib/selenium/webdriver/firefox/service.rbs

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ module Selenium
44
class Service < WebDriver::Service
55
DEFAULT_PORT: 4444
66

7+
DRIVER_PATH_ENV_KEY: String
78
EXECUTABLE: "geckodriver"
89

910
SHUTDOWN_SUPPORTED: false

‎rb/sig/lib/selenium/webdriver/ie/service.rbs

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ module Selenium
44
class Service < WebDriver::Service
55
DEFAULT_PORT: Integer
66

7+
DRIVER_PATH_ENV_KEY: String
78
EXECUTABLE: String
89

910
SHUTDOWN_SUPPORTED: bool

‎rb/sig/lib/selenium/webdriver/safari/service.rbs

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ module Selenium
44
class Service < WebDriver::Service
55
DEFAULT_PORT: Integer
66

7+
DRIVER_PATH_ENV_KEY: String
78
EXECUTABLE: String
89

910
SHUTDOWN_SUPPORTED: bool

‎rb/spec/integration/selenium/webdriver/ie/service_spec.rb

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# frozen_string_literal: true
2+
3+
# Licensed to the Software Freedom Conservancy (SFC) under one
4+
# or more contributor license agreements. See the NOTICE file
5+
# distributed with this work for additional information
6+
# regarding copyright ownership. The SFC licenses this file
7+
# to you under the Apache License, Version 2.0 (the
8+
# "License"); you may not use this file except in compliance
9+
# with the License. You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing,
14+
# software distributed under the License is distributed on an
15+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
# KIND, either express or implied. See the License for the
17+
# specific language governing permissions and limitations
18+
# under the License.
19+
20+
require_relative '../spec_helper'
21+
22+
module Selenium
23+
module WebDriver
24+
module IE
25+
describe Service, exclusive: [{bidi: false, reason: 'Not yet implemented with BiDi'}, {browser: :ie}] do
26+
let(:service) { described_class.new }
27+
let(:service_manager) { service.launch }
28+
29+
after { service_manager.stop }
30+
31+
it 'auto uses iedriver' do
32+
service.executable_path = DriverFinder.new(Options.new, described_class.new).driver_path
33+
34+
expect(service_manager.uri).to be_a(URI)
35+
end
36+
37+
it 'can be started outside driver' do
38+
expect(service_manager.uri).to be_a(URI)
39+
end
40+
end
41+
end # IE
42+
end # WebDriver
43+
end # Selenium

‎rb/spec/integration/selenium/webdriver/safari/service_spec.rb

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# frozen_string_literal: true
2+
3+
# Licensed to the Software Freedom Conservancy (SFC) under one
4+
# or more contributor license agreements. See the NOTICE file
5+
# distributed with this work for additional information
6+
# regarding copyright ownership. The SFC licenses this file
7+
# to you under the Apache License, Version 2.0 (the
8+
# "License"); you may not use this file except in compliance
9+
# with the License. You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing,
14+
# software distributed under the License is distributed on an
15+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
# KIND, either express or implied. See the License for the
17+
# specific language governing permissions and limitations
18+
# under the License.
19+
20+
require_relative '../spec_helper'
21+
22+
module Selenium
23+
module WebDriver
24+
module Safari
25+
describe Service, exclusive: [{bidi: false, reason: 'Not yet implemented with BiDi'}, {browser: :safari}] do
26+
let(:service) { described_class.new }
27+
let(:service_manager) { service.launch }
28+
29+
after { service_manager.stop }
30+
31+
it 'auto uses safaridriver' do
32+
service.executable_path = DriverFinder.new(Options.new, described_class.new).driver_path
33+
34+
expect(service_manager.uri).to be_a(URI)
35+
end
36+
37+
it 'can be started outside driver' do
38+
expect(service_manager.uri).to be_a(URI)
39+
end
40+
end
41+
end # Safari
42+
end # WebDriver
43+
end # Selenium

‎rb/spec/unit/selenium/webdriver/chrome/service_spec.rb

+22
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,28 @@ module Chrome
119119
driver.new(service: service)
120120
expect(described_class).not_to have_received(:new)
121121
end
122+
123+
context 'with a path env variable' do
124+
let(:service) { described_class.new }
125+
let(:service_path) { "/path/to/#{Service::EXECUTABLE}" }
126+
127+
before do
128+
ENV['SE_CHROMEDRIVER'] = service_path
129+
end
130+
131+
after { ENV.delete('SE_CHROMEDRIVER') }
132+
133+
it 'uses the path from the environment' do
134+
expect(service.executable_path).to match(/chromedriver/)
135+
end
136+
137+
it 'updates the path after setting the environment variable' do
138+
ENV['SE_CHROMEDRIVER'] = '/foo/bar'
139+
service.executable_path = service_path
140+
141+
expect(service.executable_path).to match(/chromedriver/)
142+
end
143+
end
122144
end
123145
end
124146
end # Chrome

‎rb/spec/unit/selenium/webdriver/edge/service_spec.rb

+22
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,28 @@ module Edge
129129
expect(service.log).to be_nil
130130
expect(service.args).to eq ['--log-path=/path/to/log.txt']
131131
end
132+
133+
context 'with a path env variable' do
134+
let(:service) { described_class.new }
135+
let(:service_path) { "/path/to/#{Service::EXECUTABLE}" }
136+
137+
before do
138+
ENV['SE_EDGEDRIVER'] = service_path
139+
end
140+
141+
after { ENV.delete('SE_EDGEDRIVER') }
142+
143+
it 'uses the path from the environment' do
144+
expect(service.executable_path).to match(/edgedriver/)
145+
end
146+
147+
it 'updates the path after setting the environment variable' do
148+
ENV['SE_EDGEDRIVER'] = '/foo/bar'
149+
service.executable_path = service_path
150+
151+
expect(service.executable_path).to match(/edgedriver/)
152+
end
153+
end
132154
end
133155
end
134156
end # Edge

‎rb/spec/unit/selenium/webdriver/firefox/service_spec.rb

+22
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,28 @@ module Firefox
117117

118118
expect(described_class).not_to have_received(:new)
119119
end
120+
121+
context 'with a path env variable' do
122+
let(:service) { described_class.new }
123+
let(:service_path) { "/path/to/#{Service::EXECUTABLE}" }
124+
125+
before do
126+
ENV['SE_GECKODRIVER'] = service_path
127+
end
128+
129+
after { ENV.delete('SE_GECKODRIVER') }
130+
131+
it 'uses the path from the environment' do
132+
expect(service.executable_path).to match(/geckodriver/)
133+
end
134+
135+
it 'updates the path after setting the environment variable' do
136+
ENV['SE_GECKODRIVER'] = '/foo/bar'
137+
service.executable_path = service_path
138+
139+
expect(service.executable_path).to match(/geckodriver/)
140+
end
141+
end
120142
end
121143
end
122144
end # Firefox

‎rb/spec/unit/selenium/webdriver/ie/service_spec.rb

+22
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,28 @@ module IE
119119

120120
expect(described_class).not_to have_received(:new)
121121
end
122+
123+
context 'with a path env variable' do
124+
let(:service) { described_class.new }
125+
let(:service_path) { "/path/to/#{Service::EXECUTABLE}" }
126+
127+
before do
128+
ENV['SE_IEDRIVER'] = service_path
129+
end
130+
131+
after { ENV.delete('SE_IEDRIVER') }
132+
133+
it 'uses the path from the environment' do
134+
expect(service.executable_path).to match(/IEDriver/)
135+
end
136+
137+
it 'updates the path after setting the environment variable' do
138+
ENV['SE_IEDRIVER'] = '/foo/bar'
139+
service.executable_path = service_path
140+
141+
expect(service.executable_path).to match(/IEDriver/)
142+
end
143+
end
122144
end
123145
end
124146
end # IE

‎rb/spec/unit/selenium/webdriver/safari/service_spec.rb

+22
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,28 @@ module Safari
114114

115115
expect(described_class).not_to have_received(:new)
116116
end
117+
118+
context 'with a path env variable' do
119+
let(:service) { described_class.new }
120+
let(:service_path) { "/path/to/#{Service::EXECUTABLE}" }
121+
122+
before do
123+
ENV['SE_SAFARIDRIVER'] = service_path
124+
end
125+
126+
after { ENV.delete('SE_SAFARIDRIVER') }
127+
128+
it 'uses the path from the environment' do
129+
expect(service.executable_path).to match(/safaridriver/)
130+
end
131+
132+
it 'updates the path after setting the environment variable' do
133+
ENV['SE_SAFARIDRIVER'] = '/foo/bar'
134+
service.executable_path = service_path
135+
136+
expect(service.executable_path).to match(/safaridriver/)
137+
end
138+
end
117139
end
118140
end
119141
end # Safari

0 commit comments

Comments
 (0)