Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#995 add android viewtag for espresso driver #996

Merged
merged 3 commits into from
Aug 11, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions src/main/java/io/appium/java_client/FindsByAndroidViewTag.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
/*
* 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;

import org.openqa.selenium.NoSuchElementException;
import org.openqa.selenium.WebDriverException;
import org.openqa.selenium.WebElement;

import java.util.List;

public interface FindsByAndroidViewTag<T extends WebElement> extends FindsByFluentSelector<T> {
/**
* Method performs the searching for a single element by view tag selector
* and value of the given selector.
*
* @param using an view tag selector
* @return The first element that matches the given selector
*
* @throws WebDriverException This method is not applicable with browser/webview UI.
* @throws NoSuchElementException when no one element is found
*/
default T findElementByAndroidViewTag(String using) {
return findElement(MobileSelector.ANDROID_VIEWTAG.toString(), using);
}

/**
* Method performs the searching for a list of elements by view tag selector
* and value of the given selector.
*
* @param using an view tag selector
* @return a list of elements that match the given selector
*
* @throws WebDriverException This method is not applicable with browser/webview UI.
*/
default List<T> findElementsByAndroidViewTag(String using) {
return findElements(MobileSelector.ANDROID_VIEWTAG.toString(), using);
}
}
73 changes: 73 additions & 0 deletions src/main/java/io/appium/java_client/MobileBy.java
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,16 @@ public static By windowsAutomation(final String windowsAutomation) {
return new ByWindowsAutomation(windowsAutomation);
}

/**
* This locator strategy is available in Espresso Driver mode.
* @since Appium 1.8.2 beta
* @param tag is an view tag string
* @return an instance of {@link ByAndroidViewTag}
*/
public static By AndroidViewTag(final String tag) {
return new ByAndroidViewTag(tag);
}

/**
* This locator strategy is available only if OpenCV libraries and
* NodeJS bindings are installed on the server machine.
Expand Down Expand Up @@ -561,6 +571,69 @@ protected ByImage(String b64Template) {
return "By.Image: " + getLocatorString();
}
}

public static class ByAndroidViewTag extends MobileBy implements Serializable {

public ByAndroidViewTag(String tag) {
super(MobileSelector.ANDROID_VIEWTAG, tag);
}

/**
* {@inheritDoc}
*
* @throws WebDriverException when current session doesn't support the given selector or when
* value of the selector is not consistent.
* @throws IllegalArgumentException when it is impossible to find something on the given
* {@link SearchContext} instance
*/
@SuppressWarnings("unchecked")
@Override
public List<WebElement> findElements(SearchContext context) throws WebDriverException,
IllegalArgumentException {
Class<?> contextClass = context.getClass();

if (FindsByAndroidViewTag.class.isAssignableFrom(contextClass)) {
return FindsByAndroidViewTag.class.cast(context)
.findElementsByAndroidViewTag(getLocatorString());
}

if (FindsByFluentSelector.class.isAssignableFrom(contextClass)) {
return super.findElements(context);
}

throw formIllegalArgumentException(contextClass, FindsByAndroidViewTag.class,
FindsByFluentSelector.class);
}

/**
* {@inheritDoc}
*
* @throws WebDriverException when current session doesn't support the given selector or when
* value of the selector is not consistent.
* @throws IllegalArgumentException when it is impossible to find something on the given
* {@link SearchContext} instance
*/
@Override public WebElement findElement(SearchContext context) throws WebDriverException,
IllegalArgumentException {
Class<?> contextClass = context.getClass();

if (FindsByAndroidViewTag.class.isAssignableFrom(contextClass)) {
return FindsByAndroidViewTag.class.cast(context)
.findElementByAndroidViewTag(getLocatorString());
}

if (FindsByFluentSelector.class.isAssignableFrom(contextClass)) {
return super.findElement(context);
}

throw formIllegalArgumentException(contextClass, FindsByAndroidViewTag.class,
FindsByFluentSelector.class);
}

@Override public String toString() {
return "By.AndroidViewTag: " + getLocatorString();
}
}
}


3 changes: 2 additions & 1 deletion src/main/java/io/appium/java_client/MobileSelector.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ public enum MobileSelector {
IOS_PREDICATE_STRING("-ios predicate string"),
IOS_CLASS_CHAIN("-ios class chain"),
WINDOWS_UI_AUTOMATION("-windows uiautomation"),
IMAGE("-image");
IMAGE("-image"),
ANDROID_VIEWTAG("-android viewtag");

private final String selector;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import io.appium.java_client.AppiumDriver;
import io.appium.java_client.CommandExecutionHelper;
import io.appium.java_client.FindsByAndroidUIAutomator;
import io.appium.java_client.FindsByAndroidViewTag;
import io.appium.java_client.HasOnScreenKeyboard;
import io.appium.java_client.LocksDevice;
import io.appium.java_client.android.connection.HasNetworkConnection;
Expand Down Expand Up @@ -61,7 +62,8 @@
public class AndroidDriver<T extends WebElement>
extends AppiumDriver<T>
implements PressesKey, HasNetworkConnection, PushesFiles, StartsActivity,
FindsByAndroidUIAutomator<T>, LocksDevice, HasAndroidSettings, HasAndroidDeviceDetails,
FindsByAndroidUIAutomator<T>, FindsByAndroidViewTag<T>,
LocksDevice, HasAndroidSettings, HasAndroidDeviceDetails,
HasSupportedPerformanceDataType, AuthenticatesByFinger, HasOnScreenKeyboard,
CanRecordScreen, SupportsSpecialEmulatorCommands,
SupportsNetworkStateManagement, ListensToLogcatMessages, HasAndroidClipboard,
Expand Down