001/*
002 * Copyright (C) 2007 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.ALLOWS_NULL_VALUES;
020import static com.google.common.collect.testing.features.CollectionFeature.FAILS_FAST_ON_CONCURRENT_MODIFICATION;
021import static com.google.common.collect.testing.features.CollectionFeature.RESTRICTS_ELEMENTS;
022import static com.google.common.collect.testing.features.CollectionFeature.SUPPORTS_ADD;
023import static com.google.common.collect.testing.features.CollectionSize.ZERO;
024
025import com.google.common.annotations.GwtCompatible;
026import com.google.common.annotations.GwtIncompatible;
027import com.google.common.annotations.J2ktIncompatible;
028import com.google.common.collect.testing.AbstractCollectionTester;
029import com.google.common.collect.testing.Helpers;
030import com.google.common.collect.testing.features.CollectionFeature;
031import com.google.common.collect.testing.features.CollectionSize;
032import java.lang.reflect.Method;
033import java.util.ConcurrentModificationException;
034import java.util.Iterator;
035import org.junit.Ignore;
036
037/**
038 * A generic JUnit test which tests {@code add} operations on a collection. Can't be invoked
039 * directly; please see {@link com.google.common.collect.testing.CollectionTestSuiteBuilder}.
040 *
041 * @author Chris Povirk
042 * @author Kevin Bourrillion
043 */
044@GwtCompatible(emulated = true)
045@Ignore // Affects only Android test runner, which respects JUnit 4 annotations on JUnit 3 tests.
046@SuppressWarnings("JUnit4ClassUsedInJUnit3")
047public class CollectionAddTester<E> extends AbstractCollectionTester<E> {
048  @CollectionFeature.Require(SUPPORTS_ADD)
049  public void testAdd_supportedNotPresent() {
050    assertTrue("add(notPresent) should return true", collection.add(e3()));
051    expectAdded(e3());
052  }
053
054  @CollectionFeature.Require(absent = SUPPORTS_ADD)
055  public void testAdd_unsupportedNotPresent() {
056    try {
057      collection.add(e3());
058      fail("add(notPresent) should throw");
059    } catch (UnsupportedOperationException expected) {
060    }
061    expectUnchanged();
062    expectMissing(e3());
063  }
064
065  @CollectionFeature.Require(absent = SUPPORTS_ADD)
066  @CollectionSize.Require(absent = ZERO)
067  public void testAdd_unsupportedPresent() {
068    try {
069      assertFalse("add(present) should return false or throw", collection.add(e0()));
070    } catch (UnsupportedOperationException tolerated) {
071    }
072    expectUnchanged();
073  }
074
075  @CollectionFeature.Require(
076      value = {SUPPORTS_ADD, ALLOWS_NULL_VALUES},
077      absent = RESTRICTS_ELEMENTS)
078  public void testAdd_nullSupported() {
079    assertTrue("add(null) should return true", collection.add(null));
080    expectAdded((E) null);
081  }
082
083  @CollectionFeature.Require(value = SUPPORTS_ADD, absent = ALLOWS_NULL_VALUES)
084  public void testAdd_nullUnsupported() {
085    try {
086      collection.add(null);
087      fail("add(null) should throw");
088    } catch (NullPointerException expected) {
089    }
090    expectUnchanged();
091    expectNullMissingWhenNullUnsupported("Should not contain null after unsupported add(null)");
092  }
093
094  @CollectionFeature.Require({SUPPORTS_ADD, FAILS_FAST_ON_CONCURRENT_MODIFICATION})
095  @CollectionSize.Require(absent = ZERO)
096  public void testAddConcurrentWithIteration() {
097    try {
098      Iterator<E> iterator = collection.iterator();
099      assertTrue(collection.add(e3()));
100      iterator.next();
101      fail("Expected ConcurrentModificationException");
102    } catch (ConcurrentModificationException expected) {
103      // success
104    }
105  }
106
107  /**
108   * Returns the {@link Method} instance for {@link #testAdd_nullSupported()} so that tests of
109   * {@link java.util.Collections#checkedCollection(java.util.Collection, Class)} can suppress it
110   * with {@code FeatureSpecificTestSuiteBuilder.suppressing()} until <a
111   * href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6409434">Sun bug 6409434</a> is fixed.
112   * It's unclear whether nulls were to be permitted or forbidden, but presumably the eventual fix
113   * will be to permit them, as it seems more likely that code would depend on that behavior than on
114   * the other. Thus, we say the bug is in add(), which fails to support null.
115   */
116  @J2ktIncompatible
117  @GwtIncompatible // reflection
118  public static Method getAddNullSupportedMethod() {
119    return Helpers.getMethod(CollectionAddTester.class, "testAdd_nullSupported");
120  }
121
122  /**
123   * Returns the {@link Method} instance for {@link #testAdd_nullSupported()} so that tests of
124   * {@link java.util.TreeSet} can suppress it with {@code
125   * FeatureSpecificTestSuiteBuilder.suppressing()} until <a
126   * href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=5045147">Sun bug 5045147</a> is fixed.
127   */
128  @J2ktIncompatible
129  @GwtIncompatible // reflection
130  public static Method getAddNullUnsupportedMethod() {
131    return Helpers.getMethod(CollectionAddTester.class, "testAdd_nullUnsupported");
132  }
133
134  /**
135   * Returns the {@link Method} instance for {@link #testAdd_unsupportedNotPresent()} so that tests
136   * can suppress it with {@code FeatureSpecificTestSuiteBuilder.suppressing()} while we figure out
137   * what to do with <a
138   * href="https://github.com/openjdk/jdk/blob/c25c4896ad9ef031e3cddec493aef66ff87c48a7/src/java.base/share/classes/java/util/concurrent/ConcurrentHashMap.java#L4830">{@code
139   * ConcurrentHashMap} support for {@code entrySet().add()}</a>.
140   */
141  @J2ktIncompatible
142  @GwtIncompatible // reflection
143  public static Method getAddUnsupportedNotPresentMethod() {
144    return Helpers.getMethod(CollectionAddTester.class, "testAdd_unsupportedNotPresent");
145  }
146}