AlarmQueueTest.java

/*******************************************************************************
 * This file is part of OpenNMS(R).
 *
 * Copyright (C) 2009-2011 The OpenNMS Group, Inc.
 * OpenNMS(R) is Copyright (C) 1999-2011 The OpenNMS Group, Inc.
 *
 * OpenNMS(R) is a registered trademark of The OpenNMS Group, Inc.
 *
 * OpenNMS(R) is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 *
 * OpenNMS(R) 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 for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with OpenNMS(R).  If not, see:
 *      http://www.gnu.org/licenses/
 *
 * For more information contact:
 *     OpenNMS(R) Licensing <license@opennms.org>
 *     http://www.opennms.org/
 *     http://www.opennms.com/
 *******************************************************************************/

package org.opennms.netmgt.alarmd.api.support;

import static org.junit.Assert.*;

import java.util.List;

import org.junit.Test;
import org.opennms.netmgt.alarmd.api.NorthboundAlarm;
import org.opennms.netmgt.alarmd.api.support.AlarmQueue;
import org.opennms.netmgt.model.OnmsAlarm;

/**
 * Tests the AlarmQueue for NBI
 * 
 * @author <a mailto:brozow@opennms.org>Matt Brozowski</a>
 * @author <a mailto:david@opennms.org>David Hustace</a>
 *
 */
public class AlarmQueueTest implements StatusFactory<NorthboundAlarm>{

    public int alarmNumber = 0;
    
    private NorthboundAlarm createAlarm() {
        OnmsAlarm alarm = new OnmsAlarm();
        alarm.setId(++alarmNumber);
        alarm.setUei("uei.opennms.org/test/httpNorthBounder");
        
        return new NorthboundAlarm(alarm);
    }
    
    @Test
    public void testRegularForwarding() throws InterruptedException {
        AlarmQueue<NorthboundAlarm> queue = new AlarmQueue<NorthboundAlarm>(this);
        queue.setMaxBatchSize(3);
        queue.init();
    
        queue.accept(createAlarm());
        queue.preserve(createAlarm());
        queue.accept(createAlarm());
        
        List<NorthboundAlarm> alarms = queue.getAlarmsToForward();
        assertNotNull(alarms);
        assertEquals(3, alarms.size());
        
        queue.forwardSuccessful(alarms);
        
        queue.preserve(createAlarm());
        queue.accept(createAlarm());
        queue.preserve(createAlarm());
        queue.accept(createAlarm());
        
        alarms = queue.getAlarmsToForward();
        assertNotNull(alarms);
        assertEquals(3, alarms.size());
        
        queue.forwardSuccessful(alarms);
        
        alarms = queue.getAlarmsToForward();
        assertNotNull(alarms);
        assertEquals(1, alarms.size());
        
        queue.forwardSuccessful(alarms);

        
    }

    public void testFailure() throws InterruptedException {
        AlarmQueue<NorthboundAlarm> queue = new AlarmQueue<NorthboundAlarm>(this);
        queue.setMaxBatchSize(3);
        queue.init();
    
        queue.accept(createAlarm());  // 1
        queue.preserve(createAlarm()); // 2
        queue.accept(createAlarm());  // 3
        
        List<NorthboundAlarm> alarms = queue.getAlarmsToForward();
        assertNotNull(alarms);
        assertEquals(3, alarms.size());
        
        queue.forwardSuccessful(alarms);
        
        queue.preserve(createAlarm()); // 4
        queue.accept(createAlarm());  // 5
        queue.preserve(createAlarm()); // 6
        queue.accept(createAlarm());  // 7
        
        alarms = queue.getAlarmsToForward();
        assertNotNull(alarms);
        assertEquals(3, alarms.size());
        
        queue.forwardFailed(alarms);
        
        queue.accept(createAlarm()); // 8
        
        alarms = queue.getAlarmsToForward();
        assertNotNull(alarms);
        assertEquals(2, alarms.size());
        assertPreservedAlarm(alarms, 0, 4);
        assertPreservedAlarm(alarms, 1, 6);
        
        queue.forwardFailed(alarms);
        
        queue.preserve(createAlarm()); // 9
        queue.accept(createAlarm()); // 10
        queue.preserve(createAlarm()); // 11
        queue.accept(createAlarm()); // 12
        
        alarms = queue.getAlarmsToForward();
        assertNotNull(alarms);
        assertEquals(3, alarms.size());
        assertPreservedAlarm(alarms, 0, 4);
        assertPreservedAlarm(alarms, 1, 6);
        assertPreservedAlarm(alarms, 2, 9);
        
        queue.forwardSuccessful(alarms);

        queue.preserve(createAlarm()); // 13
        queue.accept(createAlarm()); // 14

        alarms = queue.getAlarmsToForward();
        assertNotNull(alarms);
        assertEquals(1, alarms.size());
        assertPreservedAlarm(alarms, 0, 11);

        queue.forwardSuccessful(alarms);

        alarms = queue.getAlarmsToForward();
        assertNotNull(alarms);
        assertEquals(2, alarms.size());
        assertPreservedAlarm(alarms, 0, 13);
        assertEquals(14, alarms.get(1).getId().intValue());

        queue.forwardSuccessful(alarms);
        
        
    }

    private void assertPreservedAlarm(List<NorthboundAlarm> alarms, int index, int id) {
        assertTrue(alarms.get(index).isPreserved());
        assertEquals(id, alarms.get(index).getId().intValue());
    }

	@Override
	public NorthboundAlarm createSyncLostMessage() {
		return NorthboundAlarm.SYNC_LOST_ALARM;
	}

}