broker-plugins/amqp-0-10-protocol/src/test/java/org/apache/qpid/server/protocol/v0_10/transport/RangeSetTest.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
 *
 *   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.
 *
 */

package org.apache.qpid.server.protocol.v0_10.transport;

import static org.apache.qpid.server.util.Serial.COMPARATOR;
import static org.apache.qpid.server.util.Serial.eq;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

import org.junit.Test;

import org.apache.qpid.test.utils.UnitTestBase;


/**
 * RangeSetTest
 */
public class RangeSetTest extends UnitTestBase
{

    private void check(RangeSet ranges)
    {
        List<Integer> posts = new ArrayList<Integer>();
        for (Range range : ranges)
        {
            posts.add(range.getLower());
            posts.add(range.getUpper());
        }

        List<Integer> sorted = new ArrayList<Integer>(posts);
        Collections.sort(sorted, COMPARATOR);

        assertEquals(posts, sorted);

        int idx = 1;
        while (idx + 1 < posts.size())
        {
            final boolean condition = !eq(posts.get(idx) + 1, posts.get(idx+1));
            assertTrue(condition);
            idx += 2;
        }
    }

    @Test
    public void test1()
    {
        RangeSet ranges = RangeSetFactory.createRangeSet();
        ranges.add(5, 10);
        check(ranges);
        ranges.add(15, 20);
        check(ranges);
        ranges.add(23, 25);
        check(ranges);
        ranges.add(12, 14);
        check(ranges);
        ranges.add(0, 1);
        check(ranges);
        ranges.add(3, 11);
        check(ranges);
    }

    @Test
    public void test2()
    {
        RangeSet rs = RangeSetFactory.createRangeSet();
        check(rs);

        rs.add(1);
        assertTrue(rs.includes(1));
        final boolean condition10 = !rs.includes(2);
        assertTrue(condition10);
        final boolean condition9 = !rs.includes(0);
        assertTrue(condition9);
        check(rs);

        rs.add(2);
        final boolean condition8 = !rs.includes(0);
        assertTrue(condition8);
        assertTrue(rs.includes(1));
        assertTrue(rs.includes(2));
        final boolean condition7 = !rs.includes(3);
        assertTrue(condition7);
        check(rs);

        rs.add(0);

        final boolean condition6 = !rs.includes(-1);
        assertTrue(condition6);
        assertTrue(rs.includes(0));
        assertTrue(rs.includes(1));
        assertTrue(rs.includes(2));
        final boolean condition5 = !rs.includes(3);
        assertTrue(condition5);
        check(rs);

        rs.add(37);

        final boolean condition4 = !rs.includes(-1);
        assertTrue(condition4);
        assertTrue(rs.includes(0));
        assertTrue(rs.includes(1));
        assertTrue(rs.includes(2));
        final boolean condition3 = !rs.includes(3);
        assertTrue(condition3);
        final boolean condition2 = !rs.includes(36);
        assertTrue(condition2);
        assertTrue(rs.includes(37));
        final boolean condition1 = !rs.includes(38);
        assertTrue(condition1);
        check(rs);

        rs.add(-1);
        check(rs);

        rs.add(-3);
        check(rs);

        rs.add(1, 20);
        final boolean condition = !rs.includes(21);
        assertTrue(condition);
        assertTrue(rs.includes(20));
        check(rs);
    }

    @Test
    public void testAddSelf()
    {
        RangeSet a = RangeSetFactory.createRangeSet();
        a.add(0, 8);
        check(a);
        a.add(0, 8);
        check(a);
        assertEquals((long) a.size(), (long) 1);
        Range range = a.iterator().next();
        assertEquals((long) range.getLower(), (long) 0);
        assertEquals((long) range.getUpper(), (long) 8);
    }

    @Test
    public void testIntersect1()
    {
        Range a = Range.newInstance(0, 10);
        Range b = Range.newInstance(9, 20);
        Range i1 = a.intersect(b);
        Range i2 = b.intersect(a);
        assertEquals((long) i1.getUpper(), (long) 10);
        assertEquals((long) i2.getUpper(), (long) 10);
        assertEquals((long) i1.getLower(), (long) 9);
        assertEquals((long) i2.getLower(), (long) 9);
    }

    @Test
    public void testIntersect2()
    {
        Range a = Range.newInstance(0, 10);
        Range b = Range.newInstance(11, 20);
        assertNull(a.intersect(b));
        assertNull(b.intersect(a));
    }

    @Test
    public void testIntersect3()
    {
        Range a = Range.newInstance(0, 10);
        Range b = Range.newInstance(3, 5);
        Range i1 = a.intersect(b);
        Range i2 = b.intersect(a);
        assertEquals((long) i1.getUpper(), (long) 5);
        assertEquals((long) i2.getUpper(), (long) 5);
        assertEquals((long) i1.getLower(), (long) 3);
        assertEquals((long) i2.getLower(), (long) 3);
    }

    @Test
    public void testSubtract1()
    {
        Range a = Range.newInstance(0, 10);
        assertTrue(a.subtract(a).isEmpty());
    }

    @Test
    public void testSubtract2()
    {
        Range a = Range.newInstance(0, 10);
        Range b = Range.newInstance(20, 30);
        List<Range> ranges = a.subtract(b);
        assertEquals((long) ranges.size(), (long) 1);
        Range d = ranges.get(0);
        assertEquals((long) d.getLower(), (long) a.getLower());
        assertEquals((long) d.getUpper(), (long) a.getUpper());
    }

    @Test
    public void testSubtract3()
    {
        Range a = Range.newInstance(20, 30);
        Range b = Range.newInstance(0, 10);
        List<Range> ranges = a.subtract(b);
        assertEquals((long) ranges.size(), (long) 1);
        Range d = ranges.get(0);
        assertEquals((long) d.getLower(), (long) a.getLower());
        assertEquals((long) d.getUpper(), (long) a.getUpper());
    }

    @Test
    public void testSubtract4()
    {
        Range a = Range.newInstance(0, 10);
        Range b = Range.newInstance(3, 5);
        List<Range> ranges = a.subtract(b);
        assertEquals((long) ranges.size(), (long) 2);
        Range low = ranges.get(0);
        Range high = ranges.get(1);
        assertEquals((long) low.getLower(), (long) 0);
        assertEquals((long) low.getUpper(), (long) 2);
        assertEquals((long) high.getLower(), (long) 6);
        assertEquals((long) high.getUpper(), (long) 10);
    }

    @Test
    public void testSubtract5()
    {
        Range a = Range.newInstance(0, 10);
        Range b = Range.newInstance(3, 20);
        List<Range> ranges = a.subtract(b);
        assertEquals((long) ranges.size(), (long) 1);
        Range d = ranges.get(0);
        assertEquals((long) d.getLower(), (long) 0);
        assertEquals((long) d.getUpper(), (long) 2);
    }

    @Test
    public void testSubtract6()
    {
        Range a = Range.newInstance(0, 10);
        Range b = Range.newInstance(-10, 5);
        List<Range> ranges = a.subtract(b);
        assertEquals((long) ranges.size(), (long) 1);
        Range d = ranges.get(0);
        assertEquals((long) d.getLower(), (long) 6);
        assertEquals((long) d.getUpper(), (long) 10);
    }

    @Test
    public void testSetSubtract1()
    {
        final RangeSet orig = createRangeSet(0, 10) ;
        final RangeSet update = createRangeSet(3, 15) ;
        orig.subtract(update) ;
        checkRange(orig, 0, 2) ;
    }

    @Test
    public void testSetSubtract2()
    {
        final RangeSet orig = createRangeSet(0, 10) ;
        final RangeSet update = createRangeSet(3, 10) ;
        orig.subtract(update) ;
        checkRange(orig, 0, 2) ;
    }

    @Test
    public void testSetSubtract3()
    {
        final RangeSet orig = createRangeSet(0, 10) ;
        final RangeSet update = createRangeSet(3, 4) ;
        orig.subtract(update) ;
        checkRange(orig, 0, 2, 5, 10) ;
    }

    @Test
    public void testSetSubtract4()
    {
        final RangeSet orig = createRangeSet(3, 15) ;
        final RangeSet update = createRangeSet(0, 10) ;
        orig.subtract(update) ;
        checkRange(orig, 11, 15) ;
    }

    @Test
    public void testSetSubtract5()
    {
        final RangeSet orig = createRangeSet(3, 10) ;
        final RangeSet update = createRangeSet(0, 10) ;
        orig.subtract(update) ;
        checkRange(orig) ;
    }

    @Test
    public void testSetSubtract6()
    {
        final RangeSet orig = createRangeSet(3, 10) ;
        final RangeSet update = createRangeSet(0, 15) ;
        orig.subtract(update) ;
        checkRange(orig) ;
    }

    @Test
    public void testSetSubtract7()
    {
        final RangeSet orig = createRangeSet(0, 10) ;
        final RangeSet update = createRangeSet(0, 15) ;
        orig.subtract(update) ;
        checkRange(orig) ;
    }

    @Test
    public void testSetSubtract8()
    {
        final RangeSet orig = createRangeSet(0, 15) ;
        final RangeSet update = createRangeSet(0, 10) ;
        orig.subtract(update) ;
        checkRange(orig, 11, 15) ;
    }

    @Test
    public void testSetSubtract9()
    {
        final RangeSet orig = createRangeSet(0, 15, 20, 30) ;
        final RangeSet update = createRangeSet(2, 3, 5, 6, 8, 9, 22, 23, 27, 28) ;
        orig.subtract(update) ;
        checkRange(orig, 0, 1, 4, 4, 7, 7, 10, 15, 20, 21, 24, 26, 29, 30) ;
    }

    @Test
    public void testSetSubtract10()
    {
        final RangeSet orig = createRangeSet(0, 15, 20, 30) ;
        final RangeSet update = createRangeSet(0, 2, 4, 6, 10, 22, 24, 24, 27, 30) ;
        orig.subtract(update) ;
        checkRange(orig, 3, 3, 7, 9, 23, 23, 25, 26) ;
    }

    @Test
    public void testSetSubtract11()
    {
        final RangeSet orig = createRangeSet(0, 2, 4, 6, 10, 22, 24, 24, 27, 30) ;
        final RangeSet update = createRangeSet(0, 2, 4, 6, 10, 22, 24, 24, 27, 30) ;
        orig.subtract(update) ;
        checkRange(orig) ;
    }
    
    private RangeSet createRangeSet(int ... bounds)
    {
        RangeSet set = RangeSetFactory.createRangeSet();
        final int length = (bounds == null ? 0 : bounds.length) ;
        int count = 0 ;
        while(count < length)
        {
            set.add(bounds[count++], bounds[count++]) ;
        }
        return set ;
    }
    
    private void checkRange(final RangeSet rangeSet, int ... bounds)
    {
        final int length = (bounds == null ? 0 : bounds.length) ;
        assertEquals("Range count", (long) (length / 2), (long) rangeSet.size());
        final Iterator<Range> iter = rangeSet.iterator() ;
        int count = 0 ;
        while(count < length)
        {
            final Range range = iter.next() ;
            final long expected1 = bounds[count++];
            assertEquals("Range lower", expected1, (long) range.getLower());
            final long expected = bounds[count++];
            assertEquals("Range upper", expected, (long) range.getUpper());
        }
    }
}