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
|
# frozen_string_literal: true
# Licensed to the Software Freedom Conservancy (SFC) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The SFC licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
module Selenium
module WebDriver
module Firefox
class Options < WebDriver::Common::Options
attr_reader :args, :prefs, :options, :profile
attr_accessor :binary, :log_level
KEY = 'moz:firefoxOptions'
#
# Create a new Options instance, only for W3C-capable versions of Firefox.
#
# @example
# options = Selenium::WebDriver::Firefox::Options.new(args: ['--host=127.0.0.1'])
# driver = Selenium::WebDriver.for :firefox, options: options
#
# @param [Hash] opts the pre-defined options to create the Firefox::Options with
# @option opts [String] :binary Path to the Firefox executable to use
# @option opts [Array<String>] :args List of command-line arguments to use when starting geckodriver
# @option opts [Profile, String] :profile Encoded profile string or Profile instance
# @option opts [String, Symbol] :log_level Log level for geckodriver
# @option opts [Hash] :prefs A hash with each entry consisting of the key of the preference and its value
# @option opts [Hash] :options A hash for raw options
#
def initialize(**opts)
@args = Set.new(opts.delete(:args) || [])
@binary = opts.delete(:binary)
@profile = process_profile(opts.delete(:profile))
@log_level = opts.delete(:log_level)
@prefs = opts.delete(:prefs) || {}
@options = opts.delete(:options) || {}
end
#
# Add a command-line argument to use when starting Firefox.
#
# @example Start geckodriver on a specific host
# options = Selenium::WebDriver::Firefox::Options.new
# options.add_argument('--host=127.0.0.1')
#
# @param [String] arg The command-line argument to add
#
def add_argument(arg)
@args << arg
end
#
# Add a new option not yet handled by these bindings.
#
# @example
# options = Selenium::WebDriver::Firefox::Options.new
# options.add_option(:foo, 'bar')
#
# @param [String, Symbol] name Name of the option
# @param [Boolean, String, Integer] value Value of the option
#
def add_option(name, value)
@options[name] = value
end
#
# Add a preference that is only applied to the user profile in use.
#
# @example Set the default homepage
# options = Selenium::WebDriver::Firefox::Options.new
# options.add_preference('browser.startup.homepage', 'http://www.seleniumhq.com/')
#
# @param [String] name Key of the preference
# @param [Boolean, String, Integer] value Value of the preference
#
def add_preference(name, value)
prefs[name] = value
end
#
# Run Firefox in headless mode.
#
# @example Enable headless mode
# options = Selenium::WebDriver::Firefox::Options.new
# options.headless!
#
def headless!
add_argument '-headless'
end
#
# Sets Firefox profile.
#
# @example Set the custom profile
# profile = Selenium::WebDriver::Firefox::Profile.new
# options = Selenium::WebDriver::Firefox::Options.new
# options.profile = profile
#
# @example Use existing profile
# options = Selenium::WebDriver::Firefox::Options.new
# options.profile = 'myprofile'
#
# @param [Profile, String] profile Profile to be used
#
def profile=(profile)
@profile = process_profile(profile)
end
#
# @api private
#
def as_json(*)
opts = @options
opts[:profile] = @profile.encoded if @profile
opts[:args] = @args.to_a if @args.any?
opts[:binary] = @binary if @binary
opts[:prefs] = @prefs unless @prefs.empty?
opts[:log] = {level: @log_level} if @log_level
{KEY => generate_as_json(opts)}
end
private
def process_profile(profile)
return unless profile
case profile
when Profile
profile
when String
Profile.from_name(profile)
else
raise Error::WebDriverError, "don't know how to handle profile: #{profile.inspect}"
end
end
end # Options
end # Firefox
end # WebDriver
end # Selenium
|
