jdk-24/test/jdk/java/util/HashMap/TreeBinAssert.java

/*
 * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

/**
 * @test
 * @bug 8205399
 * @summary Check for AssertionError from HashMap TreeBin after Iterator.remove
 * @run testng/othervm -esa TreeBinAssert
 */

import org.testng.annotations.DataProvider;
import org.testng.annotations.Test;
import org.testng.annotations.BeforeTest;
import java.util.Map;
import java.util.Set;
import java.util.Iterator;
import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.function.BiConsumer;
import java.util.function.Function;

public class TreeBinAssert {
    private static final int ITR_RM = -1; // Remove an item via Iterator
    private static final int BIN352442_SIZE = 524288;
    private static final int BIN552165_SIZE = 1048576;

    @DataProvider(name = "SizeAndHashes")
    public Object[][] sizeAndHashes() {
        return new Object[][] {
            {   // Bin 352442
                BIN352442_SIZE,
                new int[] {
                    2020958394,
                    631595194,
                    1984782522,
                    419782842,
                    285565114,
                    1432182970,
                    841310394,
                    320692410,
                    303390906,
                    ITR_RM,
                    ITR_RM,
                    ITR_RM,
                    ITR_RM,
                    ITR_RM,
                    ITR_RM,
                    ITR_RM,
                    ITR_RM,
                    519397562,
                    ITR_RM,
                    626352314,
                    101540026
                }
            },{ // Bin 552165
                BIN552165_SIZE,
                new int[] {
                    790129893,
                    1214803173,
                    1212706021,
                    608726245,
                    2073586917,
                    1433955557,
                    692612325,
                    370699493,
                    2061004005,
                    48786661,
                    ITR_RM,
                    ITR_RM,
                    1418226917,
                    ITR_RM,
                    ITR_RM,
                    ITR_RM,
                    ITR_RM,
                    ITR_RM,
                    ITR_RM,
                    ITR_RM,
                    1487432933,
                    ITR_RM,
                    ITR_RM,
                    1880648933,
                    338193637
                }
            }
        };
    }

    @BeforeTest
    public void checkAssertionStatus() {
        if (!HashMap.class.desiredAssertionStatus()) {
            System.out.println("*** Superficial test run.  Test should be run with -esa ***\n");
            return;
        }
    }

    @Test(dataProvider = "SizeAndHashes")
    public void testMap(int size, int[] hashes) {
        Map<Key,Integer> map = new HashMap<>(size);

        doTest(map, hashes,
               (c,k) -> { ((Map<Key,Integer>)c).put(k,0); },
               (c)   -> { return ((Map<Key,Integer>)c).keySet().iterator(); }
        );
    }

    @Test(dataProvider = "SizeAndHashes")
    public void testSet(int size, int[] hashes) {
        Set<Key> set = new LinkedHashSet<>(size);

        doTest(set, hashes,
               (c,k) -> { ((Set<Key>)c).add(k); },
               (c)   -> { return ((Set<Key>)c).iterator(); }
        );
    }

    private void doTest(Object collection, int[] hashes,
                        BiConsumer<Object,Key> addKey,
                        Function<Object,Iterator<Key>> mkItr) {
        Iterator<Key> itr = null; // saved iterator, used for removals
        for (int h : hashes) {
            if (h == ITR_RM) {
                if (itr == null) {
                    itr = mkItr.apply(collection);
                }
                itr.next();
                itr.remove();
            } else {
                itr = null;
                addKey.accept(collection, new Key(h));
            }
        }
    }

    /**
     * Class that will have specified hash code in a HashMap.
     */
    static class Key implements Comparable<Key> {
        final int hash;

        public Key(int desiredHash) {
            // Account for processing done by HashMap
            this.hash = desiredHash ^ (desiredHash >>> 16);
        }

        @Override public int hashCode() { return this.hash; }

        @Override public boolean equals(Object o) {
            return o.hashCode() == this.hashCode();
        }

        @Override public int compareTo(Key k) {
            return Integer.compare(this.hash, k.hash);
        }
    }
}