001/*
002 * Copyright (C) 2015 The Guava Authors
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.google.common.collect.testing.testers;
018
019import static com.google.common.collect.testing.features.CollectionFeature.KNOWN_ORDER;
020import static com.google.common.collect.testing.features.CollectionSize.ZERO;
021import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_KEYS;
022import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_VALUES;
023import static java.util.Arrays.asList;
024
025import com.google.common.annotations.GwtCompatible;
026import com.google.common.collect.testing.AbstractMapTester;
027import com.google.common.collect.testing.Helpers;
028import com.google.common.collect.testing.features.CollectionFeature;
029import com.google.common.collect.testing.features.CollectionSize;
030import com.google.common.collect.testing.features.MapFeature;
031import java.util.ArrayList;
032import java.util.List;
033import java.util.Map;
034import java.util.Map.Entry;
035import org.junit.Ignore;
036
037/**
038 * A generic JUnit test which tests {@link Map#forEach}. Can't be invoked directly; please see
039 * {@link com.google.common.collect.testing.MapTestSuiteBuilder}.
040 *
041 * @author Louis Wasserman
042 */
043@GwtCompatible
044@Ignore("test runners must not instantiate and run this directly, only via suites we build")
045// @Ignore affects the Android test runner, which respects JUnit 4 annotations on JUnit 3 tests.
046@SuppressWarnings("JUnit4ClassUsedInJUnit3")
047@IgnoreJRERequirement // We opt into library desugaring for our tests.
048public class MapForEachTester<K, V> extends AbstractMapTester<K, V> {
049  @CollectionFeature.Require(KNOWN_ORDER)
050  public void testForEachKnownOrder() {
051    List<Entry<K, V>> entries = new ArrayList<>();
052    getMap().forEach((k, v) -> entries.add(entry(k, v)));
053    assertEquals(getOrderedElements(), entries);
054  }
055
056  @CollectionFeature.Require(absent = KNOWN_ORDER)
057  public void testForEachUnknownOrder() {
058    List<Entry<K, V>> entries = new ArrayList<>();
059    getMap().forEach((k, v) -> entries.add(entry(k, v)));
060    Helpers.assertEqualIgnoringOrder(getSampleEntries(), entries);
061  }
062
063  @MapFeature.Require(ALLOWS_NULL_KEYS)
064  @CollectionSize.Require(absent = ZERO)
065  public void testForEach_nullKeys() {
066    initMapWithNullKey();
067    List<Entry<K, V>> expectedEntries = asList(createArrayWithNullKey());
068    List<Entry<K, V>> entries = new ArrayList<>();
069    getMap().forEach((k, v) -> entries.add(entry(k, v)));
070    Helpers.assertEqualIgnoringOrder(expectedEntries, entries);
071  }
072
073  @MapFeature.Require(ALLOWS_NULL_VALUES)
074  @CollectionSize.Require(absent = ZERO)
075  public void testForEach_nullValues() {
076    initMapWithNullValue();
077    List<Entry<K, V>> expectedEntries = asList(createArrayWithNullValue());
078    List<Entry<K, V>> entries = new ArrayList<>();
079    getMap().forEach((k, v) -> entries.add(entry(k, v)));
080    Helpers.assertEqualIgnoringOrder(expectedEntries, entries);
081  }
082}