diff --git a/src/main/java/io/appium/java_client/ios/IOSDriver.java b/src/main/java/io/appium/java_client/ios/IOSDriver.java index 1b70f5765..9aedde7a2 100644 --- a/src/main/java/io/appium/java_client/ios/IOSDriver.java +++ b/src/main/java/io/appium/java_client/ios/IOSDriver.java @@ -56,7 +56,7 @@ public class IOSDriver extends AppiumDriver implements HidesKeyboardWithKeyName, ShakesDevice, HasIOSSettings, FindsByIosUIAutomation, LocksDevice, PerformsTouchID, FindsByIosNSPredicate, - FindsByIosClassChain, PushesFiles, CanRecordScreen, HasIOSClipboard { + FindsByIosClassChain, PushesFiles, CanRecordScreen, HasIOSClipboard, ListensToSyslogMessages { private static final String IOS_PLATFORM = MobilePlatform.IOS; diff --git a/src/main/java/io/appium/java_client/ios/ListensToSyslogMessages.java b/src/main/java/io/appium/java_client/ios/ListensToSyslogMessages.java new file mode 100644 index 000000000..a0dbf44a1 --- /dev/null +++ b/src/main/java/io/appium/java_client/ios/ListensToSyslogMessages.java @@ -0,0 +1,138 @@ +/* + * 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.ios; + +import static io.appium.java_client.service.local.AppiumServiceBuilder.DEFAULT_APPIUM_PORT; +import static org.openqa.selenium.remote.DriverCommand.EXECUTE_SCRIPT; + +import com.google.common.collect.ImmutableMap; + +import io.appium.java_client.ExecutesMethod; +import io.appium.java_client.ws.StringWebSocketClient; +import org.openqa.selenium.remote.RemoteWebDriver; + +import java.net.URI; +import java.net.URISyntaxException; +import java.util.Collections; +import java.util.function.Consumer; + +public interface ListensToSyslogMessages extends ExecutesMethod { + StringWebSocketClient syslogClient = new StringWebSocketClient(); + + /** + * Start syslog messages broadcast via web socket. + * This method assumes that Appium server is running on localhost and + * is assigned to the default port (4723). + */ + default void startSyslogBroadcast() { + startSyslogBroadcast("localhost", DEFAULT_APPIUM_PORT); + } + + /** + * Start syslog messages broadcast via web socket. + * This method assumes that Appium server is assigned to the default port (4723). + * + * @param host the name of the host where Appium server is running + */ + default void startSyslogBroadcast(String host) { + startSyslogBroadcast(host, DEFAULT_APPIUM_PORT); + } + + /** + * Start syslog messages broadcast via web socket. + * + * @param host the name of the host where Appium server is running + * @param port the port of the host where Appium server is running + */ + default void startSyslogBroadcast(String host, int port) { + execute(EXECUTE_SCRIPT, ImmutableMap.of("script", "mobile: startLogsBroadcast", + "args", Collections.emptyList())); + final URI endpointUri; + try { + endpointUri = new URI(String.format("ws://%s:%s/ws/session/%s/appium/device/syslog", + host, port, ((RemoteWebDriver) this).getSessionId())); + } catch (URISyntaxException e) { + throw new IllegalArgumentException(e); + } + syslogClient.connect(endpointUri); + } + + /** + * Adds a new log messages broadcasting handler. + * Several handlers might be assigned to a single server. + * Multiple calls to this method will cause such handler + * to be called multiple times. + * + * @param handler a function, which accepts a single argument, which is the actual log message + */ + default void addSyslogMessagesListener(Consumer handler) { + syslogClient.addMessageHandler(handler); + } + + /** + * Adds a new log broadcasting errors handler. + * Several handlers might be assigned to a single server. + * Multiple calls to this method will cause such handler + * to be called multiple times. + * + * @param handler a function, which accepts a single argument, which is the actual exception instance + */ + default void addSyslogErrorsListener(Consumer handler) { + syslogClient.addErrorHandler(handler); + } + + /** + * Adds a new log broadcasting connection handler. + * Several handlers might be assigned to a single server. + * Multiple calls to this method will cause such handler + * to be called multiple times. + * + * @param handler a function, which is executed as soon as the client is successfully + * connected to the web socket + */ + default void addSyslogConnectionListener(Runnable handler) { + syslogClient.addConnectionHandler(handler); + } + + /** + * Adds a new log broadcasting disconnection handler. + * Several handlers might be assigned to a single server. + * Multiple calls to this method will cause such handler + * to be called multiple times. + * + * @param handler a function, which is executed as soon as the client is successfully + * disconnected from the web socket + */ + default void addSyslogDisconnectionListener(Runnable handler) { + syslogClient.addDisconnectionHandler(handler); + } + + /** + * Removes all existing syslog handlers. + */ + default void removeAllSyslogListeners() { + syslogClient.removeAllHandlers(); + } + + /** + * Stops syslog messages broadcast via web socket. + */ + default void stopSyslogBroadcast() { + execute(EXECUTE_SCRIPT, ImmutableMap.of("script", "mobile: stopLogsBroadcast", + "args", Collections.emptyList())); + } +} diff --git a/src/test/java/io/appium/java_client/ios/IOSSyslogListenerTest.java b/src/test/java/io/appium/java_client/ios/IOSSyslogListenerTest.java new file mode 100644 index 000000000..45e6c8af4 --- /dev/null +++ b/src/test/java/io/appium/java_client/ios/IOSSyslogListenerTest.java @@ -0,0 +1,38 @@ +package io.appium.java_client.ios; + +import static org.junit.Assert.assertTrue; + +import org.apache.commons.lang3.time.DurationFormatUtils; +import org.junit.Test; + +import java.time.Duration; +import java.util.concurrent.Semaphore; +import java.util.concurrent.TimeUnit; + +public class IOSSyslogListenerTest extends UICatalogIOSTest { + + @Test + public void verifySyslogListenerCanBeAssigned() { + final Semaphore messageSemaphore = new Semaphore(1); + final Duration timeout = Duration.ofSeconds(15); + + driver.addSyslogMessagesListener((msg) -> messageSemaphore.release()); + driver.addSyslogConnectionListener(() -> System.out.println("Connected to the web socket")); + driver.addSyslogDisconnectionListener(() -> System.out.println("Disconnected from the web socket")); + driver.addSyslogErrorsListener(Throwable::printStackTrace); + try { + driver.startSyslogBroadcast(); + messageSemaphore.acquire(); + // This is needed for pushing some internal log messages + driver.runAppInBackground(Duration.ofSeconds(1)); + assertTrue(String.format("Didn't receive any log message after %s timeout", + DurationFormatUtils.formatDuration(timeout.toMillis(), "H:mm:ss", true)), + messageSemaphore.tryAcquire(timeout.toMillis(), TimeUnit.MILLISECONDS)); + } catch (InterruptedException e) { + throw new IllegalStateException(e); + } finally { + messageSemaphore.release(); + driver.stopSyslogBroadcast(); + } + } +}