forked from SeleniumHQ/selenium
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Edge::Options for insiders Edge builds
It allows to configure the following options: * ms:inPrivate which controls InPrivate browsing mode * ms:extensionPaths which loads extensions on start * ms:startPage which specifies default page Refer to https://docs.microsoft.com/en-us/microsoft-edge/webdriver for details.
- Loading branch information
Showing
3 changed files
with
127 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
# 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 Edge | ||
class Options | ||
attr_accessor :in_private, :start_page | ||
attr_reader :extension_paths | ||
|
||
# | ||
# Create a new Options instance for Edge. | ||
# | ||
# @example | ||
# options = Selenium::WebDriver::Edge::Options.new(in_private: true) | ||
# driver = Selenium::WebDriver.for :edge, options: options | ||
# | ||
# @param [Hash] opts the pre-defined options to create the Edge::Options with | ||
# @option opts [Boolean] :in_private Start in private mode. Default is false | ||
# @option opts [Array<String>] :extension_paths A list of full paths to extensions to install on startup | ||
# @option opts [String] :start_page Default page to start with | ||
# | ||
# @see https://docs.microsoft.com/en-us/microsoft-edge/webdriver | ||
# | ||
|
||
def initialize(**opts) | ||
@in_private = opts.delete(:in_private) || false | ||
@extension_paths = opts.delete(:extension_paths) || [] | ||
@start_page = opts.delete(:start_page) | ||
end | ||
|
||
# | ||
# Add an extension by local path. | ||
# | ||
# @example | ||
# options = Selenium::WebDriver::Edge::Options.new | ||
# options.add_extension_path('C:\path\to\extension') | ||
# | ||
# @param [String] path The local path to the extension folder | ||
# | ||
|
||
def add_extension_path(path) | ||
raise Error::WebDriverError, "could not find extension at #{path.inspect}" unless File.directory?(path) | ||
@extension_paths << path | ||
end | ||
|
||
# | ||
# @api private | ||
# | ||
|
||
def as_json(*) | ||
opts = {} | ||
|
||
opts['ms:inPrivate'] = true if @in_private | ||
opts['ms:extensionPaths'] = @extension_paths if @extension_paths.any? | ||
opts['ms:startPage'] = @start_page if @start_page | ||
|
||
opts | ||
end | ||
end # Options | ||
end # Edge | ||
end # WebDriver | ||
end # Selenium |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# 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. | ||
|
||
require File.expand_path('../../spec_helper', __FILE__) | ||
|
||
module Selenium | ||
module WebDriver | ||
module Edge | ||
describe Options do | ||
describe '#add_extension path' do | ||
it 'adds extension path to the list' do | ||
subject.add_extension_path(__dir__) | ||
expect(subject.extension_paths).to eq([__dir__]) | ||
end | ||
|
||
it 'raises error if path is not a directory' do | ||
expect { subject.add_extension_path(__FILE__) }.to raise_error(Error::WebDriverError) | ||
end | ||
end | ||
|
||
describe '#as_json' do | ||
it 'returns JSON hash' do | ||
options = Options.new(in_private: true, start_page: 'http://seleniumhq.org') | ||
options.add_extension_path(__dir__) | ||
expect(options.as_json).to eq({ | ||
'ms:inPrivate' => true, | ||
'ms:extensionPaths' => [__dir__], | ||
'ms:startPage' => 'http://seleniumhq.org' | ||
}) | ||
end | ||
end | ||
end # Options | ||
end # Edge | ||
end # WebDriver | ||
end # Selenium |