X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fnetconf%2Fconfig-netconf-connector%2Fsrc%2Ftest%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fnetconf%2Fconfignetconfconnector%2FNetconfMappingTest.java;h=f151949abc3c859018e02daca7620d25b2d1b34e;hp=8b6b1aefc1971d2af9fbc7f69b4264cc79ed3327;hb=9c9f6e506395f806978a955a8cf51ba736b978ad;hpb=e27d63bdcfbfb0c1078a9c3e5aabf59ae7e2315f diff --git a/opendaylight/netconf/config-netconf-connector/src/test/java/org/opendaylight/controller/netconf/confignetconfconnector/NetconfMappingTest.java b/opendaylight/netconf/config-netconf-connector/src/test/java/org/opendaylight/controller/netconf/confignetconfconnector/NetconfMappingTest.java index 8b6b1aefc1..f151949abc 100644 --- a/opendaylight/netconf/config-netconf-connector/src/test/java/org/opendaylight/controller/netconf/confignetconfconnector/NetconfMappingTest.java +++ b/opendaylight/netconf/config-netconf-connector/src/test/java/org/opendaylight/controller/netconf/confignetconfconnector/NetconfMappingTest.java @@ -13,7 +13,12 @@ import com.google.common.base.Preconditions; import com.google.common.collect.Lists; import com.google.common.collect.Maps; import com.google.common.collect.Sets; -import org.apache.commons.lang3.StringUtils; +import org.custommonkey.xmlunit.AbstractNodeTester; +import org.custommonkey.xmlunit.NodeTest; +import org.custommonkey.xmlunit.NodeTestException; +import org.custommonkey.xmlunit.NodeTester; +import org.custommonkey.xmlunit.XMLAssert; +import org.custommonkey.xmlunit.XMLUnit; import org.junit.Before; import org.junit.Ignore; import org.junit.Test; @@ -41,7 +46,6 @@ import org.opendaylight.controller.config.yang.test.impl.NetconfTestImplModuleMX import org.opendaylight.controller.config.yang.test.impl.Peers; import org.opendaylight.controller.config.yangjmxgenerator.ModuleMXBeanEntry; import org.opendaylight.controller.netconf.api.NetconfDocumentedException; -import org.opendaylight.controller.netconf.api.NetconfOperationRouter; import org.opendaylight.controller.netconf.confignetconfconnector.operations.Commit; import org.opendaylight.controller.netconf.confignetconfconnector.operations.DiscardChanges; import org.opendaylight.controller.netconf.confignetconfconnector.operations.editconfig.EditConfig; @@ -52,7 +56,8 @@ import org.opendaylight.controller.netconf.confignetconfconnector.osgi.YangStore import org.opendaylight.controller.netconf.confignetconfconnector.osgi.YangStoreSnapshot; import org.opendaylight.controller.netconf.confignetconfconnector.transactions.TransactionProvider; import org.opendaylight.controller.netconf.impl.mapping.operations.DefaultCloseSession; -import org.opendaylight.controller.netconf.impl.osgi.NetconfOperationServiceSnapshot; +import org.opendaylight.controller.netconf.impl.osgi.NetconfOperationRouter; +import org.opendaylight.controller.netconf.impl.osgi.NetconfOperationServiceSnapshotImpl; import org.opendaylight.controller.netconf.mapping.api.HandlingPriority; import org.opendaylight.controller.netconf.mapping.api.NetconfOperation; import org.opendaylight.controller.netconf.mapping.api.NetconfOperationChainedExecution; @@ -72,7 +77,10 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.w3c.dom.Document; import org.w3c.dom.Element; +import org.w3c.dom.Node; import org.w3c.dom.NodeList; +import org.w3c.dom.Text; +import org.w3c.dom.traversal.DocumentTraversal; import org.xml.sax.SAXException; import javax.management.InstanceAlreadyExistsException; @@ -87,11 +95,13 @@ import java.net.URISyntaxException; import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; +import java.util.Collections; import java.util.HashSet; import java.util.List; import java.util.Map; import java.util.Set; +import static org.custommonkey.xmlunit.XMLAssert.assertXMLEqual; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertThat; import static org.junit.Assert.assertTrue; @@ -101,6 +111,9 @@ import static org.mockito.Mockito.doReturn; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.verifyNoMoreInteractions; +import static org.opendaylight.controller.netconf.util.test.XmlUnitUtil.assertContainsElement; +import static org.opendaylight.controller.netconf.util.test.XmlUnitUtil.assertContainsElementWithText; +import static org.opendaylight.controller.netconf.util.xml.XmlUtil.readXmlToElement; public class NetconfMappingTest extends AbstractConfigTest { @@ -108,6 +121,7 @@ public class NetconfMappingTest extends AbstractConfigTest { private static final String INSTANCE_NAME = "instance-from-code"; private static final String NETCONF_SESSION_ID = "foo"; + private static final String TEST_NAMESPACE= "urn:opendaylight:params:xml:ns:yang:controller:test:impl"; private NetconfTestImplModuleFactory factory; private DepTestImplModuleFactory factory2; private IdentityTestModuleFactory factory3; @@ -117,7 +131,7 @@ public class NetconfMappingTest extends AbstractConfigTest { @Mock NetconfOperationRouter netconfOperationRouter; @Mock - NetconfOperationServiceSnapshot netconfOperationServiceSnapshot; + NetconfOperationServiceSnapshotImpl netconfOperationServiceSnapshot; private TransactionProvider transactionProvider; @@ -180,72 +194,101 @@ public class NetconfMappingTest extends AbstractConfigTest { createModule(INSTANCE_NAME); edit("netconfMessages/editConfig.xml"); - Element config = getConfigCandidate(); - assertCorrectServiceNames(config, 6, "ref_test2", "user_to_instance_from_code", "ref_dep_user", + Document config = getConfigCandidate(); + assertCorrectServiceNames(config, Sets.newHashSet("ref_test2", "user_to_instance_from_code", "ref_dep_user", "ref_dep_user_two", "ref_from_code_to_instance-from-code_dep_1", - "ref_from_code_to_instance-from-code_1"); + "ref_from_code_to_instance-from-code_1")); edit("netconfMessages/editConfig_addServiceName.xml"); config = getConfigCandidate(); - assertCorrectServiceNames(config, 7, "ref_test2", "user_to_instance_from_code", "ref_dep_user", + assertCorrectServiceNames(config, Sets.newHashSet("ref_test2", "user_to_instance_from_code", "ref_dep_user", "ref_dep_user_two", "ref_from_code_to_instance-from-code_dep_1", - "ref_from_code_to_instance-from-code_1", "ref_dep_user_another"); + "ref_from_code_to_instance-from-code_1", "ref_dep_user_another")); edit("netconfMessages/editConfig_addServiceNameOnTest.xml"); config = getConfigCandidate(); - assertCorrectServiceNames(config, 7, "ref_test2", "user_to_instance_from_code", "ref_dep_user", + assertCorrectServiceNames(config, Sets.newHashSet("ref_test2", "user_to_instance_from_code", "ref_dep_user", "ref_dep_user_two", "ref_from_code_to_instance-from-code_dep_1", - "ref_from_code_to_instance-from-code_1", "ref_dep_user_another"); + "ref_from_code_to_instance-from-code_1", "ref_dep_user_another")); commit(); config = getConfigRunning(); assertCorrectRefNamesForDependencies(config); - assertCorrectServiceNames(config, 7, "ref_test2", "user_to_instance_from_code", "ref_dep_user", + assertCorrectServiceNames(config, Sets.newHashSet("ref_test2", "user_to_instance_from_code", "ref_dep_user", "ref_dep_user_two", "ref_from_code_to_instance-from-code_dep_1", - "ref_from_code_to_instance-from-code_1", "ref_dep_user_another"); + "ref_from_code_to_instance-from-code_1", "ref_dep_user_another")); edit("netconfMessages/editConfig_replace_default.xml"); config = getConfigCandidate(); - assertCorrectServiceNames(config, 2, "ref_dep", "ref_dep2"); + assertCorrectServiceNames(config, Sets.newHashSet("ref_dep", "ref_dep2")); edit("netconfMessages/editConfig_remove.xml"); config = getConfigCandidate(); - assertCorrectServiceNames(config, 0); + assertCorrectServiceNames(config, Collections.emptySet()); commit(); config = getConfigCandidate(); - assertCorrectServiceNames(config, 0); + assertCorrectServiceNames(config, Collections.emptySet()); } - private void assertCorrectRefNamesForDependencies(Element config) { + private void assertCorrectRefNamesForDependencies(Document config) throws NodeTestException { NodeList modulesList = config.getElementsByTagName("modules"); assertEquals(1, modulesList.getLength()); - Element modules = (Element) modulesList.item(0); + NodeTest nt = new NodeTest((DocumentTraversal) config, modulesList.item(0)); + NodeTester tester = new AbstractNodeTester() { + private int defaultRefNameCount = 0; + private int userRefNameCount = 0; - String trimmedModules = XmlUtil.toString(modules).replaceAll("\\s", ""); - int defaultRefNameCount = StringUtils.countMatches(trimmedModules, "ref_dep2"); - int userRefNameCount = StringUtils.countMatches(trimmedModules, "ref_dep_user_two"); + @Override + public void testText(Text text) throws NodeTestException { + if(text.getData().equals("ref_dep2")) { + defaultRefNameCount++; + } else if(text.getData().equals("ref_dep_user_two")) { + userRefNameCount++; + } + } - assertEquals(0, defaultRefNameCount); - assertEquals(2, userRefNameCount); + @Override + public void noMoreNodes(NodeTest forTest) throws NodeTestException { + assertEquals(0, defaultRefNameCount); + assertEquals(2, userRefNameCount); + } + }; + nt.performTest(tester, Node.TEXT_NODE); } - private void assertCorrectServiceNames(Element configCandidate, int servicesSize, String... refNames) { - NodeList elements = configCandidate.getElementsByTagName("provider"); - assertEquals(servicesSize, elements.getLength()); + private void assertCorrectServiceNames(Document configCandidate, final Set refNames) throws NodeTestException { - NodeList servicesList = configCandidate.getElementsByTagName("services"); - assertEquals(1, servicesList.getLength()); + NodeList servicesNodes = configCandidate.getElementsByTagName("services"); + assertEquals(1, servicesNodes.getLength()); - Element services = (Element) servicesList.item(0); - String trimmedServices = XmlUtil.toString(services).replaceAll("\\s", ""); + NodeTest nt = new NodeTest((DocumentTraversal) configCandidate, servicesNodes.item(0)); + NodeTester tester = new AbstractNodeTester() { - for (String s : refNames) { - assertThat(trimmedServices, JUnitMatchers.containsString(s)); - } + @Override + public void testElement(Element element) throws NodeTestException { + if(element.getNodeName() != null) { + if(element.getNodeName().equals("name")) { + String elmText = element.getTextContent(); + if(refNames.contains(elmText)) { + refNames.remove(elmText); + return; + } else { + throw new NodeTestException("Unexpected services defined: " + elmText); + } + } + } + } + + @Override + public void noMoreNodes(NodeTest forTest) throws NodeTestException { + assertTrue(refNames.isEmpty()); + } + }; + nt.performTest(tester, Node.ELEMENT_NODE); } @Test @@ -255,19 +298,18 @@ public class NetconfMappingTest extends AbstractConfigTest { edit("netconfMessages/editConfig.xml"); commit(); - Element response = getConfigRunning(); - String trimmedResponse = XmlUtil.toString(response).replaceAll("\\s", ""); - assertContainsString(trimmedResponse, "0:0:0:0:0:0:0:1"); - assertContainsString(trimmedResponse, "456"); + Document response = getConfigRunning(); + Element ipElement = readXmlToElement("0:0:0:0:0:0:0:1"); + assertContainsElement(response, readXmlToElement("0:0:0:0:0:0:0:1")); + + assertContainsElement(response, readXmlToElement("456")); edit("netconfMessages/editConfig_setUnions.xml"); commit(); response = getConfigRunning(); - - trimmedResponse = XmlUtil.toString(response).replaceAll("\\s", ""); - assertContainsString(trimmedResponse, "127.1.2.3"); - assertContainsString(trimmedResponse, "randomStringForUnion"); + assertContainsElement(response, readXmlToElement("127.1.2.3")); + assertContainsElement(response, readXmlToElement("randomStringForUnion")); } @@ -277,7 +319,7 @@ public class NetconfMappingTest extends AbstractConfigTest { createModule(INSTANCE_NAME); edit("netconfMessages/editConfig.xml"); - Element configCandidate = getConfigCandidate(); + Document configCandidate = getConfigCandidate(); checkBinaryLeafEdited(configCandidate); @@ -287,7 +329,7 @@ public class NetconfMappingTest extends AbstractConfigTest { // check after edit commit(); - Element response = getConfigRunning(); + Document response = getConfigRunning(); checkBinaryLeafEdited(response); checkTypeConfigAttribute(response); @@ -299,17 +341,12 @@ public class NetconfMappingTest extends AbstractConfigTest { edit("netconfMessages/editConfig_remove.xml"); commit(); - response = getConfigCandidate(); - final String responseFromCandidate = XmlUtil.toString(response).replaceAll("\\s+", ""); - response = getConfigRunning(); - final String responseFromRunning = XmlUtil.toString(response).replaceAll("\\s+", ""); - assertEquals(responseFromCandidate, responseFromRunning); - - final String expectedResult = XmlFileLoader.fileToString("netconfMessages/editConfig_expectedResult.xml") - .replaceAll("\\s+", ""); + assertXMLEqual(getConfigCandidate(), getConfigRunning()); - assertEquals(expectedResult, responseFromRunning); - assertEquals(expectedResult, responseFromCandidate); + final Document expectedResult = XmlFileLoader.xmlFileToDocument("netconfMessages/editConfig_expectedResult.xml"); + XMLUnit.setIgnoreWhitespace(true); + assertXMLEqual(expectedResult, getConfigRunning()); + assertXMLEqual(expectedResult, getConfigCandidate()); edit("netconfMessages/editConfig_none.xml"); closeSession(); @@ -318,12 +355,10 @@ public class NetconfMappingTest extends AbstractConfigTest { verifyNoMoreInteractions(netconfOperationServiceSnapshot); } - private void checkBigDecimal(Element response) { - String responseTrimmed = XmlUtil.toString(response).replaceAll("\\s", ""); - - assertContainsString(responseTrimmed, "2.58"); + private void checkBigDecimal(Document response) throws NodeTestException, SAXException, IOException { + assertContainsElement(response, readXmlToElement("2.58")); // Default - assertContainsString(responseTrimmed, "2.00"); + assertContainsElement(response, readXmlToElement("2.00")); } @@ -345,14 +380,14 @@ public class NetconfMappingTest extends AbstractConfigTest { executeOp(commitOp, "netconfMessages/commit.xml"); } - private Element getConfigCandidate() throws ParserConfigurationException, SAXException, IOException, + private Document getConfigCandidate() throws ParserConfigurationException, SAXException, IOException, NetconfDocumentedException { GetConfig getConfigOp = new GetConfig(yangStoreSnapshot, Optional. absent(), transactionProvider, configRegistryClient, NETCONF_SESSION_ID); return executeOp(getConfigOp, "netconfMessages/getConfig_candidate.xml"); } - private Element getConfigRunning() throws ParserConfigurationException, SAXException, IOException, + private Document getConfigRunning() throws ParserConfigurationException, SAXException, IOException, NetconfDocumentedException { GetConfig getConfigOp = new GetConfig(yangStoreSnapshot, Optional. absent(), transactionProvider, configRegistryClient, NETCONF_SESSION_ID); @@ -376,7 +411,7 @@ public class NetconfMappingTest extends AbstractConfigTest { edit("netconfMessages/editConfig.xml"); commit(); - Element response = getConfigRunning(); + Document response = getConfigRunning(); final int allInstances = response.getElementsByTagName("module").getLength(); edit("netconfMessages/editConfig_replace_default.xml"); @@ -396,7 +431,7 @@ public class NetconfMappingTest extends AbstractConfigTest { } catch (NetconfDocumentedException e) { String message = e.getMessage(); assertContainsString(message, "Element simple-long-2 present multiple times with different namespaces"); - assertContainsString(message, "urn:opendaylight:params:xml:ns:yang:controller:test:impl"); + assertContainsString(message, TEST_NAMESPACE); assertContainsString(message, XmlNetconfConstants.URN_OPENDAYLIGHT_PARAMS_XML_NS_YANG_CONTROLLER_CONFIG); throw e; } @@ -422,7 +457,7 @@ public class NetconfMappingTest extends AbstractConfigTest { } catch (NetconfDocumentedException e) { String message = e.getMessage(); assertContainsString(message, "Element binaryLeaf present multiple times with different namespaces"); - assertContainsString(message, "urn:opendaylight:params:xml:ns:yang:controller:test:impl"); + assertContainsString(message, TEST_NAMESPACE); assertContainsString(message, XmlNetconfConstants.URN_OPENDAYLIGHT_PARAMS_XML_NS_YANG_CONTROLLER_CONFIG); throw e; } @@ -435,7 +470,7 @@ public class NetconfMappingTest extends AbstractConfigTest { edit("netconfMessages/namespaces/editConfig_typeNameConfigAttributeMatching.xml"); commit(); - Element response = getConfigRunning(); + Document response = getConfigRunning(); checkTypeConfigAttribute(response); } @@ -477,7 +512,7 @@ public class NetconfMappingTest extends AbstractConfigTest { edit("netconfMessages/editConfig.xml"); commit(); - Element response = getConfigRunning(); + Document response = getConfigRunning(); final int allInstances = response.getElementsByTagName("instance").getLength(); edit("netconfMessages/editConfig_replace_module.xml"); @@ -506,53 +541,42 @@ public class NetconfMappingTest extends AbstractConfigTest { executeOp(discardOp, "netconfMessages/discardChanges.xml"); } - private void checkBinaryLeafEdited(final Element response) { - String responseTrimmed = XmlUtil.toString(response).replaceAll("\\s", ""); - String substring = "YmluYXJ5"; - assertContainsString(responseTrimmed, substring); - substring = "ZGVmYXVsdEJpbg=="; - assertContainsString(responseTrimmed, substring); + private void checkBinaryLeafEdited(final Document response) throws NodeTestException, SAXException, IOException { + assertContainsElement(response, readXmlToElement("YmluYXJ5")); + assertContainsElement(response, readXmlToElement("ZGVmYXVsdEJpbg==")); } - private void checkTypedefs(final Element response) { - String responseTrimmed = XmlUtil.toString(response).replaceAll("\\s", ""); + private void checkTypedefs(final Document response) throws NodeTestException, SAXException, IOException { - String substring = "10"; - assertContainsString(responseTrimmed, substring); + assertContainsElement(response, readXmlToElement("10")); // Default - assertContainsString(responseTrimmed, - "1"); + assertContainsElement(response, readXmlToElement("1")); - assertContainsString(responseTrimmed, - "20"); + assertContainsElement(response, readXmlToElement("20")); // Default - assertContainsString(responseTrimmed, - "2"); + assertContainsElement(response, readXmlToElement("2")); - assertContainsString(responseTrimmed, - "TWO"); + assertContainsElement(response, readXmlToElement("TWO")); // Default - assertContainsString(responseTrimmed, - "ONE"); + assertContainsElement(response, readXmlToElement("ONE")); } private void assertContainsString(String string, String substring) { assertThat(string, JUnitMatchers.containsString(substring)); } - private void checkEnum(final Element response) { - XmlElement modulesElement = XmlElement.fromDomElement(response).getOnlyChildElement("data") + private void checkEnum(final Document response) throws NetconfDocumentedException { + XmlElement modulesElement = XmlElement.fromDomElement(response.getDocumentElement()).getOnlyChildElement("data") .getOnlyChildElement("modules"); String enumName = "extended-enum"; String enumContent = "TWO"; for (XmlElement moduleElement : modulesElement.getChildElements("module")) { - String name = moduleElement.getOnlyChildElement("name").getTextContent(); + String name = moduleElement.getOnlyChildElement("prefix:name").getTextContent(); if(name.equals(INSTANCE_NAME)) { XmlElement enumAttr = moduleElement.getOnlyChildElement(enumName); assertEquals(enumContent, enumAttr.getTextContent()); - return; } } @@ -560,14 +584,14 @@ public class NetconfMappingTest extends AbstractConfigTest { fail("Enum attribute " + enumName + ":" + enumContent + " not present in " + XmlUtil.toString(response)); } - private void checkTestingDeps(Element response) { + private void checkTestingDeps(Document response) { int testingDepsSize = response.getElementsByTagName("testing-deps").getLength(); assertEquals(2, testingDepsSize); } - private void checkTypeConfigAttribute(Element response) { + private void checkTypeConfigAttribute(Document response) throws NetconfDocumentedException { - XmlElement modulesElement = XmlElement.fromDomElement(response).getOnlyChildElement("data") + XmlElement modulesElement = XmlElement.fromDomElement(response.getDocumentElement()).getOnlyChildElement("data") .getOnlyChildElement("modules"); List expectedValues = Lists.newArrayList("default-string", "configAttributeType"); @@ -575,7 +599,7 @@ public class NetconfMappingTest extends AbstractConfigTest { for (XmlElement moduleElement : modulesElement.getChildElements("module")) { for (XmlElement type : moduleElement.getChildElements("type")) { - if (type.getAttribute(XmlUtil.XMLNS_ATTRIBUTE_KEY).equals("") == false) { + if (type.getNamespace() != null) { configAttributeType.add(type.getTextContent()); } } @@ -629,7 +653,7 @@ public class NetconfMappingTest extends AbstractConfigTest { // check after edit commit(); - Element response = get(); + Document response = get(); assertEquals(2/*With runtime beans*/ + 2 /*Without runtime beans*/, getElementsSize(response, "module")); // data from state @@ -649,29 +673,31 @@ public class NetconfMappingTest extends AbstractConfigTest { RuntimeRpc netconf = new RuntimeRpc(yangStoreSnapshot, configRegistryClient, NETCONF_SESSION_ID); response = executeOp(netconf, "netconfMessages/rpc.xml"); - assertContainsString(XmlUtil.toString(response), "testarg1".toUpperCase()); + assertContainsElementWithText(response, "testarg1"); response = executeOp(netconf, "netconfMessages/rpcInner.xml"); - assertContainsString(XmlUtil.toString(response), "ok"); + Document expectedReplyOk = XmlFileLoader.xmlFileToDocument("netconfMessages/rpc-reply_ok.xml"); + XMLUnit.setIgnoreWhitespace(true); + XMLAssert.assertXMLEqual(expectedReplyOk, response); response = executeOp(netconf, "netconfMessages/rpcInnerInner.xml"); - assertContainsString(XmlUtil.toString(response), "true"); + assertContainsElementWithText(response, "true"); response = executeOp(netconf, "netconfMessages/rpcInnerInner_complex_output.xml"); - assertContainsString(XmlUtil.toString(response), "1"); - assertContainsString(XmlUtil.toString(response), "2"); + assertContainsElementWithText(response, "1"); + assertContainsElementWithText(response, "2"); } - private Element get() throws NetconfDocumentedException, ParserConfigurationException, SAXException, IOException { + private Document get() throws NetconfDocumentedException, ParserConfigurationException, SAXException, IOException { Get getOp = new Get(yangStoreSnapshot, configRegistryClient, NETCONF_SESSION_ID, transactionProvider); return executeOp(getOp, "netconfMessages/get.xml"); } - private int getElementsSize(Element response, String elementName) { + private int getElementsSize(Document response, String elementName) { return response.getElementsByTagName(elementName).getLength(); } - private Element executeOp(final NetconfOperation op, final String filename) throws ParserConfigurationException, + private Document executeOp(final NetconfOperation op, final String filename) throws ParserConfigurationException, SAXException, IOException, NetconfDocumentedException { final Document request = XmlFileLoader.xmlFileToDocument(filename); @@ -683,7 +709,7 @@ public class NetconfMappingTest extends AbstractConfigTest { final Document response = op.handle(request, NetconfOperationChainedExecution.EXECUTION_TERMINATION_POINT); logger.debug("Got response\n{}", XmlUtil.toString(response)); - return response.getDocumentElement(); + return response; } private List getYangs() throws FileNotFoundException {