directmemory-cache/src/test/java/org/apache/directmemory/memory/allocator/MergingByteBufferAllocatorImplTest.java

package org.apache.directmemory.memory.allocator;

/*
 * 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 static org.junit.Assert.assertNotNull;

import java.io.IOException;
import java.nio.BufferOverflowException;

import junit.framework.Assert;

import org.apache.directmemory.DirectMemory;
import org.apache.directmemory.cache.CacheService;
import org.apache.directmemory.memory.MemoryManagerServiceImpl;
import org.apache.directmemory.memory.buffer.MemoryBuffer;
import org.junit.Test;

public class MergingByteBufferAllocatorImplTest
{
    @Test
    public void allocationTest()
        throws IOException
    {

        Allocator allocator = new MergingByteBufferAllocatorImpl( 0, 5000 );

        MemoryBuffer bf1 = allocator.allocate( 250 );
        Assert.assertEquals( 250, bf1.maxCapacity() );
        Assert.assertEquals( 250, bf1.capacity() );

        MemoryBuffer bf2 = allocator.allocate( 251 );
        Assert.assertEquals( 251, bf2.maxCapacity() );
        Assert.assertEquals( 251, bf2.capacity() );

        MemoryBuffer bf3 = allocator.allocate( 200 );
        Assert.assertEquals( 200, bf3.maxCapacity() );
        Assert.assertEquals( 200, bf3.capacity() );

        MemoryBuffer bf4 = allocator.allocate( 2000 );
        Assert.assertEquals( 2000, bf4.maxCapacity() );
        Assert.assertEquals( 2000, bf4.capacity() );

        MemoryBuffer bf5 = allocator.allocate( 2001 );
        Assert.assertEquals( 2001, bf5.maxCapacity() );
        Assert.assertEquals( 2001, bf5.capacity() );

        MemoryBuffer bf6 = allocator.allocate( 298 );
        Assert.assertEquals( 298, bf6.maxCapacity() );
        Assert.assertEquals( 298, bf6.capacity() );

        MemoryBuffer bf7 = allocator.allocate( 128 );
        Assert.assertNull( bf7 );

        allocator.close();
    }

    @Test
    public void releaseTest()
        throws IOException
    {

        Allocator allocator = new MergingByteBufferAllocatorImpl( 0, 1000 );

        MemoryBuffer bf1 = allocator.allocate( 250 );
        Assert.assertEquals( 250, bf1.maxCapacity() );
        Assert.assertEquals( 250, bf1.capacity() );

        MemoryBuffer bf2 = allocator.allocate( 251 );
        Assert.assertEquals( 251, bf2.maxCapacity() );
        Assert.assertEquals( 251, bf2.capacity() );

        MemoryBuffer bf3 = allocator.allocate( 252 );
        Assert.assertEquals( 252, bf3.maxCapacity() );
        Assert.assertEquals( 252, bf3.capacity() );

        MemoryBuffer bf4 = allocator.allocate( 500 );
        Assert.assertNull( bf4 );

        allocator.free( bf1 );
        allocator.free( bf2 );

        MemoryBuffer bf5 = allocator.allocate( 500 );
        Assert.assertEquals( 501, bf5.maxCapacity() );
        Assert.assertEquals( 500, bf5.capacity() );

        allocator.close();
    }

    @Test
    public void allocateAndFreeTest()
        throws IOException
    {

        Allocator allocator = new MergingByteBufferAllocatorImpl( 0, 1000 );

        for ( int i = 0; i < 1000; i++ )
        {
            MemoryBuffer bf1 = allocator.allocate( 250 );
            Assert.assertEquals( 250, bf1.maxCapacity() );
            Assert.assertEquals( 250, bf1.capacity() );

            allocator.free( bf1 );
        }

        MemoryBuffer bf2 = allocator.allocate( 1000 );
        Assert.assertEquals( 1000, bf2.maxCapacity() );
        Assert.assertEquals( 1000, bf2.capacity() );

        allocator.close();
    }

    @Test
    public void allocationWithoutSplittingPointerTest()
        throws IOException
    {

        Allocator allocator = new MergingByteBufferAllocatorImpl( 0, 200 );

        MemoryBuffer bf1 = allocator.allocate( 180 );
        Assert.assertEquals( 200, bf1.maxCapacity() );
        Assert.assertEquals( 180, bf1.capacity() );

        MemoryBuffer bf2 = allocator.allocate( 5 );
        Assert.assertNull( bf2 );

        allocator.free( bf1 );

        MemoryBuffer bf3 = allocator.allocate( 10 );
        Assert.assertEquals( 10, bf3.maxCapacity() );
        Assert.assertEquals( 10, bf3.capacity() );

        MemoryBuffer bf4 = allocator.allocate( 20 );
        Assert.assertEquals( 20, bf4.maxCapacity() );
        Assert.assertEquals( 20, bf4.capacity() );

        MemoryBuffer bf5 = allocator.allocate( 30 );
        Assert.assertEquals( 30, bf5.maxCapacity() );
        Assert.assertEquals( 30, bf5.capacity() );

        allocator.free( bf4 );
        allocator.free( bf3 );

        MemoryBuffer bf6 = allocator.allocate( 25 );
        Assert.assertEquals( 30, bf6.maxCapacity() );
        Assert.assertEquals( 25, bf6.capacity() );

        allocator.close();
    }

    @Test
    public void allocationWithDifferentRatioTest()
        throws IOException
    {

        MergingByteBufferAllocatorImpl allocator = new MergingByteBufferAllocatorImpl( 0, 200 );
        allocator.setSizeRatioThreshold( 0.95 );

        allocator.setSizeRatioThreshold( 10 );

        MemoryBuffer bf1 = allocator.allocate( 180 );
        Assert.assertEquals( 180, bf1.maxCapacity() );
        Assert.assertEquals( 180, bf1.capacity() );

        MemoryBuffer bf2 = allocator.allocate( 10 );
        Assert.assertEquals( 20, bf2.maxCapacity() );
        Assert.assertEquals( 10, bf2.capacity() );

        allocator.close();
    }

    @Test( expected = BufferOverflowException.class )
    public void allocationThrowingBOExceptionTest()
        throws IOException
    {

        MergingByteBufferAllocatorImpl allocator = new MergingByteBufferAllocatorImpl( 0, 200 );
        allocator.setReturnNullWhenBufferIsFull( false );

        try
        {
            allocator.allocate( 210 );
            Assert.fail();
        }
        finally
        {
            allocator.close();
        }
    }

    @Test
    public void testJiraIssue118()
        throws Exception
    {
        CacheService<String, Object> cacheService = new DirectMemory<String, Object>() 
                        .setNumberOfBuffers(1) 
                        .setInitialCapacity(1) 
                        .setMemoryManager(new MemoryManagerServiceImpl<Object>(true)) 
                        .setSize(350 *(1024*1024)) 
                        .setConcurrencyLevel(1) 
                        .newCacheService();
        assertNotNull(cacheService);
    }

}