ServiceTestRule.startService now verifies that the provided intent actually matched a service.

PiperOrigin-RevId: 751093014

Author: copybara-androidxtest

runner/rules/CHANGELOG.md

@@ -10,6 +10,9 @@
 
 **Breaking Changes**
 
+* `ServiceTestRule.startService` will now throw if the provided intent does not
+  launch a service.
+
 **API Changes**
 
 **Breaking API Changes**

runner/rules/java/androidx/test/rule/ServiceTestRule.java

@@ -120,10 +120,20 @@ public static ServiceTestRule withTimeout(long timeout, TimeUnit timeUnit) {
    *     {@link android.content.Context#startService(Intent) Context.startService (Intent)}.
    * @throws SecurityException if you do not have permission to bind to the given service.
    * @throws TimeoutException if timed out waiting for a successful connection with the service.
+   * @throws IllegalArgumentException if the intent did not resolve to a service
    */
   public void startService(@NonNull Intent intent) throws TimeoutException {
     serviceIntent = Checks.checkNotNull(intent, "intent can't be null");
-    InstrumentationRegistry.getInstrumentation().getTargetContext().startService(serviceIntent);
+    ComponentName componentName =
+        InstrumentationRegistry.getInstrumentation().getTargetContext().startService(serviceIntent);
+    if (componentName == null) {
+      throw new IllegalArgumentException(
+          "Intent "
+              + intent
+              + "did not start a service - this could be triggered by:\n"
+              + "  1. Your service is not declared in the manifest\n"
+              + "  2. The service is not visible to your app, because of package filtering\n");
+    }
     serviceStarted = true;
 
     // bind to the started service to guarantee its started and connected before test execution

runner/rules/javatests/androidx/test/rule/ServiceTestRuleTest.java

@@ -17,11 +17,12 @@
 package androidx.test.rule;
 
 import static androidx.test.core.app.ApplicationProvider.getApplicationContext;
+import static org.hamcrest.CoreMatchers.containsString;
 import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.MatcherAssert.assertThat;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.assertThat;
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
 import static org.junit.runner.JUnitCore.runClasses;
@@ -250,6 +251,22 @@ public void checkServiceTimeoutLogic() {
 
   @Rule public final ServiceTestRule serviceRule = new ServiceTestRule();
 
+  @Test
+  public void verifyFailureIfServiceNotStarted() throws Exception {
+    final class NotDeclaredService extends Service {
+      @Override
+      public IBinder onBind(Intent intent) {
+        return null;
+      }
+    }
+    try {
+      serviceRule.startService(new Intent(getApplicationContext(), NotDeclaredService.class));
+      fail("Should have thrown");
+    } catch (IllegalArgumentException e) {
+      assertThat(e.getMessage(), containsString("did not start a service"));
+    }
+  }
+
   @Test
   public void verifySuccessfulServiceStart() throws TimeoutException {
     serviceRule.startService(new Intent(getApplicationContext(), TestService.class));