Merge pull request #20517 from wordpress-mobile/andy/issue-20461

[Test] Add custom Rule to retry failed tests if annotated appropriately.

WordPress/src/androidTest/java/org/wordpress/android/e2e/StatsGranularTabsTest.kt

@@ -11,6 +11,7 @@ import org.junit.Test
 import org.wordpress.android.BuildConfig
 import org.wordpress.android.R
 import org.wordpress.android.e2e.pages.MySitesPage
+import org.wordpress.android.rules.Retry
 import org.wordpress.android.support.BaseTest
 import org.wordpress.android.support.ComposeEspressoLink
 import org.wordpress.android.support.WPSupportUtils
@@ -37,8 +38,8 @@ class StatsGranularTabsTest : BaseTest() {
         }
     }
 
-    @Test
     @Ignore("The 'Days' screen might occasionally not load. Disabled until tests rerun is implemented.")
+    @Test
     fun e2eAllDayStatsLoad() {
         val todayVisits = StatsVisitsData("97", "28", "14", "11")
         val postsList: List<StatsKeyValueData> = StatsMocksReader().readDayTopPostsToList()

WordPress/src/androidTest/java/org/wordpress/android/rules/Retry.kt

@@ -0,0 +1,10 @@
+package org.wordpress.android.rules
+
+/**
+ * Annotation used to denote you want to retry a UI test function.
+ *
+ * @property numberOfTimes the number of times you want to retry the function, with a default of 1.
+ */
+@Retention(AnnotationRetention.RUNTIME)
+@Target(AnnotationTarget.FUNCTION)
+annotation class Retry(val numberOfTimes: Int = 1)

WordPress/src/androidTest/java/org/wordpress/android/rules/RetryTestRule.kt

@@ -0,0 +1,40 @@
+package org.wordpress.android.rules
+
+import android.util.Log
+import org.junit.rules.TestRule
+import org.junit.runner.Description
+import org.junit.runners.model.Statement
+
+const val TAG = "RetryTestRule"
+
+/**
+ * Custom rule used to retry running a test if a problem occurs.
+ */
+class RetryTestRule : TestRule {
+    override fun apply(base: Statement?, description: Description?): Statement {
+        return object : Statement() {
+            override fun evaluate() {
+                // We only retry functions that are annotated with @Retry.
+                val retry = description?.getAnnotation(Retry::class.java)
+                if (retry != null) {
+                    var lastThrown: Throwable? = null
+                    for (i in 0..retry.numberOfTimes) {
+                        try {
+                            base?.evaluate()
+                            return
+                        } catch (t: Throwable) {
+                            Log.e(TAG, "Test failed to run due to problem on run $i", t)
+                            lastThrown = t
+                        }
+                    }
+                    Log.e(TAG, "Could not pass test.")
+                    if (lastThrown != null) {
+                        throw lastThrown
+                    }
+                }
+                // If test function does not have @Retry, run as normal.
+                base?.evaluate()
+            }
+        }
+    }
+}

WordPress/src/androidTest/java/org/wordpress/android/support/BaseTest.java

@@ -34,6 +34,7 @@
 import org.wordpress.android.editor.Utils;
 import org.wordpress.android.mocks.AndroidNotifier;
 import org.wordpress.android.mocks.AssetFileSource;
+import org.wordpress.android.rules.RetryTestRule;
 import org.wordpress.android.ui.WPLaunchActivity;
 import org.wordpress.android.wiremock.WireMockStub;
 
@@ -77,6 +78,9 @@ public class BaseTest {
     @Rule(order = 4)
     public WireMockRule wireMockRule;
 
+    @Rule(order = 5)
+    public RetryTestRule retryTestRule = new RetryTestRule();
+
     public BaseTest() {
         this(null);
     }