HashBagTest.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.collections4.bag;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;

import java.io.InvalidObjectException;

import org.apache.commons.collections4.Bag;
import org.junit.jupiter.api.Test;

/**
 * Extension of {@link AbstractBagTest} for exercising the {@link HashBag}
 * implementation.
 */
public class HashBagTest<T> extends AbstractBagTest<T> {

    @Override
    public String getCompatibilityVersion() {
        return "4";
    }

    @Override
    protected int getIterationBehaviour() {
        return UNORDERED;
    }

    @Override
    public Bag<T> makeObject() {
        return new HashBag<>();
    }

    @Test
    void testAddClampsCountAndSizeToIntegerMaxValue() {
        final HashBag<String> bag = new HashBag<>();
        bag.add("X", Integer.MAX_VALUE - 1);
        bag.add("Y", Integer.MAX_VALUE - 1);
        assertEquals(Integer.MAX_VALUE, bag.size());
        bag.add("X", 10);
        assertEquals(Integer.MAX_VALUE, bag.getCount("X"));
        assertEquals(Integer.MAX_VALUE, bag.size());
        assertEquals(2, bag.uniqueSet().size());
        // true size is 2 * Integer.MAX_VALUE - 11 after this, so size() must stay saturated
        bag.remove("X", 10);
        assertEquals(Integer.MAX_VALUE - 10, bag.getCount("X"));
        assertEquals(Integer.MAX_VALUE, bag.size());
        // size() only drops below Integer.MAX_VALUE once the true size does
        bag.remove("Y");
        assertEquals(Integer.MAX_VALUE - 10, bag.size());
    }

    @Test
    void testDeserializeRejectsNonPositiveCount() throws Exception {
        final int marker = 0x11223344;
        final HashBag<String> bag = new HashBag<>();
        bag.add("X", marker);
        final byte[] byteArray = serialize(bag);
        for (final int count : new int[] { 0, -7 }) {
            final byte[] bytes = byteArray.clone();
            replaceInt(bytes, marker, count);
            assertThrows(InvalidObjectException.class, () -> deserialize(bytes));
        }
    }

//    void testCreate() throws Exception {
//        Bag<T> bag = makeObject();
//        writeExternalFormToDisk((java.io.Serializable) bag, "src/test/resources/data/test/HashBag.emptyCollection.version4.obj");
//        bag = makeFullCollection();
//        writeExternalFormToDisk((java.io.Serializable) bag, "src/test/resources/data/test/HashBag.fullCollection.version4.obj");
//    }
}