Move ShardingFilter to androidx.test.filters.

PiperOrigin-RevId: 831630355

Author: brettchabot

runner/android_junit_runner/java/androidx/test/BUILD

@@ -60,6 +60,7 @@ java_library(
         "//visibility:public",
     ],
     deps = [
+        "//opensource:androidsdk_compiletime",
         "//opensource/androidx:annotation",
         "@maven//:junit_junit",
     ],

runner/android_junit_runner/java/androidx/test/filters/SdkSuppressFilter.java

@@ -0,0 +1,60 @@
+package androidx.test.filters;
+
+import android.os.Build.VERSION;
+import androidx.annotation.Nullable;
+import androidx.annotation.RestrictTo;
+import androidx.annotation.RestrictTo.Scope;
+import java.util.Objects;
+import org.junit.runner.Description;
+
+/**
+ * A JUnit {@link Filter} that implements SdkSuppress annotation based filtering.
+ *
+ * @hide
+ */
+@RestrictTo(Scope.LIBRARY)
+public final class SdkSuppressFilter extends AbstractFilter {
+
+  @Override
+  protected boolean evaluateTest(Description description) {
+    final SdkSuppress sdkSuppress = getAnnotationForTest(description);
+    if (sdkSuppress != null) {
+      if ((VERSION.SDK_INT >= sdkSuppress.minSdkVersion()
+              && VERSION.SDK_INT <= sdkSuppress.maxSdkVersion()
+              && !isInExcludedSdks(sdkSuppress.excludedSdks()))
+          || Objects.equals(sdkSuppress.codeName(), VERSION.CODENAME)) {
+        return true; // run the test
+      }
+      return false; // don't run the test
+    }
+    return true; // no SdkSuppress, run the test
+  }
+
+  @Nullable
+  private SdkSuppress getAnnotationForTest(Description description) {
+    final SdkSuppress s = description.getAnnotation(SdkSuppress.class);
+    if (s != null) {
+      return s;
+    }
+    final Class<?> testClass = description.getTestClass();
+    if (testClass != null) {
+      return testClass.getAnnotation(SdkSuppress.class);
+    }
+    return null;
+  }
+
+  /** {@inheritDoc} */
+  @Override
+  public String describe() {
+    return "skip tests annotated with SdkSuppress if necessary";
+  }
+
+  private boolean isInExcludedSdks(int[] excludedSdks) {
+    for (int sdk : excludedSdks) {
+      if (sdk == VERSION.SDK_INT) {
+        return true;
+      }
+    }
+    return false;
+  }
+}

runner/android_junit_runner/java/androidx/test/filters/ShardingFilter.java

@@ -0,0 +1,40 @@
+package androidx.test.filters;
+
+import androidx.annotation.RestrictTo;
+import androidx.annotation.RestrictTo.Scope;
+import org.junit.runner.Description;
+import org.junit.runner.manipulation.Filter;
+
+/**
+ * A JUnit sharding filter uses the hashcode of the test description to assign it to a shard.
+ *
+ * @hide
+ */
+@RestrictTo(Scope.LIBRARY)
+public class ShardingFilter extends Filter {
+  private final int numShards;
+  private final int shardIndex;
+
+  public ShardingFilter(int numShards, int shardIndex) {
+    this.numShards = numShards;
+    this.shardIndex = shardIndex;
+  }
+
+  @Override
+  public boolean shouldRun(Description description) {
+    if (description.isTest()) {
+      return (Math.floorMod(description.hashCode(), numShards)) == shardIndex;
+    }
+
+    // The description is a suite, so assume that it can be run so that filtering is
+    // applied to its children. If after filtering it has no children then it will be
+    // automatically filtered out.
+    return true;
+  }
+
+  /** {@inheritDoc} */
+  @Override
+  public String describe() {
+    return String.format("Shard %d of %d shards", shardIndex, numShards);
+  }
+}

runner/android_junit_runner/java/androidx/test/internal/runner/TestRequestBuilder.java

@@ -17,20 +17,21 @@
 package androidx.test.internal.runner;
 
 import android.app.Instrumentation;
+import android.os.Build;
 import android.os.Bundle;
 import android.util.Log;
 import androidx.annotation.VisibleForTesting;
 import androidx.test.filters.AbstractFilter;
 import androidx.test.filters.CustomFilter;
 import androidx.test.filters.RequiresDevice;
-import androidx.test.filters.SdkSuppress;
+import androidx.test.filters.SdkSuppressFilter;
+import androidx.test.filters.ShardingFilter;
 import androidx.test.filters.TestsRegExFilter;
 import androidx.test.internal.runner.ClassPathScanner.ChainedClassNameFilter;
 import androidx.test.internal.runner.ClassPathScanner.ExcludeClassNamesFilter;
 import androidx.test.internal.runner.ClassPathScanner.ExcludePackageNameFilter;
 import androidx.test.internal.runner.ClassPathScanner.ExternalClassNameFilter;
 import androidx.test.internal.runner.ClassPathScanner.InclusivePackageNamesFilter;
-import androidx.test.internal.util.Checks;
 import androidx.tracing.Trace;
 import java.io.IOException;
 import java.lang.annotation.Annotation;
@@ -84,7 +85,6 @@ public class TestRequestBuilder {
           .intersect(new CustomFilters());
   private List<Class<? extends RunnerBuilder>> customRunnerBuilderClasses = new ArrayList<>();
   private boolean skipExecution = false;
-  private final DeviceBuild deviceBuild;
   private long perTestTimeout = 0;
   private ClassLoader classLoader;
 
@@ -96,39 +96,6 @@ public class TestRequestBuilder {
    */
   private boolean ignoreSuiteMethods = false;
 
-  /**
-   * Accessor interface for retrieving device build properties.
-   *
-   * <p>Used so unit tests can mock calls
-   */
-  interface DeviceBuild {
-    /** Returns the SDK API level for current device. */
-    int getSdkVersionInt();
-
-    /** Returns the hardware type of the current device. */
-    String getHardware();
-
-    /** Returns the version code name of the current device. */
-    String getCodeName();
-  }
-
-  private static class DeviceBuildImpl implements DeviceBuild {
-    @Override
-    public int getSdkVersionInt() {
-      return android.os.Build.VERSION.SDK_INT;
-    }
-
-    @Override
-    public String getHardware() {
-      return android.os.Build.HARDWARE;
-    }
-
-    @Override
-    public String getCodeName() {
-      return android.os.Build.VERSION.CODENAME;
-    }
-  }
-
   /** Filter that only runs tests whose method or class has been annotated with given filter. */
   private static class AnnotationInclusionFilter extends AbstractFilter {
 
@@ -277,42 +244,6 @@ public String describe() {
     }
   }
 
-  private class SdkSuppressFilter extends AbstractFilter {
-
-    @Override
-    protected boolean evaluateTest(Description description) {
-      final SdkSuppress sdkSuppress = getAnnotationForTest(description);
-      if (sdkSuppress != null) {
-        if ((getDeviceSdkInt() >= sdkSuppress.minSdkVersion()
-                && getDeviceSdkInt() <= sdkSuppress.maxSdkVersion()
-                && !isInExcludedSdks(sdkSuppress.excludedSdks()))
-            || getDeviceCodeName().equals(sdkSuppress.codeName())) {
-          return true; // run the test
-        }
-        return false; // don't run the test
-      }
-      return true; // no SdkSuppress, run the test
-    }
-
-    private SdkSuppress getAnnotationForTest(Description description) {
-      final SdkSuppress s = description.getAnnotation(SdkSuppress.class);
-      if (s != null) {
-        return s;
-      }
-      final Class<?> testClass = description.getTestClass();
-      if (testClass != null) {
-        return testClass.getAnnotation(SdkSuppress.class);
-      }
-      return null;
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public String describe() {
-      return String.format("skip tests annotated with SdkSuppress if necessary");
-    }
-  }
-
   /** Class that filters out tests annotated with {@link RequiresDevice} when running on emulator */
   @VisibleForTesting
   class RequiresDeviceFilter extends AnnotationExclusionFilter {
@@ -335,7 +266,7 @@ class RequiresDeviceFilter extends AnnotationExclusionFilter {
     protected boolean evaluateTest(Description description) {
       if (!super.evaluateTest(description)) {
         // annotation is present - check if device is an emulator
-        return !emulatorHardwareNames.contains(getDeviceHardware());
+        return !emulatorHardwareNames.contains(Build.HARDWARE);
       }
       return true;
     }
@@ -347,34 +278,6 @@ public String describe() {
     }
   }
 
-  private static class ShardingFilter extends Filter {
-    private final int numShards;
-    private final int shardIndex;
-
-    ShardingFilter(int numShards, int shardIndex) {
-      this.numShards = numShards;
-      this.shardIndex = shardIndex;
-    }
-
-    @Override
-    public boolean shouldRun(Description description) {
-      if (description.isTest()) {
-        return (Math.abs(description.hashCode()) % numShards) == shardIndex;
-      }
-
-      // The description is a suite, so assume that it can be run so that filtering is
-      // applied to its children. If after filtering it has no children then it will be
-      // automatically filtered out.
-      return true;
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public String describe() {
-      return String.format("Shard %s of %s shards", shardIndex, numShards);
-    }
-  }
-
   /**
    * A {@link Request} that doesn't report an error if all tests are filtered out. Done for
    * consistency with InstrumentationTestRunner.
@@ -536,18 +439,10 @@ public TestRequestBuilder(Instrumentation instr, Bundle bundle) {
 
   /** Creates a TestRequestBuilder */
   public TestRequestBuilder() {
-    this(new DeviceBuildImpl());
-  }
-
-  /** Alternate TestRequestBuilder constructor that accepts a custom DeviceBuild */
-  @VisibleForTesting
-  TestRequestBuilder(DeviceBuild deviceBuildAccessor) {
-    deviceBuild = Checks.checkNotNull(deviceBuildAccessor);
-
     maybeAddLegacySuppressFilter();
   }
 
-  // add legacy Suppress filer iff it is on classpath
+  // add legacy Suppress filter iff it is on classpath
   private void maybeAddLegacySuppressFilter() {
     try {
       Class<? extends Annotation> legacySuppressClass =
@@ -929,25 +824,4 @@ private Class<? extends Annotation> loadAnnotationClass(String className) {
     }
     return null;
   }
-
-  private int getDeviceSdkInt() {
-    return deviceBuild.getSdkVersionInt();
-  }
-
-  private String getDeviceHardware() {
-    return deviceBuild.getHardware();
-  }
-
-  private String getDeviceCodeName() {
-    return deviceBuild.getCodeName();
-  }
-
-  private boolean isInExcludedSdks(int[] excludedSdks) {
-    for (int sdk : excludedSdks) {
-      if (sdk == getDeviceSdkInt()) {
-        return true;
-      }
-    }
-    return false;
-  }
 }