Bug 1034509 - Fix timing issue in testDistribution. r=nalexander

mobile/android/base/distribution/ReferrerReceiver.java

@@ -9,10 +9,12 @@ import org.json.JSONException;
 import org.json.JSONObject;
 import org.mozilla.gecko.GeckoAppShell;
 import org.mozilla.gecko.GeckoEvent;
+import org.mozilla.gecko.mozglue.RobocopTarget;
 
 import android.content.BroadcastReceiver;
 import android.content.Context;
 import android.content.Intent;
+import android.support.v4.content.LocalBroadcastManager;
 import android.text.TextUtils;
 import android.util.Log;
 
@@ -21,6 +23,10 @@ public class ReferrerReceiver extends BroadcastReceiver {
 
     private static final String ACTION_INSTALL_REFERRER = "com.android.vending.INSTALL_REFERRER";
 
+    // Sent when we're done.
+    @RobocopTarget
+    public static final String ACTION_REFERRER_RECEIVED = "org.mozilla.fennec.REFERRER_RECEIVED";
+
     /**
      * If the install intent has this source, we'll track the campaign ID.
      */
@@ -52,6 +58,10 @@ public class ReferrerReceiver extends BroadcastReceiver {
         if (TextUtils.equals(referrer.source, MOZILLA_UTM_SOURCE)) {
             propagateMozillaCampaign(referrer);
         }
+
+        // Broadcast a secondary, local intent to allow test code to respond.
+        final Intent receivedIntent = new Intent(ACTION_REFERRER_RECEIVED);
+        LocalBroadcastManager.getInstance(context).sendBroadcast(receivedIntent);
     }
 
 

mobile/android/base/tests/testDistribution.java

@@ -17,13 +17,17 @@ import org.mozilla.gecko.AppConstants;
 import org.mozilla.gecko.db.BrowserContract;
 import org.mozilla.gecko.distribution.Distribution;
 import org.mozilla.gecko.distribution.ReferrerDescriptor;
+import org.mozilla.gecko.distribution.ReferrerReceiver;
 import org.mozilla.gecko.mozglue.RobocopTarget;
 import org.mozilla.gecko.util.ThreadUtils;
 
 import android.app.Activity;
+import android.content.BroadcastReceiver;
 import android.content.Context;
 import android.content.Intent;
+import android.content.IntentFilter;
 import android.content.SharedPreferences;
+import android.support.v4.content.LocalBroadcastManager;
 import android.util.Log;
 
 /**
@@ -139,41 +143,65 @@ public class testDistribution extends ContentProviderTest {
         doTestInvalidReferrerIntent();
     }
 
+    private void doReferrerTest(String ref, final TestableDistribution distribution, final Runnable distributionReady) throws InterruptedException {
+        final Intent intent = new Intent(ACTION_INSTALL_REFERRER);
+        intent.setClassName(AppConstants.ANDROID_PACKAGE_NAME, CLASS_REFERRER_RECEIVER);
+        intent.putExtra("referrer", ref);
+
+        final BroadcastReceiver receiver = new BroadcastReceiver() {
+            @Override
+            public void onReceive(Context context, Intent intent) {
+                Log.i(LOGTAG, "Test received " + intent.getAction());
+
+                ThreadUtils.postToBackgroundThread(new Runnable() {
+                    @Override
+                    public void run() {
+                        distribution.addOnDistributionReadyCallback(distributionReady);
+                        distribution.go();
+                    }
+                });
+            }
+        };
+
+        IntentFilter intentFilter = new IntentFilter(ReferrerReceiver.ACTION_REFERRER_RECEIVED);
+        final LocalBroadcastManager localBroadcastManager = LocalBroadcastManager.getInstance(mActivity);
+        localBroadcastManager.registerReceiver(receiver, intentFilter);
+
+        Log.i(LOGTAG, "Broadcasting referrer intent.");
+        try {
+            mActivity.sendBroadcast(intent, null);
+            synchronized (distribution) {
+                distribution.wait(WAIT_TIMEOUT_MSEC);
+            }
+        } finally {
+            localBroadcastManager.unregisterReceiver(receiver);
+        }
+    }
+
     public void doTestValidReferrerIntent() throws Exception {
-        // Send the faux-download intent.
         // Equivalent to
         // am broadcast -a com.android.vending.INSTALL_REFERRER \
         //              -n org.mozilla.fennec/org.mozilla.gecko.distribution.ReferrerReceiver \
         //              --es "referrer" "utm_source=mozilla&utm_medium=testmedium&utm_term=testterm&utm_content=testcontent&utm_campaign=distribution"
         final String ref = "utm_source=mozilla&utm_medium=testmedium&utm_term=testterm&utm_content=testcontent&utm_campaign=distribution";
-        final Intent intent = new Intent(ACTION_INSTALL_REFERRER);
-        intent.setClassName(AppConstants.ANDROID_PACKAGE_NAME, CLASS_REFERRER_RECEIVER);
-        intent.putExtra("referrer", ref);
-        mActivity.sendBroadcast(intent);
-
-        // Wait for the intent to be processed.
         final TestableDistribution distribution = new TestableDistribution(mActivity);
-
+        final Runnable distributionReady = new Runnable() {
-        final Object wait = new Object();
-        distribution.addOnDistributionReadyCallback(new Runnable() {
             @Override
             public void run() {
+                Log.i(LOGTAG, "Test told distribution is ready.");
                 mAsserter.ok(!distribution.exists(), "Not processed.", "No download because we're offline.");
                 ReferrerDescriptor referrerValue = TestableDistribution.getReferrerDescriptorForTesting();
                 mAsserter.dumpLog("Referrer was " + referrerValue);
                 mAsserter.is(referrerValue.content, "testcontent", "Referrer content");
                 mAsserter.is(referrerValue.medium, "testmedium", "Referrer medium");
                 mAsserter.is(referrerValue.campaign, "distribution", "Referrer campaign");
-                synchronized (wait) {
+                synchronized (distribution) {
-                    wait.notifyAll();
+                    distribution.notifyAll();
                 }
             }
-        });
+        };
 
-        distribution.go();
+        doReferrerTest(ref, distribution, distributionReady);
-        synchronized (wait) {
-            wait.wait(WAIT_TIMEOUT_MSEC);
-        }
     }
 
     /**
@@ -182,37 +210,25 @@ public class testDistribution extends ContentProviderTest {
      * even if we *do* include it in a Campaign:Set message.
      */
     public void doTestInvalidReferrerIntent() throws Exception {
-        // Send the faux-download intent.
         // Equivalent to
         // am broadcast -a com.android.vending.INSTALL_REFERRER \
         //              -n org.mozilla.fennec/org.mozilla.gecko.distribution.ReferrerReceiver \
         //              --es "referrer" "utm_source=mozilla&utm_medium=testmedium&utm_term=testterm&utm_content=testcontent&utm_campaign=testname"
         final String ref = "utm_source=mozilla&utm_medium=testmedium&utm_term=testterm&utm_content=testcontent&utm_campaign=testname";
-        final Intent intent = new Intent(ACTION_INSTALL_REFERRER);
-        intent.setClassName(AppConstants.ANDROID_PACKAGE_NAME, CLASS_REFERRER_RECEIVER);
-        intent.putExtra("referrer", ref);
-        mActivity.sendBroadcast(intent);
-
-        // Wait for the intent to be processed.
         final TestableDistribution distribution = new TestableDistribution(mActivity);
-
+        final Runnable distributionReady = new Runnable() {
-        final Object wait = new Object();
-        distribution.addOnDistributionReadyCallback(new Runnable() {
             @Override
             public void run() {
                 mAsserter.ok(!distribution.exists(), "Not processed.", "No download because campaign was wrong.");
                 ReferrerDescriptor referrerValue = TestableDistribution.getReferrerDescriptorForTesting();
                 mAsserter.is(referrerValue, null, "No referrer.");
-                synchronized (wait) {
+                synchronized (distribution) {
-                    wait.notifyAll();
+                    distribution.notifyAll();
                 }
             }
-        });
+        };
 
-        distribution.go();
+        doReferrerTest(ref, distribution, distributionReady);
-        synchronized (wait) {
-            wait.wait(WAIT_TIMEOUT_MSEC);
-        }
     }
 
     // Initialize the distribution from the mock package.

mobile/android/base/util/ThreadUtils.java

@@ -154,10 +154,16 @@ public final class ThreadUtils {
             return;
         }
 
-        final String message = "Expected thread " +
+        final String message;
-                               expectedThreadId + " (\"" + expectedThread.getName() +
+        if (expected) {
-                               "\"), but running on thread " +
+            message = "Expected thread " + expectedThreadId +
-                               currentThreadId + " (\"" + currentThread.getName() + ")";
+                      " (\"" + expectedThread.getName() + "\"), but running on thread " +
+                      currentThreadId + " (\"" + currentThread.getName() + "\")";
+        } else {
+            message = "Expected anything but " + expectedThreadId +
+                      " (\"" + expectedThread.getName() + "\"), but running there.";
+        }
+
         final IllegalThreadStateException e = new IllegalThreadStateException(message);
 
         switch (behavior) {