Augment the matcher that allows the user to match the entries of a map with a convenience factory method which takes a variable number of matchers for individual map entries

tomwhoiscontrary · tomwhoiscontrary · commit 1de3808afb20 · 2015-10-31T23:33:15.000Z
diff --git a/hamcrest-library/src/main/java/org/hamcrest/Matchers.java b/hamcrest-library/src/main/java/org/hamcrest/Matchers.java
@@ -1079,6 +1079,20 @@ public static <K, V> org.hamcrest.Matcher<java.util.Map<? extends K,? extends V>
     return org.hamcrest.collection.IsMapWithEntries.hasEntries(entriesMatcher);
   }
 
+  /**
+   * Creates a matcher for {@link java.util.Map}s matching when the examined {@link java.util.Map}'s set of entries
+   * contains, in any order, entries satisfying the specified <code>entriesMatchers</code>.
+   * For example:
+   * <pre>assertThat(myMap, hasEntries(entry("a key"), entry("another key")))</pre>
+   *
+   * @param entriesMatchers
+   *     the matchers that must be satisfied by the entries
+   */
+  @SafeVarargs
+  public static <K, V> Matcher<java.util.Map<? extends K, ? extends V>> hasEntries(Matcher<? super java.util.Map.Entry<? extends K, ? extends V>>... entriesMatchers) {
+    return org.hamcrest.collection.IsMapWithEntries.hasEntries(entriesMatchers);
+  }
+
   /**
    * Creates a matcher for {@link java.util.Map.Entry}s matching when the examined {@link java.util.Map.Entry} has a key which satisfies
    * the specified <code>keyMatcher</code>, and a value which satisfies the specified <code>valueMatcher</code>.
diff --git a/hamcrest-library/src/main/java/org/hamcrest/collection/IsMapWithEntries.java b/hamcrest-library/src/main/java/org/hamcrest/collection/IsMapWithEntries.java
@@ -30,4 +30,18 @@ public IsMapWithEntries(Matcher<? super Set<? extends Map.Entry<? extends K, ? e
         return new IsMapWithEntries<>(entriesMatcher);
     }
 
+    /**
+     * Creates a matcher for {@link Map}s matching when the examined {@link Map}'s set of entries
+     * contains, in any order, entries satisfying the specified <code>entriesMatchers</code>.
+     * For example:
+     * <pre>assertThat(myMap, hasEntries(entry("a key"), entry("another key")))</pre>
+     *
+     * @param entriesMatchers
+     *     the matchers that must be satisfied by the entries
+     */
+    @SafeVarargs
+    public static <K, V> Matcher<Map<? extends K, ? extends V>> hasEntries(Matcher<? super Map.Entry<? extends K, ? extends V>>... entriesMatchers) {
+        return new IsMapWithEntries<>(IsIterableContainingInAnyOrder.containsInAnyOrder(entriesMatchers));
+    }
+
 }
diff --git a/hamcrest-library/src/test/java/org/hamcrest/collection/IsMapWithEntriesTest.java b/hamcrest-library/src/test/java/org/hamcrest/collection/IsMapWithEntriesTest.java
@@ -5,7 +5,10 @@
 import org.hamcrest.Matchers;
 
 import java.util.Collections;
+import java.util.LinkedHashMap;
+import java.util.Map;
 
+import static org.hamcrest.collection.IsMapEntry.entry;
 import static org.hamcrest.collection.IsMapWithEntries.hasEntries;
 
 public class IsMapWithEntriesTest extends AbstractMatcherTest {
@@ -31,4 +34,13 @@ public void testHasReadableDescription() {
         assertDescription("a map with entries an empty collection", hasEntries(Matchers.empty()));
     }
 
+    public void testMatchesANumberOfExplicitEntriesInAnyOrder() {
+        Map<String, Integer> map = new LinkedHashMap<>();
+        map.put("c", 3);
+        map.put("b", 2);
+        map.put("a", 1);
+
+        assertMatches(hasEntries(entry("a", Matchers.equalTo(1)), entry("b", Matchers.equalTo(2)), entry("c", Matchers.equalTo(3))), map);
+    }
+
 }
