How to use AppiumFluentWait.IterationInfo class of io.appium.java_client package

Best io.appium code snippet using io.appium.java_client.AppiumFluentWait.IterationInfo

AppiumFluentWait.java

Source:AppiumFluentWait.java

1/*2 * Licensed under the Apache License, Version 2.0 (the "License");3 * you may not use this file except in compliance with the License.4 * See the NOTICE file distributed with this work for additional5 * information regarding copyright ownership.6 * You may obtain a copy of the License at7 *8 *     http://www.apache.org/licenses/LICENSE-2.09 *10 * Unless required by applicable law or agreed to in writing, software11 * distributed under the License is distributed on an "AS IS" BASIS,12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.13 * See the License for the specific language governing permissions and14 * limitations under the License.15 */16package io.appium.java_client;17import com.google.common.base.Throwables;18import org.openqa.selenium.TimeoutException;19import org.openqa.selenium.WebDriverException;20import org.openqa.selenium.support.ui.Clock;21import org.openqa.selenium.support.ui.Duration;22import org.openqa.selenium.support.ui.FluentWait;23import org.openqa.selenium.support.ui.Sleeper;24import java.lang.reflect.Field;25import java.util.List;26import java.util.concurrent.TimeUnit;27import java.util.function.Function;28import java.util.function.Supplier;29public class AppiumFluentWait<T> extends FluentWait<T> {30    private Function<IterationInfo, Duration> pollingStrategy = null;31    public static class IterationInfo {32        private final long number;33        private final Duration elapsed;34        private final Duration total;35        private final Duration interval;36        /**37         * The class is used to represent information about a single loop iteration in {@link #until(Function)}38         * method.39         *40         * @param number loop iteration number, starts from 141         * @param elapsed the amount of elapsed time since the loop started42         * @param total the amount of total time to run the loop43         * @param interval the default time interval for each loop iteration44         */45        public IterationInfo(long number, Duration elapsed, Duration total, Duration interval) {46            this.number = number;47            this.elapsed = elapsed;48            this.total = total;49            this.interval = interval;50        }51        /**52         * The current iteration number.53         *54         * @return current iteration number. It starts from 155         */56        public long getNumber() {57            return number;58        }59        /**60         * The amount of elapsed time.61         *62         * @return the amount of elapsed time63         */64        public Duration getElapsed() {65            return elapsed;66        }67        /**68         * The amount of total time.69         *70         * @return the amount of total time71         */72        public Duration getTotal() {73            return total;74        }75        /**76         * The current interval.77         *78         * @return The actual value of current interval or the default one if it is not set79         */80        public Duration getInterval() {81            return interval;82        }83    }84    /**85     * @param input The input value to pass to the evaluated conditions.86     */87    public AppiumFluentWait(T input) {88        super(input);89    }90    /**91     * @param input   The input value to pass to the evaluated conditions.92     * @param clock   The clock to use when measuring the timeout.93     * @param sleeper Used to put the thread to sleep between evaluation loops.94     */95    public AppiumFluentWait(T input, Clock clock, Sleeper sleeper) {96        super(input, clock, sleeper);97    }98    private <B> B getPrivateFieldValue(String fieldName, Class<B> fieldType) {99        try {100            final Field f = getClass().getSuperclass().getDeclaredField(fieldName);101            f.setAccessible(true);102            return fieldType.cast(f.get(this));103        } catch (NoSuchFieldException | IllegalAccessException e) {104            throw new WebDriverException(e);105        }106    }107    private Object getPrivateFieldValue(String fieldName) {108        try {109            final Field f = getClass().getSuperclass().getDeclaredField(fieldName);110            f.setAccessible(true);111            return f.get(this);112        } catch (NoSuchFieldException | IllegalAccessException e) {113            throw new WebDriverException(e);114        }115    }116    protected Clock getClock() {117        return getPrivateFieldValue("clock", Clock.class);118    }119    protected Duration getTimeout() {120        return getPrivateFieldValue("timeout", Duration.class);121    }122    protected Duration getInterval() {123        return getPrivateFieldValue("interval", Duration.class);124    }125    protected Sleeper getSleeper() {126        return getPrivateFieldValue("sleeper", Sleeper.class);127    }128    @SuppressWarnings("unchecked")129    protected List<Class<? extends Throwable>> getIgnoredExceptions() {130        return getPrivateFieldValue("ignoredExceptions", List.class);131    }132    @SuppressWarnings("unchecked")133    protected Supplier<String> getMessageSupplier() {134        return getPrivateFieldValue("messageSupplier", Supplier.class);135    }136    @SuppressWarnings("unchecked")137    protected T getInput() {138        return (T) getPrivateFieldValue("input");139    }140    /**141     * Sets the strategy for polling. The default strategy is null,142     * which means, that polling interval is always a constant value and is143     * set by {@link #pollingEvery(long, TimeUnit)} method. Otherwise the value set by that144     * method might be just a helper to calculate the actual interval.145     * Although, by setting an alternative polling strategy you may flexibly control146     * the duration of this interval for each polling round.147     * For example we'd like to wait two times longer than before each time we cannot find148     * an element:149     * <code>150     *   final Wait&lt;WebElement&gt; wait = new AppiumFluentWait&lt;&gt;(el)151     *     .withPollingStrategy(info -&gt; new Duration(info.getNumber() * 2, TimeUnit.SECONDS))152     *     .withTimeout(6, TimeUnit.SECONDS);153     *   wait.until(WebElement::isDisplayed);154     * </code>155     * Or we want the next time period is Euler's number e raised to the power of current iteration156     * number:157     * <code>158     *   final Wait&lt;WebElement&gt; wait = new AppiumFluentWait&lt;&gt;(el)159     *     .withPollingStrategy(info -&gt; new Duration((long) Math.exp(info.getNumber()), TimeUnit.SECONDS))160     *     .withTimeout(6, TimeUnit.SECONDS);161     *   wait.until(WebElement::isDisplayed);162     * </code>163     * Or we'd like to have some advanced algorithm, which waits longer first, but then use the default interval when it164     * reaches some constant:165     * <code>166     *   final Wait&lt;WebElement&gt; wait = new AppiumFluentWait&lt;&gt;(el)167     *     .withPollingStrategy(info -&gt; new Duration(info.getNumber() &lt; 5168     *       ? 4 - info.getNumber() : info.getInterval().in(TimeUnit.SECONDS), TimeUnit.SECONDS))169     *     .withTimeout(30, TimeUnit.SECONDS)170     *     .pollingEvery(1, TimeUnit.SECONDS);171     *   wait.until(WebElement::isDisplayed);172     * </code>173     *174     * @param pollingStrategy Function instance, where the first parameter175     *                        is the information about the current loop iteration (see {@link IterationInfo})176     *                        and the expected result is the calculated interval. It is highly177     *                        recommended that the value returned by this lambda is greater than zero.178     * @return A self reference.179     */180    public AppiumFluentWait<T> withPollingStrategy(Function<IterationInfo, Duration> pollingStrategy) {181        this.pollingStrategy = pollingStrategy;182        return this;183    }184    /**185     * Repeatedly applies this instance's input value to the given function until one of the following186     * occurs:187     * <ol>188     * <li>the function returns neither null nor false,</li>189     * <li>the function throws an unignored exception,</li>190     * <li>the timeout expires,191     * <li>192     * <li>the current thread is interrupted</li>193     * </ol>194     *195     * @param isTrue the parameter to pass to the expected condition196     * @param <V>    The function's expected return type.197     * @return The functions' return value if the function returned something different198     *         from null or false before the timeout expired.199     * @throws TimeoutException If the timeout expires.200     */201    @Override202    public <V> V until(Function<? super T, V> isTrue) {203        final long start = getClock().now();204        final long end = getClock().laterBy(getTimeout().in(TimeUnit.MILLISECONDS));205        long iterationNumber = 1;206        Throwable lastException;207        while (true) {208            try {209                V value = isTrue.apply(getInput());210                if (value != null && (Boolean.class != value.getClass() || Boolean.TRUE.equals(value))) {211                    return value;212                }213                // Clear the last exception; if another retry or timeout exception would214                // be caused by a false or null value, the last exception is not the215                // cause of the timeout.216                lastException = null;217            } catch (Throwable e) {218                lastException = propagateIfNotIgnored(e);219            }220            // Check the timeout after evaluating the function to ensure conditions221            // with a zero timeout can succeed.222            if (!getClock().isNowBefore(end)) {223                String message = getMessageSupplier() != null ? getMessageSupplier().get() : null;224                String timeoutMessage = String.format(225                        "Expected condition failed: %s (tried for %d second(s) with %s interval)",226                        message == null ? "waiting for " + isTrue : message,227                        getTimeout().in(TimeUnit.SECONDS), getInterval());228                throw timeoutException(timeoutMessage, lastException);229            }230            try {231                Duration interval = getInterval();232                if (pollingStrategy != null) {233                    final IterationInfo info = new IterationInfo(iterationNumber,234                            new Duration(getClock().now() - start, TimeUnit.MILLISECONDS), getTimeout(),235                            interval);236                    interval = pollingStrategy.apply(info);237                }238                getSleeper().sleep(interval);239            } catch (InterruptedException e) {240                Thread.currentThread().interrupt();241                throw new WebDriverException(e);242            }243            ++iterationNumber;244        }245    }246    protected Throwable propagateIfNotIgnored(Throwable e) {247        for (Class<? extends Throwable> ignoredException : getIgnoredExceptions()) {248            if (ignoredException.isInstance(e)) {249                return e;250            }251        }252        Throwables.throwIfUnchecked(e);253        throw new WebDriverException(e);254    }255}...

ElementHelper.java

Source:ElementHelper.java

1package com.george5613.test.helper;2import com.george5613.test.app.global.Context;3import com.george5613.test.callback.ActivityStatusCallback;4import com.george5613.test.callback.ElementStatusCallback;5import io.appium.java_client.AppiumFluentWait;6import io.appium.java_client.MobileElement;7import io.appium.java_client.android.AndroidDriver;8import io.appium.java_client.android.AndroidElement;9import org.openqa.selenium.TimeoutException;10import org.openqa.selenium.support.ui.Wait;11import java.time.Clock;12import java.util.List;13import java.util.function.Function;14import static java.time.Duration.ofMillis;15import static java.time.Duration.ofSeconds;16public class ElementHelper {17    private static class ElementStore {18        private AndroidElement mElement;19        public ElementStore() {20        }21        public AndroidElement getElement() {22            return mElement;23        }24        public void storeElement(AndroidElement element) {25            mElement = element;26        }27        public boolean isTouch() {28            return mElement != null;29        }30    }31    public static void waitForElementById(Context context, String rid, ElementStatusCallback callback) {32        ElementStore store = new ElementStore();33        final Wait<ElementStore> wait = new AppiumFluentWait<>(store, Clock.systemDefaultZone(), duration -> {34            store.storeElement(context.getDriver().findElementById(rid));35            Thread.sleep(duration.toMillis());36        }).withPollingStrategy(AppiumFluentWait.IterationInfo::getInterval)37                .withTimeout(ofSeconds(3))38                .pollingEvery(ofMillis(200));39        try {40            wait.until(new Function<ElementStore, Boolean>() {41                @Override42                public Boolean apply(ElementStore elementStore) {43                    return elementStore.isTouch();44                }45            });46            if (callback != null) callback.onElementTouch(store.getElement());47        } catch (TimeoutException ex) {48            if (callback != null) callback.onTimeout();49        }50    }51    public static void waitForElementByClass(Context context, String className, ElementStatusCallback callback) {52        ElementStore store = new ElementStore();53        final Wait<ElementStore> wait = new AppiumFluentWait<>(store, Clock.systemDefaultZone(), duration -> {54            store.storeElement(context.getDriver().findElementByClassName(className));55            Thread.sleep(duration.toMillis());56        }).withPollingStrategy(AppiumFluentWait.IterationInfo::getInterval)57                .withTimeout(ofSeconds(3))58                .pollingEvery(ofMillis(200));59        try {60            wait.until(new Function<ElementStore, Boolean>() {61                @Override62                public Boolean apply(ElementStore elementStore) {63                    return elementStore.isTouch();64                }65            });66            if (callback != null) callback.onElementTouch(store.getElement());67        } catch (TimeoutException ex) {68            if (callback != null) callback.onTimeout();69        }70    }71    public static AndroidElement findElementById(Context context, String rid) {72        AndroidElement result;73        try {74            result = context.getDriver().findElementById(rid);75        } catch (Exception e) {76            result = null;77        }78        return result;79    }80    public static MobileElement findElementById(MobileElement element, String rid) {81        MobileElement result;82        try {83            result = element.findElementById(rid);84        } catch (Exception e) {85            result = null;86        }87        return result;88    }89    public static List<MobileElement> findElementsByClassName(MobileElement element, String className) {90        List<MobileElement> result;91        try {92            result = element.findElementsByClassName(className);93        } catch (Exception e) {94            result = null;95        }96        return result;97    }98}...

AppiumFluentWaitTest.java

Source:AppiumFluentWaitTest.java

1/*2 * Licensed under the Apache License, Version 2.0 (the "License");3 * you may not use this file except in compliance with the License.4 * See the NOTICE file distributed with this work for additional5 * information regarding copyright ownership.6 * You may obtain a copy of the License at7 *8 *     http://www.apache.org/licenses/LICENSE-2.09 *10 * Unless required by applicable law or agreed to in writing, software11 * distributed under the License is distributed on an "AS IS" BASIS,12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.13 * See the License for the specific language governing permissions and14 * limitations under the License.15 */16package io.appium.java_client.appium;17import static java.time.Duration.ofSeconds;18import static org.hamcrest.MatcherAssert.assertThat;19import static org.hamcrest.core.Is.is;20import static org.hamcrest.core.IsEqual.equalTo;21import io.appium.java_client.AppiumFluentWait;22import org.junit.Assert;23import org.junit.Test;24import org.openqa.selenium.TimeoutException;25import org.openqa.selenium.support.ui.Wait;26import java.time.Clock;27import java.util.concurrent.atomic.AtomicInteger;28import java.util.function.Function;29public class AppiumFluentWaitTest {30    31    private static class FakeElement {32        public boolean isDisplayed() {33            return false;34        }35    }36    @Test(expected = TimeoutException.class)37    public void testDefaultStrategy() {38        final FakeElement el = new FakeElement();39        final Wait<FakeElement> wait = new AppiumFluentWait<>(el, Clock.systemDefaultZone(), duration -> {40            assertThat(duration.getSeconds(), is(equalTo(1L)));41            Thread.sleep(duration.toMillis());42        }).withPollingStrategy(AppiumFluentWait.IterationInfo::getInterval)43                .withTimeout(ofSeconds(3))44                .pollingEvery(ofSeconds(1));45        wait.until(FakeElement::isDisplayed);46        Assert.fail("TimeoutException is expected");47    }48    @Test49    public void testCustomStrategyOverridesDefaultInterval() {50        final FakeElement el = new FakeElement();51        final AtomicInteger callsCounter = new AtomicInteger(0);52        final Wait<FakeElement> wait = new AppiumFluentWait<>(el, Clock.systemDefaultZone(), duration -> {53            callsCounter.incrementAndGet();54            assertThat(duration.getSeconds(), is(equalTo(2L)));55            Thread.sleep(duration.toMillis());56        }).withPollingStrategy(info -> ofSeconds(2))57                .withTimeout(ofSeconds(3))58                .pollingEvery(ofSeconds(1));59        try {60            wait.until(FakeElement::isDisplayed);61            Assert.fail("TimeoutException is expected");62        } catch (TimeoutException e) {63            // this is expected64            assertThat(callsCounter.get(), is(equalTo(2)));65        }66    }67    @Test68    public void testIntervalCalculationForCustomStrategy() {69        final FakeElement el = new FakeElement();70        final AtomicInteger callsCounter = new AtomicInteger(0);71        // Linear dependency72        final Function<Long, Long> pollingStrategy = x -> x * 2;73        final Wait<FakeElement> wait = new AppiumFluentWait<>(el, Clock.systemDefaultZone(), duration -> {74            int callNumber = callsCounter.incrementAndGet();75            assertThat(duration.getSeconds(), is(equalTo(pollingStrategy.apply((long) callNumber))));76            Thread.sleep(duration.toMillis());77        }).withPollingStrategy(info -> ofSeconds(pollingStrategy.apply(info.getNumber())))78                .withTimeout(ofSeconds(4))79                .pollingEvery(ofSeconds(1));80        try {81            wait.until(FakeElement::isDisplayed);82            Assert.fail("TimeoutException is expected");83        } catch (TimeoutException e) {84            // this is expected85            assertThat(callsCounter.get(), is(equalTo(2)));86        }87    }88}...

ActivityHelper.java

Source:ActivityHelper.java

1package com.george5613.test.helper;2import com.george5613.test.callback.ActivityStatusCallback;3import io.appium.java_client.AppiumFluentWait;4import io.appium.java_client.android.AndroidDriver;5import io.appium.java_client.android.AndroidElement;6import org.openqa.selenium.TimeoutException;7import org.openqa.selenium.support.ui.Wait;8import java.time.Clock;9import java.util.function.Function;10import static java.time.Duration.ofSeconds;11public class ActivityHelper {12    private static class ActivityNameStore {13        private String mTouchName;14        private String mActivityName = "";15        public ActivityNameStore(String name) {16            this.mTouchName = name;17        }18        public void storeActivity(String activity) {19            mActivityName = activity;20        }21        public boolean isTouch() {22            return mActivityName.equals(mTouchName);23        }24    }25    public static void waitFor(AndroidDriver<AndroidElement> driver, String activityName, ActivityStatusCallback callback) {26        ActivityNameStore store = new ActivityNameStore(activityName);27        final Wait<ActivityNameStore> wait = new AppiumFluentWait<>(store, Clock.systemDefaultZone(), duration -> {28            store.storeActivity(driver.currentActivity());29            Thread.sleep(duration.toMillis());30        }).withPollingStrategy(AppiumFluentWait.IterationInfo::getInterval)31                .withTimeout(ofSeconds(3))32                .pollingEvery(ofSeconds(1));33        try {34            wait.until(new Function<ActivityNameStore, Boolean>() {35                @Override36                public Boolean apply(ActivityNameStore activityStatus) {37                    return activityStatus.isTouch();38                }39            });40            if (callback != null) callback.onActivityTouch();41        } catch (TimeoutException ex) {42            if (callback != null) callback.onTimeout();43        }44    }45}...

PermissionGrantAction.java

Source:PermissionGrantAction.java

1package com.george5613.test.app.common;2import com.george5613.test.app.global.Context;3import com.george5613.test.base.BaseAction;4import com.george5613.test.helper.ElementHelper;5import com.george5613.test.status.ElementStatus;6import io.appium.java_client.AppiumFluentWait;7import io.appium.java_client.android.AndroidDriver;8import io.appium.java_client.android.AndroidElement;9import org.openqa.selenium.support.ui.Wait;10import java.time.Clock;11import java.util.function.Function;12import static com.george5613.test.app.global.Constant.PERMISSION_ACTIVITY;13import static java.time.Duration.ofSeconds;14public class PermissionGrantAction extends BaseAction {15    public static final String TAG = PERMISSION_ACTIVITY;16    public PermissionGrantAction(Context context) {17        super(context);18    }19    @Override20    public String getTag() {21        return TAG;22    }23    @Override24    public void doStep() {25        grantPermission();26    }27    public void grantPermission() {28        ElementStatus element = new ElementStatus();29        final Wait<ElementStatus> wait = new AppiumFluentWait<>(element, Clock.systemDefaultZone(), duration -> {30            element.setElement(ElementHelper.findElementById(mContext, "com.android.packageinstaller:id/permission_allow_button"));31            Thread.sleep(duration.toMillis());32        }).withPollingStrategy(AppiumFluentWait.IterationInfo::getInterval)33                .withTimeout(ofSeconds(2))34                .pollingEvery(ofSeconds(1));35        try {36            wait.until(new Function<ElementStatus, Boolean>() {37                @Override38                public Boolean apply(ElementStatus elementStatus) {39                    return elementStatus.isFind();40                }41            });42            element.grant();43            grantPermission();44        } catch (Exception ex) {45            return;46        }47    }48}...