BEGIN_PUBLIC

Define isEqualTo for `PersistableBundleSubject`

Defines a brute force `isEqualTo` API for `PersistableBundle` by converting it to a map and taking advantage of the existing `MapSubject`. `PersistableBundle` has historically been very painful to test since they are lazy containers and do not implement equals. While the existing per value subjects are useful, they do not allow for generic comparison in parametrized tests which limits flexibility and results in more boilerplate in unit tests.
END_PUBLIC

PiperOrigin-RevId: 816295120

Author: rayanosseiran

ext/truth/CHANGELOG.md

@@ -10,6 +10,8 @@
 
 * `BundleSubject` and `PersistableBundleSubject` now share `BaseBundle` support,
   including additional array type assertions
+* `PersistableBundleSubject` now supports `isEqualTo` and `isNotEqualTo` for
+  direct comparison between two `PersistableBundle`'s.
 * Added `integerArrayList` method to `BundleSubject`.
 
 **Breaking Changes**

ext/truth/java/androidx/test/ext/truth/api/current_public.txt

@@ -149,7 +149,9 @@ package androidx.test.ext.truth.os {
     method public final com.google.common.truth.PrimitiveIntArraySubject! intArray(String!);
     method public final com.google.common.truth.IntegerSubject! integer(String!);
     method public final void isEmpty();
+    method public void isEqualTo(android.os.PersistableBundle!);
     method public final void isNotEmpty();
+    method public void isNotEqualTo(android.os.PersistableBundle!);
     method public final com.google.common.truth.PrimitiveLongArraySubject! longArray(String!);
     method public final com.google.common.truth.LongSubject! longInt(String!);
     method public androidx.test.ext.truth.os.PersistableBundleSubject! persistableBundle(String!);

ext/truth/java/androidx/test/ext/truth/os/PersistableBundleSubject.java

@@ -21,6 +21,8 @@
 import com.google.common.truth.FailureMetadata;
 import com.google.common.truth.Subject;
 import com.google.common.truth.Truth;
+import java.util.HashMap;
+import java.util.Map;
 
 /**
  * Subject for making assertions about {@link PersistableBundle}s.
@@ -34,6 +36,43 @@ public static PersistableBundleSubject assertThat(PersistableBundle persistableB
     return Truth.assertAbout(persistableBundles()).that(persistableBundle);
   }
 
+  public final void isEqualTo(PersistableBundle other) {
+    // If either are null, just fall back to an equals() comparison.
+    if (actual == null || other == null) {
+      super.isEqualTo(other);
+      return;
+    }
+
+    // PersistableBundle doesn't implement equals() so we convert it to a Map so we can use the
+    // existing Truth implementation.
+    Truth.assertThat(toMap(actual)).isEqualTo(toMap(other));
+  }
+
+  public final void isNotEqualTo(PersistableBundle other) {
+    // If either are null, just fall back to an equals() comparison.
+    if (actual == null || other == null) {
+      super.isNotEqualTo(other);
+      return;
+    }
+
+    // PersistableBundle doesn't implement equals() so we convert it to a Map so we can use the
+    // existing Truth implementation.
+    Truth.assertThat(toMap(actual)).isNotEqualTo(toMap(other));
+  }
+
+  /** Converts the {@link PersistableBundle} to a {@link Map} for comparison. */
+  private final Map<String, Object> toMap(PersistableBundle bundle) {
+    Map<String, Object> map = new HashMap<>();
+    for (String key : bundle.keySet()) {
+      Object value = bundle.get(key);
+      if (value instanceof PersistableBundle) {
+        value = toMap((PersistableBundle) value);
+      }
+      map.put(key, value);
+    }
+    return map;
+  }
+
   public static Subject.Factory<PersistableBundleSubject, PersistableBundle> persistableBundles() {
     return PersistableBundleSubject::new;
   }