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.NETCONF_CANDIDATE_NODEID;
17 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.NETCONF_EDIT_CONFIG_NODEID;
18 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.NETCONF_GET_CONFIG_NODEID;
19 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.NETCONF_GET_NODEID;
20 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.NETCONF_RUNNING_NODEID;
21 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.createEditConfigStructure;
22 import static org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil.toFilterStructure;
24 import java.io.IOException;
25 import java.util.ArrayList;
26 import java.util.HashMap;
27 import java.util.List;
28 import java.util.Optional;
30 import org.custommonkey.xmlunit.Diff;
31 import org.custommonkey.xmlunit.ElementNameAndAttributeQualifier;
32 import org.custommonkey.xmlunit.XMLUnit;
33 import org.junit.AfterClass;
34 import org.junit.Before;
35 import org.junit.BeforeClass;
36 import org.junit.Test;
37 import org.opendaylight.mdsal.binding.runtime.spi.BindingRuntimeHelpers;
38 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
39 import org.opendaylight.netconf.api.messages.NetconfMessage;
40 import org.opendaylight.netconf.api.xml.XmlUtil;
41 import org.opendaylight.netconf.client.mdsal.AbstractBaseSchemasTest;
42 import org.opendaylight.netconf.client.mdsal.MonitoringSchemaSourceProvider;
43 import org.opendaylight.netconf.common.mdsal.NormalizedDataUtil;
44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.Commit;
45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.DiscardChanges;
46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.EditConfig;
47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.Get;
48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.GetConfig;
49 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.IetfNetconfData;
50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.Lock;
51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.get.config.output.Data;
52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscription;
53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscriptionInput;
54 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.GetSchema;
55 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfState;
56 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Capabilities;
57 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Datastores;
58 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Schemas;
59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Sessions;
60 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Statistics;
61 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.datastores.Datastore;
62 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.datastores.datastore.Locks;
63 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;
64 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.Schema;
65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.Session;
66 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfConfigChange;
67 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.netconf.config.change.Edit;
68 import org.opendaylight.yangtools.yang.common.QName;
69 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
70 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
71 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
72 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
73 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
74 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
75 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
76 import org.opendaylight.yangtools.yang.data.api.schema.DOMSourceAnyxmlNode;
77 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
78 import org.opendaylight.yangtools.yang.data.api.schema.MountPointContext;
79 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
80 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
81 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
82 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
83 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
84 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
85 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
86 import org.w3c.dom.Element;
87 import org.w3c.dom.Node;
88 import org.xml.sax.SAXException;
90 public class NetconfMessageTransformerTest extends AbstractBaseSchemasTest {
92 private static final String REVISION_EXAMPLE_SERVER_FARM = "2018-08-07";
93 private static final String URN_EXAMPLE_SERVER_FARM = "urn:example:server-farm";
95 private static final String REVISION_EXAMPLE_SERVER_FARM_2 = "2019-05-20";
96 private static final String URN_EXAMPLE_SERVER_FARM_2 = "urn:example:server-farm-2";
98 private static final String URN_EXAMPLE_CONFLICT = "urn:example:conflict";
100 private static final String URN_EXAMPLE_AUGMENTED_ACTION = "urn:example:augmented-action";
102 private static final String URN_EXAMPLE_RPCS_ACTIONS_OUTPUTS = "urn:example:rpcs-actions-outputs";
104 private static final QName SERVER_QNAME =
105 QName.create(URN_EXAMPLE_SERVER_FARM, REVISION_EXAMPLE_SERVER_FARM, "server");
106 private static final QName RESET_QNAME = QName.create(SERVER_QNAME, "reset");
107 private static final Absolute RESET_SERVER_PATH = Absolute.of(SERVER_QNAME, RESET_QNAME);
108 private static final QName APPLICATIONS_QNAME = QName.create(URN_EXAMPLE_SERVER_FARM_2,
109 REVISION_EXAMPLE_SERVER_FARM_2, "applications");
110 private static final QName APPLICATION_QNAME = QName.create(APPLICATIONS_QNAME, "application");
111 private static final QName KILL_QNAME = QName.create(APPLICATION_QNAME, "kill");
112 private static final Absolute KILL_SERVER_APP_PATH =
113 Absolute.of(SERVER_QNAME, APPLICATIONS_QNAME, APPLICATION_QNAME, KILL_QNAME);
115 private static final QName DEVICE_QNAME =
116 QName.create(URN_EXAMPLE_SERVER_FARM, REVISION_EXAMPLE_SERVER_FARM, "device");
117 private static final QName START_QNAME = QName.create(DEVICE_QNAME, "start");
118 private static final Absolute START_DEVICE_PATH = Absolute.of(DEVICE_QNAME, START_QNAME);
119 private static final QName INTERFACE_QNAME = QName.create(DEVICE_QNAME, "interface");
120 private static final QName ENABLE_QNAME = QName.create(INTERFACE_QNAME, "enable");
121 private static final Absolute ENABLE_INTERFACE_PATH = Absolute.of(DEVICE_QNAME, INTERFACE_QNAME, ENABLE_QNAME);
123 private static final QName DISABLE_QNAME = QName.create(URN_EXAMPLE_AUGMENTED_ACTION, "disable");
124 private static final Absolute DISABLE_INTERFACE_PATH = Absolute.of(DEVICE_QNAME, INTERFACE_QNAME, DISABLE_QNAME);
126 private static final QName CHECK_WITH_OUTPUT_QNAME =
127 QName.create(URN_EXAMPLE_RPCS_ACTIONS_OUTPUTS, "check-with-output");
128 private static final Absolute CHECK_WITH_OUTPUT_INTERFACE_PATH =
129 Absolute.of(DEVICE_QNAME, INTERFACE_QNAME, CHECK_WITH_OUTPUT_QNAME);
130 private static final QName CHECK_WITHOUT_OUTPUT_QNAME =
131 QName.create(URN_EXAMPLE_RPCS_ACTIONS_OUTPUTS, "check-without-output");
132 private static final Absolute CHECK_WITHOUT_OUTPUT_INTERFACE_PATH =
133 Absolute.of(DEVICE_QNAME, INTERFACE_QNAME, CHECK_WITHOUT_OUTPUT_QNAME);
134 private static final QName RPC_WITH_OUTPUT_QNAME =
135 QName.create(URN_EXAMPLE_RPCS_ACTIONS_OUTPUTS, "rpc-with-output");
136 private static final QName RPC_WITHOUT_OUTPUT_QNAME =
137 QName.create(URN_EXAMPLE_RPCS_ACTIONS_OUTPUTS, "rpc-without-output");
139 private static final QName BOX_OUT_QNAME =
140 QName.create(URN_EXAMPLE_SERVER_FARM, REVISION_EXAMPLE_SERVER_FARM, "box-out");
141 private static final QName BOX_IN_QNAME = QName.create(BOX_OUT_QNAME, "box-in");
142 private static final QName OPEN_QNAME = QName.create(BOX_IN_QNAME, "open");
143 private static final Absolute OPEN_BOXES_PATH = Absolute.of(BOX_OUT_QNAME, BOX_IN_QNAME, OPEN_QNAME);
145 private static final QName FOO_QNAME = QName.create(URN_EXAMPLE_CONFLICT, "foo");
146 private static final QName BAR_QNAME = QName.create(URN_EXAMPLE_CONFLICT, "bar");
147 private static final QName XYZZY_QNAME = QName.create(URN_EXAMPLE_CONFLICT, "xyzzy");
148 private static final Absolute XYZZY_FOO_PATH = Absolute.of(FOO_QNAME, XYZZY_QNAME);
149 private static final Absolute XYZZY_BAR_PATH = Absolute.of(BAR_QNAME, XYZZY_QNAME);
151 private static final QName CONFLICT_CHOICE_QNAME = QName.create(URN_EXAMPLE_CONFLICT, "conflict-choice");
152 private static final QName CHOICE_CONT_QNAME = QName.create(URN_EXAMPLE_CONFLICT, "choice-cont");
153 private static final QName CHOICE_ACTION_QNAME = QName.create(URN_EXAMPLE_CONFLICT, "choice-action");
154 private static final Absolute CHOICE_ACTION_PATH =
155 Absolute.of(CONFLICT_CHOICE_QNAME, CHOICE_CONT_QNAME, CHOICE_CONT_QNAME, CHOICE_ACTION_QNAME);
157 private static EffectiveModelContext PARTIAL_SCHEMA;
158 private static EffectiveModelContext SCHEMA;
159 private static EffectiveModelContext ACTION_SCHEMA;
161 private NetconfMessageTransformer actionNetconfMessageTransformer;
162 private NetconfMessageTransformer netconfMessageTransformer;
165 public static void beforeClass() {
166 PARTIAL_SCHEMA = BindingRuntimeHelpers.createEffectiveModel(NetconfState.class);
167 SCHEMA = BindingRuntimeHelpers.createEffectiveModel(IetfNetconfData.class, NetconfState.class,
168 NetconfConfigChange.class);
169 ACTION_SCHEMA = YangParserTestUtils.parseYangResources(NetconfMessageTransformerTest.class,
170 "/schemas/example-server-farm.yang","/schemas/example-server-farm-2.yang",
171 "/schemas/conflicting-actions.yang", "/schemas/augmented-action.yang",
172 "/schemas/rpcs-actions-outputs.yang");
176 public static void afterClass() {
177 PARTIAL_SCHEMA = null;
179 ACTION_SCHEMA = null;
183 public void setUp() throws Exception {
184 XMLUnit.setIgnoreWhitespace(true);
185 XMLUnit.setIgnoreAttributeOrder(true);
186 XMLUnit.setIgnoreComments(true);
188 netconfMessageTransformer = getTransformer(SCHEMA);
189 actionNetconfMessageTransformer = new NetconfMessageTransformer(MountPointContext.of(ACTION_SCHEMA), true,
190 BASE_SCHEMAS.baseSchema());
194 public void testLockRequestBaseSchemaNotPresent() throws Exception {
195 final var transformer = getTransformer(PARTIAL_SCHEMA);
196 final var netconfMessage = transformer.toRpcRequest(Lock.QNAME,
197 NetconfBaseOps.getLockContent(NETCONF_CANDIDATE_NODEID));
199 <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="m-0">
206 """, XmlUtil.toString(netconfMessage.getDocument()));
210 public void testCreateSubscriberNotificationSchemaNotPresent() throws Exception {
211 final var transformer = new NetconfMessageTransformer(MountPointContext.of(SCHEMA), true,
212 BASE_SCHEMAS.baseSchemaWithNotifications());
213 var netconfMessage = transformer.toRpcRequest(CreateSubscription.QNAME, Builders.containerBuilder()
214 .withNodeIdentifier(new NodeIdentifier(CreateSubscriptionInput.QNAME))
217 <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="m-0">
218 <create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"/>
220 """, XmlUtil.toString(netconfMessage.getDocument()));
224 public void testLockSchemaRequest() throws Exception {
225 final var transformer = getTransformer(PARTIAL_SCHEMA);
226 final String result = "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\"><ok/></rpc-reply>";
228 transformer.toRpcResult(
229 RpcResultBuilder.success(new NetconfMessage(XmlUtil.readXmlToDocument(result))).build(),
234 public void testRpcEmptyBodyWithOutputDefinedSchemaResult() throws Exception {
235 final String result = "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\"><ok/></rpc-reply>";
237 final var domRpcResult = actionNetconfMessageTransformer.toRpcResult(
238 RpcResultBuilder.success(new NetconfMessage(XmlUtil.readXmlToDocument(result))).build(),
239 RPC_WITH_OUTPUT_QNAME);
240 assertNotNull(domRpcResult);
244 public void testRpcEmptyBodyWithoutOutputDefinedSchemaResult() throws Exception {
245 final String result = "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\"><ok/></rpc-reply>";
247 final var domRpcResult = actionNetconfMessageTransformer.toRpcResult(
248 RpcResultBuilder.success(new NetconfMessage(XmlUtil.readXmlToDocument(result))).build(),
249 RPC_WITHOUT_OUTPUT_QNAME);
250 assertNotNull(domRpcResult);
254 public void testDiscardChangesRequest() throws Exception {
255 final var netconfMessage = netconfMessageTransformer.toRpcRequest(DiscardChanges.QNAME, null);
257 <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="m-0">
260 """, XmlUtil.toString(netconfMessage.getDocument()));
264 public void testGetSchemaRequest() throws Exception {
265 final var netconfMessage = netconfMessageTransformer.toRpcRequest(GetSchema.QNAME,
266 MonitoringSchemaSourceProvider.createGetSchemaRequest("module", Optional.of("2012-12-12")));
267 assertSimilarXml(netconfMessage, """
268 <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
269 <get-schema xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
270 <format>yang</format>
271 <identifier>module</identifier>
272 <version>2012-12-12</version>
278 public void testGetSchemaResponse() throws Exception {
279 final var transformer = getTransformer(SCHEMA);
280 final var response = new NetconfMessage(XmlUtil.readXmlToDocument("""
281 <rpc-reply message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
282 <data xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
283 <schema xmlns="http://www.w3.org/2001/XMLSchema">Random YANG SCHEMA</schema>
286 final var compositeNodeRpcResult = transformer.toRpcResult(RpcResultBuilder.success(response).build(),
288 assertTrue(compositeNodeRpcResult.errors().isEmpty());
289 assertNotNull(compositeNodeRpcResult.value());
290 final var schemaContent = ((DOMSourceAnyxmlNode) compositeNodeRpcResult.value()
291 .body().iterator().next()).body();
293 <data xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
294 <schema xmlns="http://www.w3.org/2001/XMLSchema">Random YANG SCHEMA</schema>
296 """, XmlUtil.toString((Element) schemaContent.getNode()));
300 public void testGetConfigResponse() throws Exception {
301 final var response = new NetconfMessage(XmlUtil.readXmlToDocument("""
302 <rpc-reply message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
304 <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
307 <identifier>module</identifier>
308 <version>2012-12-12</version>
309 <format xmlns:x="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">x:yang</format>
316 final var transformer = getTransformer(SCHEMA);
317 final var compositeNodeRpcResult = transformer.toRpcResult(RpcResultBuilder.success(response).build(),
319 assertTrue(compositeNodeRpcResult.errors().isEmpty());
320 assertNotNull(compositeNodeRpcResult.value());
322 final var values = MonitoringSchemaSourceProvider.createGetSchemaRequest(
323 "module", Optional.of("2012-12-12")).body();
325 final var keys = new HashMap<QName, Object>();
326 for (var value : values) {
327 keys.put(value.name().getNodeType(), value.body());
330 final var schemaNode = Builders.mapEntryBuilder()
331 .withNodeIdentifier(NodeIdentifierWithPredicates.of(Schema.QNAME, keys))
335 final var data = (DOMSourceAnyxmlNode) compositeNodeRpcResult.value()
336 .getChildByArg(new NodeIdentifier(Data.QNAME));
338 final var nodeResult = NormalizedDataUtil.transformDOMSourceToNormalizedNode(SCHEMA, data.body());
339 final var result = (ContainerNode) nodeResult.getResult().data();
340 final var state = (ContainerNode) result.getChildByArg(new NodeIdentifier(NetconfState.QNAME));
341 final var schemas = (ContainerNode) state.getChildByArg(new NodeIdentifier(Schemas.QNAME));
342 final var schemaParent = (MapNode) schemas.getChildByArg(new NodeIdentifier(Schema.QNAME));
343 assertEquals(1, schemaParent.body().size());
345 assertEquals(schemaNode, schemaParent.body().iterator().next());
349 public void testGetConfigLeafRequest() throws Exception {
350 final var filter = toFilterStructure(YangInstanceIdentifier.of(
351 new NodeIdentifier(NetconfState.QNAME),
352 new NodeIdentifier(Schemas.QNAME),
353 new NodeIdentifier(Schema.QNAME),
354 NodeIdentifierWithPredicates.of(Schema.QNAME),
355 new NodeIdentifier(QName.create(Schemas.QNAME, "version"))), SCHEMA);
357 final var source = NetconfBaseOps.getSourceNode(NETCONF_RUNNING_NODEID);
359 final var netconfMessage = netconfMessageTransformer.toRpcRequest(GetConfig.QNAME,
360 NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_NODEID, source, filter));
362 assertSimilarXml(netconfMessage, """
363 <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
365 <filter type="subtree">
366 <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
382 public void testGetConfigRequest() throws Exception {
383 final var filter = toFilterStructure(YangInstanceIdentifier.of(NetconfState.QNAME, Schemas.QNAME), SCHEMA);
385 final var source = NetconfBaseOps.getSourceNode(NETCONF_RUNNING_NODEID);
387 final var netconfMessage = netconfMessageTransformer.toRpcRequest(GetConfig.QNAME,
388 NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_NODEID, source, filter));
390 assertSimilarXml(netconfMessage, """
391 <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
393 <filter type="subtree">
394 <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
406 public void testEditConfigRequest() throws Exception {
407 final var values = MonitoringSchemaSourceProvider.createGetSchemaRequest(
408 "module", Optional.of("2012-12-12")).body();
410 final var keys = new HashMap<QName, Object>();
411 for (var value : values) {
412 keys.put(value.name().getNodeType(), value.body());
415 final var schemaNode = Builders.mapEntryBuilder()
416 .withNodeIdentifier(NodeIdentifierWithPredicates.of(Schema.QNAME, keys))
420 final var id = YangInstanceIdentifier.builder()
421 .node(NetconfState.QNAME).node(Schemas.QNAME).node(Schema.QNAME)
422 .nodeWithKey(Schema.QNAME, keys).build();
423 final var editConfigStructure =
424 createEditConfigStructure(BASE_SCHEMAS.baseSchemaWithNotifications().modelContext(), id,
425 Optional.empty(), Optional.ofNullable(schemaNode));
427 final var target = NetconfBaseOps.getTargetNode(NETCONF_CANDIDATE_NODEID);
429 final var wrap = NetconfMessageTransformUtil.wrap(NETCONF_EDIT_CONFIG_NODEID, editConfigStructure, target);
430 final var netconfMessage = netconfMessageTransformer.toRpcRequest(EditConfig.QNAME, wrap);
432 assertSimilarXml(netconfMessage, """
433 <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
439 <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
442 <identifier>module</identifier>
443 <version>2012-12-12</version>
444 <format>yang</format>
453 private static void assertSimilarXml(final NetconfMessage netconfMessage, final String xmlContent)
454 throws SAXException, IOException {
455 final Diff diff = XMLUnit.compareXML(netconfMessage.getDocument(), XmlUtil.readXmlToDocument(xmlContent));
456 diff.overrideElementQualifier(new ElementNameAndAttributeQualifier());
457 assertTrue(diff.toString(), diff.similar());
461 public void testGetRequest() throws Exception {
462 final var capability = QName.create(Capabilities.QNAME, "capability");
463 final var filter = toFilterStructure(YangInstanceIdentifier.of(
464 new NodeIdentifier(NetconfState.QNAME),
465 new NodeIdentifier(Capabilities.QNAME),
466 new NodeIdentifier(capability),
467 new NodeWithValue<>(capability, "a:b:c")), SCHEMA);
469 final var netconfMessage = netconfMessageTransformer.toRpcRequest(Get.QNAME,
470 NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, filter));
472 assertSimilarXml(netconfMessage, """
473 <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
474 <get xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
475 <filter type="subtree">
476 <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
478 <capability>a:b:c</capability>
487 public void testGetLeafList() throws IOException, SAXException {
488 final var filter = toFilterStructure(YangInstanceIdentifier.of(
491 QName.create(Capabilities.QNAME, "capability")), SCHEMA);
492 final var netconfMessage = netconfMessageTransformer.toRpcRequest(Get.QNAME,
493 NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, filter));
495 assertSimilarXml(netconfMessage, """
496 <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
498 <filter type="subtree">
499 <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
510 public void testGetList() throws IOException, SAXException {
511 final var filter = toFilterStructure(YangInstanceIdentifier.of(
514 QName.create(Datastores.QNAME, "datastore")), SCHEMA);
515 final var netconfMessage = netconfMessageTransformer.toRpcRequest(Get.QNAME,
516 NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, filter));
518 assertSimilarXml(netconfMessage, """
519 <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
521 <filter type="subtree">
522 <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
532 private static NetconfMessageTransformer getTransformer(final EffectiveModelContext schema) {
533 return new NetconfMessageTransformer(MountPointContext.of(schema), true, BASE_SCHEMAS.baseSchema());
537 public void testCommitResponse() throws Exception {
538 final var compositeNodeRpcResult = netconfMessageTransformer.toRpcResult(
539 RpcResultBuilder.success(new NetconfMessage(XmlUtil.readXmlToDocument(
540 "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\"><ok/></rpc-reply>"))).build(),
542 assertTrue(compositeNodeRpcResult.errors().isEmpty());
543 assertNull(compositeNodeRpcResult.value());
547 public void getActionsTest() {
548 final var schemaPaths = Set.of(RESET_SERVER_PATH, START_DEVICE_PATH, ENABLE_INTERFACE_PATH, OPEN_BOXES_PATH,
549 KILL_SERVER_APP_PATH, XYZZY_FOO_PATH, XYZZY_BAR_PATH, CHOICE_ACTION_PATH, DISABLE_INTERFACE_PATH,
550 CHECK_WITH_OUTPUT_INTERFACE_PATH, CHECK_WITHOUT_OUTPUT_INTERFACE_PATH);
552 var actions = NetconfMessageTransformer.getActions(ACTION_SCHEMA);
553 assertEquals(schemaPaths.size(), actions.size());
555 for (var path : schemaPaths) {
556 assertNotNull("Action for " + path + " not found", actions.get(path));
561 public void toActionRequestListTopLevelTest() {
562 QName nameQname = QName.create(SERVER_QNAME, "name");
563 List<PathArgument> nodeIdentifiers = new ArrayList<>();
564 nodeIdentifiers.add(new NodeIdentifier(SERVER_QNAME));
565 nodeIdentifiers.add(NodeIdentifierWithPredicates.of(SERVER_QNAME, nameQname, "test"));
566 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
568 ContainerNode data = initInputAction(QName.create(SERVER_QNAME, "reset-at"), "now");
570 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
571 RESET_SERVER_PATH, domDataTreeIdentifier, data);
573 Node childAction = checkBasePartOfActionRequest(actionRequest);
575 Node childServer = childAction.getFirstChild();
576 checkNode(childServer, "server", "server", URN_EXAMPLE_SERVER_FARM);
578 Node childName = childServer.getFirstChild();
579 checkNode(childName, "name", "name", URN_EXAMPLE_SERVER_FARM);
581 Node childTest = childName.getFirstChild();
582 assertEquals(childTest.getNodeValue(), "test");
584 checkAction(RESET_QNAME, childName.getNextSibling(), "reset-at", "reset-at", "now");
588 public void toActionRequestContainerTopLevelTest() {
589 List<PathArgument> nodeIdentifiers = List.of(NodeIdentifier.create(DEVICE_QNAME));
590 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
592 ContainerNode payload = initInputAction(QName.create(DEVICE_QNAME, "start-at"), "now");
593 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
594 START_DEVICE_PATH, domDataTreeIdentifier, payload);
596 Node childAction = checkBasePartOfActionRequest(actionRequest);
598 Node childDevice = childAction.getFirstChild();
599 checkNode(childDevice, "device", "device", URN_EXAMPLE_SERVER_FARM);
601 checkAction(START_QNAME, childDevice.getFirstChild(), "start-at", "start-at", "now");
605 public void toActionRequestContainerInContainerTest() {
606 List<PathArgument> nodeIdentifiers = new ArrayList<>();
607 nodeIdentifiers.add(NodeIdentifier.create(BOX_OUT_QNAME));
608 nodeIdentifiers.add(NodeIdentifier.create(BOX_IN_QNAME));
610 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
612 ContainerNode payload = initInputAction(QName.create(BOX_OUT_QNAME, "start-at"), "now");
613 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
614 OPEN_BOXES_PATH, domDataTreeIdentifier, payload);
616 Node childAction = checkBasePartOfActionRequest(actionRequest);
618 Node childBoxOut = childAction.getFirstChild();
619 checkNode(childBoxOut, "box-out", "box-out", URN_EXAMPLE_SERVER_FARM);
621 Node childBoxIn = childBoxOut.getFirstChild();
622 checkNode(childBoxIn, "box-in", "box-in", URN_EXAMPLE_SERVER_FARM);
624 Node action = childBoxIn.getFirstChild();
625 checkNode(action, OPEN_QNAME.getLocalName(), OPEN_QNAME.getLocalName(), OPEN_QNAME.getNamespace().toString());
629 public void toActionRequestListInContainerTest() {
630 QName nameQname = QName.create(INTERFACE_QNAME, "name");
632 List<PathArgument> nodeIdentifiers = new ArrayList<>();
633 nodeIdentifiers.add(NodeIdentifier.create(DEVICE_QNAME));
634 nodeIdentifiers.add(NodeIdentifier.create(INTERFACE_QNAME));
635 nodeIdentifiers.add(NodeIdentifierWithPredicates.of(INTERFACE_QNAME, nameQname, "test"));
637 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
639 ContainerNode payload = initEmptyInputAction(INTERFACE_QNAME);
640 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
641 ENABLE_INTERFACE_PATH, domDataTreeIdentifier, payload);
643 Node childAction = checkBasePartOfActionRequest(actionRequest);
645 Node childDevice = childAction.getFirstChild();
646 checkNode(childDevice, "device", "device", URN_EXAMPLE_SERVER_FARM);
648 Node childInterface = childDevice.getFirstChild();
649 checkNode(childInterface, "interface", "interface", URN_EXAMPLE_SERVER_FARM);
651 Node childName = childInterface.getFirstChild();
652 checkNode(childName, "name", "name", nameQname.getNamespace().toString());
654 Node childTest = childName.getFirstChild();
655 assertEquals(childTest.getNodeValue(), "test");
657 Node action = childInterface.getLastChild();
658 checkNode(action, ENABLE_QNAME.getLocalName(), ENABLE_QNAME.getLocalName(),
659 ENABLE_QNAME.getNamespace().toString());
663 public void toActionRequestListInContainerAugmentedIntoListTest() {
664 QName serverNameQname = QName.create(SERVER_QNAME, "name");
665 QName applicationNameQname = QName.create(APPLICATION_QNAME, "name");
667 List<PathArgument> nodeIdentifiers = new ArrayList<>();
668 nodeIdentifiers.add(NodeIdentifier.create(SERVER_QNAME));
669 nodeIdentifiers.add(NodeIdentifierWithPredicates.of(SERVER_QNAME, serverNameQname, "testServer"));
670 nodeIdentifiers.add(NodeIdentifier.create(APPLICATIONS_QNAME));
671 nodeIdentifiers.add(NodeIdentifier.create(APPLICATION_QNAME));
672 nodeIdentifiers.add(NodeIdentifierWithPredicates.of(APPLICATION_QNAME,
673 applicationNameQname, "testApplication"));
675 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
677 ContainerNode payload = initEmptyInputAction(APPLICATION_QNAME);
678 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
679 KILL_SERVER_APP_PATH, domDataTreeIdentifier, payload);
681 Node childAction = checkBasePartOfActionRequest(actionRequest);
683 Node childServer = childAction.getFirstChild();
684 checkNode(childServer, "server", "server", URN_EXAMPLE_SERVER_FARM);
686 Node childServerName = childServer.getFirstChild();
687 checkNode(childServerName, "name", "name", URN_EXAMPLE_SERVER_FARM);
689 Node childServerNameTest = childServerName.getFirstChild();
690 assertEquals(childServerNameTest.getNodeValue(), "testServer");
692 Node childApplications = childServer.getLastChild();
693 checkNode(childApplications, "applications", "applications", URN_EXAMPLE_SERVER_FARM_2);
695 Node childApplication = childApplications.getFirstChild();
696 checkNode(childApplication, "application", "application", URN_EXAMPLE_SERVER_FARM_2);
698 Node childApplicationName = childApplication.getFirstChild();
699 checkNode(childApplicationName, "name", "name", URN_EXAMPLE_SERVER_FARM_2);
701 Node childApplicationNameTest = childApplicationName.getFirstChild();
702 assertEquals(childApplicationNameTest.getNodeValue(), "testApplication");
704 Node childKillAction = childApplication.getLastChild();
705 checkNode(childApplication, "application", "application", URN_EXAMPLE_SERVER_FARM_2);
706 checkNode(childKillAction, KILL_QNAME.getLocalName(), KILL_QNAME.getLocalName(),
707 KILL_QNAME.getNamespace().toString());
711 public void toActionRequestConflictingInListTest() {
712 QName barInputQname = QName.create(BAR_QNAME, "bar");
713 QName barIdQname = QName.create(BAR_QNAME, "bar-id");
716 List<PathArgument> nodeIdentifiers = new ArrayList<>();
717 nodeIdentifiers.add(NodeIdentifier.create(BAR_QNAME));
718 nodeIdentifiers.add(NodeIdentifierWithPredicates.of(BAR_QNAME, barIdQname, "test"));
720 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
722 ContainerNode payload = Builders.containerBuilder()
723 .withNodeIdentifier(NodeIdentifier.create(QName.create(barInputQname, "input")))
724 .withChild(ImmutableNodes.leafNode(barInputQname, barInput))
727 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
728 XYZZY_BAR_PATH, domDataTreeIdentifier, payload);
730 Node childAction = checkBasePartOfActionRequest(actionRequest);
732 Node childBar = childAction.getFirstChild();
733 checkNode(childBar, "bar", "bar", URN_EXAMPLE_CONFLICT);
735 Node childBarId = childBar.getFirstChild();
736 checkNode(childBarId, "bar-id", "bar-id", URN_EXAMPLE_CONFLICT);
738 Node childTest = childBarId.getFirstChild();
739 assertEquals(childTest.getNodeValue(), "test");
741 Node action = childBar.getLastChild();
742 checkNode(action, XYZZY_QNAME.getLocalName(), XYZZY_QNAME.getLocalName(),
743 XYZZY_QNAME.getNamespace().toString());
747 public void toActionRequestConflictingInContainerTest() {
748 QName fooInputQname = QName.create(FOO_QNAME, "foo");
750 List<PathArgument> nodeIdentifiers = new ArrayList<>();
751 nodeIdentifiers.add(NodeIdentifier.create(FOO_QNAME));
752 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
753 ContainerNode payload = initInputAction(fooInputQname, "test");
755 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
756 XYZZY_FOO_PATH, domDataTreeIdentifier, payload);
758 Node childAction = checkBasePartOfActionRequest(actionRequest);
760 Node childBar = childAction.getFirstChild();
761 checkNode(childBar, "foo", "foo", URN_EXAMPLE_CONFLICT);
763 Node action = childBar.getLastChild();
764 checkNode(action, XYZZY_QNAME.getLocalName(), XYZZY_QNAME.getLocalName(),
765 XYZZY_QNAME.getNamespace().toString());
769 public void toActionRequestChoiceTest() {
770 List<PathArgument> nodeIdentifiers = new ArrayList<>();
771 nodeIdentifiers.add(NodeIdentifier.create(CONFLICT_CHOICE_QNAME));
772 nodeIdentifiers.add(NodeIdentifier.create(CHOICE_CONT_QNAME));
773 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
774 NormalizedNode payload = initEmptyInputAction(CHOICE_ACTION_QNAME);
776 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
777 CHOICE_ACTION_PATH, domDataTreeIdentifier, payload);
779 Node childAction = checkBasePartOfActionRequest(actionRequest);
781 Node childChoiceCont = childAction.getFirstChild();
782 checkNode(childChoiceCont, "choice-cont", "choice-cont", URN_EXAMPLE_CONFLICT);
784 Node action = childChoiceCont.getLastChild();
785 checkNode(action, CHOICE_ACTION_QNAME.getLocalName(), CHOICE_ACTION_QNAME.getLocalName(),
786 CHOICE_ACTION_QNAME.getNamespace().toString());
790 public void toAugmentedActionRequestListInContainerTest() {
791 QName nameQname = QName.create(INTERFACE_QNAME, "name");
793 List<PathArgument> nodeIdentifiers = new ArrayList<>();
794 nodeIdentifiers.add(NodeIdentifier.create(DEVICE_QNAME));
795 nodeIdentifiers.add(NodeIdentifier.create(INTERFACE_QNAME));
796 nodeIdentifiers.add(NodeIdentifierWithPredicates.of(INTERFACE_QNAME, nameQname, "test"));
798 DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
800 NormalizedNode payload = initEmptyInputAction(INTERFACE_QNAME);
801 NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
802 DISABLE_INTERFACE_PATH, domDataTreeIdentifier, payload);
804 Node childAction = checkBasePartOfActionRequest(actionRequest);
806 Node childDevice = childAction.getFirstChild();
807 checkNode(childDevice, "device", "device", URN_EXAMPLE_SERVER_FARM);
809 Node childInterface = childDevice.getFirstChild();
810 checkNode(childInterface, "interface", "interface", URN_EXAMPLE_SERVER_FARM);
812 Node childName = childInterface.getFirstChild();
813 checkNode(childName, "name", "name", nameQname.getNamespace().toString());
815 Node childTest = childName.getFirstChild();
816 assertEquals(childTest.getNodeValue(), "test");
818 Node action = childInterface.getLastChild();
819 checkNode(action, DISABLE_QNAME.getLocalName(), DISABLE_QNAME.getLocalName(),
820 DISABLE_QNAME.getNamespace().toString());
824 public void toActionResultTest() throws Exception {
825 var message = new NetconfMessage(XmlUtil.readXmlToDocument("""
826 <rpc-reply message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
827 <reset-finished-at xmlns="urn:example:server-farm">now</reset-finished-at>
829 final var actionResult = actionNetconfMessageTransformer.toActionResult(RESET_SERVER_PATH, message);
830 assertNotNull(actionResult);
831 final var containerNode = actionResult.getOutput().orElseThrow();
832 assertNotNull(containerNode);
833 assertEquals("now", containerNode.body().iterator().next().body());
837 public void toActionEmptyBodyWithOutputDefinedResultTest() throws Exception {
838 final var message = new NetconfMessage(XmlUtil.readXmlToDocument("""
839 <rpc-reply message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
842 final var actionResult =
843 actionNetconfMessageTransformer.toActionResult(CHECK_WITH_OUTPUT_INTERFACE_PATH, message);
844 assertNotNull(actionResult);
845 assertTrue(actionResult.getOutput().isEmpty());
849 public void toActionEmptyBodyWithoutOutputDefinedResultTest() throws Exception {
850 final var message = new NetconfMessage(XmlUtil.readXmlToDocument("""
851 <rpc-reply message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
854 final var actionResult =
855 actionNetconfMessageTransformer.toActionResult(CHECK_WITHOUT_OUTPUT_INTERFACE_PATH, message);
856 assertNotNull(actionResult);
857 assertTrue(actionResult.getOutput().isEmpty());
861 public void getTwoNonOverlappingFieldsTest() throws IOException, SAXException {
862 // preparation of the fields
863 final var parentYiid = YangInstanceIdentifier.of(NetconfState.QNAME);
864 final var netconfStartTimeField = YangInstanceIdentifier.of(Statistics.QNAME,
865 QName.create(Statistics.QNAME, "netconf-start-time"));
866 final var datastoresField = YangInstanceIdentifier.of(Datastores.QNAME);
868 // building filter structure and NETCONF message
869 final var filterStructure = toFilterStructure(
870 List.of(FieldsFilter.of(parentYiid, List.of(netconfStartTimeField, datastoresField))), SCHEMA);
871 final var netconfMessage = netconfMessageTransformer.toRpcRequest(Get.QNAME,
872 NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, filterStructure));
875 assertSimilarXml(netconfMessage, """
876 <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
878 <filter type="subtree">
879 <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
881 <netconf-start-time/>
891 public void getOverlappingFieldsTest() throws IOException, SAXException {
892 // preparation of the fields
893 final var parentYiid = YangInstanceIdentifier.of(NetconfState.QNAME);
894 final var capabilitiesField = YangInstanceIdentifier.of(Capabilities.QNAME);
895 final var capabilityField = YangInstanceIdentifier.of(Capabilities.QNAME,
896 QName.create(Capabilities.QNAME, "capability"));
897 final var datastoreField = YangInstanceIdentifier.of(Datastores.QNAME);
898 final var locksFields = YangInstanceIdentifier.of(
899 new NodeIdentifier(Datastores.QNAME),
900 new NodeIdentifier(Datastore.QNAME),
901 // Note: acts as 'select all'
902 NodeIdentifierWithPredicates.of(Datastore.QNAME),
903 new NodeIdentifier(Locks.QNAME));
905 // building filter structure and NETCONF message
906 final var filterStructure = toFilterStructure(
907 List.of(FieldsFilter.of(parentYiid,
908 List.of(capabilitiesField, capabilityField, datastoreField, locksFields))),
910 final var netconfMessage = netconfMessageTransformer.toRpcRequest(Get.QNAME,
911 NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, filterStructure));
914 assertSimilarXml(netconfMessage, """
915 <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
917 <filter type="subtree">
918 <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
928 public void getOverlappingFieldsWithEmptyFieldTest() throws IOException, SAXException {
929 // preparation of the fields
930 final var parentYiid = YangInstanceIdentifier.of(NetconfState.QNAME);
931 final var capabilitiesField = YangInstanceIdentifier.of(Capabilities.QNAME);
933 // building filter structure and NETCONF message
934 final var filterStructure = toFilterStructure(
935 List.of(FieldsFilter.of(parentYiid, List.of(capabilitiesField, YangInstanceIdentifier.of()))),
937 final var netconfMessage = netconfMessageTransformer.toRpcRequest(Get.QNAME,
938 NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, filterStructure));
941 assertSimilarXml(netconfMessage, """
942 <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
944 <filter type="subtree">
945 <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring"/>
952 public void getSpecificFieldsUnderListTest() throws IOException, SAXException {
953 // preparation of the fields
954 final var parentYiid = YangInstanceIdentifier.of(
955 new NodeIdentifier(NetconfState.QNAME),
956 new NodeIdentifier(Schemas.QNAME),
957 new NodeIdentifier(Schema.QNAME),
958 NodeIdentifierWithPredicates.of(Schema.QNAME));
959 final var versionField = YangInstanceIdentifier.of(
960 QName.create(Schema.QNAME, "version"));
961 final var identifierField = YangInstanceIdentifier.of(
962 QName.create(Schema.QNAME, "namespace"));
964 // building filter structure and NETCONF message
965 final var filterStructure = toFilterStructure(
966 List.of(FieldsFilter.of(parentYiid, List.of(versionField, identifierField))), SCHEMA);
967 final var netconfMessage = netconfMessageTransformer.toRpcRequest(Get.QNAME,
968 NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, filterStructure));
971 assertSimilarXml(netconfMessage, """
972 <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
974 <filter type="subtree">
975 <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
991 public void getSpecificFieldsUnderMultipleLists() throws IOException, SAXException {
992 // preparation of the fields
993 final var parentYiid = YangInstanceIdentifier.of(NetconfState.QNAME, Datastores.QNAME);
994 final var partialLockYiid = YangInstanceIdentifier.of(
995 new NodeIdentifier(Datastore.QNAME),
996 NodeIdentifierWithPredicates.of(Datastore.QNAME),
997 new NodeIdentifier(Locks.QNAME),
998 new NodeIdentifier(QName.create(Locks.QNAME, "lock-type")),
999 new NodeIdentifier(PartialLock.QNAME),
1000 NodeIdentifierWithPredicates.of(PartialLock.QNAME));
1001 final var lockedTimeField = partialLockYiid.node(QName.create(Locks.QNAME, "locked-time"));
1002 final var lockedBySessionField = partialLockYiid.node(QName.create(Locks.QNAME, "locked-by-session"));
1004 // building filter structure and NETCONF message
1005 final var filterStructure = toFilterStructure(
1006 List.of(FieldsFilter.of(parentYiid, List.of(lockedTimeField, lockedBySessionField))),
1008 final var netconfMessage = netconfMessageTransformer.toRpcRequest(Get.QNAME,
1009 NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, filterStructure));
1012 assertSimilarXml(netconfMessage, """
1013 <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
1015 <filter type="subtree">
1016 <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
1022 <locked-by-session/>
1036 public void getWholeListsUsingFieldsTest() throws IOException, SAXException {
1037 // preparation of the fields
1038 final var parentYiid = YangInstanceIdentifier.of(NetconfState.QNAME);
1039 final var datastoreListField = YangInstanceIdentifier.of(
1040 new NodeIdentifier(Datastores.QNAME),
1041 new NodeIdentifier(Datastore.QNAME),
1042 NodeIdentifierWithPredicates.of(Datastore.QNAME));
1043 final var sessionListField = YangInstanceIdentifier.of(
1044 new NodeIdentifier(Sessions.QNAME),
1045 new NodeIdentifier(Session.QNAME),
1046 NodeIdentifierWithPredicates.of(Session.QNAME));
1048 // building filter structure and NETCONF message
1049 final var filterStructure = toFilterStructure(
1050 List.of(FieldsFilter.of(parentYiid, List.of(datastoreListField, sessionListField))), SCHEMA);
1051 final var netconfMessage = netconfMessageTransformer.toRpcRequest(Get.QNAME,
1052 NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, filterStructure));
1055 assertSimilarXml(netconfMessage, """
1056 <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
1058 <filter type="subtree">
1059 <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
1073 public void getSpecificListEntriesWithSpecificFieldsTest() throws IOException, SAXException {
1074 // preparation of the fields
1075 final var parentYiid = YangInstanceIdentifier.of(NetconfState.QNAME, Sessions.QNAME);
1076 final var sessionId = QName.create(Session.QNAME, "session-id");
1077 final var session1Field = YangInstanceIdentifier.of(
1078 new NodeIdentifier(Session.QNAME),
1079 NodeIdentifierWithPredicates.of(Session.QNAME, sessionId, 1));
1080 final var session2TransportField = YangInstanceIdentifier.of(
1081 new NodeIdentifier(Session.QNAME),
1082 NodeIdentifierWithPredicates.of(Session.QNAME, sessionId, 2),
1083 new NodeIdentifier(QName.create(Session.QNAME, "transport")));
1085 // building filter structure and NETCONF message
1086 final var filterStructure = toFilterStructure(
1087 List.of(FieldsFilter.of(parentYiid, List.of(session1Field, session2TransportField))), SCHEMA);
1088 final var netconfMessage = netconfMessageTransformer.toRpcRequest(Get.QNAME,
1089 NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, filterStructure));
1092 assertSimilarXml(netconfMessage, """
1093 <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
1095 <filter type="subtree">
1096 <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
1099 <session-id>1</session-id>
1102 <session-id>2</session-id>
1113 // Proof that YANGTOOLS-1362 works on DOM level
1114 public void testConfigChangeToNotification() throws SAXException, IOException {
1115 final var message = new NetconfMessage(XmlUtil.readXmlToDocument(
1116 "<notification xmlns=\"urn:ietf:params:xml:ns:netconf:notification:1.0\">\n"
1117 + " <eventTime>2021-11-11T11:26:16Z</eventTime> \n"
1118 + " <netconf-config-change xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-notifications\">\n"
1119 + " <changed-by> \n"
1120 + " <username>root</username> \n"
1121 + " <session-id>3</session-id> \n"
1122 + " </changed-by> \n"
1123 + " <datastore>running</datastore> \n"
1125 + " <target xmlns:ncm=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">/ncm:netconf-state"
1126 + "/ncm:datastores/ncm:datastore[ncm:name='running']</target>\n"
1127 + " <operation>replace</operation> \n"
1129 + " </netconf-config-change> \n"
1130 + "</notification>"));
1132 final var change = netconfMessageTransformer.toNotification(message).getBody();
1133 final var editList = change.getChildByArg(new NodeIdentifier(Edit.QNAME));
1134 assertThat(editList, instanceOf(UnkeyedListNode.class));
1135 final var edits = ((UnkeyedListNode) editList).body();
1136 assertEquals(1, edits.size());
1137 final var edit = edits.iterator().next();
1138 final var target = edit.getChildByArg(new NodeIdentifier(QName.create(Edit.QNAME, "target"))).body();
1139 assertThat(target, instanceOf(YangInstanceIdentifier.class));
1141 final var args = ((YangInstanceIdentifier) target).getPathArguments();
1142 assertEquals(4, args.size());
1145 private static void checkAction(final QName actionQname, final Node action , final String inputLocalName,
1146 final String inputNodeName, final String inputValue) {
1147 checkNode(action, actionQname.getLocalName(), actionQname.getLocalName(),
1148 actionQname.getNamespace().toString());
1150 Node childResetAt = action.getFirstChild();
1151 checkNode(childResetAt, inputLocalName, inputNodeName, actionQname.getNamespace().toString());
1153 Node firstChild = childResetAt.getFirstChild();
1154 assertEquals(firstChild.getNodeValue(), inputValue);
1157 private static Node checkBasePartOfActionRequest(final NetconfMessage actionRequest) {
1158 Node baseRpc = actionRequest.getDocument().getFirstChild();
1159 checkNode(baseRpc, "rpc", "rpc", "urn:ietf:params:xml:ns:netconf:base:1.0");
1160 assertTrue(baseRpc.getLocalName().equals("rpc"));
1161 assertTrue(baseRpc.getNodeName().equals("rpc"));
1163 Node messageId = baseRpc.getAttributes().getNamedItem("message-id");
1164 assertNotNull(messageId);
1165 assertTrue(messageId.getNodeValue().contains("m-"));
1166 Node childAction = baseRpc.getFirstChild();
1168 checkNode(childAction, "action", "action", "urn:ietf:params:xml:ns:yang:1");
1172 private static DOMDataTreeIdentifier prepareDataTreeId(final List<PathArgument> nodeIdentifiers) {
1173 YangInstanceIdentifier yangInstanceIdentifier =
1174 YangInstanceIdentifier.builder().append(nodeIdentifiers).build();
1175 DOMDataTreeIdentifier domDataTreeIdentifier =
1176 DOMDataTreeIdentifier.of(org.opendaylight.mdsal.common.api.LogicalDatastoreType.CONFIGURATION,
1177 yangInstanceIdentifier);
1178 return domDataTreeIdentifier;
1181 private static ContainerNode initInputAction(final QName qname, final String value) {
1182 return Builders.containerBuilder()
1183 .withNodeIdentifier(NodeIdentifier.create(QName.create(qname, "input")))
1184 .withChild(ImmutableNodes.leafNode(qname, value))
1188 private static ContainerNode initEmptyInputAction(final QName qname) {
1189 return Builders.containerBuilder()
1190 .withNodeIdentifier(NodeIdentifier.create(QName.create(qname, "input")))
1194 private static void checkNode(final Node childServer, final String expectedLocalName, final String expectedNodeName,
1195 final String expectedNamespace) {
1196 assertNotNull(childServer);
1197 assertEquals(childServer.getLocalName(), expectedLocalName);
1198 assertEquals(childServer.getNodeName(), expectedNodeName);
1199 assertEquals(childServer.getNamespaceURI(), expectedNamespace);