/*******************************************************************************
* This file is part of OpenNMS(R).
*
* Copyright (C) 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.protocols.nsclient.config;
import static org.junit.Assert.assertEquals;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import org.exolab.castor.xml.MarshalException;
import org.exolab.castor.xml.ValidationException;
import org.junit.Test;
import org.opennms.protocols.nsclient.config.NSClientPeerFactory;
/**
* JUnit tests for the configureSNMP event handling and optimization of
* the SNMP configuration XML.
*
* @author <a href="mailto:david@opennms.org>David Hustace</a>
*
*/
public class NSClientPeerFactoryTest {
/**
* @throws MarshalException
* @throws ValidationException
* @throws IOException
*/
@Test
public final void testOneSpecific() throws MarshalException, ValidationException, IOException {
String amiConfigXml = "<?xml version=\"1.0\"?>\n" +
"<nsclient-config retry=\"3\" timeout=\"800\"\n" +
" password=\"password\">\n" +
" <definition>\n" +
" <specific>192.168.0.5</specific>\n" +
" </definition>\n" +
"\n" +
"</nsclient-config>\n" +
"";
NSClientPeerFactory factory = new NSClientPeerFactory(new ByteArrayInputStream(amiConfigXml.getBytes("UTF-8")));
assertEquals(1, factory.getConfig().getDefinitionCount());
factory.optimize();
assertEquals(1, factory.getConfig().getDefinitionCount());
}
/**
* This tests the merging of a new specific into a definition that already contains a specific
* that is adjacent. The two specifics should be converted to a single range in the definition.
*
* @throws MarshalException
* @throws ValidationException
* @throws IOException
*/
@Test
public final void testAddAdjacentSpecificToDef() throws MarshalException, ValidationException, IOException {
String amiConfigXml = "<?xml version=\"1.0\"?>\n" +
"<nsclient-config retry=\"3\" timeout=\"800\"\n" +
" password=\"password\">\n" +
" <definition>\n" +
" <specific>192.168.0.5</specific>\n" +
" <specific>192.168.0.6</specific>\n" +
" </definition>\n" +
"\n" +
"</nsclient-config>\n" +
"";
NSClientPeerFactory factory = new NSClientPeerFactory(new ByteArrayInputStream(amiConfigXml.getBytes("UTF-8")));
assertEquals(1, factory.getConfig().getDefinitionCount());
assertEquals(2, factory.getConfig().getDefinition(0).getSpecificCount());
assertEquals(0, factory.getConfig().getDefinition(0).getRangeCount());
factory.optimize();
assertEquals(1, factory.getConfig().getDefinitionCount());
assertEquals(0, factory.getConfig().getDefinition(0).getSpecificCount());
assertEquals(1, factory.getConfig().getDefinition(0).getRangeCount());
assertEquals("192.168.0.5", factory.getConfig().getDefinition(0).getRange(0).getBegin());
assertEquals("192.168.0.6", factory.getConfig().getDefinition(0).getRange(0).getEnd());
}
@Test
public final void testAddAdjacentSpecificToDefIPv6() throws MarshalException, ValidationException, IOException {
String amiConfigXml = "<?xml version=\"1.0\"?>\n" +
"<nsclient-config retry=\"3\" timeout=\"800\"\n" +
" password=\"password\">\n" +
" <definition>\n" +
" <specific>fe80:0000:0000:0000:0000:0000:0000:fedb</specific>\n" +
" <specific>fe80:0000:0000:0000:0000:0000:0000:fedc</specific>\n" +
" </definition>\n" +
"\n" +
"</nsclient-config>\n" +
"";
NSClientPeerFactory factory = new NSClientPeerFactory(new ByteArrayInputStream(amiConfigXml.getBytes("UTF-8")));
assertEquals(1, factory.getConfig().getDefinitionCount());
assertEquals(2, factory.getConfig().getDefinition(0).getSpecificCount());
assertEquals(0, factory.getConfig().getDefinition(0).getRangeCount());
factory.optimize();
assertEquals(1, factory.getConfig().getDefinitionCount());
assertEquals(0, factory.getConfig().getDefinition(0).getSpecificCount());
assertEquals(1, factory.getConfig().getDefinition(0).getRangeCount());
assertEquals("fe80:0000:0000:0000:0000:0000:0000:fedb", factory.getConfig().getDefinition(0).getRange(0).getBegin());
assertEquals("fe80:0000:0000:0000:0000:0000:0000:fedc", factory.getConfig().getDefinition(0).getRange(0).getEnd());
}
@Test
public final void testAddAdjacentSpecificToDefIPv6WithSameScopeId() throws MarshalException, ValidationException, IOException {
String amiConfigXml = "<?xml version=\"1.0\"?>\n" +
"<nsclient-config retry=\"3\" timeout=\"800\"\n" +
" password=\"password\">\n" +
" <definition>\n" +
" <specific>fe80:0000:0000:0000:0000:0000:0000:fedb%5</specific>\n" +
" <specific>fe80:0000:0000:0000:0000:0000:0000:fedc%5</specific>\n" +
" </definition>\n" +
"\n" +
"</nsclient-config>\n" +
"";
NSClientPeerFactory factory = new NSClientPeerFactory(new ByteArrayInputStream(amiConfigXml.getBytes("UTF-8")));
assertEquals(1, factory.getConfig().getDefinitionCount());
assertEquals(2, factory.getConfig().getDefinition(0).getSpecificCount());
assertEquals(0, factory.getConfig().getDefinition(0).getRangeCount());
factory.optimize();
assertEquals(1, factory.getConfig().getDefinitionCount());
assertEquals(0, factory.getConfig().getDefinition(0).getSpecificCount());
assertEquals(1, factory.getConfig().getDefinition(0).getRangeCount());
assertEquals("fe80:0000:0000:0000:0000:0000:0000:fedb%5", factory.getConfig().getDefinition(0).getRange(0).getBegin());
assertEquals("fe80:0000:0000:0000:0000:0000:0000:fedc%5", factory.getConfig().getDefinition(0).getRange(0).getEnd());
}
@Test
public final void testAddAdjacentSpecificToDefIPv6WithDifferentScopeIds() throws MarshalException, ValidationException, IOException {
String amiConfigXml = "<?xml version=\"1.0\"?>\n" +
"<nsclient-config retry=\"3\" timeout=\"800\"\n" +
" password=\"password\">\n" +
" <definition>\n" +
" <specific>fe80:0000:0000:0000:0000:0000:0000:fedb%1</specific>\n" +
" <specific>fe80:0000:0000:0000:0000:0000:0000:fedc%2</specific>\n" +
" </definition>\n" +
"\n" +
"</nsclient-config>\n" +
"";
NSClientPeerFactory factory = new NSClientPeerFactory(new ByteArrayInputStream(amiConfigXml.getBytes("UTF-8")));
assertEquals(1, factory.getConfig().getDefinitionCount());
assertEquals(2, factory.getConfig().getDefinition(0).getSpecificCount());
assertEquals(0, factory.getConfig().getDefinition(0).getRangeCount());
factory.optimize();
// No optimization should occur because the addresses have different scope IDs
assertEquals(1, factory.getConfig().getDefinitionCount());
assertEquals(2, factory.getConfig().getDefinition(0).getSpecificCount());
assertEquals(0, factory.getConfig().getDefinition(0).getRangeCount());
}
/**
* This tests the ability to move a specific from one definition into a range of another definition. The
* results should be that the 2 ranges in the first definition are recombined into a single range based on
* the single IP address that was in a different existing definition that will now be removed and the definition
* deleted.
*
* @throws MarshalException
* @throws ValidationException
* @throws IOException
*/
@Test
public void testRecombineSpecificIntoRange() throws MarshalException, ValidationException, IOException {
String amiConfigXml = "<?xml version=\"1.0\"?>\n" +
"<nsclient-config retry=\"3\" timeout=\"800\"\n" +
" password=\"password\">\n" +
" <definition>\n" +
" <range begin=\"fe80:0000:0000:0000:0000:0000:0000:fed0%1\" end=\"fe80:0000:0000:0000:0000:0000:0000:fed9%1\"/>\n" +
" <range begin=\"fe80:0000:0000:0000:0000:0000:0000:fedb%1\" end=\"fe80:0000:0000:0000:0000:0000:0000:fedf%1\"/>\n" +
" <specific>fe80:0000:0000:0000:0000:0000:0000:feda%1</specific>\n" +
" </definition>\n" +
"\n" +
"</nsclient-config>\n" +
"";
NSClientPeerFactory factory = new NSClientPeerFactory(new ByteArrayInputStream(amiConfigXml.getBytes("UTF-8")));
assertEquals(1, factory.getConfig().getDefinitionCount());
assertEquals(1, factory.getConfig().getDefinition(0).getSpecificCount());
assertEquals(2, factory.getConfig().getDefinition(0).getRangeCount());
factory.optimize();
assertEquals(1, factory.getConfig().getDefinitionCount());
assertEquals(0, factory.getConfig().getDefinition(0).getSpecificCount());
assertEquals(1, factory.getConfig().getDefinition(0).getRangeCount());
assertEquals("fe80:0000:0000:0000:0000:0000:0000:fed0%1", factory.getConfig().getDefinition(0).getRange(0).getBegin());
assertEquals("fe80:0000:0000:0000:0000:0000:0000:fedf%1", factory.getConfig().getDefinition(0).getRange(0).getEnd());
}
/**
* This tests the ability to move a specific from one definition into a range of another definition. The
* results should be that the 2 ranges in the first definition are recombined into a single range based on
* the single IP address that was in a different existing definition that will now be removed and the definition
* deleted.
*
* @throws MarshalException
* @throws ValidationException
* @throws IOException
*/
@Test
public void testRecombineSpecificIntoRangeWithDifferentScopeIds() throws MarshalException, ValidationException, IOException {
String amiConfigXml = "<?xml version=\"1.0\"?>\n" +
"<nsclient-config retry=\"3\" timeout=\"800\"\n" +
" password=\"password\">\n" +
" <definition>\n" +
" <range begin=\"fe80:0000:0000:0000:0000:0000:0000:fed0%1\" end=\"fe80:0000:0000:0000:0000:0000:0000:fed9%1\"/>\n" +
" <range begin=\"fe80:0000:0000:0000:0000:0000:0000:fedb%2\" end=\"fe80:0000:0000:0000:0000:0000:0000:fedf%2\"/>\n" +
" <specific>fe80:0000:0000:0000:0000:0000:0000:feda%1</specific>\n" +
" </definition>\n" +
"\n" +
"</nsclient-config>\n" +
"";
NSClientPeerFactory factory = new NSClientPeerFactory(new ByteArrayInputStream(amiConfigXml.getBytes("UTF-8")));
assertEquals(1, factory.getConfig().getDefinitionCount());
assertEquals(1, factory.getConfig().getDefinition(0).getSpecificCount());
assertEquals(2, factory.getConfig().getDefinition(0).getRangeCount());
factory.optimize();
assertEquals(1, factory.getConfig().getDefinitionCount());
assertEquals(0, factory.getConfig().getDefinition(0).getSpecificCount());
assertEquals(2, factory.getConfig().getDefinition(0).getRangeCount());
assertEquals("fe80:0000:0000:0000:0000:0000:0000:fed0%1", factory.getConfig().getDefinition(0).getRange(0).getBegin());
assertEquals("fe80:0000:0000:0000:0000:0000:0000:feda%1", factory.getConfig().getDefinition(0).getRange(0).getEnd());
assertEquals("fe80:0000:0000:0000:0000:0000:0000:fedb%2", factory.getConfig().getDefinition(0).getRange(1).getBegin());
assertEquals("fe80:0000:0000:0000:0000:0000:0000:fedf%2", factory.getConfig().getDefinition(0).getRange(1).getEnd());
}
/**
* This tests the addition of a new specific definition that is the same address as the beginning of
* a range in a current definition.
*
* @throws MarshalException
* @throws ValidationException
* @throws IOException
*/
@Test
public final void testNewSpecificSameAsBeginInOldDef() throws MarshalException, ValidationException, IOException {
String amiConfigXml = "<?xml version=\"1.0\"?>\n" +
"<nsclient-config retry=\"3\" timeout=\"800\"\n" +
" password=\"password\">\n" +
" <definition>\n" +
" <range begin=\"192.168.0.6\" end=\"192.168.0.12\"/>\n" +
" <specific>192.168.0.6</specific>\n" +
" </definition>\n" +
"\n" +
"</nsclient-config>\n" +
"";
NSClientPeerFactory factory = new NSClientPeerFactory(new ByteArrayInputStream(amiConfigXml.getBytes("UTF-8")));
assertEquals(1, factory.getConfig().getDefinitionCount());
assertEquals(1, factory.getConfig().getDefinition(0).getSpecificCount());
assertEquals(1, factory.getConfig().getDefinition(0).getRangeCount());
factory.optimize();
assertEquals(1, factory.getConfig().getDefinitionCount());
assertEquals(0, factory.getConfig().getDefinition(0).getSpecificCount());
assertEquals(1, factory.getConfig().getDefinition(0).getRangeCount());
assertEquals("192.168.0.6", factory.getConfig().getDefinition(0).getRange(0).getBegin());
assertEquals("192.168.0.12", factory.getConfig().getDefinition(0).getRange(0).getEnd());
}
/**
* This tests the addition of a new specific definition that is the same address as the beginning of
* a range in a current definition.
*
* @throws MarshalException
* @throws ValidationException
* @throws IOException
*/
@Test
public final void testNewSpecificSameAsEndInOldDef() throws MarshalException, ValidationException, IOException {
String amiConfigXml = "<?xml version=\"1.0\"?>\n" +
"<nsclient-config retry=\"3\" timeout=\"800\"\n" +
" password=\"password\">\n" +
" <definition>\n" +
" <range begin=\"192.168.0.6\" end=\"192.168.0.12\"/>\n" +
" <specific>192.168.0.12</specific>\n" +
" </definition>\n" +
"\n" +
"</nsclient-config>\n" +
"";
NSClientPeerFactory factory = new NSClientPeerFactory(new ByteArrayInputStream(amiConfigXml.getBytes("UTF-8")));
assertEquals(1, factory.getConfig().getDefinitionCount());
assertEquals(1, factory.getConfig().getDefinition(0).getSpecificCount());
assertEquals(1, factory.getConfig().getDefinition(0).getRangeCount());
factory.optimize();
assertEquals(1, factory.getConfig().getDefinitionCount());
assertEquals(0, factory.getConfig().getDefinition(0).getSpecificCount());
assertEquals(1, factory.getConfig().getDefinition(0).getRangeCount());
assertEquals("192.168.0.6", factory.getConfig().getDefinition(0).getRange(0).getBegin());
assertEquals("192.168.0.12", factory.getConfig().getDefinition(0).getRange(0).getEnd());
}
/**
* This tests the merging of a new definition that contains a range of IP addresses that overlaps
* the end of one range and the beginning of another range in a current definition.
*
* @throws MarshalException
* @throws ValidationException
* @throws IOException
*/
@Test
public void testOverlapsTwoRanges() throws MarshalException, ValidationException, IOException {
String amiConfigXml = "<?xml version=\"1.0\"?>\n" +
"<nsclient-config retry=\"3\" timeout=\"800\"\n" +
" password=\"password\">\n" +
" <definition>\n" +
" <range begin=\"192.168.0.6\" end=\"192.168.0.12\"/>\n" +
" <range begin=\"192.168.0.20\" end=\"192.168.0.100\"/>\n" +
" <range begin=\"192.168.0.8\" end=\"192.168.0.30\"/>\n" +
" </definition>\n" +
"\n" +
"</nsclient-config>\n" +
"";
NSClientPeerFactory factory = new NSClientPeerFactory(new ByteArrayInputStream(amiConfigXml.getBytes("UTF-8")));
assertEquals(1, factory.getConfig().getDefinitionCount());
assertEquals(0, factory.getConfig().getDefinition(0).getSpecificCount());
assertEquals(3, factory.getConfig().getDefinition(0).getRangeCount());
factory.optimize();
assertEquals(1, factory.getConfig().getDefinitionCount());
assertEquals(0, factory.getConfig().getDefinition(0).getSpecificCount());
assertEquals(1, factory.getConfig().getDefinition(0).getRangeCount());
assertEquals("192.168.0.6", factory.getConfig().getDefinition(0).getRange(0).getBegin());
assertEquals("192.168.0.100", factory.getConfig().getDefinition(0).getRange(0).getEnd());
}
}