How to use SafariTechPreviewDriverService class of org.openqa.selenium.safari package

1// Licensed to the Software Freedom Conservancy (SFC) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The SFC licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18package org.openqa.selenium.safari;
19
20import static org.mockito.ArgumentMatchers.any;
21import static org.mockito.ArgumentMatchers.anyInt;
22import static org.mockito.ArgumentMatchers.eq;
23import static org.mockito.Mockito.doReturn;
24import static org.mockito.Mockito.spy;
25import static org.mockito.Mockito.verify;
26
27import org.junit.Test;
28import org.junit.experimental.categories.Category;
29import org.openqa.selenium.testing.UnitTests;
30
31import java.io.File;
32import java.time.Duration;
33
34@Category(UnitTests.class)
35public class SafariTechPreviewDriverServiceTest {
36
37  @Test
38  public void builderPassesTimeoutToDriverService() {
39    File exe = new File("someFile");
40    Duration defaultTimeout = Duration.ofSeconds(20);
41    Duration customTimeout = Duration.ofSeconds(60);
42
43    SafariTechPreviewDriverService.Builder builderMock =
44      spy(MockSafariTechPreviewDriverServiceBuilder.class);
45    doReturn(exe).when(builderMock).findDefaultExecutable();
46    builderMock.build();
47
48    verify(builderMock).createDriverService(any(), anyInt(), eq(defaultTimeout), any(), any());
49
50    builderMock.withTimeout(customTimeout);
51    builderMock.build();
52    verify(builderMock).createDriverService(any(), anyInt(), eq(customTimeout), any(), any());
53  }
54
55  public static class MockSafariTechPreviewDriverServiceBuilder
56    extends SafariTechPreviewDriverService.Builder {
57
58    @Override
59    public SafariTechPreviewDriverService.Builder usingDriverExecutable(File file) {
60      return this;
61    }
62  }
63}
64

Source: SafariTechPreviewDriverServiceTest.java

// 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 org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyInt;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.verify;

import org.junit.Test;
import org.junit.experimental.categories.Category;
import org.openqa.selenium.testing.UnitTests;

import java.io.File;
import java.time.Duration;

@Category(UnitTests.class)
public class SafariTechPreviewDriverServiceTest {

  @Test
  public void builderPassesTimeoutToDriverService() {
    File exe = new File("someFile");
    Duration defaultTimeout = Duration.ofSeconds(20);
    Duration customTimeout = Duration.ofSeconds(60);

    SafariTechPreviewDriverService.Builder builderMock =
      spy(MockSafariTechPreviewDriverServiceBuilder.class);
    doReturn(exe).when(builderMock).findDefaultExecutable();
    builderMock.build();

    verify(builderMock).createDriverService(any(), anyInt(), eq(defaultTimeout), any(), any());

    builderMock.withTimeout(customTimeout);
    builderMock.build();
    verify(builderMock).createDriverService(any(), anyInt(), eq(customTimeout), any(), any());
  }

  public static class MockSafariTechPreviewDriverServiceBuilder
    extends SafariTechPreviewDriverService.Builder {

    @Override
    public SafariTechPreviewDriverService.Builder usingDriverExecutable(File file) {
      return this;
    }
  }
}

1// Licensed to the Software Freedom Conservancy (SFC) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The SFC licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18package org.openqa.selenium.safari;
19
20import static java.util.concurrent.TimeUnit.MILLISECONDS;
21
22import com.google.auto.service.AutoService;
23
24import org.openqa.selenium.Capabilities;
25import org.openqa.selenium.WebDriverException;
26import org.openqa.selenium.net.PortProber;
27import org.openqa.selenium.remote.service.DriverService;
28
29import java.io.File;
30import java.io.IOException;
31import java.time.Duration;
32import java.util.Arrays;
33import java.util.List;
34import java.util.Map;
35
36public class SafariTechPreviewDriverService extends DriverService {
37
38  /**
39   * System property that defines the location of the tech preview safaridriver executable that
40   * will be used by the {@link #createDefaultService() default service}.
41   */
42  public static final String TP_SAFARI_DRIVER_EXE_PROPERTY = "webdriver.tp.safari.driver";
43
44  private static final File TP_SAFARI_DRIVER_EXECUTABLE =
45    new File("/Applications/Safari Technology Preview.app/Contents/MacOS/safaridriver");
46
47  public SafariTechPreviewDriverService(
48    File executable,
49    int port,
50    List<String> args,
51    Map<String, String> environment) throws IOException {
52    super(executable, port, DEFAULT_TIMEOUT, args, environment);
53  }
54
55  public SafariTechPreviewDriverService(
56    File executable,
57    int port,
58    Duration timeout,
59    List<String> args,
60    Map<String, String> environment) throws IOException {
61    super(executable, port, timeout, args, environment);
62  }
63
64  public static SafariTechPreviewDriverService createDefaultService() {
65    return new Builder().build();
66  }
67
68  @Override
69  protected void waitUntilAvailable() {
70    try {
71      PortProber.waitForPortUp(getUrl().getPort(), (int) getTimeout().toMillis(), MILLISECONDS);
72    } catch (RuntimeException e) {
73      throw new WebDriverException(e);
74    }
75  }
76
77  @AutoService(DriverService.Builder.class)
78  public static class Builder extends DriverService.Builder<
79    SafariTechPreviewDriverService, SafariTechPreviewDriverService.Builder> {
80
81    @Override
82    public int score(Capabilities capabilities) {
83      int score = 0;
84
85      if (SafariOptions.SAFARI_TECH_PREVIEW.equals(capabilities.getBrowserName())) {
86        score++;
87      }
88
89      return score;
90    }
91
92    @Override
93    protected File findDefaultExecutable() {
94      File exe;
95      if (System.getProperty(TP_SAFARI_DRIVER_EXE_PROPERTY) != null) {
96        exe = new File(System.getProperty(TP_SAFARI_DRIVER_EXE_PROPERTY));
97      } else {
98        exe = TP_SAFARI_DRIVER_EXECUTABLE;
99      }
100
101      if (!exe.isFile()) {
102        throw new WebDriverException("Unable to find driver executable: " + exe);
103      }
104
105      return exe;
106    }
107
108    @Override
109    protected List<String> createArgs() {
110      return Arrays.asList("--port", String.valueOf(getPort()));
111    }
112
113    @Override
114    protected SafariTechPreviewDriverService createDriverService(
115      File exe,
116      int port,
117      Duration timeout,
118      List<String> args,
119      Map<String, String> environment) {
120      try {
121        return new SafariTechPreviewDriverService(exe, port, timeout, args, environment);
122      } catch (IOException e) {
123        throw new WebDriverException(e);
124      }
125    }
126  }
127}
128

Source: SafariTechPreviewDriverService.java

// 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.MILLISECONDS;

import com.google.auto.service.AutoService;

import org.openqa.selenium.Capabilities;
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.time.Duration;
import java.util.Arrays;
import java.util.List;
import java.util.Map;

public class SafariTechPreviewDriverService extends DriverService {

  /**
   * System property that defines the location of the tech preview safaridriver executable that
   * will be used by the {@link #createDefaultService() default service}.
   */
  public static final String TP_SAFARI_DRIVER_EXE_PROPERTY = "webdriver.tp.safari.driver";

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

  public SafariTechPreviewDriverService(
    File executable,
    int port,
    List<String> args,
    Map<String, String> environment) throws IOException {
    super(executable, port, DEFAULT_TIMEOUT, args, environment);
  }

  public SafariTechPreviewDriverService(
    File executable,
    int port,
    Duration timeout,
    List<String> args,
    Map<String, String> environment) throws IOException {
    super(executable, port, timeout, args, environment);
  }

  public static SafariTechPreviewDriverService createDefaultService() {
    return new Builder().build();
  }

  @Override
  protected void waitUntilAvailable() {
    try {
      PortProber.waitForPortUp(getUrl().getPort(), (int) getTimeout().toMillis(), MILLISECONDS);
    } catch (RuntimeException e) {
      throw new WebDriverException(e);
    }
  }

  @AutoService(DriverService.Builder.class)
  public static class Builder extends DriverService.Builder<
    SafariTechPreviewDriverService, SafariTechPreviewDriverService.Builder> {

    @Override
    public int score(Capabilities capabilities) {
      int score = 0;

      if (SafariOptions.SAFARI_TECH_PREVIEW.equals(capabilities.getBrowserName())) {
        score++;
      }

      return score;
    }

    @Override
    protected File findDefaultExecutable() {
      File exe;
      if (System.getProperty(TP_SAFARI_DRIVER_EXE_PROPERTY) != null) {
        exe = new File(System.getProperty(TP_SAFARI_DRIVER_EXE_PROPERTY));
      } else {
        exe = TP_SAFARI_DRIVER_EXECUTABLE;
      }

      if (!exe.isFile()) {
        throw new WebDriverException("Unable to find driver executable: " + exe);
      }

      return exe;
    }

    @Override
    protected List<String> createArgs() {
      return Arrays.asList("--port", String.valueOf(getPort()));
    }

    @Override
    protected SafariTechPreviewDriverService createDriverService(
      File exe,
      int port,
      Duration timeout,
      List<String> args,
      Map<String, String> environment) {
      try {
        return new SafariTechPreviewDriverService(exe, port, timeout, args, environment);
      } catch (IOException e) {
        throw new WebDriverException(e);
      }
    }
  }
}