io.appium.java_client.service.local.AppiumDriverLocalService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation
Show all versions of java-client Show documentation
Java client for Appium Mobile Webdriver
/*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
* 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 io.appium.java_client.service.local;
import static com.google.common.base.Preconditions.checkNotNull;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import org.apache.commons.lang3.StringUtils;
import org.openqa.selenium.net.UrlChecker;
import org.openqa.selenium.os.CommandLine;
import org.openqa.selenium.remote.service.DriverService;
import java.io.File;
import java.io.IOException;
import java.io.OutputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.List;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.locks.ReentrantLock;
public final class AppiumDriverLocalService extends DriverService {
private static final String URL_MASK = "http://%s:%d/wd/hub";
private final File nodeJSExec;
private final int nodeJSPort;
private final ImmutableList nodeJSArgs;
private final ImmutableMap nodeJSEnvironment;
private final String ipAddress;
private final long startupTimeout;
private final TimeUnit timeUnit;
private final ReentrantLock lock = new ReentrantLock(true); //uses "fair" thread ordering policy
private final ListOutputStream stream = new ListOutputStream().add(System.out);
private CommandLine process = null;
AppiumDriverLocalService(String ipAddress, File nodeJSExec, int nodeJSPort,
ImmutableList nodeJSArgs, ImmutableMap nodeJSEnvironment,
long startupTimeout, TimeUnit timeUnit) throws IOException {
super(nodeJSExec, nodeJSPort, nodeJSArgs, nodeJSEnvironment);
this.ipAddress = ipAddress;
this.nodeJSExec = nodeJSExec;
this.nodeJSPort = nodeJSPort;
this.nodeJSArgs = nodeJSArgs;
this.nodeJSEnvironment = nodeJSEnvironment;
this.startupTimeout = startupTimeout;
this.timeUnit = timeUnit;
}
public static AppiumDriverLocalService buildDefaultService() {
return buildService(new AppiumServiceBuilder());
}
public static AppiumDriverLocalService buildService(AppiumServiceBuilder builder) {
return builder.build();
}
/**
* @return The base URL for the managed appium server.
*/
@Override public URL getUrl() {
try {
return new URL(String.format(URL_MASK, ipAddress, nodeJSPort));
} catch (MalformedURLException e) {
throw new RuntimeException(e);
}
}
@Override public boolean isRunning() {
lock.lock();
try {
if (process == null) {
return false;
}
if (!process.isRunning()) {
return false;
}
try {
ping(1500, TimeUnit.MILLISECONDS);
return true;
} catch (UrlChecker.TimeoutException e) {
return false;
}
} finally {
lock.unlock();
}
}
private void ping(long time, TimeUnit timeUnit) throws UrlChecker.TimeoutException {
URL url = getUrl();
try {
URL status = new URL(url.toString() + "/status");
new UrlChecker().waitUntilAvailable(time, timeUnit, status);
} catch (MalformedURLException e) {
throw new RuntimeException(
"There is something wrong with the URL " + url.toString().toString() + "/status");
}
}
/**
* Starts the defined appium server
*
* @throws AppiumServerHasNotBeenStartedLocallyException
* If an error occurs while spawning the child process.
* @see #stop()
*/
public void start() throws AppiumServerHasNotBeenStartedLocallyException {
lock.lock();
try {
if (isRunning()) {
return;
}
try {
process = new CommandLine(this.nodeJSExec.getCanonicalPath(),
nodeJSArgs.toArray(new String[] {}));
process.setEnvironmentVariables(nodeJSEnvironment);
process.copyOutputTo(stream);
process.executeAsync();
ping(startupTimeout, timeUnit);
} catch (Throwable e) {
destroyProcess();
String msgTxt = "The local appium server has not been started. "
+ "The given Node.js executable: " + this.nodeJSExec.getAbsolutePath()
+ " Arguments: " + nodeJSArgs.toString() + " " + "\n";
if (process != null) {
String processStream = process.getStdOut();
if (!StringUtils.isBlank(processStream)) {
msgTxt = msgTxt + "Process output: " + processStream + "\n";
}
}
throw new AppiumServerHasNotBeenStartedLocallyException(msgTxt, e);
}
} finally {
lock.unlock();
}
}
/**
* Stops this service is it is currently running. This method will attempt to block until the
* server has been fully shutdown.
*
* @see #start()
*/
@Override public void stop() {
lock.lock();
try {
if (process != null) {
destroyProcess();
}
process = null;
} finally {
lock.unlock();
}
}
private void destroyProcess() {
if (process.isRunning()) {
process.destroy();
}
}
/**
* @return String logs if the server has been run.
* null is returned otherwise.
*/
public String getStdOut() {
if (process != null) {
return process.getStdOut();
}
return null;
}
/**
* Adds other output stream which should accept server output data
* @param outputStream is an instance of {@link java.io.OutputStream}
* that is ready to accept server output
*/
public void addOutPutStream(OutputStream outputStream) {
checkNotNull(outputStream, "outputStream parameter is NULL!");
stream.add(outputStream);
}
/**
* Adds other output streams which should accept server output data
* @param outputStreams is a list of additional {@link java.io.OutputStream}
* that are ready to accept server output
*/
public void addOutPutStreams(List outputStreams) {
checkNotNull(outputStreams, "outputStreams parameter is NULL!");
for (OutputStream stream : outputStreams) {
addOutPutStream(stream);
}
}
}