2 * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.netconf.sal.connect.netconf.schema.mapping;
10 import static org.hamcrest.CoreMatchers.instanceOf;
11 import static org.hamcrest.MatcherAssert.assertThat;
12 import static org.junit.Assert.assertEquals;
13 import static org.junit.Assert.assertNotNull;
14 import static org.junit.Assert.assertNull;
15 import static org.junit.Assert.assertTrue;
16 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.CREATE_SUBSCRIPTION_RPC_CONTENT;
17 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.CREATE_SUBSCRIPTION_RPC_QNAME;
18 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.GET_SCHEMA_QNAME;
19 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_CANDIDATE_NODEID;
20 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_COMMIT_QNAME;
21 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_DISCARD_CHANGES_QNAME;
22 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_EDIT_CONFIG_QNAME;
23 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_CONFIG_QNAME;
24 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_QNAME;
25 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_LOCK_QNAME;
26 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_RUNNING_NODEID;
27 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.createEditConfigStructure;
28 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.toFilterStructure;
29 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.toId;
30 import static org.opendaylight.netconf.util.NetconfUtil.NETCONF_DATA_QNAME;
32 import com.google.common.collect.Iterables;
33 import com.google.common.collect.Lists;
34 import java.io.IOException;
35 import java.util.ArrayList;
36 import java.util.HashMap;
37 import java.util.HashSet;
38 import java.util.List;
40 import java.util.Optional;
42 import javax.xml.transform.dom.DOMSource;
43 import org.custommonkey.xmlunit.Diff;
44 import org.custommonkey.xmlunit.ElementNameAndAttributeQualifier;
45 import org.custommonkey.xmlunit.XMLUnit;
46 import org.hamcrest.CoreMatchers;
47 import org.junit.AfterClass;
48 import org.junit.Before;
49 import org.junit.BeforeClass;
50 import org.junit.Test;
51 import org.opendaylight.mdsal.binding.runtime.spi.BindingRuntimeHelpers;
52 import org.opendaylight.mdsal.dom.api.DOMActionResult;
53 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
54 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
55 import org.opendaylight.netconf.api.NetconfMessage;
56 import org.opendaylight.netconf.api.xml.XmlUtil;
57 import org.opendaylight.netconf.sal.connect.netconf.AbstractBaseSchemasTest;
58 import org.opendaylight.netconf.sal.connect.netconf.schema.NetconfRemoteSchemaYangSourceProvider;
59 import org.opendaylight.netconf.sal.connect.netconf.util.FieldsFilter;
60 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfBaseOps;
61 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
62 import org.opendaylight.netconf.util.NetconfUtil;
63 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.IetfNetconfService;
64 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfState;
65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Capabilities;
66 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Datastores;
67 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Schemas;
68 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Sessions;
69 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Statistics;
70 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.datastores.Datastore;
71 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.datastores.datastore.Locks;
72 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.datastores.datastore.locks.lock.type.partial.lock.PartialLock;
73 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.Schema;
74 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.Session;
75 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfConfigChange;
76 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.netconf.config.change.Edit;
77 import org.opendaylight.yangtools.rfc8528.data.util.EmptyMountPointContext;
78 import org.opendaylight.yangtools.yang.common.QName;
79 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
80 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
81 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
82 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
83 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
84 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
85 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
86 import org.opendaylight.yangtools.yang.data.api.schema.AnyxmlNode;
87 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
88 import org.opendaylight.yangtools.yang.data.api.schema.DOMSourceAnyxmlNode;
89 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
90 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
91 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
92 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
93 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
94 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
95 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
96 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
97 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
98 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
99 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
100 import org.w3c.dom.Node;
101 import org.xml.sax.SAXException;
103 public class NetconfMessageTransformerTest extends AbstractBaseSchemasTest {
105 private static final String REVISION_EXAMPLE_SERVER_FARM = "2018-08-07";
106 private static final String URN_EXAMPLE_SERVER_FARM = "urn:example:server-farm";
108 private static final String REVISION_EXAMPLE_SERVER_FARM_2 = "2019-05-20";
109 private static final String URN_EXAMPLE_SERVER_FARM_2 = "urn:example:server-farm-2";
111 private static final String URN_EXAMPLE_CONFLICT = "urn:example:conflict";
113 private static final String URN_EXAMPLE_AUGMENTED_ACTION = "urn:example:augmented-action";
115 private static final String URN_EXAMPLE_RPCS_ACTIONS_OUTPUTS = "urn:example:rpcs-actions-outputs";
117 private static final QName SERVER_QNAME =
118 QName.create(URN_EXAMPLE_SERVER_FARM, REVISION_EXAMPLE_SERVER_FARM, "server");
119 private static final QName RESET_QNAME = QName.create(SERVER_QNAME, "reset");
120 private static final Absolute RESET_SERVER_PATH = Absolute.of(SERVER_QNAME, RESET_QNAME);
121 private static final QName APPLICATIONS_QNAME = QName.create(URN_EXAMPLE_SERVER_FARM_2,
122 REVISION_EXAMPLE_SERVER_FARM_2, "applications");
123 private static final QName APPLICATION_QNAME = QName.create(APPLICATIONS_QNAME, "application");
124 private static final QName KILL_QNAME = QName.create(APPLICATION_QNAME, "kill");
125 private static final Absolute KILL_SERVER_APP_PATH =
126 Absolute.of(SERVER_QNAME, APPLICATIONS_QNAME, APPLICATION_QNAME, KILL_QNAME);
128 private static final QName DEVICE_QNAME =
129 QName.create(URN_EXAMPLE_SERVER_FARM, REVISION_EXAMPLE_SERVER_FARM, "device");
130 private static final QName START_QNAME = QName.create(DEVICE_QNAME, "start");
131 private static final Absolute START_DEVICE_PATH = Absolute.of(DEVICE_QNAME, START_QNAME);
132 private static final QName INTERFACE_QNAME = QName.create(DEVICE_QNAME, "interface");
133 private static final QName ENABLE_QNAME = QName.create(INTERFACE_QNAME, "enable");
134 private static final Absolute ENABLE_INTERFACE_PATH = Absolute.of(DEVICE_QNAME, INTERFACE_QNAME, ENABLE_QNAME);
136 private static final QName DISABLE_QNAME = QName.create(URN_EXAMPLE_AUGMENTED_ACTION, "disable");
137 private static final Absolute DISABLE_INTERFACE_PATH = Absolute.of(DEVICE_QNAME, INTERFACE_QNAME, DISABLE_QNAME);
139 private static final QName CHECK_WITH_OUTPUT_QNAME =
140 QName.create(URN_EXAMPLE_RPCS_ACTIONS_OUTPUTS, "check-with-output");
141 private static final Absolute CHECK_WITH_OUTPUT_INTERFACE_PATH =
142 Absolute.of(DEVICE_QNAME, INTERFACE_QNAME, CHECK_WITH_OUTPUT_QNAME);
143 private static final QName CHECK_WITHOUT_OUTPUT_QNAME =
144 QName.create(URN_EXAMPLE_RPCS_ACTIONS_OUTPUTS, "check-without-output");
145 private static final Absolute CHECK_WITHOUT_OUTPUT_INTERFACE_PATH =
146 Absolute.of(DEVICE_QNAME, INTERFACE_QNAME, CHECK_WITHOUT_OUTPUT_QNAME);
147 private static final QName RPC_WITH_OUTPUT_QNAME =
148 QName.create(URN_EXAMPLE_RPCS_ACTIONS_OUTPUTS, "rpc-with-output");
149 private static final QName RPC_WITHOUT_OUTPUT_QNAME =
150 QName.create(URN_EXAMPLE_RPCS_ACTIONS_OUTPUTS, "rpc-without-output");
152 private static final QName BOX_OUT_QNAME =
153 QName.create(URN_EXAMPLE_SERVER_FARM, REVISION_EXAMPLE_SERVER_FARM, "box-out");
154 private static final QName BOX_IN_QNAME = QName.create(BOX_OUT_QNAME, "box-in");
155 private static final QName OPEN_QNAME = QName.create(BOX_IN_QNAME, "open");
156 private static final Absolute OPEN_BOXES_PATH = Absolute.of(BOX_OUT_QNAME, BOX_IN_QNAME, OPEN_QNAME);
158 private static final QName FOO_QNAME = QName.create(URN_EXAMPLE_CONFLICT, "foo");
159 private static final QName BAR_QNAME = QName.create(URN_EXAMPLE_CONFLICT, "bar");
160 private static final QName XYZZY_QNAME = QName.create(URN_EXAMPLE_CONFLICT, "xyzzy");
161 private static final Absolute XYZZY_FOO_PATH = Absolute.of(FOO_QNAME, XYZZY_QNAME);
162 private static final Absolute XYZZY_BAR_PATH = Absolute.of(BAR_QNAME, XYZZY_QNAME);
164 private static final QName CONFLICT_CHOICE_QNAME = QName.create(URN_EXAMPLE_CONFLICT, "conflict-choice");
165 private static final QName CHOICE_CONT_QNAME = QName.create(URN_EXAMPLE_CONFLICT, "choice-cont");
166 private static final QName CHOICE_ACTION_QNAME = QName.create(URN_EXAMPLE_CONFLICT, "choice-action");
167 private static final Absolute CHOICE_ACTION_PATH =
168 Absolute.of(CONFLICT_CHOICE_QNAME, CHOICE_CONT_QNAME, CHOICE_CONT_QNAME, CHOICE_ACTION_QNAME);
170 private static EffectiveModelContext PARTIAL_SCHEMA;
171 private static EffectiveModelContext SCHEMA;
172 private static EffectiveModelContext ACTION_SCHEMA;
174 private NetconfMessageTransformer actionNetconfMessageTransformer;
175 private NetconfMessageTransformer netconfMessageTransformer;
178 public static void beforeClass() {
179 PARTIAL_SCHEMA = BindingRuntimeHelpers.createEffectiveModel(NetconfState.class);
180 SCHEMA = BindingRuntimeHelpers.createEffectiveModel(IetfNetconfService.class, NetconfState.class,
181 NetconfConfigChange.class);
182 ACTION_SCHEMA = YangParserTestUtils.parseYangResources(NetconfMessageTransformerTest.class,
183 "/schemas/example-server-farm.yang","/schemas/example-server-farm-2.yang",
184 "/schemas/conflicting-actions.yang", "/schemas/augmented-action.yang",
185 "/schemas/rpcs-actions-outputs.yang");
189 public static void afterClass() {
190 PARTIAL_SCHEMA = null;
192 ACTION_SCHEMA = null;
196 public void setUp() throws Exception {
197 XMLUnit.setIgnoreWhitespace(true);
198 XMLUnit.setIgnoreAttributeOrder(true);
199 XMLUnit.setIgnoreComments(true);
201 netconfMessageTransformer = getTransformer(SCHEMA);
202 actionNetconfMessageTransformer = new NetconfMessageTransformer(new EmptyMountPointContext(ACTION_SCHEMA),
203 true, BASE_SCHEMAS.getBaseSchema());
207 public void testLockRequestBaseSchemaNotPresent() throws Exception {
208 final NetconfMessageTransformer transformer = getTransformer(PARTIAL_SCHEMA);
209 final NetconfMessage netconfMessage = transformer.toRpcRequest(NETCONF_LOCK_QNAME,
210 NetconfBaseOps.getLockContent(NETCONF_CANDIDATE_NODEID));
212 assertThat(XmlUtil.toString(netconfMessage.getDocument()), CoreMatchers.containsString("<lock"));
213 assertThat(XmlUtil.toString(netconfMessage.getDocument()), CoreMatchers.containsString("<rpc"));
217 public void testCreateSubscriberNotificationSchemaNotPresent() throws Exception {
218 final NetconfMessageTransformer transformer = new NetconfMessageTransformer(new EmptyMountPointContext(SCHEMA),
219 true, BASE_SCHEMAS.getBaseSchemaWithNotifications());
220 NetconfMessage netconfMessage = transformer.toRpcRequest(CREATE_SUBSCRIPTION_RPC_QNAME,
221 CREATE_SUBSCRIPTION_RPC_CONTENT);
222 String documentString = XmlUtil.toString(netconfMessage.getDocument());
223 assertThat(documentString, CoreMatchers.containsString("<create-subscription"));
224 assertThat(documentString, CoreMatchers.containsString("<rpc"));
228 public void tesLockSchemaRequest() throws Exception {
229 final NetconfMessageTransformer transformer = getTransformer(PARTIAL_SCHEMA);
230 final String result = "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\"><ok/></rpc-reply>";
232 transformer.toRpcResult(
233 RpcResultBuilder.success(new NetconfMessage(XmlUtil.readXmlToDocument(result))).build(),
238 public void testRpcEmptyBodyWithOutputDefinedSchemaResult() throws Exception {
239 final String result = "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\"><ok/></rpc-reply>";
241 DOMRpcResult domRpcResult = actionNetconfMessageTransformer.toRpcResult(
242 RpcResultBuilder.success(new NetconfMessage(XmlUtil.readXmlToDocument(result))).build(),
243 RPC_WITH_OUTPUT_QNAME);
244 assertNotNull(domRpcResult);
248 public void testRpcEmptyBodyWithoutOutputDefinedSchemaResult() throws Exception {
249 final String result = "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\"><ok/></rpc-reply>";
251 DOMRpcResult domRpcResult = actionNetconfMessageTransformer.toRpcResult(
252 RpcResultBuilder.success(new NetconfMessage(XmlUtil.readXmlToDocument(result))).build(),
253 RPC_WITHOUT_OUTPUT_QNAME);
254 assertNotNull(domRpcResult);
258 public void testDiscardChangesRequest() throws Exception {
259 final NetconfMessage netconfMessage =
260 netconfMessageTransformer.toRpcRequest(NETCONF_DISCARD_CHANGES_QNAME, null);
261 assertThat(XmlUtil.toString(netconfMessage.getDocument()), CoreMatchers.containsString("<discard"));
262 assertThat(XmlUtil.toString(netconfMessage.getDocument()), CoreMatchers.containsString("<rpc"));
263 assertThat(XmlUtil.toString(netconfMessage.getDocument()), CoreMatchers.containsString("message-id"));
267 public void testGetSchemaRequest() throws Exception {
268 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(GET_SCHEMA_QNAME,
269 NetconfRemoteSchemaYangSourceProvider.createGetSchemaRequest("module", Optional.of("2012-12-12")));
270 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
271 + "<get-schema xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
272 + "<format>yang</format>\n"
273 + "<identifier>module</identifier>\n"
274 + "<version>2012-12-12</version>\n"
280 public void testGetSchemaResponse() throws Exception {
281 final NetconfMessageTransformer transformer = getTransformer(SCHEMA);
282 final NetconfMessage response = new NetconfMessage(XmlUtil.readXmlToDocument(
283 "<rpc-reply message-id=\"101\"\n"
284 + "xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
286 + "xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
287 + "<xs:schema xmlns:xs=\"http://www.w3.org/2001/XMLSchema\">\n"
288 + "Random YANG SCHEMA\n"
293 final DOMRpcResult compositeNodeRpcResult = transformer.toRpcResult(RpcResultBuilder.success(response).build(),
295 assertTrue(compositeNodeRpcResult.errors().isEmpty());
296 assertNotNull(compositeNodeRpcResult.value());
297 final DOMSource schemaContent = ((DOMSourceAnyxmlNode) compositeNodeRpcResult.value()
298 .body().iterator().next()).body();
299 assertThat(schemaContent.getNode().getTextContent(),
300 CoreMatchers.containsString("Random YANG SCHEMA"));
304 public void testGetConfigResponse() throws Exception {
305 final NetconfMessage response = new NetconfMessage(XmlUtil.readXmlToDocument("<rpc-reply message-id=\"101\"\n"
306 + "xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
308 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
311 + "<identifier>module</identifier>\n"
312 + "<version>2012-12-12</version>\n"
313 + "<format xmlns:x=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">x:yang</format>\n"
316 + "</netconf-state>\n"
320 final NetconfMessageTransformer transformer = getTransformer(SCHEMA);
321 final DOMRpcResult compositeNodeRpcResult = transformer.toRpcResult(RpcResultBuilder.success(response).build(),
322 NETCONF_GET_CONFIG_QNAME);
323 assertTrue(compositeNodeRpcResult.errors().isEmpty());
324 assertNotNull(compositeNodeRpcResult.value());
326 final List<DataContainerChild> values = Lists.newArrayList(
327 NetconfRemoteSchemaYangSourceProvider
328 .createGetSchemaRequest("module", Optional.of("2012-12-12")).body());
330 final Map<QName, Object> keys = new HashMap<>();
331 for (final DataContainerChild value : values) {
332 keys.put(value.getIdentifier().getNodeType(), value.body());
335 final NodeIdentifierWithPredicates identifierWithPredicates =
336 NodeIdentifierWithPredicates.of(Schema.QNAME, keys);
337 final MapEntryNode schemaNode =
338 Builders.mapEntryBuilder().withNodeIdentifier(identifierWithPredicates).withValue(values).build();
340 final DOMSourceAnyxmlNode data = (DOMSourceAnyxmlNode) compositeNodeRpcResult.value()
341 .findChildByArg(toId(NETCONF_DATA_QNAME)).orElseThrow();
343 NormalizedNodeResult nodeResult =
344 NetconfUtil.transformDOMSourceToNormalizedNode(SCHEMA, data.body());
345 ContainerNode result = (ContainerNode) nodeResult.getResult();
346 final ContainerNode state = (ContainerNode) result.findChildByArg(toId(NetconfState.QNAME)).get();
347 final ContainerNode schemas = (ContainerNode) state.findChildByArg(toId(Schemas.QNAME)).get();
348 final MapNode schemaParent = (MapNode) schemas.findChildByArg(toId(Schema.QNAME)).get();
349 assertEquals(1, Iterables.size(schemaParent.body()));
351 assertEquals(schemaNode, schemaParent.body().iterator().next());
355 public void testGetConfigLeafRequest() throws Exception {
356 final AnyxmlNode<?> filter = toFilterStructure(
357 YangInstanceIdentifier.create(toId(NetconfState.QNAME), toId(Schemas.QNAME), toId(Schema.QNAME),
358 NodeIdentifierWithPredicates.of(Schema.QNAME),
359 toId(QName.create(Schemas.QNAME, "version"))), SCHEMA);
361 final ContainerNode source = NetconfBaseOps.getSourceNode(NETCONF_RUNNING_NODEID);
363 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_CONFIG_QNAME,
364 NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_QNAME, source, filter));
366 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
367 + "<get-config xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
368 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
369 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
375 + "</netconf-state>\n"
385 public void testGetConfigRequest() throws Exception {
386 final AnyxmlNode<?> filter = toFilterStructure(
387 YangInstanceIdentifier.create(toId(NetconfState.QNAME), toId(Schemas.QNAME)), SCHEMA);
389 final ContainerNode source = NetconfBaseOps.getSourceNode(NETCONF_RUNNING_NODEID);
391 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_CONFIG_QNAME,
392 NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_QNAME, source, filter));
394 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
395 + "<get-config xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
396 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
397 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
409 public void testEditConfigRequest() throws Exception {
410 final List<DataContainerChild> values = Lists.newArrayList(
411 NetconfRemoteSchemaYangSourceProvider
412 .createGetSchemaRequest("module", Optional.of("2012-12-12")).body());
414 final Map<QName, Object> keys = new HashMap<>();
415 for (final DataContainerChild value : values) {
416 keys.put(value.getIdentifier().getNodeType(), value.body());
419 final NodeIdentifierWithPredicates identifierWithPredicates =
420 NodeIdentifierWithPredicates.of(Schema.QNAME, keys);
421 final MapEntryNode schemaNode =
422 Builders.mapEntryBuilder().withNodeIdentifier(identifierWithPredicates).withValue(values).build();
424 final YangInstanceIdentifier id = YangInstanceIdentifier.builder()
425 .node(NetconfState.QNAME).node(Schemas.QNAME).node(Schema.QNAME)
426 .nodeWithKey(Schema.QNAME, keys).build();
427 final DataContainerChild editConfigStructure =
428 createEditConfigStructure(BASE_SCHEMAS.getBaseSchemaWithNotifications().getEffectiveModelContext(), id,
429 Optional.empty(), Optional.ofNullable(schemaNode));
431 final DataContainerChild target = NetconfBaseOps.getTargetNode(NETCONF_CANDIDATE_NODEID);
433 final ContainerNode wrap =
434 NetconfMessageTransformUtil.wrap(NETCONF_EDIT_CONFIG_QNAME, editConfigStructure, target);
435 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_EDIT_CONFIG_QNAME, wrap);
437 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
443 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
446 + "<identifier>module</identifier>\n"
447 + "<version>2012-12-12</version>\n"
448 + "<format>yang</format>\n"
451 + "</netconf-state>\n"
457 private static void assertSimilarXml(final NetconfMessage netconfMessage, final String xmlContent)
458 throws SAXException, IOException {
459 final Diff diff = XMLUnit.compareXML(netconfMessage.getDocument(), XmlUtil.readXmlToDocument(xmlContent));
460 diff.overrideElementQualifier(new ElementNameAndAttributeQualifier());
461 assertTrue(diff.toString(), diff.similar());
465 public void testGetRequest() throws Exception {
467 final QName capability = QName.create(Capabilities.QNAME, "capability");
468 final DataContainerChild filter = toFilterStructure(
469 YangInstanceIdentifier.create(toId(NetconfState.QNAME), toId(Capabilities.QNAME), toId(capability),
470 new NodeWithValue<>(capability, "a:b:c")), SCHEMA);
472 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_QNAME,
473 NetconfMessageTransformUtil.wrap(NETCONF_GET_QNAME, filter));
475 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">"
476 + "<get xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
477 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
478 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
480 + "<capability>a:b:c</capability>\n"
481 + "</capabilities>\n"
489 public void testGetLeafList() throws IOException, SAXException {
490 final YangInstanceIdentifier path = YangInstanceIdentifier.create(
491 toId(NetconfState.QNAME),
492 toId(Capabilities.QNAME),
493 toId(QName.create(Capabilities.QNAME, "capability")));
494 final DataContainerChild filter = toFilterStructure(path, SCHEMA);
495 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_QNAME,
496 NetconfMessageTransformUtil.wrap(toId(NETCONF_GET_QNAME), filter));
498 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
500 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
501 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
504 + "</capabilities>\n"
505 + "</netconf-state>\n"
512 public void testGetList() throws IOException, SAXException {
513 final YangInstanceIdentifier path = YangInstanceIdentifier.create(
514 toId(NetconfState.QNAME),
515 toId(Datastores.QNAME),
516 toId(QName.create(Datastores.QNAME, "datastore")));
517 final DataContainerChild filter = toFilterStructure(path, SCHEMA);
518 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_QNAME,
519 NetconfMessageTransformUtil.wrap(toId(NETCONF_GET_QNAME), filter));
521 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
523 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
524 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
528 + "</netconf-state>\n"
534 private static NetconfMessageTransformer getTransformer(final EffectiveModelContext schema) {
535 return new NetconfMessageTransformer(new EmptyMountPointContext(schema), true, BASE_SCHEMAS.getBaseSchema());
539 public void testCommitResponse() throws Exception {
540 final NetconfMessage response = new NetconfMessage(XmlUtil.readXmlToDocument(
541 "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\"><ok/></rpc-reply>"
543 final DOMRpcResult compositeNodeRpcResult = netconfMessageTransformer.toRpcResult(
544 RpcResultBuilder.success(response).build(),
545 NETCONF_COMMIT_QNAME);
546 assertTrue(compositeNodeRpcResult.errors().isEmpty());
547 assertNull(compositeNodeRpcResult.value());
551 public void getActionsTest() {
552 Set<Absolute> schemaPaths = new HashSet<>();
553 schemaPaths.add(RESET_SERVER_PATH);
554 schemaPaths.add(START_DEVICE_PATH);
555 schemaPaths.add(ENABLE_INTERFACE_PATH);
556 schemaPaths.add(OPEN_BOXES_PATH);
557 schemaPaths.add(KILL_SERVER_APP_PATH);
558 schemaPaths.add(XYZZY_FOO_PATH);
559 schemaPaths.add(XYZZY_BAR_PATH);
560 schemaPaths.add(CHOICE_ACTION_PATH);
561 schemaPaths.add(DISABLE_INTERFACE_PATH);
562 schemaPaths.add(CHECK_WITH_OUTPUT_INTERFACE_PATH);
563 schemaPaths.add(CHECK_WITHOUT_OUTPUT_INTERFACE_PATH);
565 var actions = NetconfMessageTransformer.getActions(ACTION_SCHEMA);
566 assertEquals(schemaPaths.size(), actions.size());
568 for (var path : schemaPaths) {
569 assertNotNull("Action for " + path + " not found", actions.get(path));
574 public void toActionRequestListTopLevelTest() {
575 QName nameQname = QName.create(SERVER_QNAME, "name");
576 List<PathArgument> nodeIdentifiers = new ArrayList<>();
577 nodeIdentifiers.add(new NodeIdentifier(SERVER_QNAME));
578 nodeIdentifiers.add(NodeIdentifierWithPredicates.of(SERVER_QNAME, nameQname, "test"));
579 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
581 ContainerNode data = initInputAction(QName.create(SERVER_QNAME, "reset-at"), "now");
583 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
584 RESET_SERVER_PATH, domDataTreeIdentifier, data);
586 Node childAction = checkBasePartOfActionRequest(actionRequest);
588 Node childServer = childAction.getFirstChild();
589 checkNode(childServer, "server", "server", URN_EXAMPLE_SERVER_FARM);
591 Node childName = childServer.getFirstChild();
592 checkNode(childName, "name", "name", URN_EXAMPLE_SERVER_FARM);
594 Node childTest = childName.getFirstChild();
595 assertEquals(childTest.getNodeValue(), "test");
597 checkAction(RESET_QNAME, childName.getNextSibling(), "reset-at", "reset-at", "now");
601 public void toActionRequestContainerTopLevelTest() {
602 List<PathArgument> nodeIdentifiers = List.of(NodeIdentifier.create(DEVICE_QNAME));
603 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
605 ContainerNode payload = initInputAction(QName.create(DEVICE_QNAME, "start-at"), "now");
606 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
607 START_DEVICE_PATH, domDataTreeIdentifier, payload);
609 Node childAction = checkBasePartOfActionRequest(actionRequest);
611 Node childDevice = childAction.getFirstChild();
612 checkNode(childDevice, "device", "device", URN_EXAMPLE_SERVER_FARM);
614 checkAction(START_QNAME, childDevice.getFirstChild(), "start-at", "start-at", "now");
618 public void toActionRequestContainerInContainerTest() {
619 List<PathArgument> nodeIdentifiers = new ArrayList<>();
620 nodeIdentifiers.add(NodeIdentifier.create(BOX_OUT_QNAME));
621 nodeIdentifiers.add(NodeIdentifier.create(BOX_IN_QNAME));
623 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
625 ContainerNode payload = initInputAction(QName.create(BOX_OUT_QNAME, "start-at"), "now");
626 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
627 OPEN_BOXES_PATH, domDataTreeIdentifier, payload);
629 Node childAction = checkBasePartOfActionRequest(actionRequest);
631 Node childBoxOut = childAction.getFirstChild();
632 checkNode(childBoxOut, "box-out", "box-out", URN_EXAMPLE_SERVER_FARM);
634 Node childBoxIn = childBoxOut.getFirstChild();
635 checkNode(childBoxIn, "box-in", "box-in", URN_EXAMPLE_SERVER_FARM);
637 Node action = childBoxIn.getFirstChild();
638 checkNode(action, OPEN_QNAME.getLocalName(), OPEN_QNAME.getLocalName(), OPEN_QNAME.getNamespace().toString());
642 public void toActionRequestListInContainerTest() {
643 QName nameQname = QName.create(INTERFACE_QNAME, "name");
645 List<PathArgument> nodeIdentifiers = new ArrayList<>();
646 nodeIdentifiers.add(NodeIdentifier.create(DEVICE_QNAME));
647 nodeIdentifiers.add(NodeIdentifier.create(INTERFACE_QNAME));
648 nodeIdentifiers.add(NodeIdentifierWithPredicates.of(INTERFACE_QNAME, nameQname, "test"));
650 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
652 ContainerNode payload = initEmptyInputAction(INTERFACE_QNAME);
653 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
654 ENABLE_INTERFACE_PATH, domDataTreeIdentifier, payload);
656 Node childAction = checkBasePartOfActionRequest(actionRequest);
658 Node childDevice = childAction.getFirstChild();
659 checkNode(childDevice, "device", "device", URN_EXAMPLE_SERVER_FARM);
661 Node childInterface = childDevice.getFirstChild();
662 checkNode(childInterface, "interface", "interface", URN_EXAMPLE_SERVER_FARM);
664 Node childName = childInterface.getFirstChild();
665 checkNode(childName, "name", "name", nameQname.getNamespace().toString());
667 Node childTest = childName.getFirstChild();
668 assertEquals(childTest.getNodeValue(), "test");
670 Node action = childInterface.getLastChild();
671 checkNode(action, ENABLE_QNAME.getLocalName(), ENABLE_QNAME.getLocalName(),
672 ENABLE_QNAME.getNamespace().toString());
676 public void toActionRequestListInContainerAugmentedIntoListTest() {
677 QName serverNameQname = QName.create(SERVER_QNAME, "name");
678 QName applicationNameQname = QName.create(APPLICATION_QNAME, "name");
680 List<PathArgument> nodeIdentifiers = new ArrayList<>();
681 nodeIdentifiers.add(NodeIdentifier.create(SERVER_QNAME));
682 nodeIdentifiers.add(NodeIdentifierWithPredicates.of(SERVER_QNAME, serverNameQname, "testServer"));
683 nodeIdentifiers.add(new AugmentationIdentifier(Set.of(APPLICATIONS_QNAME)));
684 nodeIdentifiers.add(NodeIdentifier.create(APPLICATIONS_QNAME));
685 nodeIdentifiers.add(NodeIdentifier.create(APPLICATION_QNAME));
686 nodeIdentifiers.add(NodeIdentifierWithPredicates.of(APPLICATION_QNAME,
687 applicationNameQname, "testApplication"));
689 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
691 ContainerNode payload = initEmptyInputAction(APPLICATION_QNAME);
692 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
693 KILL_SERVER_APP_PATH, domDataTreeIdentifier, payload);
695 Node childAction = checkBasePartOfActionRequest(actionRequest);
697 Node childServer = childAction.getFirstChild();
698 checkNode(childServer, "server", "server", URN_EXAMPLE_SERVER_FARM);
700 Node childServerName = childServer.getFirstChild();
701 checkNode(childServerName, "name", "name", URN_EXAMPLE_SERVER_FARM);
703 Node childServerNameTest = childServerName.getFirstChild();
704 assertEquals(childServerNameTest.getNodeValue(), "testServer");
706 Node childApplications = childServer.getLastChild();
707 checkNode(childApplications, "applications", "applications", URN_EXAMPLE_SERVER_FARM_2);
709 Node childApplication = childApplications.getFirstChild();
710 checkNode(childApplication, "application", "application", URN_EXAMPLE_SERVER_FARM_2);
712 Node childApplicationName = childApplication.getFirstChild();
713 checkNode(childApplicationName, "name", "name", URN_EXAMPLE_SERVER_FARM_2);
715 Node childApplicationNameTest = childApplicationName.getFirstChild();
716 assertEquals(childApplicationNameTest.getNodeValue(), "testApplication");
718 Node childKillAction = childApplication.getLastChild();
719 checkNode(childApplication, "application", "application", URN_EXAMPLE_SERVER_FARM_2);
720 checkNode(childKillAction, KILL_QNAME.getLocalName(), KILL_QNAME.getLocalName(),
721 KILL_QNAME.getNamespace().toString());
725 public void toActionRequestConflictingInListTest() {
726 QName barInputQname = QName.create(BAR_QNAME, "bar");
727 QName barIdQname = QName.create(BAR_QNAME, "bar-id");
730 List<PathArgument> nodeIdentifiers = new ArrayList<>();
731 nodeIdentifiers.add(NodeIdentifier.create(BAR_QNAME));
732 nodeIdentifiers.add(NodeIdentifierWithPredicates.of(BAR_QNAME, barIdQname, "test"));
734 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
736 ContainerNode payload = Builders.containerBuilder()
737 .withNodeIdentifier(NodeIdentifier.create(QName.create(barInputQname, "input")))
738 .withChild(ImmutableNodes.leafNode(barInputQname, barInput))
741 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
742 XYZZY_BAR_PATH, domDataTreeIdentifier, payload);
744 Node childAction = checkBasePartOfActionRequest(actionRequest);
746 Node childBar = childAction.getFirstChild();
747 checkNode(childBar, "bar", "bar", URN_EXAMPLE_CONFLICT);
749 Node childBarId = childBar.getFirstChild();
750 checkNode(childBarId, "bar-id", "bar-id", URN_EXAMPLE_CONFLICT);
752 Node childTest = childBarId.getFirstChild();
753 assertEquals(childTest.getNodeValue(), "test");
755 Node action = childBar.getLastChild();
756 checkNode(action, XYZZY_QNAME.getLocalName(), XYZZY_QNAME.getLocalName(),
757 XYZZY_QNAME.getNamespace().toString());
761 public void toActionRequestConflictingInContainerTest() {
762 QName fooInputQname = QName.create(FOO_QNAME, "foo");
764 List<PathArgument> nodeIdentifiers = new ArrayList<>();
765 nodeIdentifiers.add(NodeIdentifier.create(FOO_QNAME));
766 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
767 ContainerNode payload = initInputAction(fooInputQname, "test");
769 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
770 XYZZY_FOO_PATH, domDataTreeIdentifier, payload);
772 Node childAction = checkBasePartOfActionRequest(actionRequest);
774 Node childBar = childAction.getFirstChild();
775 checkNode(childBar, "foo", "foo", URN_EXAMPLE_CONFLICT);
777 Node action = childBar.getLastChild();
778 checkNode(action, XYZZY_QNAME.getLocalName(), XYZZY_QNAME.getLocalName(),
779 XYZZY_QNAME.getNamespace().toString());
783 public void toActionRequestChoiceTest() {
784 List<PathArgument> nodeIdentifiers = new ArrayList<>();
785 nodeIdentifiers.add(NodeIdentifier.create(CONFLICT_CHOICE_QNAME));
786 nodeIdentifiers.add(NodeIdentifier.create(CHOICE_CONT_QNAME));
787 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
788 NormalizedNode payload = initEmptyInputAction(CHOICE_ACTION_QNAME);
790 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
791 CHOICE_ACTION_PATH, domDataTreeIdentifier, payload);
793 Node childAction = checkBasePartOfActionRequest(actionRequest);
795 Node childChoiceCont = childAction.getFirstChild();
796 checkNode(childChoiceCont, "choice-cont", "choice-cont", URN_EXAMPLE_CONFLICT);
798 Node action = childChoiceCont.getLastChild();
799 checkNode(action, CHOICE_ACTION_QNAME.getLocalName(), CHOICE_ACTION_QNAME.getLocalName(),
800 CHOICE_ACTION_QNAME.getNamespace().toString());
804 public void toAugmentedActionRequestListInContainerTest() {
805 QName nameQname = QName.create(INTERFACE_QNAME, "name");
807 List<PathArgument> nodeIdentifiers = new ArrayList<>();
808 nodeIdentifiers.add(NodeIdentifier.create(DEVICE_QNAME));
809 nodeIdentifiers.add(NodeIdentifier.create(INTERFACE_QNAME));
810 nodeIdentifiers.add(NodeIdentifierWithPredicates.of(INTERFACE_QNAME, nameQname, "test"));
812 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
814 NormalizedNode payload = initEmptyInputAction(INTERFACE_QNAME);
815 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
816 DISABLE_INTERFACE_PATH, domDataTreeIdentifier, payload);
818 Node childAction = checkBasePartOfActionRequest(actionRequest);
820 Node childDevice = childAction.getFirstChild();
821 checkNode(childDevice, "device", "device", URN_EXAMPLE_SERVER_FARM);
823 Node childInterface = childDevice.getFirstChild();
824 checkNode(childInterface, "interface", "interface", URN_EXAMPLE_SERVER_FARM);
826 Node childName = childInterface.getFirstChild();
827 checkNode(childName, "name", "name", nameQname.getNamespace().toString());
829 Node childTest = childName.getFirstChild();
830 assertEquals(childTest.getNodeValue(), "test");
832 Node action = childInterface.getLastChild();
833 checkNode(action, DISABLE_QNAME.getLocalName(), DISABLE_QNAME.getLocalName(),
834 DISABLE_QNAME.getNamespace().toString());
838 public void toActionResultTest() throws Exception {
839 NetconfMessage message = new NetconfMessage(XmlUtil.readXmlToDocument(
840 "<rpc-reply message-id=\"101\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">"
841 + "<reset-finished-at xmlns=\"urn:example:server-farm\">"
843 + "</reset-finished-at>"
845 DOMActionResult actionResult = actionNetconfMessageTransformer.toActionResult(RESET_SERVER_PATH, message);
846 assertNotNull(actionResult);
847 ContainerNode containerNode = actionResult.getOutput().get();
848 assertNotNull(containerNode);
849 assertEquals("now", containerNode.body().iterator().next().body());
853 public void toActionEmptyBodyWithOutputDefinedResultTest() throws Exception {
854 NetconfMessage message = new NetconfMessage(XmlUtil.readXmlToDocument(
855 "<rpc-reply message-id=\"101\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">"
858 DOMActionResult actionResult =
859 actionNetconfMessageTransformer.toActionResult(CHECK_WITH_OUTPUT_INTERFACE_PATH, message);
860 assertNotNull(actionResult);
861 assertTrue(actionResult.getOutput().isEmpty());
865 public void toActionEmptyBodyWithoutOutputDefinedResultTest() throws Exception {
866 NetconfMessage message = new NetconfMessage(XmlUtil.readXmlToDocument(
867 "<rpc-reply message-id=\"101\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">"
870 DOMActionResult actionResult =
871 actionNetconfMessageTransformer.toActionResult(CHECK_WITHOUT_OUTPUT_INTERFACE_PATH, message);
872 assertNotNull(actionResult);
873 assertTrue(actionResult.getOutput().isEmpty());
877 public void getTwoNonOverlappingFieldsTest() throws IOException, SAXException {
878 // preparation of the fields
879 final YangInstanceIdentifier parentYiid = YangInstanceIdentifier.create(toId(NetconfState.QNAME));
880 final YangInstanceIdentifier netconfStartTimeField = YangInstanceIdentifier.create(toId(Statistics.QNAME),
881 toId(QName.create(Statistics.QNAME, "netconf-start-time")));
882 final YangInstanceIdentifier datastoresField = YangInstanceIdentifier.create(toId(Datastores.QNAME));
884 // building filter structure and NETCONF message
885 final AnyxmlNode<?> filterStructure = toFilterStructure(
886 List.of(FieldsFilter.of(parentYiid, List.of(netconfStartTimeField, datastoresField))), SCHEMA);
887 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_QNAME,
888 NetconfMessageTransformUtil.wrap(toId(NETCONF_GET_QNAME), filterStructure));
891 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
893 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
894 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
896 + "<netconf-start-time/>\n"
899 + "</netconf-state>\n"
906 public void getOverlappingFieldsTest() throws IOException, SAXException {
907 // preparation of the fields
908 final YangInstanceIdentifier parentYiid = YangInstanceIdentifier.create(toId(NetconfState.QNAME));
909 final YangInstanceIdentifier capabilitiesField = YangInstanceIdentifier.create(toId(Capabilities.QNAME));
910 final YangInstanceIdentifier capabilityField = YangInstanceIdentifier.create(toId(Capabilities.QNAME),
911 toId(QName.create(Capabilities.QNAME, "capability").intern()));
912 final YangInstanceIdentifier datastoreField = YangInstanceIdentifier.create(toId(Datastores.QNAME));
913 final YangInstanceIdentifier locksFields = YangInstanceIdentifier.create(toId(Datastores.QNAME),
914 toId(Datastore.QNAME), NodeIdentifierWithPredicates.of(Datastore.QNAME), toId(Locks.QNAME));
916 // building filter structure and NETCONF message
917 final AnyxmlNode<?> filterStructure = toFilterStructure(
918 List.of(FieldsFilter.of(parentYiid,
919 List.of(capabilitiesField, capabilityField, datastoreField, locksFields))),
921 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_QNAME,
922 NetconfMessageTransformUtil.wrap(toId(NETCONF_GET_QNAME), filterStructure));
925 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
927 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
928 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
929 + "<capabilities/>\n"
931 + "</netconf-state>\n"
938 public void getOverlappingFieldsWithEmptyFieldTest() throws IOException, SAXException {
939 // preparation of the fields
940 final YangInstanceIdentifier parentYiid = YangInstanceIdentifier.create(toId(NetconfState.QNAME));
941 final YangInstanceIdentifier capabilitiesField = YangInstanceIdentifier.create(toId(Capabilities.QNAME));
943 // building filter structure and NETCONF message
944 final AnyxmlNode<?> filterStructure = toFilterStructure(
945 List.of(FieldsFilter.of(parentYiid, List.of(capabilitiesField, YangInstanceIdentifier.empty()))),
947 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_QNAME,
948 NetconfMessageTransformUtil.wrap(toId(NETCONF_GET_QNAME), filterStructure));
951 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
953 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
954 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\"/>\n"
961 public void getSpecificFieldsUnderListTest() throws IOException, SAXException {
962 // preparation of the fields
963 final YangInstanceIdentifier parentYiid = YangInstanceIdentifier.create(toId(NetconfState.QNAME),
964 toId(Schemas.QNAME), toId(Schema.QNAME), NodeIdentifierWithPredicates.of(Schema.QNAME));
965 final YangInstanceIdentifier versionField = YangInstanceIdentifier.create(
966 toId(QName.create(Schema.QNAME, "version").intern()));
967 final YangInstanceIdentifier identifierField = YangInstanceIdentifier.create(
968 toId(QName.create(Schema.QNAME, "namespace").intern()));
970 // building filter structure and NETCONF message
971 final AnyxmlNode<?> filterStructure = toFilterStructure(
972 List.of(FieldsFilter.of(parentYiid, List.of(versionField, identifierField))), SCHEMA);
973 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_QNAME,
974 NetconfMessageTransformUtil.wrap(toId(NETCONF_GET_QNAME), filterStructure));
977 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
979 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
980 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
985 // explicitly fetched list keys - identifier and format
990 + "</netconf-state>\n"
997 public void getSpecificFieldsUnderMultipleLists() throws IOException, SAXException {
998 // preparation of the fields
999 final YangInstanceIdentifier parentYiid = YangInstanceIdentifier.create(
1000 toId(NetconfState.QNAME), toId(Datastores.QNAME));
1001 final YangInstanceIdentifier partialLockYiid = YangInstanceIdentifier.create(toId(Datastore.QNAME),
1002 NodeIdentifierWithPredicates.of(Datastore.QNAME), toId(Locks.QNAME),
1003 toId(QName.create(Locks.QNAME, "lock-type").intern()), toId(PartialLock.QNAME),
1004 NodeIdentifierWithPredicates.of(PartialLock.QNAME));
1005 final YangInstanceIdentifier lockedTimeField = partialLockYiid.node(
1006 QName.create(Locks.QNAME, "locked-time").intern());
1007 final YangInstanceIdentifier lockedBySessionField = partialLockYiid.node(
1008 QName.create(Locks.QNAME, "locked-by-session").intern());
1010 // building filter structure and NETCONF message
1011 final AnyxmlNode<?> filterStructure = toFilterStructure(
1012 List.of(FieldsFilter.of(parentYiid, List.of(lockedTimeField, lockedBySessionField))),
1014 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_QNAME,
1015 NetconfMessageTransformUtil.wrap(toId(NETCONF_GET_QNAME), filterStructure));
1018 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
1020 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
1021 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
1025 + "<partial-lock>\n"
1026 + "<locked-time/>\n"
1027 + "<locked-by-session/>\n"
1029 + "</partial-lock>\n"
1034 + "</netconf-state>\n"
1041 public void getWholeListsUsingFieldsTest() throws IOException, SAXException {
1042 // preparation of the fields
1043 final YangInstanceIdentifier parentYiid = YangInstanceIdentifier.create(toId(NetconfState.QNAME));
1044 final YangInstanceIdentifier datastoreListField = YangInstanceIdentifier.create(toId(Datastores.QNAME),
1045 toId(Datastore.QNAME), NodeIdentifierWithPredicates.of(Datastore.QNAME));
1046 final YangInstanceIdentifier sessionListField = YangInstanceIdentifier.create(toId(Sessions.QNAME),
1047 toId(Session.QNAME), NodeIdentifierWithPredicates.of(Session.QNAME));
1049 // building filter structure and NETCONF message
1050 final AnyxmlNode<?> filterStructure = toFilterStructure(
1051 List.of(FieldsFilter.of(parentYiid, List.of(datastoreListField, sessionListField))), SCHEMA);
1052 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_QNAME,
1053 NetconfMessageTransformUtil.wrap(toId(NETCONF_GET_QNAME), filterStructure));
1056 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
1058 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
1059 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
1066 + "</netconf-state>\n"
1073 public void getSpecificListEntriesWithSpecificFieldsTest() throws IOException, SAXException {
1074 // preparation of the fields
1075 final YangInstanceIdentifier parentYiid = YangInstanceIdentifier.create(toId(NetconfState.QNAME),
1076 toId(Sessions.QNAME));
1077 final QName sessionId = QName.create(Session.QNAME, "session-id").intern();
1078 final YangInstanceIdentifier session1Field = YangInstanceIdentifier.create(toId(Session.QNAME),
1079 NodeIdentifierWithPredicates.of(Session.QNAME, sessionId, 1));
1080 final YangInstanceIdentifier session2TransportField = YangInstanceIdentifier.create(toId(Session.QNAME),
1081 NodeIdentifierWithPredicates.of(Session.QNAME, sessionId, 2),
1082 toId(QName.create(Session.QNAME, "transport").intern()));
1084 // building filter structure and NETCONF message
1085 final AnyxmlNode<?> filterStructure = toFilterStructure(
1086 List.of(FieldsFilter.of(parentYiid, List.of(session1Field, session2TransportField))), SCHEMA);
1087 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_QNAME,
1088 NetconfMessageTransformUtil.wrap(toId(NETCONF_GET_QNAME), filterStructure));
1091 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
1093 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
1094 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
1097 + "<session-id>1</session-id>\n"
1100 + "<session-id>2</session-id>\n"
1104 + "</netconf-state>\n"
1111 // Proof that YANGTOOLS-1362 works on DOM level
1112 public void testConfigChangeToNotification() throws SAXException, IOException {
1113 final var message = new NetconfMessage(XmlUtil.readXmlToDocument(
1114 "<notification xmlns=\"urn:ietf:params:xml:ns:netconf:notification:1.0\">\n"
1115 + " <eventTime>2021-11-11T11:26:16Z</eventTime> \n"
1116 + " <netconf-config-change xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-notifications\">\n"
1117 + " <changed-by> \n"
1118 + " <username>root</username> \n"
1119 + " <session-id>3</session-id> \n"
1120 + " </changed-by> \n"
1121 + " <datastore>running</datastore> \n"
1123 + " <target xmlns:ncm=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">/ncm:netconf-state"
1124 + "/ncm:datastores/ncm:datastore[ncm:name='running']</target>\n"
1125 + " <operation>replace</operation> \n"
1127 + " </netconf-config-change> \n"
1128 + "</notification>"));
1130 final var change = netconfMessageTransformer.toNotification(message).getBody();
1131 final var editList = change.getChildByArg(new NodeIdentifier(Edit.QNAME));
1132 assertThat(editList, instanceOf(UnkeyedListNode.class));
1133 final var edits = ((UnkeyedListNode) editList).body();
1134 assertEquals(1, edits.size());
1135 final var edit = edits.iterator().next();
1136 final var target = edit.getChildByArg(new NodeIdentifier(QName.create(Edit.QNAME, "target"))).body();
1137 assertThat(target, instanceOf(YangInstanceIdentifier.class));
1139 final var args = ((YangInstanceIdentifier) target).getPathArguments();
1140 assertEquals(4, args.size());
1143 private static void checkAction(final QName actionQname, final Node action , final String inputLocalName,
1144 final String inputNodeName, final String inputValue) {
1145 checkNode(action, actionQname.getLocalName(), actionQname.getLocalName(),
1146 actionQname.getNamespace().toString());
1148 Node childResetAt = action.getFirstChild();
1149 checkNode(childResetAt, inputLocalName, inputNodeName, actionQname.getNamespace().toString());
1151 Node firstChild = childResetAt.getFirstChild();
1152 assertEquals(firstChild.getNodeValue(), inputValue);
1155 private static Node checkBasePartOfActionRequest(final NetconfMessage actionRequest) {
1156 Node baseRpc = actionRequest.getDocument().getFirstChild();
1157 checkNode(baseRpc, "rpc", "rpc", NetconfUtil.NETCONF_QNAME.getNamespace().toString());
1158 assertTrue(baseRpc.getLocalName().equals("rpc"));
1159 assertTrue(baseRpc.getNodeName().equals("rpc"));
1161 Node messageId = baseRpc.getAttributes().getNamedItem("message-id");
1162 assertNotNull(messageId);
1163 assertTrue(messageId.getNodeValue().contains("m-"));
1164 Node childAction = baseRpc.getFirstChild();
1166 checkNode(childAction, "action", "action", NetconfMessageTransformUtil.NETCONF_ACTION_NAMESPACE.toString());
1170 private static DOMDataTreeIdentifier prepareDataTreeId(final List<PathArgument> nodeIdentifiers) {
1171 YangInstanceIdentifier yangInstanceIdentifier =
1172 YangInstanceIdentifier.builder().append(nodeIdentifiers).build();
1173 DOMDataTreeIdentifier domDataTreeIdentifier =
1174 new DOMDataTreeIdentifier(org.opendaylight.mdsal.common.api.LogicalDatastoreType.CONFIGURATION,
1175 yangInstanceIdentifier);
1176 return domDataTreeIdentifier;
1179 private static ContainerNode initInputAction(final QName qname, final String value) {
1180 return Builders.containerBuilder()
1181 .withNodeIdentifier(NodeIdentifier.create(QName.create(qname, "input")))
1182 .withChild(ImmutableNodes.leafNode(qname, value))
1186 private static ContainerNode initEmptyInputAction(final QName qname) {
1187 return Builders.containerBuilder()
1188 .withNodeIdentifier(NodeIdentifier.create(QName.create(qname, "input")))
1192 private static void checkNode(final Node childServer, final String expectedLocalName, final String expectedNodeName,
1193 final String expectedNamespace) {
1194 assertNotNull(childServer);
1195 assertEquals(childServer.getLocalName(), expectedLocalName);
1196 assertEquals(childServer.getNodeName(), expectedNodeName);
1197 assertEquals(childServer.getNamespaceURI(), expectedNamespace);