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.client.mdsal.impl;
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.client.mdsal.impl.NetconfMessageTransformUtil.CREATE_SUBSCRIPTION_RPC_CONTENT;
17 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.CREATE_SUBSCRIPTION_RPC_QNAME;
18 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.GET_SCHEMA_QNAME;
19 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.NETCONF_CANDIDATE_NODEID;
20 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.NETCONF_COMMIT_QNAME;
21 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.NETCONF_DISCARD_CHANGES_QNAME;
22 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.NETCONF_EDIT_CONFIG_QNAME;
23 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.NETCONF_GET_CONFIG_QNAME;
24 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.NETCONF_GET_QNAME;
25 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.NETCONF_LOCK_QNAME;
26 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.NETCONF_RUNNING_NODEID;
27 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.createEditConfigStructure;
28 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.toFilterStructure;
29 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.toId;
30 import static org.opendaylight.netconf.common.mdsal.NormalizedDataUtil.NETCONF_DATA_QNAME;
32 import java.io.IOException;
33 import java.util.ArrayList;
34 import java.util.HashMap;
35 import java.util.HashSet;
36 import java.util.List;
38 import java.util.Optional;
40 import javax.xml.transform.dom.DOMSource;
41 import org.custommonkey.xmlunit.Diff;
42 import org.custommonkey.xmlunit.ElementNameAndAttributeQualifier;
43 import org.custommonkey.xmlunit.XMLUnit;
44 import org.hamcrest.CoreMatchers;
45 import org.junit.AfterClass;
46 import org.junit.Before;
47 import org.junit.BeforeClass;
48 import org.junit.Test;
49 import org.opendaylight.mdsal.binding.runtime.spi.BindingRuntimeHelpers;
50 import org.opendaylight.mdsal.dom.api.DOMActionResult;
51 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
52 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
53 import org.opendaylight.netconf.api.NetconfMessage;
54 import org.opendaylight.netconf.api.xml.XmlUtil;
55 import org.opendaylight.netconf.client.mdsal.AbstractBaseSchemasTest;
56 import org.opendaylight.netconf.client.mdsal.MonitoringSchemaSourceProvider;
57 import org.opendaylight.netconf.common.mdsal.NormalizedDataUtil;
58 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.IetfNetconfService;
59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfState;
60 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Capabilities;
61 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Datastores;
62 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Schemas;
63 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Sessions;
64 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Statistics;
65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.datastores.Datastore;
66 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.datastores.datastore.Locks;
67 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;
68 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.Schema;
69 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.Session;
70 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfConfigChange;
71 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.netconf.config.change.Edit;
72 import org.opendaylight.yangtools.yang.common.QName;
73 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
74 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
75 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
76 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
77 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
78 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
79 import org.opendaylight.yangtools.yang.data.api.schema.AnyxmlNode;
80 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
81 import org.opendaylight.yangtools.yang.data.api.schema.DOMSourceAnyxmlNode;
82 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
83 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
84 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
85 import org.opendaylight.yangtools.yang.data.api.schema.MountPointContext;
86 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
87 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
88 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
89 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
90 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
91 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
92 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
93 import org.w3c.dom.Node;
94 import org.xml.sax.SAXException;
96 public class NetconfMessageTransformerTest extends AbstractBaseSchemasTest {
98 private static final String REVISION_EXAMPLE_SERVER_FARM = "2018-08-07";
99 private static final String URN_EXAMPLE_SERVER_FARM = "urn:example:server-farm";
101 private static final String REVISION_EXAMPLE_SERVER_FARM_2 = "2019-05-20";
102 private static final String URN_EXAMPLE_SERVER_FARM_2 = "urn:example:server-farm-2";
104 private static final String URN_EXAMPLE_CONFLICT = "urn:example:conflict";
106 private static final String URN_EXAMPLE_AUGMENTED_ACTION = "urn:example:augmented-action";
108 private static final String URN_EXAMPLE_RPCS_ACTIONS_OUTPUTS = "urn:example:rpcs-actions-outputs";
110 private static final QName SERVER_QNAME =
111 QName.create(URN_EXAMPLE_SERVER_FARM, REVISION_EXAMPLE_SERVER_FARM, "server");
112 private static final QName RESET_QNAME = QName.create(SERVER_QNAME, "reset");
113 private static final Absolute RESET_SERVER_PATH = Absolute.of(SERVER_QNAME, RESET_QNAME);
114 private static final QName APPLICATIONS_QNAME = QName.create(URN_EXAMPLE_SERVER_FARM_2,
115 REVISION_EXAMPLE_SERVER_FARM_2, "applications");
116 private static final QName APPLICATION_QNAME = QName.create(APPLICATIONS_QNAME, "application");
117 private static final QName KILL_QNAME = QName.create(APPLICATION_QNAME, "kill");
118 private static final Absolute KILL_SERVER_APP_PATH =
119 Absolute.of(SERVER_QNAME, APPLICATIONS_QNAME, APPLICATION_QNAME, KILL_QNAME);
121 private static final QName DEVICE_QNAME =
122 QName.create(URN_EXAMPLE_SERVER_FARM, REVISION_EXAMPLE_SERVER_FARM, "device");
123 private static final QName START_QNAME = QName.create(DEVICE_QNAME, "start");
124 private static final Absolute START_DEVICE_PATH = Absolute.of(DEVICE_QNAME, START_QNAME);
125 private static final QName INTERFACE_QNAME = QName.create(DEVICE_QNAME, "interface");
126 private static final QName ENABLE_QNAME = QName.create(INTERFACE_QNAME, "enable");
127 private static final Absolute ENABLE_INTERFACE_PATH = Absolute.of(DEVICE_QNAME, INTERFACE_QNAME, ENABLE_QNAME);
129 private static final QName DISABLE_QNAME = QName.create(URN_EXAMPLE_AUGMENTED_ACTION, "disable");
130 private static final Absolute DISABLE_INTERFACE_PATH = Absolute.of(DEVICE_QNAME, INTERFACE_QNAME, DISABLE_QNAME);
132 private static final QName CHECK_WITH_OUTPUT_QNAME =
133 QName.create(URN_EXAMPLE_RPCS_ACTIONS_OUTPUTS, "check-with-output");
134 private static final Absolute CHECK_WITH_OUTPUT_INTERFACE_PATH =
135 Absolute.of(DEVICE_QNAME, INTERFACE_QNAME, CHECK_WITH_OUTPUT_QNAME);
136 private static final QName CHECK_WITHOUT_OUTPUT_QNAME =
137 QName.create(URN_EXAMPLE_RPCS_ACTIONS_OUTPUTS, "check-without-output");
138 private static final Absolute CHECK_WITHOUT_OUTPUT_INTERFACE_PATH =
139 Absolute.of(DEVICE_QNAME, INTERFACE_QNAME, CHECK_WITHOUT_OUTPUT_QNAME);
140 private static final QName RPC_WITH_OUTPUT_QNAME =
141 QName.create(URN_EXAMPLE_RPCS_ACTIONS_OUTPUTS, "rpc-with-output");
142 private static final QName RPC_WITHOUT_OUTPUT_QNAME =
143 QName.create(URN_EXAMPLE_RPCS_ACTIONS_OUTPUTS, "rpc-without-output");
145 private static final QName BOX_OUT_QNAME =
146 QName.create(URN_EXAMPLE_SERVER_FARM, REVISION_EXAMPLE_SERVER_FARM, "box-out");
147 private static final QName BOX_IN_QNAME = QName.create(BOX_OUT_QNAME, "box-in");
148 private static final QName OPEN_QNAME = QName.create(BOX_IN_QNAME, "open");
149 private static final Absolute OPEN_BOXES_PATH = Absolute.of(BOX_OUT_QNAME, BOX_IN_QNAME, OPEN_QNAME);
151 private static final QName FOO_QNAME = QName.create(URN_EXAMPLE_CONFLICT, "foo");
152 private static final QName BAR_QNAME = QName.create(URN_EXAMPLE_CONFLICT, "bar");
153 private static final QName XYZZY_QNAME = QName.create(URN_EXAMPLE_CONFLICT, "xyzzy");
154 private static final Absolute XYZZY_FOO_PATH = Absolute.of(FOO_QNAME, XYZZY_QNAME);
155 private static final Absolute XYZZY_BAR_PATH = Absolute.of(BAR_QNAME, XYZZY_QNAME);
157 private static final QName CONFLICT_CHOICE_QNAME = QName.create(URN_EXAMPLE_CONFLICT, "conflict-choice");
158 private static final QName CHOICE_CONT_QNAME = QName.create(URN_EXAMPLE_CONFLICT, "choice-cont");
159 private static final QName CHOICE_ACTION_QNAME = QName.create(URN_EXAMPLE_CONFLICT, "choice-action");
160 private static final Absolute CHOICE_ACTION_PATH =
161 Absolute.of(CONFLICT_CHOICE_QNAME, CHOICE_CONT_QNAME, CHOICE_CONT_QNAME, CHOICE_ACTION_QNAME);
163 private static EffectiveModelContext PARTIAL_SCHEMA;
164 private static EffectiveModelContext SCHEMA;
165 private static EffectiveModelContext ACTION_SCHEMA;
167 private NetconfMessageTransformer actionNetconfMessageTransformer;
168 private NetconfMessageTransformer netconfMessageTransformer;
171 public static void beforeClass() {
172 PARTIAL_SCHEMA = BindingRuntimeHelpers.createEffectiveModel(NetconfState.class);
173 SCHEMA = BindingRuntimeHelpers.createEffectiveModel(IetfNetconfService.class, NetconfState.class,
174 NetconfConfigChange.class);
175 ACTION_SCHEMA = YangParserTestUtils.parseYangResources(NetconfMessageTransformerTest.class,
176 "/schemas/example-server-farm.yang","/schemas/example-server-farm-2.yang",
177 "/schemas/conflicting-actions.yang", "/schemas/augmented-action.yang",
178 "/schemas/rpcs-actions-outputs.yang");
182 public static void afterClass() {
183 PARTIAL_SCHEMA = null;
185 ACTION_SCHEMA = null;
189 public void setUp() throws Exception {
190 XMLUnit.setIgnoreWhitespace(true);
191 XMLUnit.setIgnoreAttributeOrder(true);
192 XMLUnit.setIgnoreComments(true);
194 netconfMessageTransformer = getTransformer(SCHEMA);
195 actionNetconfMessageTransformer = new NetconfMessageTransformer(MountPointContext.of(ACTION_SCHEMA),
196 true, BASE_SCHEMAS.getBaseSchema());
200 public void testLockRequestBaseSchemaNotPresent() throws Exception {
201 final NetconfMessageTransformer transformer = getTransformer(PARTIAL_SCHEMA);
202 final NetconfMessage netconfMessage = transformer.toRpcRequest(NETCONF_LOCK_QNAME,
203 NetconfBaseOps.getLockContent(NETCONF_CANDIDATE_NODEID));
205 assertThat(XmlUtil.toString(netconfMessage.getDocument()), CoreMatchers.containsString("<lock"));
206 assertThat(XmlUtil.toString(netconfMessage.getDocument()), CoreMatchers.containsString("<rpc"));
210 public void testCreateSubscriberNotificationSchemaNotPresent() throws Exception {
211 final NetconfMessageTransformer transformer = new NetconfMessageTransformer(MountPointContext.of(SCHEMA), true,
212 BASE_SCHEMAS.getBaseSchemaWithNotifications());
213 NetconfMessage netconfMessage = transformer.toRpcRequest(CREATE_SUBSCRIPTION_RPC_QNAME,
214 CREATE_SUBSCRIPTION_RPC_CONTENT);
215 String documentString = XmlUtil.toString(netconfMessage.getDocument());
216 assertThat(documentString, CoreMatchers.containsString("<create-subscription"));
217 assertThat(documentString, CoreMatchers.containsString("<rpc"));
221 public void tesLockSchemaRequest() throws Exception {
222 final NetconfMessageTransformer transformer = getTransformer(PARTIAL_SCHEMA);
223 final String result = "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\"><ok/></rpc-reply>";
225 transformer.toRpcResult(
226 RpcResultBuilder.success(new NetconfMessage(XmlUtil.readXmlToDocument(result))).build(),
231 public void testRpcEmptyBodyWithOutputDefinedSchemaResult() throws Exception {
232 final String result = "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\"><ok/></rpc-reply>";
234 DOMRpcResult domRpcResult = actionNetconfMessageTransformer.toRpcResult(
235 RpcResultBuilder.success(new NetconfMessage(XmlUtil.readXmlToDocument(result))).build(),
236 RPC_WITH_OUTPUT_QNAME);
237 assertNotNull(domRpcResult);
241 public void testRpcEmptyBodyWithoutOutputDefinedSchemaResult() throws Exception {
242 final String result = "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\"><ok/></rpc-reply>";
244 DOMRpcResult domRpcResult = actionNetconfMessageTransformer.toRpcResult(
245 RpcResultBuilder.success(new NetconfMessage(XmlUtil.readXmlToDocument(result))).build(),
246 RPC_WITHOUT_OUTPUT_QNAME);
247 assertNotNull(domRpcResult);
251 public void testDiscardChangesRequest() throws Exception {
252 final NetconfMessage netconfMessage =
253 netconfMessageTransformer.toRpcRequest(NETCONF_DISCARD_CHANGES_QNAME, null);
254 assertThat(XmlUtil.toString(netconfMessage.getDocument()), CoreMatchers.containsString("<discard"));
255 assertThat(XmlUtil.toString(netconfMessage.getDocument()), CoreMatchers.containsString("<rpc"));
256 assertThat(XmlUtil.toString(netconfMessage.getDocument()), CoreMatchers.containsString("message-id"));
260 public void testGetSchemaRequest() throws Exception {
261 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(GET_SCHEMA_QNAME,
262 MonitoringSchemaSourceProvider.createGetSchemaRequest("module", Optional.of("2012-12-12")));
263 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
264 + "<get-schema xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
265 + "<format>yang</format>\n"
266 + "<identifier>module</identifier>\n"
267 + "<version>2012-12-12</version>\n"
273 public void testGetSchemaResponse() throws Exception {
274 final NetconfMessageTransformer transformer = getTransformer(SCHEMA);
275 final NetconfMessage response = new NetconfMessage(XmlUtil.readXmlToDocument(
276 "<rpc-reply message-id=\"101\"\n"
277 + "xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
279 + "xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
280 + "<xs:schema xmlns:xs=\"http://www.w3.org/2001/XMLSchema\">\n"
281 + "Random YANG SCHEMA\n"
286 final DOMRpcResult compositeNodeRpcResult = transformer.toRpcResult(RpcResultBuilder.success(response).build(),
288 assertTrue(compositeNodeRpcResult.errors().isEmpty());
289 assertNotNull(compositeNodeRpcResult.value());
290 final DOMSource schemaContent = ((DOMSourceAnyxmlNode) compositeNodeRpcResult.value()
291 .body().iterator().next()).body();
292 assertThat(schemaContent.getNode().getTextContent(),
293 CoreMatchers.containsString("Random YANG SCHEMA"));
297 public void testGetConfigResponse() throws Exception {
298 final NetconfMessage response = new NetconfMessage(XmlUtil.readXmlToDocument("<rpc-reply message-id=\"101\"\n"
299 + "xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
301 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
304 + "<identifier>module</identifier>\n"
305 + "<version>2012-12-12</version>\n"
306 + "<format xmlns:x=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">x:yang</format>\n"
309 + "</netconf-state>\n"
313 final NetconfMessageTransformer transformer = getTransformer(SCHEMA);
314 final DOMRpcResult compositeNodeRpcResult = transformer.toRpcResult(RpcResultBuilder.success(response).build(),
315 NETCONF_GET_CONFIG_QNAME);
316 assertTrue(compositeNodeRpcResult.errors().isEmpty());
317 assertNotNull(compositeNodeRpcResult.value());
319 final var values = MonitoringSchemaSourceProvider.createGetSchemaRequest(
320 "module", Optional.of("2012-12-12")).body();
322 final Map<QName, Object> keys = new HashMap<>();
323 for (final DataContainerChild value : values) {
324 keys.put(value.getIdentifier().getNodeType(), value.body());
327 final NodeIdentifierWithPredicates identifierWithPredicates =
328 NodeIdentifierWithPredicates.of(Schema.QNAME, keys);
329 final MapEntryNode schemaNode =
330 Builders.mapEntryBuilder().withNodeIdentifier(identifierWithPredicates).withValue(values).build();
332 final DOMSourceAnyxmlNode data = (DOMSourceAnyxmlNode) compositeNodeRpcResult.value()
333 .findChildByArg(toId(NETCONF_DATA_QNAME)).orElseThrow();
335 var nodeResult = NormalizedDataUtil.transformDOMSourceToNormalizedNode(SCHEMA, data.body());
336 ContainerNode result = (ContainerNode) nodeResult.getResult().data();
337 final ContainerNode state = (ContainerNode) result.getChildByArg(toId(NetconfState.QNAME));
338 final ContainerNode schemas = (ContainerNode) state.getChildByArg(toId(Schemas.QNAME));
339 final MapNode schemaParent = (MapNode) schemas.getChildByArg(toId(Schema.QNAME));
340 assertEquals(1, schemaParent.body().size());
342 assertEquals(schemaNode, schemaParent.body().iterator().next());
346 public void testGetConfigLeafRequest() throws Exception {
347 final AnyxmlNode<?> filter = toFilterStructure(
348 YangInstanceIdentifier.create(toId(NetconfState.QNAME), toId(Schemas.QNAME), toId(Schema.QNAME),
349 NodeIdentifierWithPredicates.of(Schema.QNAME),
350 toId(QName.create(Schemas.QNAME, "version"))), SCHEMA);
352 final ContainerNode source = NetconfBaseOps.getSourceNode(NETCONF_RUNNING_NODEID);
354 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_CONFIG_QNAME,
355 NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_QNAME, source, filter));
357 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
358 + "<get-config xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
359 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
360 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
366 + "</netconf-state>\n"
376 public void testGetConfigRequest() throws Exception {
377 final AnyxmlNode<?> filter = toFilterStructure(
378 YangInstanceIdentifier.create(toId(NetconfState.QNAME), toId(Schemas.QNAME)), SCHEMA);
380 final ContainerNode source = NetconfBaseOps.getSourceNode(NETCONF_RUNNING_NODEID);
382 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_CONFIG_QNAME,
383 NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_QNAME, source, filter));
385 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
386 + "<get-config xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
387 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
388 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
400 public void testEditConfigRequest() throws Exception {
401 final var values = MonitoringSchemaSourceProvider.createGetSchemaRequest(
402 "module", Optional.of("2012-12-12")).body();
404 final Map<QName, Object> keys = new HashMap<>();
405 for (final DataContainerChild value : values) {
406 keys.put(value.getIdentifier().getNodeType(), value.body());
409 final NodeIdentifierWithPredicates identifierWithPredicates =
410 NodeIdentifierWithPredicates.of(Schema.QNAME, keys);
411 final MapEntryNode schemaNode =
412 Builders.mapEntryBuilder().withNodeIdentifier(identifierWithPredicates).withValue(values).build();
414 final YangInstanceIdentifier id = YangInstanceIdentifier.builder()
415 .node(NetconfState.QNAME).node(Schemas.QNAME).node(Schema.QNAME)
416 .nodeWithKey(Schema.QNAME, keys).build();
417 final DataContainerChild editConfigStructure =
418 createEditConfigStructure(BASE_SCHEMAS.getBaseSchemaWithNotifications().getEffectiveModelContext(), id,
419 Optional.empty(), Optional.ofNullable(schemaNode));
421 final DataContainerChild target = NetconfBaseOps.getTargetNode(NETCONF_CANDIDATE_NODEID);
423 final ContainerNode wrap =
424 NetconfMessageTransformUtil.wrap(NETCONF_EDIT_CONFIG_QNAME, editConfigStructure, target);
425 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_EDIT_CONFIG_QNAME, wrap);
427 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
433 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
436 + "<identifier>module</identifier>\n"
437 + "<version>2012-12-12</version>\n"
438 + "<format>yang</format>\n"
441 + "</netconf-state>\n"
447 private static void assertSimilarXml(final NetconfMessage netconfMessage, final String xmlContent)
448 throws SAXException, IOException {
449 final Diff diff = XMLUnit.compareXML(netconfMessage.getDocument(), XmlUtil.readXmlToDocument(xmlContent));
450 diff.overrideElementQualifier(new ElementNameAndAttributeQualifier());
451 assertTrue(diff.toString(), diff.similar());
455 public void testGetRequest() throws Exception {
457 final QName capability = QName.create(Capabilities.QNAME, "capability");
458 final DataContainerChild filter = toFilterStructure(
459 YangInstanceIdentifier.create(toId(NetconfState.QNAME), toId(Capabilities.QNAME), toId(capability),
460 new NodeWithValue<>(capability, "a:b:c")), SCHEMA);
462 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_QNAME,
463 NetconfMessageTransformUtil.wrap(NETCONF_GET_QNAME, filter));
465 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">"
466 + "<get xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
467 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
468 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
470 + "<capability>a:b:c</capability>\n"
471 + "</capabilities>\n"
479 public void testGetLeafList() throws IOException, SAXException {
480 final YangInstanceIdentifier path = YangInstanceIdentifier.create(
481 toId(NetconfState.QNAME),
482 toId(Capabilities.QNAME),
483 toId(QName.create(Capabilities.QNAME, "capability")));
484 final DataContainerChild filter = toFilterStructure(path, SCHEMA);
485 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_QNAME,
486 NetconfMessageTransformUtil.wrap(toId(NETCONF_GET_QNAME), filter));
488 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
490 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
491 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
494 + "</capabilities>\n"
495 + "</netconf-state>\n"
502 public void testGetList() throws IOException, SAXException {
503 final YangInstanceIdentifier path = YangInstanceIdentifier.create(
504 toId(NetconfState.QNAME),
505 toId(Datastores.QNAME),
506 toId(QName.create(Datastores.QNAME, "datastore")));
507 final DataContainerChild filter = toFilterStructure(path, SCHEMA);
508 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_QNAME,
509 NetconfMessageTransformUtil.wrap(toId(NETCONF_GET_QNAME), filter));
511 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
513 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
514 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
518 + "</netconf-state>\n"
524 private static NetconfMessageTransformer getTransformer(final EffectiveModelContext schema) {
525 return new NetconfMessageTransformer(MountPointContext.of(schema), true, BASE_SCHEMAS.getBaseSchema());
529 public void testCommitResponse() throws Exception {
530 final NetconfMessage response = new NetconfMessage(XmlUtil.readXmlToDocument(
531 "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\"><ok/></rpc-reply>"
533 final DOMRpcResult compositeNodeRpcResult = netconfMessageTransformer.toRpcResult(
534 RpcResultBuilder.success(response).build(),
535 NETCONF_COMMIT_QNAME);
536 assertTrue(compositeNodeRpcResult.errors().isEmpty());
537 assertNull(compositeNodeRpcResult.value());
541 public void getActionsTest() {
542 Set<Absolute> schemaPaths = new HashSet<>();
543 schemaPaths.add(RESET_SERVER_PATH);
544 schemaPaths.add(START_DEVICE_PATH);
545 schemaPaths.add(ENABLE_INTERFACE_PATH);
546 schemaPaths.add(OPEN_BOXES_PATH);
547 schemaPaths.add(KILL_SERVER_APP_PATH);
548 schemaPaths.add(XYZZY_FOO_PATH);
549 schemaPaths.add(XYZZY_BAR_PATH);
550 schemaPaths.add(CHOICE_ACTION_PATH);
551 schemaPaths.add(DISABLE_INTERFACE_PATH);
552 schemaPaths.add(CHECK_WITH_OUTPUT_INTERFACE_PATH);
553 schemaPaths.add(CHECK_WITHOUT_OUTPUT_INTERFACE_PATH);
555 var actions = NetconfMessageTransformer.getActions(ACTION_SCHEMA);
556 assertEquals(schemaPaths.size(), actions.size());
558 for (var path : schemaPaths) {
559 assertNotNull("Action for " + path + " not found", actions.get(path));
564 public void toActionRequestListTopLevelTest() {
565 QName nameQname = QName.create(SERVER_QNAME, "name");
566 List<PathArgument> nodeIdentifiers = new ArrayList<>();
567 nodeIdentifiers.add(new NodeIdentifier(SERVER_QNAME));
568 nodeIdentifiers.add(NodeIdentifierWithPredicates.of(SERVER_QNAME, nameQname, "test"));
569 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
571 ContainerNode data = initInputAction(QName.create(SERVER_QNAME, "reset-at"), "now");
573 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
574 RESET_SERVER_PATH, domDataTreeIdentifier, data);
576 Node childAction = checkBasePartOfActionRequest(actionRequest);
578 Node childServer = childAction.getFirstChild();
579 checkNode(childServer, "server", "server", URN_EXAMPLE_SERVER_FARM);
581 Node childName = childServer.getFirstChild();
582 checkNode(childName, "name", "name", URN_EXAMPLE_SERVER_FARM);
584 Node childTest = childName.getFirstChild();
585 assertEquals(childTest.getNodeValue(), "test");
587 checkAction(RESET_QNAME, childName.getNextSibling(), "reset-at", "reset-at", "now");
591 public void toActionRequestContainerTopLevelTest() {
592 List<PathArgument> nodeIdentifiers = List.of(NodeIdentifier.create(DEVICE_QNAME));
593 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
595 ContainerNode payload = initInputAction(QName.create(DEVICE_QNAME, "start-at"), "now");
596 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
597 START_DEVICE_PATH, domDataTreeIdentifier, payload);
599 Node childAction = checkBasePartOfActionRequest(actionRequest);
601 Node childDevice = childAction.getFirstChild();
602 checkNode(childDevice, "device", "device", URN_EXAMPLE_SERVER_FARM);
604 checkAction(START_QNAME, childDevice.getFirstChild(), "start-at", "start-at", "now");
608 public void toActionRequestContainerInContainerTest() {
609 List<PathArgument> nodeIdentifiers = new ArrayList<>();
610 nodeIdentifiers.add(NodeIdentifier.create(BOX_OUT_QNAME));
611 nodeIdentifiers.add(NodeIdentifier.create(BOX_IN_QNAME));
613 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
615 ContainerNode payload = initInputAction(QName.create(BOX_OUT_QNAME, "start-at"), "now");
616 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
617 OPEN_BOXES_PATH, domDataTreeIdentifier, payload);
619 Node childAction = checkBasePartOfActionRequest(actionRequest);
621 Node childBoxOut = childAction.getFirstChild();
622 checkNode(childBoxOut, "box-out", "box-out", URN_EXAMPLE_SERVER_FARM);
624 Node childBoxIn = childBoxOut.getFirstChild();
625 checkNode(childBoxIn, "box-in", "box-in", URN_EXAMPLE_SERVER_FARM);
627 Node action = childBoxIn.getFirstChild();
628 checkNode(action, OPEN_QNAME.getLocalName(), OPEN_QNAME.getLocalName(), OPEN_QNAME.getNamespace().toString());
632 public void toActionRequestListInContainerTest() {
633 QName nameQname = QName.create(INTERFACE_QNAME, "name");
635 List<PathArgument> nodeIdentifiers = new ArrayList<>();
636 nodeIdentifiers.add(NodeIdentifier.create(DEVICE_QNAME));
637 nodeIdentifiers.add(NodeIdentifier.create(INTERFACE_QNAME));
638 nodeIdentifiers.add(NodeIdentifierWithPredicates.of(INTERFACE_QNAME, nameQname, "test"));
640 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
642 ContainerNode payload = initEmptyInputAction(INTERFACE_QNAME);
643 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
644 ENABLE_INTERFACE_PATH, domDataTreeIdentifier, payload);
646 Node childAction = checkBasePartOfActionRequest(actionRequest);
648 Node childDevice = childAction.getFirstChild();
649 checkNode(childDevice, "device", "device", URN_EXAMPLE_SERVER_FARM);
651 Node childInterface = childDevice.getFirstChild();
652 checkNode(childInterface, "interface", "interface", URN_EXAMPLE_SERVER_FARM);
654 Node childName = childInterface.getFirstChild();
655 checkNode(childName, "name", "name", nameQname.getNamespace().toString());
657 Node childTest = childName.getFirstChild();
658 assertEquals(childTest.getNodeValue(), "test");
660 Node action = childInterface.getLastChild();
661 checkNode(action, ENABLE_QNAME.getLocalName(), ENABLE_QNAME.getLocalName(),
662 ENABLE_QNAME.getNamespace().toString());
666 public void toActionRequestListInContainerAugmentedIntoListTest() {
667 QName serverNameQname = QName.create(SERVER_QNAME, "name");
668 QName applicationNameQname = QName.create(APPLICATION_QNAME, "name");
670 List<PathArgument> nodeIdentifiers = new ArrayList<>();
671 nodeIdentifiers.add(NodeIdentifier.create(SERVER_QNAME));
672 nodeIdentifiers.add(NodeIdentifierWithPredicates.of(SERVER_QNAME, serverNameQname, "testServer"));
673 nodeIdentifiers.add(NodeIdentifier.create(APPLICATIONS_QNAME));
674 nodeIdentifiers.add(NodeIdentifier.create(APPLICATION_QNAME));
675 nodeIdentifiers.add(NodeIdentifierWithPredicates.of(APPLICATION_QNAME,
676 applicationNameQname, "testApplication"));
678 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
680 ContainerNode payload = initEmptyInputAction(APPLICATION_QNAME);
681 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
682 KILL_SERVER_APP_PATH, domDataTreeIdentifier, payload);
684 Node childAction = checkBasePartOfActionRequest(actionRequest);
686 Node childServer = childAction.getFirstChild();
687 checkNode(childServer, "server", "server", URN_EXAMPLE_SERVER_FARM);
689 Node childServerName = childServer.getFirstChild();
690 checkNode(childServerName, "name", "name", URN_EXAMPLE_SERVER_FARM);
692 Node childServerNameTest = childServerName.getFirstChild();
693 assertEquals(childServerNameTest.getNodeValue(), "testServer");
695 Node childApplications = childServer.getLastChild();
696 checkNode(childApplications, "applications", "applications", URN_EXAMPLE_SERVER_FARM_2);
698 Node childApplication = childApplications.getFirstChild();
699 checkNode(childApplication, "application", "application", URN_EXAMPLE_SERVER_FARM_2);
701 Node childApplicationName = childApplication.getFirstChild();
702 checkNode(childApplicationName, "name", "name", URN_EXAMPLE_SERVER_FARM_2);
704 Node childApplicationNameTest = childApplicationName.getFirstChild();
705 assertEquals(childApplicationNameTest.getNodeValue(), "testApplication");
707 Node childKillAction = childApplication.getLastChild();
708 checkNode(childApplication, "application", "application", URN_EXAMPLE_SERVER_FARM_2);
709 checkNode(childKillAction, KILL_QNAME.getLocalName(), KILL_QNAME.getLocalName(),
710 KILL_QNAME.getNamespace().toString());
714 public void toActionRequestConflictingInListTest() {
715 QName barInputQname = QName.create(BAR_QNAME, "bar");
716 QName barIdQname = QName.create(BAR_QNAME, "bar-id");
719 List<PathArgument> nodeIdentifiers = new ArrayList<>();
720 nodeIdentifiers.add(NodeIdentifier.create(BAR_QNAME));
721 nodeIdentifiers.add(NodeIdentifierWithPredicates.of(BAR_QNAME, barIdQname, "test"));
723 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
725 ContainerNode payload = Builders.containerBuilder()
726 .withNodeIdentifier(NodeIdentifier.create(QName.create(barInputQname, "input")))
727 .withChild(ImmutableNodes.leafNode(barInputQname, barInput))
730 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
731 XYZZY_BAR_PATH, domDataTreeIdentifier, payload);
733 Node childAction = checkBasePartOfActionRequest(actionRequest);
735 Node childBar = childAction.getFirstChild();
736 checkNode(childBar, "bar", "bar", URN_EXAMPLE_CONFLICT);
738 Node childBarId = childBar.getFirstChild();
739 checkNode(childBarId, "bar-id", "bar-id", URN_EXAMPLE_CONFLICT);
741 Node childTest = childBarId.getFirstChild();
742 assertEquals(childTest.getNodeValue(), "test");
744 Node action = childBar.getLastChild();
745 checkNode(action, XYZZY_QNAME.getLocalName(), XYZZY_QNAME.getLocalName(),
746 XYZZY_QNAME.getNamespace().toString());
750 public void toActionRequestConflictingInContainerTest() {
751 QName fooInputQname = QName.create(FOO_QNAME, "foo");
753 List<PathArgument> nodeIdentifiers = new ArrayList<>();
754 nodeIdentifiers.add(NodeIdentifier.create(FOO_QNAME));
755 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
756 ContainerNode payload = initInputAction(fooInputQname, "test");
758 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
759 XYZZY_FOO_PATH, domDataTreeIdentifier, payload);
761 Node childAction = checkBasePartOfActionRequest(actionRequest);
763 Node childBar = childAction.getFirstChild();
764 checkNode(childBar, "foo", "foo", URN_EXAMPLE_CONFLICT);
766 Node action = childBar.getLastChild();
767 checkNode(action, XYZZY_QNAME.getLocalName(), XYZZY_QNAME.getLocalName(),
768 XYZZY_QNAME.getNamespace().toString());
772 public void toActionRequestChoiceTest() {
773 List<PathArgument> nodeIdentifiers = new ArrayList<>();
774 nodeIdentifiers.add(NodeIdentifier.create(CONFLICT_CHOICE_QNAME));
775 nodeIdentifiers.add(NodeIdentifier.create(CHOICE_CONT_QNAME));
776 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
777 NormalizedNode payload = initEmptyInputAction(CHOICE_ACTION_QNAME);
779 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
780 CHOICE_ACTION_PATH, domDataTreeIdentifier, payload);
782 Node childAction = checkBasePartOfActionRequest(actionRequest);
784 Node childChoiceCont = childAction.getFirstChild();
785 checkNode(childChoiceCont, "choice-cont", "choice-cont", URN_EXAMPLE_CONFLICT);
787 Node action = childChoiceCont.getLastChild();
788 checkNode(action, CHOICE_ACTION_QNAME.getLocalName(), CHOICE_ACTION_QNAME.getLocalName(),
789 CHOICE_ACTION_QNAME.getNamespace().toString());
793 public void toAugmentedActionRequestListInContainerTest() {
794 QName nameQname = QName.create(INTERFACE_QNAME, "name");
796 List<PathArgument> nodeIdentifiers = new ArrayList<>();
797 nodeIdentifiers.add(NodeIdentifier.create(DEVICE_QNAME));
798 nodeIdentifiers.add(NodeIdentifier.create(INTERFACE_QNAME));
799 nodeIdentifiers.add(NodeIdentifierWithPredicates.of(INTERFACE_QNAME, nameQname, "test"));
801 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
803 NormalizedNode payload = initEmptyInputAction(INTERFACE_QNAME);
804 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
805 DISABLE_INTERFACE_PATH, domDataTreeIdentifier, payload);
807 Node childAction = checkBasePartOfActionRequest(actionRequest);
809 Node childDevice = childAction.getFirstChild();
810 checkNode(childDevice, "device", "device", URN_EXAMPLE_SERVER_FARM);
812 Node childInterface = childDevice.getFirstChild();
813 checkNode(childInterface, "interface", "interface", URN_EXAMPLE_SERVER_FARM);
815 Node childName = childInterface.getFirstChild();
816 checkNode(childName, "name", "name", nameQname.getNamespace().toString());
818 Node childTest = childName.getFirstChild();
819 assertEquals(childTest.getNodeValue(), "test");
821 Node action = childInterface.getLastChild();
822 checkNode(action, DISABLE_QNAME.getLocalName(), DISABLE_QNAME.getLocalName(),
823 DISABLE_QNAME.getNamespace().toString());
827 public void toActionResultTest() throws Exception {
828 NetconfMessage message = new NetconfMessage(XmlUtil.readXmlToDocument(
829 "<rpc-reply message-id=\"101\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">"
830 + "<reset-finished-at xmlns=\"urn:example:server-farm\">"
832 + "</reset-finished-at>"
834 DOMActionResult actionResult = actionNetconfMessageTransformer.toActionResult(RESET_SERVER_PATH, message);
835 assertNotNull(actionResult);
836 ContainerNode containerNode = actionResult.getOutput().orElseThrow();
837 assertNotNull(containerNode);
838 assertEquals("now", containerNode.body().iterator().next().body());
842 public void toActionEmptyBodyWithOutputDefinedResultTest() throws Exception {
843 NetconfMessage message = new NetconfMessage(XmlUtil.readXmlToDocument(
844 "<rpc-reply message-id=\"101\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">"
847 DOMActionResult actionResult =
848 actionNetconfMessageTransformer.toActionResult(CHECK_WITH_OUTPUT_INTERFACE_PATH, message);
849 assertNotNull(actionResult);
850 assertTrue(actionResult.getOutput().isEmpty());
854 public void toActionEmptyBodyWithoutOutputDefinedResultTest() throws Exception {
855 NetconfMessage message = new NetconfMessage(XmlUtil.readXmlToDocument(
856 "<rpc-reply message-id=\"101\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">"
859 DOMActionResult actionResult =
860 actionNetconfMessageTransformer.toActionResult(CHECK_WITHOUT_OUTPUT_INTERFACE_PATH, message);
861 assertNotNull(actionResult);
862 assertTrue(actionResult.getOutput().isEmpty());
866 public void getTwoNonOverlappingFieldsTest() throws IOException, SAXException {
867 // preparation of the fields
868 final YangInstanceIdentifier parentYiid = YangInstanceIdentifier.create(toId(NetconfState.QNAME));
869 final YangInstanceIdentifier netconfStartTimeField = YangInstanceIdentifier.create(toId(Statistics.QNAME),
870 toId(QName.create(Statistics.QNAME, "netconf-start-time")));
871 final YangInstanceIdentifier datastoresField = YangInstanceIdentifier.create(toId(Datastores.QNAME));
873 // building filter structure and NETCONF message
874 final AnyxmlNode<?> filterStructure = toFilterStructure(
875 List.of(FieldsFilter.of(parentYiid, List.of(netconfStartTimeField, datastoresField))), SCHEMA);
876 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_QNAME,
877 NetconfMessageTransformUtil.wrap(toId(NETCONF_GET_QNAME), filterStructure));
880 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
882 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
883 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
885 + "<netconf-start-time/>\n"
888 + "</netconf-state>\n"
895 public void getOverlappingFieldsTest() throws IOException, SAXException {
896 // preparation of the fields
897 final YangInstanceIdentifier parentYiid = YangInstanceIdentifier.create(toId(NetconfState.QNAME));
898 final YangInstanceIdentifier capabilitiesField = YangInstanceIdentifier.create(toId(Capabilities.QNAME));
899 final YangInstanceIdentifier capabilityField = YangInstanceIdentifier.create(toId(Capabilities.QNAME),
900 toId(QName.create(Capabilities.QNAME, "capability").intern()));
901 final YangInstanceIdentifier datastoreField = YangInstanceIdentifier.create(toId(Datastores.QNAME));
902 final YangInstanceIdentifier locksFields = YangInstanceIdentifier.create(toId(Datastores.QNAME),
903 toId(Datastore.QNAME), NodeIdentifierWithPredicates.of(Datastore.QNAME), toId(Locks.QNAME));
905 // building filter structure and NETCONF message
906 final AnyxmlNode<?> filterStructure = toFilterStructure(
907 List.of(FieldsFilter.of(parentYiid,
908 List.of(capabilitiesField, capabilityField, datastoreField, locksFields))),
910 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_QNAME,
911 NetconfMessageTransformUtil.wrap(toId(NETCONF_GET_QNAME), filterStructure));
914 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
916 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
917 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
918 + "<capabilities/>\n"
920 + "</netconf-state>\n"
927 public void getOverlappingFieldsWithEmptyFieldTest() throws IOException, SAXException {
928 // preparation of the fields
929 final YangInstanceIdentifier parentYiid = YangInstanceIdentifier.create(toId(NetconfState.QNAME));
930 final YangInstanceIdentifier capabilitiesField = YangInstanceIdentifier.create(toId(Capabilities.QNAME));
932 // building filter structure and NETCONF message
933 final AnyxmlNode<?> filterStructure = toFilterStructure(
934 List.of(FieldsFilter.of(parentYiid, List.of(capabilitiesField, YangInstanceIdentifier.of()))),
936 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_QNAME,
937 NetconfMessageTransformUtil.wrap(toId(NETCONF_GET_QNAME), filterStructure));
940 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
942 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
943 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\"/>\n"
950 public void getSpecificFieldsUnderListTest() throws IOException, SAXException {
951 // preparation of the fields
952 final YangInstanceIdentifier parentYiid = YangInstanceIdentifier.create(toId(NetconfState.QNAME),
953 toId(Schemas.QNAME), toId(Schema.QNAME), NodeIdentifierWithPredicates.of(Schema.QNAME));
954 final YangInstanceIdentifier versionField = YangInstanceIdentifier.create(
955 toId(QName.create(Schema.QNAME, "version").intern()));
956 final YangInstanceIdentifier identifierField = YangInstanceIdentifier.create(
957 toId(QName.create(Schema.QNAME, "namespace").intern()));
959 // building filter structure and NETCONF message
960 final AnyxmlNode<?> filterStructure = toFilterStructure(
961 List.of(FieldsFilter.of(parentYiid, List.of(versionField, identifierField))), SCHEMA);
962 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_QNAME,
963 NetconfMessageTransformUtil.wrap(toId(NETCONF_GET_QNAME), filterStructure));
966 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
968 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
969 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
974 // explicitly fetched list keys - identifier and format
979 + "</netconf-state>\n"
986 public void getSpecificFieldsUnderMultipleLists() throws IOException, SAXException {
987 // preparation of the fields
988 final YangInstanceIdentifier parentYiid = YangInstanceIdentifier.create(
989 toId(NetconfState.QNAME), toId(Datastores.QNAME));
990 final YangInstanceIdentifier partialLockYiid = YangInstanceIdentifier.create(toId(Datastore.QNAME),
991 NodeIdentifierWithPredicates.of(Datastore.QNAME), toId(Locks.QNAME),
992 toId(QName.create(Locks.QNAME, "lock-type").intern()), toId(PartialLock.QNAME),
993 NodeIdentifierWithPredicates.of(PartialLock.QNAME));
994 final YangInstanceIdentifier lockedTimeField = partialLockYiid.node(
995 QName.create(Locks.QNAME, "locked-time").intern());
996 final YangInstanceIdentifier lockedBySessionField = partialLockYiid.node(
997 QName.create(Locks.QNAME, "locked-by-session").intern());
999 // building filter structure and NETCONF message
1000 final AnyxmlNode<?> filterStructure = toFilterStructure(
1001 List.of(FieldsFilter.of(parentYiid, List.of(lockedTimeField, lockedBySessionField))),
1003 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_QNAME,
1004 NetconfMessageTransformUtil.wrap(toId(NETCONF_GET_QNAME), filterStructure));
1007 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
1009 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
1010 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
1014 + "<partial-lock>\n"
1015 + "<locked-time/>\n"
1016 + "<locked-by-session/>\n"
1018 + "</partial-lock>\n"
1023 + "</netconf-state>\n"
1030 public void getWholeListsUsingFieldsTest() throws IOException, SAXException {
1031 // preparation of the fields
1032 final YangInstanceIdentifier parentYiid = YangInstanceIdentifier.create(toId(NetconfState.QNAME));
1033 final YangInstanceIdentifier datastoreListField = YangInstanceIdentifier.create(toId(Datastores.QNAME),
1034 toId(Datastore.QNAME), NodeIdentifierWithPredicates.of(Datastore.QNAME));
1035 final YangInstanceIdentifier sessionListField = YangInstanceIdentifier.create(toId(Sessions.QNAME),
1036 toId(Session.QNAME), NodeIdentifierWithPredicates.of(Session.QNAME));
1038 // building filter structure and NETCONF message
1039 final AnyxmlNode<?> filterStructure = toFilterStructure(
1040 List.of(FieldsFilter.of(parentYiid, List.of(datastoreListField, sessionListField))), SCHEMA);
1041 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_QNAME,
1042 NetconfMessageTransformUtil.wrap(toId(NETCONF_GET_QNAME), filterStructure));
1045 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
1047 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
1048 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
1055 + "</netconf-state>\n"
1062 public void getSpecificListEntriesWithSpecificFieldsTest() throws IOException, SAXException {
1063 // preparation of the fields
1064 final YangInstanceIdentifier parentYiid = YangInstanceIdentifier.create(toId(NetconfState.QNAME),
1065 toId(Sessions.QNAME));
1066 final QName sessionId = QName.create(Session.QNAME, "session-id").intern();
1067 final YangInstanceIdentifier session1Field = YangInstanceIdentifier.create(toId(Session.QNAME),
1068 NodeIdentifierWithPredicates.of(Session.QNAME, sessionId, 1));
1069 final YangInstanceIdentifier session2TransportField = YangInstanceIdentifier.create(toId(Session.QNAME),
1070 NodeIdentifierWithPredicates.of(Session.QNAME, sessionId, 2),
1071 toId(QName.create(Session.QNAME, "transport").intern()));
1073 // building filter structure and NETCONF message
1074 final AnyxmlNode<?> filterStructure = toFilterStructure(
1075 List.of(FieldsFilter.of(parentYiid, List.of(session1Field, session2TransportField))), SCHEMA);
1076 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(NETCONF_GET_QNAME,
1077 NetconfMessageTransformUtil.wrap(toId(NETCONF_GET_QNAME), filterStructure));
1080 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
1082 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
1083 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
1086 + "<session-id>1</session-id>\n"
1089 + "<session-id>2</session-id>\n"
1093 + "</netconf-state>\n"
1100 // Proof that YANGTOOLS-1362 works on DOM level
1101 public void testConfigChangeToNotification() throws SAXException, IOException {
1102 final var message = new NetconfMessage(XmlUtil.readXmlToDocument(
1103 "<notification xmlns=\"urn:ietf:params:xml:ns:netconf:notification:1.0\">\n"
1104 + " <eventTime>2021-11-11T11:26:16Z</eventTime> \n"
1105 + " <netconf-config-change xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-notifications\">\n"
1106 + " <changed-by> \n"
1107 + " <username>root</username> \n"
1108 + " <session-id>3</session-id> \n"
1109 + " </changed-by> \n"
1110 + " <datastore>running</datastore> \n"
1112 + " <target xmlns:ncm=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">/ncm:netconf-state"
1113 + "/ncm:datastores/ncm:datastore[ncm:name='running']</target>\n"
1114 + " <operation>replace</operation> \n"
1116 + " </netconf-config-change> \n"
1117 + "</notification>"));
1119 final var change = netconfMessageTransformer.toNotification(message).getBody();
1120 final var editList = change.getChildByArg(new NodeIdentifier(Edit.QNAME));
1121 assertThat(editList, instanceOf(UnkeyedListNode.class));
1122 final var edits = ((UnkeyedListNode) editList).body();
1123 assertEquals(1, edits.size());
1124 final var edit = edits.iterator().next();
1125 final var target = edit.getChildByArg(new NodeIdentifier(QName.create(Edit.QNAME, "target"))).body();
1126 assertThat(target, instanceOf(YangInstanceIdentifier.class));
1128 final var args = ((YangInstanceIdentifier) target).getPathArguments();
1129 assertEquals(4, args.size());
1132 private static void checkAction(final QName actionQname, final Node action , final String inputLocalName,
1133 final String inputNodeName, final String inputValue) {
1134 checkNode(action, actionQname.getLocalName(), actionQname.getLocalName(),
1135 actionQname.getNamespace().toString());
1137 Node childResetAt = action.getFirstChild();
1138 checkNode(childResetAt, inputLocalName, inputNodeName, actionQname.getNamespace().toString());
1140 Node firstChild = childResetAt.getFirstChild();
1141 assertEquals(firstChild.getNodeValue(), inputValue);
1144 private static Node checkBasePartOfActionRequest(final NetconfMessage actionRequest) {
1145 Node baseRpc = actionRequest.getDocument().getFirstChild();
1146 checkNode(baseRpc, "rpc", "rpc", NormalizedDataUtil.NETCONF_QNAME.getNamespace().toString());
1147 assertTrue(baseRpc.getLocalName().equals("rpc"));
1148 assertTrue(baseRpc.getNodeName().equals("rpc"));
1150 Node messageId = baseRpc.getAttributes().getNamedItem("message-id");
1151 assertNotNull(messageId);
1152 assertTrue(messageId.getNodeValue().contains("m-"));
1153 Node childAction = baseRpc.getFirstChild();
1155 checkNode(childAction, "action", "action", "urn:ietf:params:xml:ns:yang:1");
1159 private static DOMDataTreeIdentifier prepareDataTreeId(final List<PathArgument> nodeIdentifiers) {
1160 YangInstanceIdentifier yangInstanceIdentifier =
1161 YangInstanceIdentifier.builder().append(nodeIdentifiers).build();
1162 DOMDataTreeIdentifier domDataTreeIdentifier =
1163 new DOMDataTreeIdentifier(org.opendaylight.mdsal.common.api.LogicalDatastoreType.CONFIGURATION,
1164 yangInstanceIdentifier);
1165 return domDataTreeIdentifier;
1168 private static ContainerNode initInputAction(final QName qname, final String value) {
1169 return Builders.containerBuilder()
1170 .withNodeIdentifier(NodeIdentifier.create(QName.create(qname, "input")))
1171 .withChild(ImmutableNodes.leafNode(qname, value))
1175 private static ContainerNode initEmptyInputAction(final QName qname) {
1176 return Builders.containerBuilder()
1177 .withNodeIdentifier(NodeIdentifier.create(QName.create(qname, "input")))
1181 private static void checkNode(final Node childServer, final String expectedLocalName, final String expectedNodeName,
1182 final String expectedNamespace) {
1183 assertNotNull(childServer);
1184 assertEquals(childServer.getLocalName(), expectedLocalName);
1185 assertEquals(childServer.getNodeName(), expectedNodeName);
1186 assertEquals(childServer.getNamespaceURI(), expectedNamespace);