org.openqa.selenium.safari.SafariDriverService Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of selenium-safari-driver Show documentation
Selenium automates browsers. That's it! What you do with that power is entirely up to you.
There is a newer version: 4.24.0
Show newest version
// 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.

package org.openqa.selenium.safari;

import static java.util.concurrent.TimeUnit.SECONDS;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;

import org.openqa.selenium.WebDriverException;
import org.openqa.selenium.net.PortProber;
import org.openqa.selenium.remote.service.DriverService;

import java.io.File;
import java.io.IOException;
import java.net.MalformedURLException;

public class SafariDriverService extends DriverService {

  private static final File SAFARI_DRIVER_EXECUTABLE = new File("/usr/bin/safaridriver");
  private static final File TP_SAFARI_DRIVER_EXECUTABLE =
    new File("/Applications/Safari Technology Preview.app/Contents/MacOS/safaridriver");

  public SafariDriverService(File executable, int port, ImmutableList args,
                             ImmutableMap environment) throws IOException {
    super(executable, port, args, environment);
  }

  public static SafariDriverService createDefaultService(SafariOptions options) {
    File exe = options.getUseTechnologyPreview() ?
               TP_SAFARI_DRIVER_EXECUTABLE : SAFARI_DRIVER_EXECUTABLE;
    if (exe.exists()) {
      return new Builder().usingPort(options.getPort()).usingDriverExecutable(exe).build();
    }
    return null;
  }

  @Override
  protected void waitUntilAvailable() throws MalformedURLException {
    try {
      PortProber.waitForPortUp(getUrl().getPort(), 20, SECONDS);
    } catch (RuntimeException e) {
      throw new WebDriverException(e);
    }
  }

  public static class Builder extends DriverService.Builder<
    SafariDriverService, SafariDriverService.Builder> {

    public SafariDriverService.Builder usingTechnologyPreview(boolean useTechnologyPreview) {
      if (useTechnologyPreview) {
        usingDriverExecutable(TP_SAFARI_DRIVER_EXECUTABLE);
      } else {
        usingDriverExecutable(SAFARI_DRIVER_EXECUTABLE);
      }
      return this;
    }

    protected File findDefaultExecutable() {
      return SAFARI_DRIVER_EXECUTABLE;
    }

    protected ImmutableList createArgs() {
      return ImmutableList.of("--port", String.valueOf(getPort()));
    }

    protected SafariDriverService createDriverService(File exe, int port, ImmutableList args,
                                              ImmutableMap environment) {
      try {
        return new SafariDriverService(exe, port, args, environment);
      } catch (IOException e) {
        throw new WebDriverException(e);
      }
    }
  }
}