/* * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ package org.opendaylight.netconf.sal.connect.netconf.schema.mapping; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertNull; import static org.junit.Assert.assertThat; import static org.junit.Assert.assertTrue; import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.CREATE_SUBSCRIPTION_RPC_CONTENT; import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.CREATE_SUBSCRIPTION_RPC_QNAME; import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.GET_SCHEMA_QNAME; import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_CANDIDATE_QNAME; import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_COMMIT_QNAME; import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_DATA_QNAME; import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_DISCARD_CHANGES_QNAME; import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_EDIT_CONFIG_QNAME; import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_CONFIG_QNAME; import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_QNAME; import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_LOCK_QNAME; import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME; import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.createEditConfigStructure; import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.toFilterStructure; import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.toId; import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.toPath; import com.google.common.base.Optional; import com.google.common.collect.Iterables; import com.google.common.collect.Lists; import com.google.common.collect.Maps; import java.io.IOException; import java.util.Arrays; import java.util.Collections; import java.util.HashSet; import java.util.List; import java.util.Map; import java.util.Set; import javax.xml.transform.dom.DOMSource; import org.apache.xerces.dom.TextImpl; import org.custommonkey.xmlunit.Diff; import org.custommonkey.xmlunit.ElementNameAndAttributeQualifier; import org.custommonkey.xmlunit.XMLUnit; import org.hamcrest.CoreMatchers; import org.junit.Before; import org.junit.Test; import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult; import org.opendaylight.mdsal.binding.generator.impl.ModuleInfoBackedContext; import org.opendaylight.mdsal.dom.api.DOMActionResult; import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier; import org.opendaylight.netconf.api.NetconfMessage; import org.opendaylight.netconf.api.xml.XmlUtil; import org.opendaylight.netconf.sal.connect.netconf.schema.NetconfRemoteSchemaYangSourceProvider; import org.opendaylight.netconf.sal.connect.netconf.util.NetconfBaseOps; import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil; import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.$YangModuleInfoImpl; import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfState; import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Capabilities; import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Schemas; import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.Schema; import org.opendaylight.yangtools.yang.common.QName; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument; import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode; import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode; import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild; import org.opendaylight.yangtools.yang.data.api.schema.LeafNode; import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode; import org.opendaylight.yangtools.yang.data.api.schema.MapNode; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; import org.opendaylight.yangtools.yang.data.impl.schema.Builders; import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder; import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeBuilder; import org.opendaylight.yangtools.yang.model.api.ActionDefinition; import org.opendaylight.yangtools.yang.model.api.SchemaContext; import org.opendaylight.yangtools.yang.model.api.SchemaPath; import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils; import org.w3c.dom.Node; import org.xml.sax.SAXException; public class NetconfMessageTransformerTest { private static final String REVISION_EXAMPLE_SERVER_FARM = "2018-08-07"; private static final String URN_EXAMPLE_SERVER_FARM = "urn:example:server-farm"; private NetconfMessageTransformer actionNetconfMessageTransformer; private NetconfMessageTransformer netconfMessageTransformer; private SchemaContext schema; @Before public void setUp() throws Exception { XMLUnit.setIgnoreWhitespace(true); XMLUnit.setIgnoreAttributeOrder(true); XMLUnit.setIgnoreComments(true); schema = getSchema(true); netconfMessageTransformer = getTransformer(schema); actionNetconfMessageTransformer = getActionMessageTransformer(); } @Test public void testLockRequestBaseSchemaNotPresent() throws Exception { final SchemaContext partialSchema = getSchema(false); final NetconfMessageTransformer transformer = getTransformer(partialSchema); final NetconfMessage netconfMessage = transformer.toRpcRequest(toPath(NETCONF_LOCK_QNAME), NetconfBaseOps.getLockContent(NETCONF_CANDIDATE_QNAME)); assertThat(XmlUtil.toString(netconfMessage.getDocument()), CoreMatchers.containsString(""; transformer.toRpcResult(new NetconfMessage(XmlUtil.readXmlToDocument(result)), toPath(NETCONF_LOCK_QNAME)); } @Test public void testDiscardChangesRequest() throws Exception { final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(toPath(NETCONF_DISCARD_CHANGES_QNAME), null); assertThat(XmlUtil.toString(netconfMessage.getDocument()), CoreMatchers.containsString("\n" + "\n" + "yang\n" + "module\n" + "2012-12-12\n" + "\n" + ""); } @Test public void testGetSchemaResponse() throws Exception { final NetconfMessageTransformer transformer = getTransformer(getSchema(true)); final NetconfMessage response = new NetconfMessage(XmlUtil.readXmlToDocument( "\n" + "\n" + "\n" + "Random YANG SCHEMA\n" + "\n" + "\n" + "" )); final DOMRpcResult compositeNodeRpcResult = transformer.toRpcResult(response, toPath(GET_SCHEMA_QNAME)); assertTrue(compositeNodeRpcResult.getErrors().isEmpty()); assertNotNull(compositeNodeRpcResult.getResult()); final DOMSource schemaContent = ((AnyXmlNode) ((ContainerNode) compositeNodeRpcResult.getResult()).getValue().iterator().next()).getValue(); assertThat(schemaContent.getNode().getTextContent(), CoreMatchers.containsString("Random YANG SCHEMA")); } @Test public void testGetConfigResponse() throws Exception { final NetconfMessage response = new NetconfMessage(XmlUtil.readXmlToDocument("\n" + "\n" + "\n" + "\n" + "\n" + "module\n" + "2012-12-12\n" + "x:yang\n" + "\n" + "\n" + "\n" + "\n" + "")); final NetconfMessageTransformer transformer = getTransformer(getSchema(true)); final DOMRpcResult compositeNodeRpcResult = transformer.toRpcResult(response, toPath(NETCONF_GET_CONFIG_QNAME)); assertTrue(compositeNodeRpcResult.getErrors().isEmpty()); assertNotNull(compositeNodeRpcResult.getResult()); final List> values = Lists.newArrayList( NetconfRemoteSchemaYangSourceProvider .createGetSchemaRequest("module", Optional.of("2012-12-12")).getValue()); final Map keys = Maps.newHashMap(); for (final DataContainerChild value : values) { keys.put(value.getNodeType(), value.getValue()); } final YangInstanceIdentifier.NodeIdentifierWithPredicates identifierWithPredicates = new YangInstanceIdentifier.NodeIdentifierWithPredicates(Schema.QNAME, keys); final MapEntryNode schemaNode = Builders.mapEntryBuilder().withNodeIdentifier(identifierWithPredicates).withValue(values).build(); final ContainerNode data = (ContainerNode) ((ContainerNode) compositeNodeRpcResult .getResult()).getChild(toId(NETCONF_DATA_QNAME)).get(); final ContainerNode state = (ContainerNode) data.getChild(toId(NetconfState.QNAME)).get(); final ContainerNode schemas = (ContainerNode) state.getChild(toId(Schemas.QNAME)).get(); final MapNode schemaParent = (MapNode) schemas.getChild(toId(Schema.QNAME)).get(); assertEquals(1, Iterables.size(schemaParent.getValue())); assertEquals(schemaNode, schemaParent.getValue().iterator().next()); } @Test public void testGetConfigRequest() throws Exception { final DataContainerChild filter = toFilterStructure( YangInstanceIdentifier.create(toId(NetconfState.QNAME), toId(Schemas.QNAME)), schema); final DataContainerChild source = NetconfBaseOps.getSourceNode(NETCONF_RUNNING_QNAME); final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(toPath(NETCONF_GET_CONFIG_QNAME), NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_QNAME, source, filter)); assertSimilarXml(netconfMessage, "\n" + "\n" + "\n" + "\n" + "\n" + "" + "\n" + "\n" + "\n" + "\n" + "" + ""); } @Test public void testEditConfigRequest() throws Exception { final List> values = Lists.newArrayList( NetconfRemoteSchemaYangSourceProvider .createGetSchemaRequest("module", Optional.of("2012-12-12")).getValue()); final Map keys = Maps.newHashMap(); for (final DataContainerChild value : values) { keys.put(value.getNodeType(), value.getValue()); } final YangInstanceIdentifier.NodeIdentifierWithPredicates identifierWithPredicates = new YangInstanceIdentifier.NodeIdentifierWithPredicates(Schema.QNAME, keys); final MapEntryNode schemaNode = Builders.mapEntryBuilder().withNodeIdentifier(identifierWithPredicates).withValue(values).build(); final YangInstanceIdentifier id = YangInstanceIdentifier.builder() .node(NetconfState.QNAME).node(Schemas.QNAME).node(Schema.QNAME) .nodeWithKey(Schema.QNAME, keys).build(); final DataContainerChild editConfigStructure = createEditConfigStructure(BaseSchema.BASE_NETCONF_CTX_WITH_NOTIFICATIONS.getSchemaContext(), id, Optional.absent(), Optional.fromNullable(schemaNode)); final DataContainerChild target = NetconfBaseOps.getTargetNode(NETCONF_CANDIDATE_QNAME); final ContainerNode wrap = NetconfMessageTransformUtil.wrap(NETCONF_EDIT_CONFIG_QNAME, editConfigStructure, target); final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(toPath(NETCONF_EDIT_CONFIG_QNAME), wrap); assertSimilarXml(netconfMessage, "\n" + "\n" + "\n" + "\n" + "\n" + "\n" + "\n" + "\n" + "\n" + "module\n" + "2012-12-12\n" + "yang\n" + "\n" + "\n" + "\n" + "\n" + "\n" + ""); } private static void assertSimilarXml(final NetconfMessage netconfMessage, final String xmlContent) throws SAXException, IOException { final Diff diff = XMLUnit.compareXML(netconfMessage.getDocument(), XmlUtil.readXmlToDocument(xmlContent)); diff.overrideElementQualifier(new ElementNameAndAttributeQualifier()); assertTrue(diff.toString(), diff.similar()); } @Test public void testGetRequest() throws Exception { final QName capability = QName.create(Capabilities.QNAME, "capability"); final DataContainerChild filter = toFilterStructure( YangInstanceIdentifier.create(toId(NetconfState.QNAME), toId(Capabilities.QNAME), toId(capability), new YangInstanceIdentifier.NodeWithValue<>(capability, "a:b:c")), schema); final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(toPath(NETCONF_GET_QNAME), NetconfMessageTransformUtil.wrap(NETCONF_GET_QNAME, filter)); assertSimilarXml(netconfMessage, "" + "\n" + "\n" + "\n" + "\n" + "a:b:c\n" + "\n" + "" + "\n" + "" + ""); } private static NetconfMessageTransformer getTransformer(final SchemaContext schema) { return new NetconfMessageTransformer(schema, true); } @Test public void testCommitResponse() throws Exception { final NetconfMessage response = new NetconfMessage(XmlUtil.readXmlToDocument( "" )); final DOMRpcResult compositeNodeRpcResult = netconfMessageTransformer.toRpcResult(response, toPath(NETCONF_COMMIT_QNAME)); assertTrue(compositeNodeRpcResult.getErrors().isEmpty()); assertNull(compositeNodeRpcResult.getResult()); } public SchemaContext getSchema(final boolean addBase) { final ModuleInfoBackedContext moduleInfoBackedContext = ModuleInfoBackedContext.create(); if (addBase) { moduleInfoBackedContext.addModuleInfos(Collections.singleton($YangModuleInfoImpl.getInstance())); } moduleInfoBackedContext .addModuleInfos(Collections.singleton(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf .netconf.monitoring.rev101004.$YangModuleInfoImpl.getInstance())); return moduleInfoBackedContext.tryToCreateSchemaContext().get(); } @Test public void getActionsTest() { QName reset = QName.create(URN_EXAMPLE_SERVER_FARM, REVISION_EXAMPLE_SERVER_FARM, "reset"); QName start = QName.create(reset, "start"); QName open = QName.create(start, "open"); Set qnames = new HashSet<>(Arrays.asList(reset, start, open)); Set actions = actionNetconfMessageTransformer.getActions(); assertTrue(!actions.isEmpty()); for (ActionDefinition actionDefinition : actions) { QName qname = actionDefinition.getQName(); assertTrue(qnames.contains(qname)); qnames.remove(qname); } } @Test public void toActionRequestListTopLevelTest() { QName qname = QName.create(URN_EXAMPLE_SERVER_FARM, REVISION_EXAMPLE_SERVER_FARM, "server"); QName nameQname = QName.create(qname, "name"); QName actionResetQName = QName.create(qname, "reset"); Set nodeIdentifiers = Collections.singleton(new NodeIdentifierWithPredicates(qname, nameQname, "test")); DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers); ContainerNode data = initInputAction(QName.create(qname, "reset-at"), "now"); NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest( SchemaPath.create(true, actionResetQName), domDataTreeIdentifier, data); Node childAction = checkBasePartOfActionRequest(actionRequest); Node childServer = childAction.getFirstChild(); checkNode(childServer, "server", "server", qname.getNamespace().toString()); Node childName = childServer.getFirstChild(); checkNode(childName, "name", "name", qname.getNamespace().toString()); TextImpl childTest = (TextImpl) childName.getFirstChild(); assertEquals(childTest.getData(), "test"); checkAction(actionResetQName, childName.getNextSibling(), "reset-at", "reset-at", "now"); } @Test public void toActionRequestContainerTopLevelTest() { QName qname = QName.create(URN_EXAMPLE_SERVER_FARM, REVISION_EXAMPLE_SERVER_FARM, "device"); QName actionStartQName = QName.create(qname, "start"); Set nodeIdentifiers = Collections.singleton(NodeIdentifier.create(qname)); DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers); NormalizedNode payload = initInputAction(QName.create(qname, "start-at"), "now"); NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest( SchemaPath.create(true, actionStartQName), domDataTreeIdentifier, payload); Node childAction = checkBasePartOfActionRequest(actionRequest); Node childDevice = childAction.getFirstChild(); checkNode(childDevice, "device", "device", qname.getNamespace().toString()); checkAction(actionStartQName, childDevice.getFirstChild(), "start-at", "start-at", "now"); } @Test public void toActionRequestContainerInContainerTest() { QName boxOutQName = QName.create(URN_EXAMPLE_SERVER_FARM, REVISION_EXAMPLE_SERVER_FARM, "box-out"); QName boxInQName = QName.create(URN_EXAMPLE_SERVER_FARM, REVISION_EXAMPLE_SERVER_FARM, "box-in"); QName actionOpenQName = QName.create(boxOutQName, "open"); Set nodeIdentifiers = new HashSet<>(); nodeIdentifiers.add(NodeIdentifier.create(boxOutQName)); nodeIdentifiers.add(NodeIdentifier.create(boxInQName)); DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers); NormalizedNode payload = initInputAction(QName.create(boxOutQName, "start-at"), "now"); NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest( SchemaPath.create(true, actionOpenQName), domDataTreeIdentifier, payload); Node childAction = checkBasePartOfActionRequest(actionRequest); Node childBoxOut = childAction.getFirstChild(); checkNode(childBoxOut, "box-out", "box-out", boxOutQName.getNamespace().toString()); Node childBoxIn = childBoxOut.getFirstChild(); checkNode(childBoxIn, "box-in", "box-in", boxOutQName.getNamespace().toString()); Node action = childBoxIn.getFirstChild(); checkNode(action, null, actionOpenQName.getLocalName(), null); } @SuppressWarnings({ "rawtypes", "unchecked" }) @Test public void toActionResultTest() throws Exception { QName qname = QName.create(URN_EXAMPLE_SERVER_FARM, REVISION_EXAMPLE_SERVER_FARM, "reset"); NetconfMessage message = new NetconfMessage(XmlUtil.readXmlToDocument( "" + "" + "now" + "" + "")); DOMActionResult actionResult = actionNetconfMessageTransformer.toActionResult( SchemaPath.create(true, qname), message); assertNotNull(actionResult); ContainerNode containerNode = actionResult.getOutput().get(); assertNotNull(containerNode); LeafNode leaf = (LeafNode) containerNode.getValue().iterator().next(); assertEquals("now", leaf.getValue()); } private void checkAction(QName actionQname, Node action , String inputLocalName, String inputNodeName, String inputValue) { checkNode(action, null, actionQname.getLocalName(), null); Node childResetAt = action.getFirstChild(); checkNode(childResetAt, inputLocalName, inputNodeName, actionQname.getNamespace().toString()); TextImpl firstChild = (TextImpl) childResetAt.getFirstChild(); assertEquals(firstChild.getData(), inputValue); } private Node checkBasePartOfActionRequest(NetconfMessage actionRequest) { Node baseRpc = actionRequest.getDocument().getFirstChild(); checkNode(baseRpc, "rpc", "rpc", NetconfMessageTransformUtil.NETCONF_QNAME.getNamespace().toString()); assertTrue(baseRpc.getLocalName().equals("rpc")); assertTrue(baseRpc.getNodeName().equals("rpc")); Node messageId = baseRpc.getAttributes().getNamedItem("message-id"); assertNotNull(messageId); assertTrue(messageId.getNodeValue().contains("m-")); Node childAction = baseRpc.getFirstChild(); checkNode(childAction, "action", "action", NetconfMessageTransformUtil.NETCONF_ACTION_NAMESPACE.toString()); return childAction; } private DOMDataTreeIdentifier prepareDataTreeId(Set nodeIdentifiers) { YangInstanceIdentifier yangInstanceIdentifier = YangInstanceIdentifier.builder().append(nodeIdentifiers).build(); DOMDataTreeIdentifier domDataTreeIdentifier = new DOMDataTreeIdentifier(org.opendaylight.mdsal.common.api.LogicalDatastoreType.CONFIGURATION, yangInstanceIdentifier); return domDataTreeIdentifier; } private ContainerNode initInputAction(QName qname, String value) { ImmutableLeafNodeBuilder immutableLeafNodeBuilder = new ImmutableLeafNodeBuilder<>(); DataContainerChild build = immutableLeafNodeBuilder.withNodeIdentifier( NodeIdentifier.create(qname)).withValue(value).build(); ContainerNode data = ImmutableContainerNodeBuilder.create().withNodeIdentifier(NodeIdentifier.create( QName.create(qname, "input"))).withChild(build).build(); return data; } private void checkNode(Node childServer, String expectedLocalName, String expectedNodeName, String expectedNamespace) { assertNotNull(childServer); assertEquals(childServer.getLocalName(), expectedLocalName); assertEquals(childServer.getNodeName(), expectedNodeName); assertEquals(childServer.getNamespaceURI(), expectedNamespace); } private SchemaContext getActionSchema() { return YangParserTestUtils.parseYangResource("/schemas/example-server-farm.yang"); } private NetconfMessageTransformer getActionMessageTransformer() { return new NetconfMessageTransformer(getActionSchema(), true); } }