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.CollectionSize.ZERO;
020import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_KEYS;
021import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_VALUES;
022import static com.google.common.collect.testing.features.MapFeature.SUPPORTS_PUT;
023
024import com.google.common.annotations.GwtCompatible;
025import com.google.common.collect.testing.AbstractMapTester;
026import com.google.common.collect.testing.features.CollectionSize;
027import com.google.common.collect.testing.features.MapFeature;
028import com.google.errorprone.annotations.CanIgnoreReturnValue;
029import java.util.Map.Entry;
030import java.util.concurrent.ConcurrentMap;
031import org.junit.Ignore;
032
033/**
034 * A generic JUnit test which tests {@code putIfAbsent} operations on a concurrent map. Can't be
035 * invoked directly; please see {@link
036 * com.google.common.collect.testing.ConcurrentMapTestSuiteBuilder}.
037 *
038 * @author Louis Wasserman
039 */
040@GwtCompatible
041@Ignore // Affects only Android test runner, which respects JUnit 4 annotations on JUnit 3 tests.
042public class ConcurrentMapPutIfAbsentTester<K, V> extends AbstractMapTester<K, V> {
043  @Override
044  protected ConcurrentMap<K, V> getMap() {
045    return (ConcurrentMap<K, V>) super.getMap();
046  }
047
048  @MapFeature.Require(SUPPORTS_PUT)
049  public void testPutIfAbsent_supportedAbsent() {
050    assertNull("putIfAbsent(notPresent, value) should return null", putIfAbsent(e3()));
051    expectAdded(e3());
052  }
053
054  @MapFeature.Require(SUPPORTS_PUT)
055  @CollectionSize.Require(absent = ZERO)
056  public void testPutIfAbsent_supportedPresent() {
057    assertEquals(
058        "putIfAbsent(present, value) should return existing value",
059        v0(),
060        getMap().putIfAbsent(k0(), v3()));
061    expectUnchanged();
062  }
063
064  @MapFeature.Require(absent = SUPPORTS_PUT)
065  public void testPutIfAbsent_unsupportedAbsent() {
066    try {
067      putIfAbsent(e3());
068      fail("putIfAbsent(notPresent, value) should throw");
069    } catch (UnsupportedOperationException expected) {
070    }
071    expectUnchanged();
072    expectMissing(e3());
073  }
074
075  @MapFeature.Require(absent = SUPPORTS_PUT)
076  @CollectionSize.Require(absent = ZERO)
077  public void testPutIfAbsent_unsupportedPresentExistingValue() {
078    try {
079      assertEquals(
080          "putIfAbsent(present, existingValue) should return present or throw",
081          v0(),
082          putIfAbsent(e0()));
083    } catch (UnsupportedOperationException tolerated) {
084    }
085    expectUnchanged();
086  }
087
088  @MapFeature.Require(absent = SUPPORTS_PUT)
089  @CollectionSize.Require(absent = ZERO)
090  public void testPutIfAbsent_unsupportedPresentDifferentValue() {
091    try {
092      getMap().putIfAbsent(k0(), v3());
093    } catch (UnsupportedOperationException tolerated) {
094    }
095    expectUnchanged();
096  }
097
098  @MapFeature.Require(value = SUPPORTS_PUT, absent = ALLOWS_NULL_KEYS)
099  public void testPutIfAbsent_nullKeyUnsupported() {
100    try {
101      getMap().putIfAbsent(null, v3());
102      fail("putIfAbsent(null, value) should throw");
103    } catch (NullPointerException expected) {
104    }
105    expectUnchanged();
106    expectNullKeyMissingWhenNullKeysUnsupported(
107        "Should not contain null key after unsupported putIfAbsent(null, value)");
108  }
109
110  @MapFeature.Require(value = SUPPORTS_PUT, absent = ALLOWS_NULL_VALUES)
111  public void testPutIfAbsent_nullValueUnsupported() {
112    try {
113      getMap().putIfAbsent(k3(), null);
114      fail("putIfAbsent(key, null) should throw");
115    } catch (NullPointerException expected) {
116    }
117    expectUnchanged();
118    expectNullValueMissingWhenNullValuesUnsupported(
119        "Should not contain null value after unsupported put(key, null)");
120  }
121
122  @MapFeature.Require(value = SUPPORTS_PUT, absent = ALLOWS_NULL_VALUES)
123  @CollectionSize.Require(absent = ZERO)
124  public void testPutIfAbsent_putWithNullValueUnsupported() {
125    try {
126      getMap().putIfAbsent(k0(), null);
127    } catch (NullPointerException tolerated) {
128    }
129    expectUnchanged();
130    expectNullValueMissingWhenNullValuesUnsupported(
131        "Should not contain null after unsupported putIfAbsent(present, null)");
132  }
133
134  @CanIgnoreReturnValue
135  private V putIfAbsent(Entry<K, V> entry) {
136    return getMap().putIfAbsent(entry.getKey(), entry.getValue());
137  }
138}