Repeatable annotations & HasSessionDetails API by TikhomirovSergey · Pull Request #497 · appium/java-client

TikhomirovSergey · Oct 28, 2016

Change list

Migration to Java 8. Repeatable annotations for page objects:

Annotations AndroidFindAll, AndroidFindBys, iOSFindAll, iOSFindBys, SelendroidFindAll,
SelendroidFindBys became deprecated.
Annotations AndroidFindBy, iOSFindBy, SelendroidFindBy became repeatable.
The new annotation io.appium.java_client.pagefactory.HowToUseLocators was added to help to define the searching strategy (chain or using all possible locators) correctly.

Also were added:

The io.appium.java_client.HasSessionDetails interface. It has methods implemented by default. This interface is implemented by AppiumDriver
The refactoring of the io.appium.java_client.AppiumFieldDecorator and related supporting tools. Now it uses session data instead of the class of the given driver for the routing between annotations.

Types of changes

Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

Details

#399 #454

The old usecase for the chained searching:

import org.openqa.selenium.remote.RemoteWebElement;
import io.appium.java_client.pagefactory.*;
import org.openqa.selenium.support.FindBys;
import org.openqa.selenium.support.FindBy;

@FindBys({@FindBy(someStrategy1), @FindBy(someStrategy2)}) 
@AndroidFindBys({@AndroidFindBy(someStrategy1), @AndroidFindBy(someStrategy2)}) 
@iOSFindBys({@iOSFindBy(someStrategy1), @iOSFindBy(someStrategy2)}) 
RemoteWebElement someElement;

@FindBys({@FindBy(someStrategy1), @FindBy(someStrategy2)}) 
@AndroidFindBys({@AndroidFindBy(someStrategy1), @AndroidFindBy(someStrategy2)}) 
@iOSFindBys({@iOSFindBy(someStrategy1), @iOSFindBy(someStrategy2)}) 
List<RemoteWebElement> someElements;

New usecases for the chained searching:

import org.openqa.selenium.remote.RemoteWebElement;
import io.appium.java_client.pagefactory.*;
import org.openqa.selenium.support.FindBys;
import org.openqa.selenium.support.FindBy;

@FindBys({@FindBy(someStrategy1), @FindBy(someStrategy2)}) 
@AndroidFindBy(someStrategy1) @AndroidFindBy(someStrategy2)
@iOSFindBy(someStrategy1) @iOSFindBy(someStrategy2) 
RemoteWebElement someElement;

@FindBys({@FindBy(someStrategy1), @FindBy(someStrategy2)}) 
@AndroidFindBy(someStrategy1) @AndroidFindBy(someStrategy2)
@iOSFindBy(someStrategy1) @iOSFindBy(someStrategy2)
List<RemoteWebElement> someElements;

or

import org.openqa.selenium.remote.RemoteWebElement;
import io.appium.java_client.pagefactory.*;
import org.openqa.selenium.support.FindBys;
import org.openqa.selenium.support.FindBy;

import static io.appium.java_client.pagefactory.LocatorGroupStrategy.CHAIN;

@HowToUseLocators(androidAutomation = CHAIN, iOSAutomation = CHAIN)
@FindBys({@FindBy(someStrategy1), @FindBy(someStrategy2)}) 
@AndroidFindBy(someStrategy1) @AndroidFindBy(someStrategy2)
@iOSFindBy(someStrategy1) @iOSFindBy(someStrategy2) 
RemoteWebElement someElement;

@HowToUseLocators(androidAutomation = CHAIN, iOSAutomation = CHAIN)
@FindBys({@FindBy(someStrategy1), @FindBy(someStrategy2)}) 
@AndroidFindBy(someStrategy1) @AndroidFindBy(someStrategy2)
@iOSFindBy(someStrategy1) @iOSFindBy(someStrategy2)
List<RemoteWebElement> someElements;

The old usecase for the searching by all possible locators:

import org.openqa.selenium.remote.RemoteWebElement;
import io.appium.java_client.pagefactory.*;
import org.openqa.selenium.support.FindBy;
import org.openqa.selenium.support.FindByAll;

@FindAll({@FindBy(someStrategy1), @FindBy(someStrategy2)}) 
@AndroidFindAll({@AndroidFindBy(someStrategy1), @AndroidFindBy(someStrategy2)}) 
@iOSFindAll({@iOSFindBy(someStrategy1), @iOSFindBy(someStrategy2)}) 
RemoteWebElement someElement;

@FindAll({@FindBy(someStrategy1), @FindBy(someStrategy2)}) 
@AndroidFindAll({@AndroidFindBy(someStrategy1), @AndroidFindBy(someStrategy2)}) 
@iOSFindAll({@iOSFindBy(someStrategy1), @iOSFindBy(someStrategy2)}) 
List<RemoteWebElement> someElements;

The new usecase for the searching by all possible locators:

import org.openqa.selenium.remote.RemoteWebElement;
import io.appium.java_client.pagefactory.*;
import org.openqa.selenium.support.FindBy;
import org.openqa.selenium.support.FindByAll;

import static io.appium.java_client.pagefactory.LocatorGroupStrategy.ALL_POSSIBLE;

@HowToUseLocators(androidAutomation = ALL_POSSIBLE, iOSAutomation = ALL_POSSIBLE)
@FindAll{@FindBy(someStrategy1), @FindBy(someStrategy2)}) 
@AndroidFindBy(someStrategy1) @AndroidFindBy(someStrategy2) 
@iOSFindBy(someStrategy1) @iOSFindBy(someStrategy2) 
RemoteWebElement someElement;

@HowToUseLocators(androidAutomation = ALL_POSSIBLE, iOSAutomation = ALL_POSSIBLE)
@FindAll({@FindBy(someStrategy1), @FindBy(someStrategy2)}) 
@AndroidFindBy(someStrategy1) @AndroidFindBy(someStrategy2)
@iOSFindBy(someStrategy1) @iOSFindBy(someStrategy2)
List<RemoteWebElement> someElements;

Also possible combined variants:

import org.openqa.selenium.remote.RemoteWebElement;
import io.appium.java_client.pagefactory.*;
import org.openqa.selenium.support.FindBy;
import org.openqa.selenium.support.FindByAll;

import static io.appium.java_client.pagefactory.LocatorGroupStrategy.CHAIN;
import static io.appium.java_client.pagefactory.LocatorGroupStrategy.ALL_POSSIBLE;

@HowToUseLocators(androidAutomation = CHAIN, iOSAutomation = ALL_POSSIBLE)
@FindAll{@FindBy(someStrategy1), @FindBy(someStrategy2)}) 
@AndroidFindBy(someStrategy1) @AndroidFindBy(someStrategy2) 
@iOSFindBy(someStrategy1) @iOSFindBy(someStrategy2) 
RemoteWebElement someElement;

@HowToUseLocators(androidAutomation = CHAIN, iOSAutomation = ALL_POSSIBLE)
@FindAll({@FindBy(someStrategy1), @FindBy(someStrategy2)}) 
@AndroidFindBy(someStrategy1) @AndroidFindBy(someStrategy2)
@iOSFindBy(someStrategy1) @iOSFindBy(someStrategy2)
List<RemoteWebElement> someElements;

or

import org.openqa.selenium.remote.RemoteWebElement;
import io.appium.java_client.pagefactory.*;
import org.openqa.selenium.support.FindBy;
import org.openqa.selenium.support.FindByAll;

import static io.appium.java_client.pagefactory.LocatorGroupStrategy.ALL_POSSIBLE;

@HowToUseLocators(iOSAutomation = ALL_POSSIBLE)
@FindAll{@FindBy(someStrategy1), @FindBy(someStrategy2)}) 
@AndroidFindBy(someStrategy1) @AndroidFindBy(someStrategy2) //this is the chain 
//by default
@iOSFindBy(someStrategy1) @iOSFindBy(someStrategy2) 
RemoteWebElement someElement;

@HowToUseLocators(iOSAutomation = ALL_POSSIBLE)
@FindAll({@FindBy(someStrategy1), @FindBy(someStrategy2)}) 
@AndroidFindBy(someStrategy1) @AndroidFindBy(someStrategy2) //this is the chain 
//by default
@iOSFindBy(someStrategy1) @iOSFindBy(someStrategy2)
List<RemoteWebElement> someElements;

- deprecated annotations: AndroidFindAll, AndroidFindBys, iOSFindAll, iOSFindBys, SelendroidFindAll, SelendroidFindBys. - new annotations were added: AndroidFindBySet, iOSFindBySet, SelendroidFindBySet, HowToUseLocators.

- added interface HasSessionDetails which contains methods with default implementation. It is implemented by AppiumDriver and MobileElement - AndroidDriverTest was modified.

…ails API

…ionDetails API was finished

…ting.

TikhomirovSergey · Oct 28, 2016

@SrinivasanTarget could you review it? :)

SrinivasanTarget

https://github.com/appium/java-client/pull/497/files#diff-73623ae00d624037c568229b4def71d6R200 should be iOSAutomation()

…epeatable_annotations # Conflicts: # src/main/java/io/appium/java_client/AppiumDriver.java

TikhomirovSergey · Oct 29, 2016

@SrinivasanTarget The issue which you pointed has got fixed.

SrinivasanTarget · Oct 30, 2016

@TikhomirovSergey I like this PR. Gonna be a big change. Code LGTM 👍 Haven't run through the tests, will run through it soon.

saikrishna321 · Oct 30, 2016

@TikhomirovSergey i'm finding hard to understand the use-of @HowToUseLocators(androidAutomation = CHAIN, iOSAutomation = ALL_POSSIBLE) can you please throw some light on this ?

SrinivasanTarget · Oct 30, 2016

@saikrishna321 Please find the simple use case below,

@HowToUseLocators(androidAutomation = CHAIN,iOSAutomation = ALL_POSSIBLE)
@AndroidFindBy(some UISelector()) @AndroidFindBy(Some view or text inside it) 
@iOSFindBy(xpath1) @iOSFindBy(xpath2)
List<RemoteWebElement> someElements;

Based on above code snippet,

CHAIN finds all the elements that matches some view or text inside it (second @AndroidFindBy) that appears under element that matches some UISelector (first @AndroidFindBy)

ALL_POSSIBLE finds all possible iOS elements that matches either xpath1 or xpath2

Incase if we didn't mention any of HowToUseLocators by default it is CHAIN

saikrishna321 · Oct 31, 2016

@SrinivasanTarget yah i get this... but what does CHAIN and ALL_POSSIBLE do ?

SrinivasanTarget · Oct 31, 2016

@saikrishna321 Have updated the comments above. Let me know if it is not clear.

SrinivasanTarget · Oct 31, 2016

@TikhomirovSergey Have run through android tests and everything LGTM.Also @codacy is Green.

TikhomirovSergey · Oct 31, 2016

@saikrishna321

yah i get this... but what does CHAIN and ALL_POSSIBLE do ?

That means that each one platform-specific locator can be a part of the chaing of the searching or it is one of possible variants to find the desired element/the desired list of elements as well.

Before we have been using such annotations as @AndroidFindBys({@AndroidFindBy(1),@AndroidFindBy(2)})/@iOSFindBys({@iOSFindBy(1), @iOSFindBy(2)}) to define the searching chain and @AndroidFindAll({@AndroidFindBy(1),@AndroidFindBy(2)})/@iOSFindAll({@iOSFindBy(1), @iOSFindBy(2)}) to define possible locators for the searching.

Now we are migrating to Java 8. It provides repeatable annotations: http://docs.oracle.com/javase/tutorial/java/annotations/repeating.html

So I think that some annotations above are redundant now. We could define the chain like:
@AndroidFindBy(1) @AndroidFindBy(2)/@iOSFindBy(1) @iOSFindBy(2)
But it is still possible that end user needs to define these locators as the set of possible variants to find an element.

So

@HowToUseLocators(iOSAutomation = ALL_POSSIBLE, androidAutomation = ALL_POSSIBLE)
@AndroidFindBy(1) @AndroidFindBy(2)
@iOSFindBy(1) @iOSFindBy(2)

If the end user needs for combined strategy for each target platform then

@HowToUseLocators(iOSAutomation = CHAIN, androidAutomation = ALL_POSSIBLE)
@AndroidFindBy(1) @AndroidFindBy(2) //each one locator is the 
//possible variant to find elements
@iOSFindBy(1) @iOSFindBy(2) //it is for the chained searching

or

@HowToUseLocators(androidAutomation = ALL_POSSIBLE)
@AndroidFindBy(1) @AndroidFindBy(2) //each one locator is the 
//possible variant to find elements
@iOSFindBy(1) @iOSFindBy(2) //it is for the chained searching by default

TikhomirovSergey · Oct 31, 2016

@SrinivasanTarget
How does iOS feels?

SrinivasanTarget · Oct 31, 2016

@TikhomirovSergey

How does iOS feels?

Have upgraded my xcode to 8 so i cant run through existing tests on XCUITest Mode. But test code for iOS looks good to me.

saikrishna321 · Oct 31, 2016

@SrinivasanTarget @TikhomirovSergey I'm still on xcode 7, any help needed to run the iOS test ?

saikrishna321 · Oct 31, 2016

@TikhomirovSergey well explained, i had a chat with @SrinivasanTarget on @CacheLookup will take a look on it ..

SrinivasanTarget · Oct 31, 2016

I'm still on xcode 7, any help needed to run the iOS test ?

@saikrishna321 May be you can help us with IOSPageFactoryTest.

saikrishna321 · Oct 31, 2016

@TikhomirovSergey @SrinivasanTarget all tests passed( Tested on iPhone 9.3 Simulator, xcode 7) 👍

TikhomirovSergey added 9 commits September 26, 2016 21:45

Migration to Java 8: Repeatable annotations

9304ebc

- deprecated annotations: AndroidFindAll, AndroidFindBys, iOSFindAll, iOSFindBys, SelendroidFindAll, SelendroidFindBys. - new annotations were added: AndroidFindBySet, iOSFindBySet, SelendroidFindBySet, HowToUseLocators.

Additional refactoring: Required HasSessionDetails API was added

0e0c8f1

- added interface HasSessionDetails which contains methods with default implementation. It is implemented by AppiumDriver and MobileElement - AndroidDriverTest was modified.

Additional refactoring: MobileElement doesn't implement HasSessionDet…

0f995a2

…ails API

Additional refactoring: Migration of page object tools to the HasSess…

f6c0f1b

…ionDetails API was finished

Migration to repeatable annotations is finished. It needs for the tes…

ff4305e

…ting.

Migration to repeatable page object annotations is finished

2d70a50

chromedriver was updated for the testing

0f84d5e

Documentation was updated

6ce94ec

Missed javadocs were provided. Checkstyle issues were fixed.

4a79257

TikhomirovSergey added enhancement refactor labels Oct 28, 2016

TikhomirovSergey added this to the 5.0.0 milestone Oct 28, 2016

TikhomirovSergey changed the title ~~Repeatable annotations~~ Repeatable annotations & HasSessionDetails API Oct 28, 2016

SrinivasanTarget requested changes Oct 29, 2016

View reviewed changes

TikhomirovSergey added 2 commits October 29, 2016 21:32

Merge branch 'master' of https://github.com/appium/java-client into r…

fe03bf8

…epeatable_annotations # Conflicts: # src/main/java/io/appium/java_client/AppiumDriver.java

Merge branch 'master' of https://github.com/appium/java-client into r…

07b86cf

…epeatable_annotations # Conflicts: # src/main/java/io/appium/java_client/AppiumDriver.java

The bug fix.

652779d

SrinivasanTarget approved these changes Oct 31, 2016

View reviewed changes

TikhomirovSergey merged commit e2dafc7 into appium:master Oct 31, 2016

Search code, repositories, users, issues, pull requests...

Uh oh!

Conversation

TikhomirovSergey commented Oct 28, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Change list

Types of changes

Details

The old usecase for the chained searching:

New usecases for the chained searching:

The old usecase for the searching by all possible locators:

The new usecase for the searching by all possible locators:

Also possible combined variants:

Uh oh!

TikhomirovSergey commented Oct 28, 2016

Uh oh!

SrinivasanTarget left a comment

Choose a reason for hiding this comment

Uh oh!

TikhomirovSergey commented Oct 29, 2016

Uh oh!

SrinivasanTarget commented Oct 30, 2016

Uh oh!

saikrishna321 commented Oct 30, 2016

Uh oh!

SrinivasanTarget commented Oct 30, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

saikrishna321 commented Oct 31, 2016

Uh oh!

SrinivasanTarget commented Oct 31, 2016

Uh oh!

SrinivasanTarget commented Oct 31, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TikhomirovSergey commented Oct 31, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TikhomirovSergey commented Oct 31, 2016

Uh oh!

SrinivasanTarget commented Oct 31, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

saikrishna321 commented Oct 31, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

saikrishna321 commented Oct 31, 2016

Uh oh!

SrinivasanTarget commented Oct 31, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

saikrishna321 commented Oct 31, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

TikhomirovSergey commented Oct 28, 2016 •

edited

Loading

SrinivasanTarget commented Oct 30, 2016 •

edited

Loading

SrinivasanTarget commented Oct 31, 2016 •

edited

Loading

TikhomirovSergey commented Oct 31, 2016 •

edited

Loading

SrinivasanTarget commented Oct 31, 2016 •

edited

Loading

saikrishna321 commented Oct 31, 2016 •

edited

Loading

SrinivasanTarget commented Oct 31, 2016 •

edited

Loading