commons-jcs-core/src/test/java/org/apache/commons/jcs/utils/struct/SortedPrefArrayUnitTest.java

package org.apache.commons.jcs.utils.struct;

/*
 * 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
 *
 *   http://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.
 */

import junit.framework.TestCase;

/**
 * Tests the SortedPrefArray used by the recycle bin.
 * @author aaronsm
 */
public class SortedPrefArrayUnitTest
    extends TestCase
{

    /**
     * Constructor for the TestSimpleLoad object
     * @param testName Description of the Parameter
     */
    public SortedPrefArrayUnitTest( String testName )
    {
        super( testName );
    }

    /**
     * @throws Exception
     */
    public void testLargePref()
        throws Exception
    {
        int maxSize = 25;

        SortedPreferentialArray<String> array = new SortedPreferentialArray<String>( maxSize );
        // array.setPreferLarge( false );
        array.setPreferLarge( true );
        String[] elem = {
            "10",
            "11",
            "01",
            "02",
            "03",
            "04",
            "05",
            "08",
            "07",
            "06",
            "09",
            "12",
            "13",
            "15",
            "14",
            "20",
            "25",
            "29",
            "28",
            "16",
            "17",
            "96",
            "00",
            "72",
            "39",
            "55",
            "44",
            "26",
            "22",
            "59",
            "38",
            "16",
            "27" };

        // put more than the max in a random order
        for ( int i = 0; i < elem.length; i++ )
        {
            array.add( elem[i] );
            // System.out.println( array.dumpArray() );
        }

        assertEquals( "Size was not as expected.", maxSize, array.size() );

        // this is a fragile test, since it relies on a hardcoded array
        String smallest = array.getSmallest();
        assertEquals( "smallest should be 08", "08", smallest );

        String largest = array.getLargest();
        assertEquals( "Largest should be 96", "96", largest );

        // this should take 96;
        String taken = array.takeNearestLargerOrEqual( "95" );
        assertEquals( "Taken should be 96", "96", taken );
        assertEquals( "Size was not as expected.", ( maxSize - 1 ), array.size() );

        // System.out.println( array.dumpArray() );
    }

    /**
     * Verify that we don't get an error when taking from an empty array.
     * @throws Exception
     */
    public void testEmptyTake()
        throws Exception
    {
        int maxSize = 25;
        SortedPreferentialArray<String> array = new SortedPreferentialArray<String>( maxSize );
        array.setPreferLarge( true );
        for ( int i = 0; i < maxSize; i++ )
        {
            String taken = array.takeNearestLargerOrEqual( String.valueOf( i ) );
            assertNull( "taken should be null, since nothing was in the array", taken );
        }
    }

    /**
     * Verify that we don't get a null pointer if we insert a null.
     * @throws Exception
     */
    public void testNullInsertion()
        throws Exception
    {
        int maxSize = 25;
        SortedPreferentialArray<String> array = new SortedPreferentialArray<String>( maxSize );
        array.setPreferLarge( true );

        String[] elem = {
            "10",
            "11",
            "01",
            "02",
            "03",
            "04",
            "05",
            "08",
            "07",
            "06",
            "09",
            "12",
            "13",
            "15",
            "14",
            "20",
            "25",
            "29",
            "28",
            "16",
            "17",
            "96",
            "00",
            "72",
            "39",
            "55",
            "44",
            "26",
            "22",
            "59",
            "38",
            "16",
            "27" };

        // put more than the max in a random order
        for ( int i = 0; i < elem.length; i++ )
        {
            array.add( elem[i] );
        }
        // System.out.println( array.dumpArray() );

        assertEquals( "Size was not as expected.", maxSize, array.size() );

        try
        {
            // should not get an error
            array.add( null );
        }
        catch ( NullPointerException e )
        {
            fail( "Got a null pointer inserting a null" );
        }

    }

    /**
     * Verify that we don't get an npe when taking with a null
     * @throws Exception
     */
    public void testNullTake()
        throws Exception
    {
        int maxSize = 25;
        SortedPreferentialArray<String> array = new SortedPreferentialArray<String>( maxSize );
        array.setPreferLarge( true );

        try
        {
            String taken = array.takeNearestLargerOrEqual( null );
            assertNull( "taken should be null, since nothing was in the array", taken );
        }
        catch ( NullPointerException e )
        {
            fail( "Got a null pointer trying to take with a null" );
        }
    }

    /**
     * Verify that we don't get an npe when taking from an array of only one
     * @throws Exception
     */
    public void testSingleItemTake()
        throws Exception
    {
        int maxSize = 25;
        SortedPreferentialArray<String> array = new SortedPreferentialArray<String>( maxSize );
        array.setPreferLarge( true );

        array.add( "10" );
        // System.out.println( array.dumpArray() );

        try
        {
            String taken = array.takeNearestLargerOrEqual( "09" );
            // System.out.println( taken );
            assertNotNull( "taken should not be null, since nothing was in the array", taken );
        }
        catch ( NullPointerException e )
        {
            fail( "Got a null pointer trying to take with a null" );
        }
    }

    /**
     * Verify that we don't get an npe when taking from an array of only one
     * @throws Exception
     */
    public void testSingleItemTakeLarger()
        throws Exception
    {
        int maxSize = 25;
        SortedPreferentialArray<String> array = new SortedPreferentialArray<String>( maxSize );
        array.setPreferLarge( true );

        array.add( "10" );

        try
        {
            String taken = array.takeNearestLargerOrEqual( "11" );
            assertNull( "taken should be null, since nothing smaller was in the array", taken );
        }
        catch ( NullPointerException e )
        {
            fail( "Got a null pointer trying to take with a null" );
        }
    }

    /**
     * Verify that we don't get an npe when taking from an array of none
     * @throws Exception
     */
    public void testSingleItemTakeLargerEmpty()
        throws Exception
    {
        int maxSize = 25;
        SortedPreferentialArray<String> array = new SortedPreferentialArray<String>( maxSize );
        array.setPreferLarge( true );

        try
        {
            String taken = array.takeNearestLargerOrEqual( "11" );
            assertNull( "taken should be null, since nothing was in the array", taken );
        }
        catch ( NullPointerException e )
        {
            fail( "Got a null pointer trying to take with a null" );
        }
    }

    /**
     * Test taking the largest item.
     * @throws Exception
     */
    public void testTakeLargestItem()
        throws Exception
    {
        int maxSize = 9;

        SortedPreferentialArray<String> array = new SortedPreferentialArray<String>( maxSize );
        // array.setPreferLarge( false );
        array.setPreferLarge( true );
        String[] elem = { "01", "02", "03", "04", "05", "08", "07", "06", "09", };

        // put more than the max in a random order
        for ( int i = 0; i < elem.length; i++ )
        {
            array.add( elem[i] );
            // System.out.println( array.dumpArray() );
        }

        assertEquals( "Size was not as expected.", maxSize, array.size() );

        // this is a fragile test, since it relies on a hardcoded array
        String smallest = array.getSmallest();
        assertEquals( "smallest is not as expected", "01", smallest );

        String largest = array.getLargest();
        assertEquals( "Largest is not as expected", "09", largest );

        // this should take 96;
        String taken = array.takeNearestLargerOrEqual( "09" );
        assertEquals( "Taken is not as expected", "09", taken );
        assertEquals( "Size was not as expected.", ( maxSize - 1 ), array.size() );

        // System.out.println( "testTakeLastItem" + array.dumpArray() );
    }

    /**
     * Test taking every last item.
     * <p>
     * @throws Exception
     */
    public void testTakeEveryLastItem()
        throws Exception
    {
        int maxSize = 9;

        SortedPreferentialArray<String> array = new SortedPreferentialArray<String>( maxSize );
        // array.setPreferLarge( false );
        array.setPreferLarge( true );
        String[] elem = { "01", "02", "03", "04", "05", "08", "07", "06", "09", };

        // put more than the max in a random order
        for ( int i = 0; i < elem.length; i++ )
        {
            array.add( elem[i] );
            // System.out.println( array.dumpArray() );
        }

        assertEquals( "Size was not as expected.", maxSize, array.size() );

        // this is a fragile test, since it relies on a hardcoded array
        String smallest = array.getSmallest();
        assertEquals( "smallest is not as expected", "01", smallest );

        String largest = array.getLargest();
        assertEquals( "Largest is not as expected", "09", largest );

        // this should take 96;
        String taken = array.takeNearestLargerOrEqual( "09" );
        assertEquals( "Taken is not as expected", "09", taken );
        assertEquals( "Size was not as expected. " + array.dumpArray(), ( maxSize - 1 ), array.size() );

        // System.out.println( "testTakeEveryLastItem" + array.dumpArray() );

        // take the rest
        // take more than the max in a reverse order
        for ( int i = elem.length - 1; i >= 0; i-- )
        {
            array.takeNearestLargerOrEqual( elem[i] );
        }
        // System.out.println( "testTakeEveryLastItem" + array.dumpArray() );

        assertEquals( "There should nothing left. " + array.dumpArray(), 0, array.size() );
    }

    /**
     * Try taking an item larger than the greatest.
     */
    public void testTakeLargerThanGreatest()
    {
        int maxSize = 3;

        SortedPreferentialArray<String> array = new SortedPreferentialArray<String>( maxSize );
        // array.setPreferLarge( false );
        array.setPreferLarge( true );
        String[] elem = { "01", "02", "03" };

        // put more than the max in a random order
        for ( int i = 0; i < elem.length; i++ )
        {
            array.add( elem[i] );
            // System.out.println( array.dumpArray() );
        }

        // DO WORK
        Comparable<String> taken = array.takeNearestLargerOrEqual( "04" );
//        System.out.println( "testTakeLargerThanGreatest" + array.dumpArray() );

        assertNull( "We should have nothing since the largest element was smaller than what we asked for. "
            + " Instead we got " + taken, taken );
    }

    /**
     * Try taking an item equal to the greatest.  Make the last two the same size
     */
    public void testEqualToGreatest_LastTwoSameSize()
    {
        int maxSize = 3;

        SortedPreferentialArray<String> array = new SortedPreferentialArray<String>( maxSize );
        // array.setPreferLarge( false );
        array.setPreferLarge( true );
        String[] elem = { "01", "02", "03", "03" };

        // put more than the max in a random order
        for ( int i = 0; i < elem.length; i++ )
        {
            array.add( elem[i] );
            // System.out.println( array.dumpArray() );
        }

        // DO WORK
        Comparable<String> taken = array.takeNearestLargerOrEqual( "03" );
        // System.out.println( "testEqualToGreatest_LastTwoSameSize" + array.dumpArray() );

        assertNotNull( "We should have something since the largest element was equal to what we asked for.", taken );
    }

    /**
     * Try taking an item equal to the greatest.  The second to last should be smaller. This verifies the most basic funtionality.
     */
    public void testEqualToGreatest()
    {
        int maxSize = 3;

        SortedPreferentialArray<String> array = new SortedPreferentialArray<String>( maxSize );
        // array.setPreferLarge( false );
        array.setPreferLarge( true );
        String[] elem = { "01", "02", "03" };

        // put more than the max in a random order
        for ( int i = 0; i < elem.length; i++ )
        {
            array.add( elem[i] );
            // System.out.println( array.dumpArray() );
        }

        // DO WORK
        Comparable<String> taken = array.takeNearestLargerOrEqual( "03" );
        // System.out.println( "testEqualToGreatest" + array.dumpArray() );

        assertNotNull( "We should have something since the largest element was equal to what we asked for.", taken );
    }
}