Feature/remove espresso from release (#152)

* remove some dependencies
* after much juggling, i think we have a pretty good solution.  we show an example of overriding the logger and json parser in the test-app
* fix so that espresso is included via interface.
* final updates for removing espresso

Author: thomaszurkan-optimizely

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

@@ -526,7 +526,7 @@ public static class Builder {
          * cached datafile.  If you set this to -1, you disable background updates.  If you don't set
          * a download interval (or set to less than 0), then no background updates will be scheduled or occur.
          *
-         * @param interval the interval
+         * @param interval the interval in seconds
          * @return this {@link Builder} instance
          */
         public Builder withDatafileDownloadInterval(long interval) {
@@ -569,7 +569,7 @@ public Builder withErrorHandler(ErrorHandler errorHandler) {
          * If you set this to -1, you disable background updates.  If you don't set
          * a event dispatch interval, then no background updates will be scheduled or occur.
          *
-         * @param interval the interval
+         * @param interval the interval in seconds
          * @return this {@link Builder} instance
          */
         public Builder withEventDispatchInterval(long interval) {

proguard-rules.txt

@@ -20,7 +20,7 @@
 ## https://developers.optimizely.com/x/solutions/sdks/reference/index.html?language=android&platform=mobile#installation
 
 # Optimizely
--keep class com.optimizely.ab.** { *; }
+#-keep class com.optimizely.ab.** { *; }
 
 # Gson
 -keepnames class com.google.gson.Gson

shared/build.gradle

@@ -55,7 +55,6 @@ 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"
     compile group: 'com.google.code.findbugs', name: 'jsr305', version: '2.0.1'
     provided "com.android.support:support-annotations:$support_annotations_ver"
 

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

@@ -0,0 +1,53 @@
+/****************************************************************************
+ * Copyright 2017, Optimizely, Inc. and contributors                   *
+ *                                                                          *
+ * 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                                  *
+ *                                                                          *
+ *    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 com.optimizely.ab.android.shared;
+
+import android.content.Context;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class CachedCounter implements CountingIdlingResourceInterface {
+    private final Cache cache;
+    private final Logger logger = LoggerFactory.getLogger("CachedCounter");
+    private final Context context;
+    private final static String fileName = "OptlyCachedCounterKey";
+    public CachedCounter(Context context) {
+        this.context = context;
+        this.cache = new Cache(context, logger);
+        if (!cache.exists(fileName)) {
+            cache.save(fileName, "0");
+        }
+    }
+
+    synchronized public void increment() {
+        String value = cache.load(fileName);
+        Integer val = Integer.valueOf(value);
+        val += 1;
+        cache.save(fileName, val.toString());
+    }
+
+    synchronized public void decrement() {
+        String value = cache.load(fileName);
+        Integer val = Integer.valueOf(value);
+        if (val == 0) {
+            return;
+        }
+        val -= 1;
+        cache.save(fileName, val.toString());
+    }
+}

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

@@ -0,0 +1,25 @@
+/****************************************************************************
+ * Copyright 2017, Optimizely, Inc. and contributors                        *
+ *                                                                          *
+ * 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                                  *
+ *                                                                          *
+ *    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 com.optimizely.ab.android.shared;
+
+/**
+ * Interface for dealing with Espresso idling counter
+ */
+public interface CountingIdlingResourceInterface {
+    public void increment();
+    public void decrement();
+}

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

@@ -16,65 +16,55 @@
 
 package com.optimizely.ab.android.shared;
 
+import android.content.Context;
 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}
+ * Manages an Espresso like CountingIdlingResource
  */
-@VisibleForTesting
 public class CountingIdlingResourceManager {
 
-    @Nullable private static CountingIdlingResource countingIdlingResource;
+    @Nullable private static CountingIdlingResourceInterface countingIdlingResource;
     @NonNull private static List<Pair<String, String>> eventList = new LinkedList<>();
 
-    @VisibleForTesting
-    @Nullable
-    public static CountingIdlingResource getIdlingResource() {
+    @Nullable public static CountingIdlingResourceInterface getIdlingResource(Context context) {
         if (countingIdlingResource == null) {
-            countingIdlingResource = new CountingIdlingResource("optimizely", true);
+            countingIdlingResource = new CachedCounter(context);
         }
         return countingIdlingResource;
     }
 
-    @VisibleForTesting
-    public static void setIdlingResource(@NonNull CountingIdlingResource countingIdlingResource) {
+    public static void setIdlingResource(@NonNull CountingIdlingResourceInterface 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;
     }

test-app/build.gradle

@@ -24,14 +24,29 @@ android {
         sourceCompatibility JavaVersion.VERSION_1_7
         targetCompatibility JavaVersion.VERSION_1_7
     }
+
+    packagingOptions {
+        exclude 'META-INF/LICENSE.txt'
+        exclude 'META-INF/NOTICE.txt'
+        exclude 'META-INF/LICENSE'
+        exclude 'META-INF/NOTICE'
+    }
 }
 
 dependencies {
     // Includes the Optimizely X Full Stack Java SDK, event handler, and user profile
-    compile project(':android-sdk')
+    compile (project(':android-sdk')) {
+        exclude group: 'com.google.code.gson', module:'gson'
+        exclude group: 'com.noveogroup.android', module:'android-logger'
+    }
     // compile 'com.optimizely.ab:android-sdk:1.0.0'
     compile 'com.android.support:appcompat-v7:24.2.1'
     compile 'com.android.support:design:24.2.1'
+    // EXAMPLE REPLACE noveogroup android-looger with slf4j-android logger
+    // https://mvnrepository.com/artifact/org.slf4j/slf4j-android
+    compile group: 'org.slf4j', name: 'slf4j-android', version: '1.7.7'
+    // EXAMPLE REPLACE gson json parsing with jackson-databind json parsing.
+    compile group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.7.1'
 
     testCompile "junit:junit:$junit_ver"
     testCompile "org.mockito:mockito-core:$mockito_ver"
@@ -50,4 +65,5 @@ dependencies {
     androidTestCompile "com.google.dexmaker:dexmaker-mockito:$dexmaker_ver"
     // androidTestCompile 'com.optimizely.ab:android-sdk:1.0.0'
     androidTestCompile project(':android-sdk')
+    androidTestCompile project(path: ':shared')
 }

test-app/src/androidTest/java/com/optimizely/ab/android/test_app/MainActivityEspressoTest.java

@@ -30,6 +30,7 @@
 
 import com.optimizely.ab.android.datafile_handler.DatafileService;
 import com.optimizely.ab.android.event_handler.EventIntentService;
+import com.optimizely.ab.android.shared.CountingIdlingResourceInterface;
 import com.optimizely.ab.android.shared.CountingIdlingResourceManager;
 import com.optimizely.ab.android.shared.ServiceScheduler;
 import com.optimizely.ab.bucketing.UserProfileService;
@@ -51,6 +52,7 @@
 import static android.support.test.espresso.action.ViewActions.click;
 import static android.support.test.espresso.assertion.ViewAssertions.matches;
 import static android.support.test.espresso.matcher.ViewMatchers.isDisplayed;
+import static android.support.test.espresso.matcher.ViewMatchers.supportsInputMethods;
 import static android.support.test.espresso.matcher.ViewMatchers.withId;
 import static junit.framework.Assert.assertFalse;
 import static junit.framework.Assert.assertNull;
@@ -71,7 +73,19 @@ public class MainActivityEspressoTest {
                 @Override
                 protected void before() throws Throwable {
                     super.before();
-                    countingIdlingResource = CountingIdlingResourceManager.getIdlingResource();
+                    countingIdlingResource = new CountingIdlingResource("optly", true);
+                    CountingIdlingResourceInterface wrapper = new CountingIdlingResourceInterface() {
+                        @Override
+                        public void increment() {
+                            countingIdlingResource.increment();
+                        }
+
+                        @Override
+                        public void decrement() {
+                            countingIdlingResource.decrement();
+                        }
+                    };
+                    CountingIdlingResourceManager.setIdlingResource(wrapper);
                     // To prove that the test fails, omit this call:
                     Espresso.registerIdlingResources(countingIdlingResource);
                 }