[SafariDriver] [Java] Support custom extensions for Safari / SafariOptions API #87

Rob--W · 2013-06-16T21:31:01Z

Solves https://code.google.com/p/selenium/issues/detail?id=4852

I've created a new class (SafariOptions) which allows one to add one or more custom extensions. To make it easier for developers to use it, the method name and signature is similar to ChromeOptions's addExtensions(File...).

This PR does not only bring extensions. It also separated the options from the SafariDriver. The old capabilities are still supported, but have been deprecated.

All new APIs are well-documented, so regenerating the javadocs after acceptance makes sense.

Example of installing extension

SafariOptions options = new SafariOptions();
options.addExtensions(new File("path/to/extension.safariextz"));

// Local
WebDriver driver = new SafariDriver(options);

// Remote
WebDriver driver = new RemoteWebDriver(new URL("http://localhost:4444/wd/hub"), options.toCapabilities());

Tests

Three tests have been added:

Verify that not using the new capability does not change old behavior
Verify that an extension is installed, if specified.
Verify that an extension is removed when the browser quits.

I've also patched the implementation of the DriverCommand.QUIT method, by closing the Web Socket connection in Java instead of sending QUIT to the Safari extension (the Safari extension silently ignores the command).
Before this fix, invoking safariDriver.quit() would always cause an IOException to be thrown: "An existing connection was forcibly closed by the remote host".

Another problem was that an existing test class did not inherit from SafariTestBase. This caused several tests to behave badly, which has also been fixed.

Ideas for future improvements

My current objective was to automate the tests of a Safari extension. Others might actually want to preserve the existing set of installed extensions, instead of adding new ones. In order to achieve this, use a third-party library (such as https://code.google.com/p/plist/) to parse Extensions.plist, and add the WebDriver Safari extension by appending values to Extensions.plist instead of overwriting it.

Signed SFC

I've signed the SFC Individual Contributor License Agreement.

daluu · 2013-06-16T23:24:43Z

For this particular change, with respect to novice Selenium and Safari users, I'd like to point out that to use the feature optimally, you'd always want to place a copy of the Safari extensions (the installers) to add in a temp location to then load with the code presented here, or store the extensions in a read-only directory. Because Safari will (as I observe) always delete the extension installer file (name.safariextz) after the extension is installed, a lame move by Apple, since in some cases, you haven't archived a backup of the extension and you've just lost it on install.

Or does the code changes here transparently handle that scenario so you don't have to worry about it?

jleyba · 2013-06-19T03:19:15Z

java/client/src/org/openqa/selenium/safari/SafariDriverConnection.java

@@ -88,6 +88,12 @@ public Response send(Command command) throws InterruptedException {

    return responses.poll(3, TimeUnit.MINUTES);
  }
+  /**


Missing blank line between methods.

jleyba · 2013-06-19T04:07:47Z

Thanks for picking this up. Have you signed the CLA?

Rob--W · 2013-06-19T19:06:04Z

@jleyba Yes I've signed the CLA.

With the latest commits, none of the previous public APIs were changed (except for renames of two classes). I have, however, added new methods (see 3d3124d) for defining the options.

What remains it to get the SafariDriver to recognize the new options on SafariOptions, preferably remaining backwards-compatible. Should I mark the previous capabilities as deprecated, and if yes, how?

Rob--W · 2013-06-30T23:01:27Z

@jleyba I've rebased the commits into logical chunks, and updated their commit messages as well as the initial post of this PR. Could you review it?

For the record, this is the result of the tests: http://pastebin.com/VMELWhMA (there are several unrelated errors, but these already existed before my PR, and they are not related to the changes I made).

jleyba · 2013-07-01T17:40:22Z

I haven't forgotten about this PR. Will try to finish up my next round of comments today.

jleyba · 2013-07-07T15:53:59Z

java/client/src/org/openqa/selenium/safari/SafariDriver.java

@@ -46,6 +49,7 @@
   * <p><strong>Warning:</strong> Since Safari uses a single profile for the
   * current user, enabling this capability will permanently erase any existing
   * session data.
+   * @deprecated use {@link SafariOptions#setUseCleanSession(boolean)} instead.


Add the @Deprecation annotation too

jleyba · 2013-07-07T16:07:35Z

java/client/src/org/openqa/selenium/safari/SafariOptions.java

+   * {@link #addExtensions(java.util.List)} and
+   * {@link #setDriverExtension(File)}.
+   *
+   * @param skipExtensionInstallation If true, the installation of extensions is skipped.


nit: document boolean values as "Whether..." statements: Whether to skip extension installation.

jleyba · 2013-07-07T16:10:15Z

Looks good - just a few nits

Rob--W · 2013-07-08T13:07:50Z

@jleyba Thanks for the review. I've revised the code. The first commit deals with comments and @Deprecated annotations, the second commit changed the String to a JSONObject, and adjusts the parsing of that type.

The functionality has not changed, my tests are still running fine. I'll squash my last two commits after you've reviewed it.

jleyba · 2013-07-08T16:58:37Z

java/client/src/org/openqa/selenium/safari/SafariDriverCommandExecutor.java

-      return itsOkToQuitMultipleTimes;
+    if (DriverCommand.QUIT.equals(command.getName())) {
+      if (server.isRunning() && connection != null) {
+        connection.close();


You can revert these changes. I just pushed a change that should make this unnecessary

https://code.google.com/p/selenium/source/detail?r=d84a49c4e2a3

Rob--W · 2013-07-16T22:58:52Z

@jleyba Can you review my latest two commits please? If they look good to you, I'll remove the commit 2ee4817 and squash the last commits to finalize the PR.

badavid · 2013-07-19T12:51:26Z

Hi everybody.
I really interested by the SafariOption in order to open SafariDriver with my favorite extensions.
I create my SafariOption java class.
But when I start my safariDriver
SafariOptions options = new SafariOptions();
options.addExtensions(new File("pathToMyExtension.safariextz"));
DesiredCapabilities capabilities = DesiredCapabilities.safari();
capabilities.setCapability(SafariOptions.CAPABILITY, options);
SafariDriver driver = new SafariDriver(capabilities);
The driver open no error appears but the webdriver don't have the extension load.
Coukd you please help my for having a correct implements of this usefull option ?

Rob--W · 2013-07-19T13:02:33Z

@badavid
Since this PR is not merged yet, could you open a new ticket at https://github.com/Rob--W/selenium/issues?

Please answer the following questions:

Platform? (OS, Safari version)
What did you do? (code)
What did you expect and what actuall happened? (e.g. "I expected to see all of my previously installed extensions, but only the SafariDriver extension is installed:)

badavid · 2013-07-19T13:16:36Z

I have openned a new ticket.

badavid · 2013-07-19T14:50:08Z

I have import all java class from the zip but i can't find other librairy to compile correctly ( org.json.jboss etc ..)

jleyba · 2013-07-19T16:15:04Z

Everything LGTM.

badavid · 2013-07-19T16:20:44Z

LGTM ? What does it means ?

lukeis · 2013-07-19T16:47:10Z

Looks Good To Me ;)

Rob--W · 2013-07-19T21:51:07Z

@jleyba Thanks for the approval. I've squashed the commits. It's identical to the previous state, except for the removal of commit 2ee4817 (as a response to #87 (diff)).

jleyba · 2013-07-23T13:11:59Z

@Rob--W Can you squash everything down into a single commit?

Rob--W · 2013-07-23T13:25:53Z

@jleyba Done.

[SafariDriver] Tests for custom Safari extensions The SafariOptions API is modelled after the ChromeOptions API, to make the learning curve easier. The APIs are compared at http://stackoverflow.com/a/17117849/938089 The SafariDriverExtension class has been renamed to SafariExtensions to emphasize the new role of the class. It's not just responsible for the installation of the SafariDriver, but also for the installation of custom Safari extensions. Moved several options from SafariDriver to SafariOptions: - Hard-coded "port" property in SafariDriver + SafariDriverServer was - Processing of "data dir" / "clean session" / "skip extension install" options has been moved from SafariDriver to SafariOptions. The corresponding capabilities are still supported, though deprecated. - Previously, setting the "skip extension install" property implied that the user has installed a custom safari driver in the browser. Setting the option would skip the replacement of Extensions.plist, causing all existing extensions to stay. With the advent of custom extensions, "skip extension install" became ambiguous: Does the user want to use a custom driver, or skip installation of all extensions, in order to use his existing extensions? The "skip extension install" feature has been replaced with two methods, "setSkipExtensionInstallation" and "setDriverExtension". The NO_INSTALL_EXTENSION_CAPABILITY capability maps to "setSkipExtensionInstallation" for backwards-compatibility. - The old capabilities have been deprecated, but they're still recognized. When the new SafariOptions.CAPABILITY capability is present, the old capabilities will be ignored. - For backwards-compatibility with old Selenium remote servers, the old capabilities are still set by the toCapabilities() method.

jleyba · 2013-07-23T13:51:51Z

Merged in 2a453fa

mosaadm · 2017-05-23T09:56:14Z

This is no longer working with selenium 3. Is there another way to do it ?

sarada-ak · 2017-05-29T11:05:35Z

I am unable to get the addExtensions method for SafariOptions class object, could any one guide me on this

jleyba reviewed Jun 19, 2013
View reviewed changes

jleyba reviewed Jul 7, 2013
View reviewed changes

jleyba reviewed Jul 8, 2013
View reviewed changes

Rob--W mentioned this pull request Jul 19, 2013

I dont succeed to use SafariOption Rob--W/selenium#1

Closed

jleyba closed this Jul 23, 2013

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[SafariDriver] [Java] Support custom extensions for Safari / SafariOptions API #87

[SafariDriver] [Java] Support custom extensions for Safari / SafariOptions API #87

Rob--W commented Jun 16, 2013

daluu commented Jun 16, 2013

jleyba Jun 19, 2013

jleyba commented Jun 19, 2013

Rob--W commented Jun 19, 2013

Rob--W commented Jun 30, 2013

jleyba commented Jul 1, 2013

jleyba Jul 7, 2013

jleyba Jul 7, 2013

jleyba commented Jul 7, 2013

Rob--W commented Jul 8, 2013

jleyba Jul 8, 2013

Rob--W commented Jul 16, 2013

badavid commented Jul 19, 2013

Rob--W commented Jul 19, 2013

badavid commented Jul 19, 2013

badavid commented Jul 19, 2013

jleyba commented Jul 19, 2013

badavid commented Jul 19, 2013

lukeis commented Jul 19, 2013

Rob--W commented Jul 19, 2013

jleyba commented Jul 23, 2013

Rob--W commented Jul 23, 2013

jleyba commented Jul 23, 2013

mosaadm commented May 23, 2017

sarada-ak commented May 29, 2017

[SafariDriver] [Java] Support custom extensions for Safari / SafariOptions API #87

[SafariDriver] [Java] Support custom extensions for Safari / SafariOptions API #87

Conversation

Rob--W commented Jun 16, 2013

Example of installing extension

Tests

Ideas for future improvements

Signed SFC

daluu commented Jun 16, 2013

jleyba Jun 19, 2013

Choose a reason for hiding this comment

jleyba commented Jun 19, 2013

Rob--W commented Jun 19, 2013

Rob--W commented Jun 30, 2013

jleyba commented Jul 1, 2013

jleyba Jul 7, 2013

Choose a reason for hiding this comment

jleyba Jul 7, 2013

Choose a reason for hiding this comment

jleyba commented Jul 7, 2013

Rob--W commented Jul 8, 2013

jleyba Jul 8, 2013

Choose a reason for hiding this comment

Rob--W commented Jul 16, 2013

badavid commented Jul 19, 2013

Rob--W commented Jul 19, 2013

badavid commented Jul 19, 2013

badavid commented Jul 19, 2013

jleyba commented Jul 19, 2013

badavid commented Jul 19, 2013

lukeis commented Jul 19, 2013

Rob--W commented Jul 19, 2013

jleyba commented Jul 23, 2013

Rob--W commented Jul 23, 2013

jleyba commented Jul 23, 2013

mosaadm commented May 23, 2017

sarada-ak commented May 29, 2017