Merge pull request #34 from optimizely/josh/test-app-enhancements-2

Gets Espresso tests recording and asserting on events

Author: jophde

android-sdk/src/main/java/com/optimizely/ab/android/sdk/AndroidOptimizely.java

@@ -113,6 +113,7 @@ public void track(@NonNull String eventName,
                       @NonNull Map<String, String> attributes) throws UnknownEventTypeException {
         if (optimizely != null) {
             optimizely.track(eventName, userId, attributes);
+
         } else {
             logger.warn("Optimizely is not initialized, could not track event {} for user {}" +
                     " with attributes", eventName, userId);

android-sdk/src/main/java/com/optimizely/ab/android/sdk/DataFileService.java

@@ -35,7 +35,10 @@
  * @hide
  */
 public class DataFileService extends Service {
-    static final String EXTRA_PROJECT_ID = "com.optimizely.ab.android.EXTRA_PROJECT_ID";
+    /**
+     * Extra containing the project id this instance of Optimizely was built with
+     */
+    public static final String EXTRA_PROJECT_ID = "com.optimizely.ab.android.EXTRA_PROJECT_ID";
     @NonNull private final IBinder binder = new LocalBinder();
     Logger logger = LoggerFactory.getLogger(getClass());
     private boolean isBound;

android-sdk/src/main/java/com/optimizely/ab/android/sdk/OptimizelyManager.java

@@ -33,6 +33,7 @@
 import android.support.annotation.Nullable;
 import android.support.annotation.RawRes;
 import android.support.annotation.RequiresApi;
+import android.support.annotation.VisibleForTesting;
 
 import com.optimizely.ab.Optimizely;
 import com.optimizely.ab.android.event_handler.OptlyEventHandler;
@@ -66,6 +67,7 @@ public class OptimizelyManager {
     @NonNull private final Logger logger;
     @Nullable private DataFileServiceConnection dataFileServiceConnection;
     @Nullable private OptimizelyStartListener optimizelyStartListener;
+    @Nullable private UserExperimentRecord userExperimentRecord;
 
     OptimizelyManager(@NonNull String projectId,
                       @NonNull Long eventHandlerDispatchInterval,
@@ -265,6 +267,7 @@ protected void onPostExecute(UserExperimentRecord userExperimentRecord) {
 
                 try {
                     OptimizelyManager.androidOptimizely = buildOptimizely(context, dataFile, userExperimentRecord);
+                    OptimizelyManager.this.userExperimentRecord = userExperimentRecord;
                     logger.info("Sending Optimizely instance to listener");
 
                     if (optimizelyStartListener != null) {
@@ -295,6 +298,21 @@ private AndroidOptimizely buildOptimizely(@NonNull Context context, @NonNull Str
         return new AndroidOptimizely(optimizely, LoggerFactory.getLogger(AndroidOptimizely.class));
     }
 
+    @VisibleForTesting
+    public UserExperimentRecord getUserExperimentRecord() {
+        return userExperimentRecord;
+    }
+
+    private boolean isAndroidVersionSupported() {
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.ICE_CREAM_SANDWICH) {
+            return true;
+        } else {
+            logger.warn("Optimizely will not work on this phone.  It's Android version {} is less the minimum supported" +
+                    "version {}", Build.VERSION.SDK_INT, Build.VERSION_CODES.ICE_CREAM_SANDWICH);
+            return false;
+        }
+    }
+
     @RequiresApi(api = Build.VERSION_CODES.ICE_CREAM_SANDWICH)
     static class OptlyActivityLifecycleCallbacks implements Application.ActivityLifecycleCallbacks {
 
@@ -486,14 +504,4 @@ public OptimizelyManager build() {
 
         }
     }
-
-    private boolean isAndroidVersionSupported() {
-        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.ICE_CREAM_SANDWICH) {
-            return true;
-        } else {
-            logger.warn("Optimizely will not work on this phone.  It's Android version {} is less the minimum supported" +
-                    "version {}", Build.VERSION.SDK_INT, Build.VERSION_CODES.ICE_CREAM_SANDWICH);
-            return false;
-        }
-    }
 }

event-handler/src/main/java/com/optimizely/ab/android/event_handler/EventDispatcher.java

@@ -22,6 +22,7 @@
 import android.support.annotation.NonNull;
 import android.util.Pair;
 
+import com.optimizely.ab.android.shared.CountingIdlingResourceManager;
 import com.optimizely.ab.android.shared.OptlyStorage;
 import com.optimizely.ab.android.shared.ServiceScheduler;
 
@@ -136,6 +137,8 @@ private boolean dispatch(Event event) {
         boolean eventWasSent = eventClient.sendEvent(event);
 
         if (eventWasSent) {
+            CountingIdlingResourceManager.decrement();
+            CountingIdlingResourceManager.recordEvent(new Pair<>(event.getURL().toString(), event.getRequestBody()));
             return true;
         } else {
             boolean eventWasStored = eventDAO.storeEvent(event);
@@ -148,6 +151,4 @@ private boolean dispatch(Event event) {
             }
         }
     }
-
-
 }

shared/build.gradle

@@ -54,6 +54,7 @@ dependencies {
     compile "com.noveogroup.android:android-logger:$android_logger_ver"
     compile "com.optimizely.ab:core-api:$java_core_ver"
     compile "com.google.code.gson:gson:$gson_ver"
+    compile "com.android.support.test.espresso:espresso-idling-resource:$espresso_ver"
     provided "com.android.support:support-annotations:$support_annotations_ver"
 
     testCompile "junit:junit:$junit_ver"

shared/src/main/java/com/optimizely/ab/android/shared/CountingIdlingResourceManager.java

@@ -0,0 +1,81 @@
+/*
+ * Copyright 2016, Optimizely
+ * <p/>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p/>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p/>
+ * 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 com.optimizely.ab.android.shared;
+
+import android.support.annotation.NonNull;
+import android.support.annotation.Nullable;
+import android.support.annotation.VisibleForTesting;
+import android.support.test.espresso.idling.CountingIdlingResource;
+import android.util.Pair;
+
+import java.util.LinkedList;
+import java.util.List;
+
+/**
+ * Manages an Espresso {@link CountingIdlingResource}
+ */
+@VisibleForTesting
+public class CountingIdlingResourceManager {
+
+    @Nullable private static CountingIdlingResource countingIdlingResource;
+    @NonNull private static List<Pair<String, String>> eventList = new LinkedList<>();
+
+    @VisibleForTesting
+    @Nullable
+    public static CountingIdlingResource getIdlingResource() {
+        if (countingIdlingResource == null) {
+            countingIdlingResource = new CountingIdlingResource("optimizely", true);
+        }
+        return countingIdlingResource;
+    }
+
+    @VisibleForTesting
+    public static void setIdlingResource(@NonNull CountingIdlingResource countingIdlingResource) {
+        CountingIdlingResourceManager.countingIdlingResource = countingIdlingResource;
+    }
+
+    @VisibleForTesting
+    public static void increment() {
+        if (countingIdlingResource != null) {
+            countingIdlingResource.increment();
+        }
+    }
+
+    @VisibleForTesting
+    public static void decrement() {
+        if (countingIdlingResource != null) {
+            countingIdlingResource.decrement();
+        }
+    }
+
+    @VisibleForTesting
+    public static void recordEvent(Pair<String, String> event) {
+        if (countingIdlingResource != null) {
+            eventList.add(event);
+        }
+    }
+
+    @VisibleForTesting
+    public static void clearEvents() {
+        eventList.clear();
+    }
+
+    @VisibleForTesting
+    public static List<Pair<String, String>> getEvents() {
+        return eventList;
+    }
+}

shared/src/main/java/com/optimizely/ab/android/shared/ServiceScheduler.java

@@ -85,6 +85,16 @@ public void unschedule(Intent intent) {
         logger.info("Unscheduled {}", intent.getComponent().toShortString());
     }
 
+    /**
+     * Is an {@link Intent} for a service scheduled
+     * @param intent the intent in question
+     * @return is it scheduled or not
+     * @hide
+     */
+    public boolean isScheduled(Intent intent) {
+        return pendingIntentFactory.hasPendingIntent(intent);
+    }
+
     /**
      * Handles the complexities around PendingIntent flags
      *

test-app/build.gradle

@@ -36,8 +36,6 @@ dependencies {
 //    compile 'com.optimizely.ab:android-sdk:0.1.2-SNAPSHOT'
     compile 'com.android.support:appcompat-v7:24.2.1'
     compile 'com.android.support:design:24.2.1'
-    compile "com.android.support.test.espresso:espresso-idling-resource:$espresso_ver"
-
 
     testCompile "junit:junit:$junit_ver"
     testCompile "org.mockito:mockito-core:$mockito_ver"