plugins/netconf-client-mdsal/src/test/java/org/opendaylight/netconf/client/mdsal/impl/NetconfMessageTransformerTest.java

   1 /*
   2  * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.netconf.client.mdsal.impl;
   9
  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;
  23
  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;
  29 import java.util.Set;
  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.CapabilityURN;
  40 import org.opendaylight.netconf.api.messages.NetconfMessage;
  41 import org.opendaylight.netconf.api.xml.XmlUtil;
  42 import org.opendaylight.netconf.client.mdsal.AbstractBaseSchemasTest;
  43 import org.opendaylight.netconf.client.mdsal.api.NetconfSessionPreferences;
  44 import org.opendaylight.netconf.common.mdsal.NormalizedDataUtil;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.Commit;
  46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.DiscardChanges;
  47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.EditConfig;
  48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.Get;
  49 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.GetConfig;
  50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.IetfNetconfData;
  51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.Lock;
  52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.get.config.output.Data;
  53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscription;
  54 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscriptionInput;
  55 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.GetSchema;
  56 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfState;
  57 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Capabilities;
  58 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Datastores;
  59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Schemas;
  60 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Sessions;
  61 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Statistics;
  62 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.datastores.Datastore;
  63 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.datastores.datastore.Locks;
  64 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;
  65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.Schema;
  66 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.Session;
  67 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfConfigChange;
  68 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.netconf.config.change.Edit;
  69 import org.opendaylight.yangtools.yang.common.QName;
  70 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  71 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  72 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  73 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  74 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  75 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  76 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  77 import org.opendaylight.yangtools.yang.data.api.schema.DOMSourceAnyxmlNode;
  78 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  79 import org.opendaylight.yangtools.yang.data.api.schema.MountPointContext;
  80 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  81 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  82 import org.opendaylight.yangtools.yang.data.spi.node.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;
  89
  90 public class NetconfMessageTransformerTest extends AbstractBaseSchemasTest {
  91
  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";
  94
  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";
  97
  98     private static final String URN_EXAMPLE_CONFLICT = "urn:example:conflict";
  99
 100     private static final String URN_EXAMPLE_AUGMENTED_ACTION = "urn:example:augmented-action";
 101
 102     private static final String URN_EXAMPLE_RPCS_ACTIONS_OUTPUTS = "urn:example:rpcs-actions-outputs";
 103
 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);
 114
 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);
 122
 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);
 125
 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");
 138
 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);
 144
 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);
 150
 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);
 156
 157     private static EffectiveModelContext PARTIAL_SCHEMA;
 158     private static EffectiveModelContext SCHEMA;
 159     private static EffectiveModelContext ACTION_SCHEMA;
 160
 161     private NetconfMessageTransformer actionNetconfMessageTransformer;
 162     private NetconfMessageTransformer netconfMessageTransformer;
 163
 164     @BeforeClass
 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");
 173     }
 174
 175     @AfterClass
 176     public static void afterClass() {
 177         PARTIAL_SCHEMA = null;
 178         SCHEMA = null;
 179         ACTION_SCHEMA = null;
 180     }
 181
 182     @Before
 183     public void setUp() throws Exception {
 184         XMLUnit.setIgnoreWhitespace(true);
 185         XMLUnit.setIgnoreAttributeOrder(true);
 186         XMLUnit.setIgnoreComments(true);
 187
 188         netconfMessageTransformer = getTransformer(SCHEMA);
 189         actionNetconfMessageTransformer = new NetconfMessageTransformer(MountPointContext.of(ACTION_SCHEMA), true,
 190             BASE_SCHEMAS.baseSchemaForCapabilities(NetconfSessionPreferences.fromStrings(Set.of())));
 191     }
 192
 193     @Test
 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));
 198         assertEquals("""
 199             <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="m-0">
 200                 <lock>
 201                     <target>
 202                         <candidate/>
 203                     </target>
 204                 </lock>
 205             </rpc>
 206             """, XmlUtil.toString(netconfMessage.getDocument()));
 207     }
 208
 209     @Test
 210     public void testCreateSubscriberNotificationSchemaNotPresent() throws Exception {
 211         final var transformer = new NetconfMessageTransformer(MountPointContext.of(SCHEMA), true,
 212             BASE_SCHEMAS.baseSchemaForCapabilities(NetconfSessionPreferences.fromStrings(
 213                 Set.of(CapabilityURN.NOTIFICATION))));
 214         var netconfMessage = transformer.toRpcRequest(CreateSubscription.QNAME, ImmutableNodes.newContainerBuilder()
 215             .withNodeIdentifier(new NodeIdentifier(CreateSubscriptionInput.QNAME))
 216             .build());
 217         assertEquals("""
 218             <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="m-0">
 219                 <create-subscription xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"/>
 220             </rpc>
 221             """, XmlUtil.toString(netconfMessage.getDocument()));
 222     }
 223
 224     @Test
 225     public void testLockSchemaRequest() throws Exception {
 226         final var transformer = getTransformer(PARTIAL_SCHEMA);
 227         final String result = "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\"><ok/></rpc-reply>";
 228
 229         transformer.toRpcResult(
 230             RpcResultBuilder.success(new NetconfMessage(XmlUtil.readXmlToDocument(result))).build(),
 231             Lock.QNAME);
 232     }
 233
 234     @Test
 235     public void testRpcEmptyBodyWithOutputDefinedSchemaResult() throws Exception {
 236         final String result = "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\"><ok/></rpc-reply>";
 237
 238         final var domRpcResult = actionNetconfMessageTransformer.toRpcResult(
 239             RpcResultBuilder.success(new NetconfMessage(XmlUtil.readXmlToDocument(result))).build(),
 240             RPC_WITH_OUTPUT_QNAME);
 241         assertNotNull(domRpcResult);
 242     }
 243
 244     @Test
 245     public void testRpcEmptyBodyWithoutOutputDefinedSchemaResult() throws Exception {
 246         final String result = "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\"><ok/></rpc-reply>";
 247
 248         final var domRpcResult = actionNetconfMessageTransformer.toRpcResult(
 249             RpcResultBuilder.success(new NetconfMessage(XmlUtil.readXmlToDocument(result))).build(),
 250             RPC_WITHOUT_OUTPUT_QNAME);
 251         assertNotNull(domRpcResult);
 252     }
 253
 254     @Test
 255     public void testDiscardChangesRequest() throws Exception {
 256         final var netconfMessage = netconfMessageTransformer.toRpcRequest(DiscardChanges.QNAME, null);
 257         assertEquals("""
 258             <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="m-0">
 259                 <discard-changes/>
 260             </rpc>
 261             """, XmlUtil.toString(netconfMessage.getDocument()));
 262     }
 263
 264     @Test
 265     public void testGetSchemaRequest() throws Exception {
 266         final var netconfMessage = netconfMessageTransformer.toRpcRequest(GetSchema.QNAME,
 267                 MonitoringSchemaSourceProvider.createGetSchemaRequest("module", Optional.of("2012-12-12")));
 268         assertSimilarXml(netconfMessage, """
 269             <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
 270               <get-schema xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
 271                 <format>yang</format>
 272                 <identifier>module</identifier>
 273                 <version>2012-12-12</version>
 274               </get-schema>
 275             </rpc>""");
 276     }
 277
 278     @Test
 279     public void testGetSchemaResponse() throws Exception {
 280         final var transformer = getTransformer(SCHEMA);
 281         final var response = new NetconfMessage(XmlUtil.readXmlToDocument("""
 282             <rpc-reply message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
 283               <data xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
 284                 <schema xmlns="http://www.w3.org/2001/XMLSchema">Random YANG SCHEMA</schema>
 285               </data>
 286             </rpc-reply>"""));
 287         final var compositeNodeRpcResult = transformer.toRpcResult(RpcResultBuilder.success(response).build(),
 288             GetSchema.QNAME);
 289         assertTrue(compositeNodeRpcResult.errors().isEmpty());
 290         assertNotNull(compositeNodeRpcResult.value());
 291         final var schemaContent = ((DOMSourceAnyxmlNode) compositeNodeRpcResult.value()
 292                 .body().iterator().next()).body();
 293         assertEquals("""
 294             <data xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
 295                 <schema xmlns="http://www.w3.org/2001/XMLSchema">Random YANG SCHEMA</schema>
 296             </data>
 297             """, XmlUtil.toString((Element) schemaContent.getNode()));
 298     }
 299
 300     @Test
 301     public void testGetConfigResponse() throws Exception {
 302         final var response = new NetconfMessage(XmlUtil.readXmlToDocument("""
 303             <rpc-reply message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
 304               <data>
 305                  <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
 306                    <schemas>
 307                      <schema>
 308                        <identifier>module</identifier>
 309                        <version>2012-12-12</version>
 310                        <format xmlns:x="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">x:yang</format>
 311                      </schema>
 312                    </schemas>
 313                  </netconf-state>
 314                </data>
 315              </rpc-reply>"""));
 316
 317         final var transformer = getTransformer(SCHEMA);
 318         final var compositeNodeRpcResult = transformer.toRpcResult(RpcResultBuilder.success(response).build(),
 319             GetConfig.QNAME);
 320         assertTrue(compositeNodeRpcResult.errors().isEmpty());
 321         assertNotNull(compositeNodeRpcResult.value());
 322
 323         final var values = MonitoringSchemaSourceProvider.createGetSchemaRequest(
 324             "module", Optional.of("2012-12-12")).body();
 325
 326         final var keys = new HashMap<QName, Object>();
 327         for (var value : values) {
 328             keys.put(value.name().getNodeType(), value.body());
 329         }
 330
 331         final var schemaNode = ImmutableNodes.newMapEntryBuilder()
 332             .withNodeIdentifier(NodeIdentifierWithPredicates.of(Schema.QNAME, keys))
 333             .withValue(values)
 334             .build();
 335
 336         final var data = (DOMSourceAnyxmlNode) compositeNodeRpcResult.value()
 337             .getChildByArg(new NodeIdentifier(Data.QNAME));
 338
 339         final var nodeResult = NormalizedDataUtil.transformDOMSourceToNormalizedNode(SCHEMA, data.body());
 340         final var result = (ContainerNode) nodeResult.getResult().data();
 341         final var state = (ContainerNode) result.getChildByArg(new NodeIdentifier(NetconfState.QNAME));
 342         final var schemas = (ContainerNode) state.getChildByArg(new NodeIdentifier(Schemas.QNAME));
 343         final var schemaParent = (MapNode) schemas.getChildByArg(new NodeIdentifier(Schema.QNAME));
 344         assertEquals(1, schemaParent.body().size());
 345
 346         assertEquals(schemaNode, schemaParent.body().iterator().next());
 347     }
 348
 349     @Test
 350     public void testGetConfigLeafRequest() throws Exception {
 351         final var filter = toFilterStructure(YangInstanceIdentifier.of(
 352             new NodeIdentifier(NetconfState.QNAME),
 353             new NodeIdentifier(Schemas.QNAME),
 354             new NodeIdentifier(Schema.QNAME),
 355             NodeIdentifierWithPredicates.of(Schema.QNAME),
 356             new NodeIdentifier(QName.create(Schemas.QNAME, "version"))), SCHEMA);
 357
 358         final var source = NetconfBaseOps.getSourceNode(NETCONF_RUNNING_NODEID);
 359
 360         final var netconfMessage = netconfMessageTransformer.toRpcRequest(GetConfig.QNAME,
 361                 NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_NODEID, source, filter));
 362
 363         assertSimilarXml(netconfMessage, """
 364             <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
 365               <get-config>
 366                 <filter type="subtree">
 367                   <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
 368                     <schemas>
 369                       <schema>
 370                         <version/>
 371                       </schema>
 372                     </schemas>
 373                   </netconf-state>
 374                 </filter>
 375                 <source>
 376                   <running/>
 377                 </source>
 378               </get-config>
 379             </rpc>""");
 380     }
 381
 382     @Test
 383     public void testGetConfigRequest() throws Exception {
 384         final var filter = toFilterStructure(YangInstanceIdentifier.of(NetconfState.QNAME, Schemas.QNAME), SCHEMA);
 385
 386         final var source = NetconfBaseOps.getSourceNode(NETCONF_RUNNING_NODEID);
 387
 388         final var netconfMessage = netconfMessageTransformer.toRpcRequest(GetConfig.QNAME,
 389                 NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_NODEID, source, filter));
 390
 391         assertSimilarXml(netconfMessage, """
 392             <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
 393               <get-config>
 394                 <filter type="subtree">
 395                   <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
 396                     <schemas/>
 397                   </netconf-state>
 398                 </filter>
 399                 <source>
 400                  <running/>
 401                 </source>
 402               </get-config>
 403             </rpc>""");
 404     }
 405
 406     @Test
 407     public void testEditConfigRequest() throws Exception {
 408         final var values = MonitoringSchemaSourceProvider.createGetSchemaRequest(
 409             "module", Optional.of("2012-12-12")).body();
 410
 411         final var keys = new HashMap<QName, Object>();
 412         for (var value : values) {
 413             keys.put(value.name().getNodeType(), value.body());
 414         }
 415
 416         final var schemaNode = ImmutableNodes.newMapEntryBuilder()
 417             .withNodeIdentifier(NodeIdentifierWithPredicates.of(Schema.QNAME, keys))
 418             .withValue(values)
 419             .build();
 420
 421         final var id = YangInstanceIdentifier.builder()
 422                 .node(NetconfState.QNAME).node(Schemas.QNAME).node(Schema.QNAME)
 423                 .nodeWithKey(Schema.QNAME, keys).build();
 424         final var editConfigStructure = createEditConfigStructure(BASE_SCHEMAS.baseSchemaForCapabilities(
 425             NetconfSessionPreferences.fromStrings(Set.of(
 426                 CapabilityURN.CANDIDATE,
 427                 "urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring?module=ietf-netconf-monitoring"
 428                     + "&revision=2010-10-04"))).modelContext(), id, Optional.empty(), Optional.ofNullable(schemaNode));
 429
 430         final var target = NetconfBaseOps.getTargetNode(NETCONF_CANDIDATE_NODEID);
 431
 432         final var wrap = NetconfMessageTransformUtil.wrap(NETCONF_EDIT_CONFIG_NODEID, editConfigStructure, target);
 433         final var netconfMessage = netconfMessageTransformer.toRpcRequest(EditConfig.QNAME, wrap);
 434
 435         assertSimilarXml(netconfMessage, """
 436             <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
 437               <edit-config>
 438                 <target>
 439                   <candidate/>
 440                 </target>
 441                 <config>
 442                   <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
 443                     <schemas>
 444                       <schema>
 445                         <identifier>module</identifier>
 446                         <version>2012-12-12</version>
 447                         <format>yang</format>
 448                       </schema>
 449                     </schemas>
 450                   </netconf-state>
 451                 </config>
 452               </edit-config>
 453             </rpc>""");
 454     }
 455
 456     private static void assertSimilarXml(final NetconfMessage netconfMessage, final String xmlContent)
 457             throws SAXException, IOException {
 458         final Diff diff = XMLUnit.compareXML(netconfMessage.getDocument(), XmlUtil.readXmlToDocument(xmlContent));
 459         diff.overrideElementQualifier(new ElementNameAndAttributeQualifier());
 460         assertTrue(diff.toString(), diff.similar());
 461     }
 462
 463     @Test
 464     public void testGetRequest() throws Exception {
 465         final var capability = QName.create(Capabilities.QNAME, "capability");
 466         final var filter = toFilterStructure(YangInstanceIdentifier.of(
 467             new NodeIdentifier(NetconfState.QNAME),
 468             new NodeIdentifier(Capabilities.QNAME),
 469             new NodeIdentifier(capability),
 470             new NodeWithValue<>(capability, "a:b:c")), SCHEMA);
 471
 472         final var netconfMessage = netconfMessageTransformer.toRpcRequest(Get.QNAME,
 473                 NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, filter));
 474
 475         assertSimilarXml(netconfMessage, """
 476             <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
 477               <get xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
 478                 <filter type="subtree">
 479                   <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
 480                     <capabilities>
 481                       <capability>a:b:c</capability>
 482                     </capabilities>
 483                   </netconf-state>
 484                 </filter>
 485               </get>
 486             </rpc>""");
 487     }
 488
 489     @Test
 490     public void testGetLeafList() throws IOException, SAXException {
 491         final var filter = toFilterStructure(YangInstanceIdentifier.of(
 492             NetconfState.QNAME,
 493             Capabilities.QNAME,
 494             QName.create(Capabilities.QNAME, "capability")), SCHEMA);
 495         final var netconfMessage = netconfMessageTransformer.toRpcRequest(Get.QNAME,
 496                 NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, filter));
 497
 498         assertSimilarXml(netconfMessage, """
 499             <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
 500               <get>
 501                 <filter type="subtree">
 502                   <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
 503                     <capabilities>
 504                       <capability/>
 505                     </capabilities>
 506                   </netconf-state>
 507                 </filter>
 508               </get>
 509             </rpc>""");
 510     }
 511
 512     @Test
 513     public void testGetList() throws IOException, SAXException {
 514         final var filter = toFilterStructure(YangInstanceIdentifier.of(
 515             NetconfState.QNAME,
 516             Datastores.QNAME,
 517             QName.create(Datastores.QNAME, "datastore")), SCHEMA);
 518         final var netconfMessage = netconfMessageTransformer.toRpcRequest(Get.QNAME,
 519                 NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, filter));
 520
 521         assertSimilarXml(netconfMessage, """
 522             <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
 523               <get>
 524                 <filter type="subtree">
 525                   <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
 526                     <datastores>
 527                       <datastore/>
 528                     </datastores>
 529                   </netconf-state>
 530                 </filter>
 531               </get>
 532             </rpc>""");
 533     }
 534
 535     private static NetconfMessageTransformer getTransformer(final EffectiveModelContext schema) {
 536         return new NetconfMessageTransformer(MountPointContext.of(schema), true,
 537             BASE_SCHEMAS.baseSchemaForCapabilities(NetconfSessionPreferences.fromStrings(Set.of())));
 538     }
 539
 540     @Test
 541     public void testCommitResponse() throws Exception {
 542         final var compositeNodeRpcResult = netconfMessageTransformer.toRpcResult(
 543             RpcResultBuilder.success(new NetconfMessage(XmlUtil.readXmlToDocument(
 544                 "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\"><ok/></rpc-reply>"))).build(),
 545             Commit.QNAME);
 546         assertTrue(compositeNodeRpcResult.errors().isEmpty());
 547         assertNull(compositeNodeRpcResult.value());
 548     }
 549
 550     @Test
 551     public void getActionsTest() {
 552         final var schemaPaths = Set.of(RESET_SERVER_PATH, START_DEVICE_PATH, ENABLE_INTERFACE_PATH, OPEN_BOXES_PATH,
 553             KILL_SERVER_APP_PATH, XYZZY_FOO_PATH, XYZZY_BAR_PATH, CHOICE_ACTION_PATH, DISABLE_INTERFACE_PATH,
 554             CHECK_WITH_OUTPUT_INTERFACE_PATH, CHECK_WITHOUT_OUTPUT_INTERFACE_PATH);
 555
 556         var actions = NetconfMessageTransformer.getActions(ACTION_SCHEMA);
 557         assertEquals(schemaPaths.size(), actions.size());
 558
 559         for (var path : schemaPaths) {
 560             assertNotNull("Action for " + path + " not found", actions.get(path));
 561         }
 562     }
 563
 564     @Test
 565     public void toActionRequestListTopLevelTest() {
 566         QName nameQname = QName.create(SERVER_QNAME, "name");
 567         List<PathArgument> nodeIdentifiers = new ArrayList<>();
 568         nodeIdentifiers.add(new NodeIdentifier(SERVER_QNAME));
 569         nodeIdentifiers.add(NodeIdentifierWithPredicates.of(SERVER_QNAME, nameQname, "test"));
 570         DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
 571
 572         ContainerNode data = initInputAction(QName.create(SERVER_QNAME, "reset-at"), "now");
 573
 574         NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
 575                 RESET_SERVER_PATH, domDataTreeIdentifier, data);
 576
 577         Node childAction = checkBasePartOfActionRequest(actionRequest);
 578
 579         Node childServer = childAction.getFirstChild();
 580         checkNode(childServer, "server", "server", URN_EXAMPLE_SERVER_FARM);
 581
 582         Node childName = childServer.getFirstChild();
 583         checkNode(childName, "name", "name", URN_EXAMPLE_SERVER_FARM);
 584
 585         Node childTest = childName.getFirstChild();
 586         assertEquals(childTest.getNodeValue(), "test");
 587
 588         checkAction(RESET_QNAME, childName.getNextSibling(), "reset-at", "reset-at", "now");
 589     }
 590
 591     @Test
 592     public void toActionRequestContainerTopLevelTest() {
 593         List<PathArgument> nodeIdentifiers = List.of(NodeIdentifier.create(DEVICE_QNAME));
 594         DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
 595
 596         ContainerNode payload = initInputAction(QName.create(DEVICE_QNAME, "start-at"), "now");
 597         NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
 598                 START_DEVICE_PATH, domDataTreeIdentifier, payload);
 599
 600         Node childAction = checkBasePartOfActionRequest(actionRequest);
 601
 602         Node childDevice = childAction.getFirstChild();
 603         checkNode(childDevice, "device", "device", URN_EXAMPLE_SERVER_FARM);
 604
 605         checkAction(START_QNAME, childDevice.getFirstChild(), "start-at", "start-at", "now");
 606     }
 607
 608     @Test
 609     public void toActionRequestContainerInContainerTest() {
 610         List<PathArgument> nodeIdentifiers = new ArrayList<>();
 611         nodeIdentifiers.add(NodeIdentifier.create(BOX_OUT_QNAME));
 612         nodeIdentifiers.add(NodeIdentifier.create(BOX_IN_QNAME));
 613
 614         DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
 615
 616         ContainerNode payload = initInputAction(QName.create(BOX_OUT_QNAME, "start-at"), "now");
 617         NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
 618                 OPEN_BOXES_PATH, domDataTreeIdentifier, payload);
 619
 620         Node childAction = checkBasePartOfActionRequest(actionRequest);
 621
 622         Node childBoxOut = childAction.getFirstChild();
 623         checkNode(childBoxOut, "box-out", "box-out", URN_EXAMPLE_SERVER_FARM);
 624
 625         Node childBoxIn = childBoxOut.getFirstChild();
 626         checkNode(childBoxIn, "box-in", "box-in", URN_EXAMPLE_SERVER_FARM);
 627
 628         Node action = childBoxIn.getFirstChild();
 629         checkNode(action, OPEN_QNAME.getLocalName(), OPEN_QNAME.getLocalName(), OPEN_QNAME.getNamespace().toString());
 630     }
 631
 632     @Test
 633     public void toActionRequestListInContainerTest() {
 634         QName nameQname = QName.create(INTERFACE_QNAME, "name");
 635
 636         List<PathArgument> nodeIdentifiers = new ArrayList<>();
 637         nodeIdentifiers.add(NodeIdentifier.create(DEVICE_QNAME));
 638         nodeIdentifiers.add(NodeIdentifier.create(INTERFACE_QNAME));
 639         nodeIdentifiers.add(NodeIdentifierWithPredicates.of(INTERFACE_QNAME, nameQname, "test"));
 640
 641         DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
 642
 643         ContainerNode payload = initEmptyInputAction(INTERFACE_QNAME);
 644         NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
 645                 ENABLE_INTERFACE_PATH, domDataTreeIdentifier, payload);
 646
 647         Node childAction = checkBasePartOfActionRequest(actionRequest);
 648
 649         Node childDevice = childAction.getFirstChild();
 650         checkNode(childDevice, "device", "device", URN_EXAMPLE_SERVER_FARM);
 651
 652         Node childInterface = childDevice.getFirstChild();
 653         checkNode(childInterface, "interface", "interface", URN_EXAMPLE_SERVER_FARM);
 654
 655         Node childName = childInterface.getFirstChild();
 656         checkNode(childName, "name", "name", nameQname.getNamespace().toString());
 657
 658         Node childTest = childName.getFirstChild();
 659         assertEquals(childTest.getNodeValue(), "test");
 660
 661         Node action = childInterface.getLastChild();
 662         checkNode(action, ENABLE_QNAME.getLocalName(), ENABLE_QNAME.getLocalName(),
 663                 ENABLE_QNAME.getNamespace().toString());
 664     }
 665
 666     @Test
 667     public void toActionRequestListInContainerAugmentedIntoListTest() {
 668         QName serverNameQname = QName.create(SERVER_QNAME, "name");
 669         QName applicationNameQname = QName.create(APPLICATION_QNAME, "name");
 670
 671         List<PathArgument> nodeIdentifiers = new ArrayList<>();
 672         nodeIdentifiers.add(NodeIdentifier.create(SERVER_QNAME));
 673         nodeIdentifiers.add(NodeIdentifierWithPredicates.of(SERVER_QNAME, serverNameQname, "testServer"));
 674         nodeIdentifiers.add(NodeIdentifier.create(APPLICATIONS_QNAME));
 675         nodeIdentifiers.add(NodeIdentifier.create(APPLICATION_QNAME));
 676         nodeIdentifiers.add(NodeIdentifierWithPredicates.of(APPLICATION_QNAME,
 677                 applicationNameQname, "testApplication"));
 678
 679         DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
 680
 681         ContainerNode payload = initEmptyInputAction(APPLICATION_QNAME);
 682         NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
 683                 KILL_SERVER_APP_PATH, domDataTreeIdentifier, payload);
 684
 685         Node childAction = checkBasePartOfActionRequest(actionRequest);
 686
 687         Node childServer = childAction.getFirstChild();
 688         checkNode(childServer, "server", "server", URN_EXAMPLE_SERVER_FARM);
 689
 690         Node childServerName = childServer.getFirstChild();
 691         checkNode(childServerName, "name", "name", URN_EXAMPLE_SERVER_FARM);
 692
 693         Node childServerNameTest = childServerName.getFirstChild();
 694         assertEquals(childServerNameTest.getNodeValue(), "testServer");
 695
 696         Node childApplications = childServer.getLastChild();
 697         checkNode(childApplications, "applications", "applications", URN_EXAMPLE_SERVER_FARM_2);
 698
 699         Node childApplication = childApplications.getFirstChild();
 700         checkNode(childApplication, "application", "application", URN_EXAMPLE_SERVER_FARM_2);
 701
 702         Node childApplicationName = childApplication.getFirstChild();
 703         checkNode(childApplicationName, "name", "name", URN_EXAMPLE_SERVER_FARM_2);
 704
 705         Node childApplicationNameTest = childApplicationName.getFirstChild();
 706         assertEquals(childApplicationNameTest.getNodeValue(), "testApplication");
 707
 708         Node childKillAction = childApplication.getLastChild();
 709         checkNode(childApplication, "application", "application", URN_EXAMPLE_SERVER_FARM_2);
 710         checkNode(childKillAction, KILL_QNAME.getLocalName(), KILL_QNAME.getLocalName(),
 711                 KILL_QNAME.getNamespace().toString());
 712     }
 713
 714     @Test
 715     public void toActionRequestConflictingInListTest() {
 716         QName barInputQname = QName.create(BAR_QNAME, "bar");
 717         QName barIdQname = QName.create(BAR_QNAME, "bar-id");
 718         Byte barInput = 1;
 719
 720         List<PathArgument> nodeIdentifiers = new ArrayList<>();
 721         nodeIdentifiers.add(NodeIdentifier.create(BAR_QNAME));
 722         nodeIdentifiers.add(NodeIdentifierWithPredicates.of(BAR_QNAME, barIdQname, "test"));
 723
 724         DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
 725
 726         ContainerNode payload = ImmutableNodes.newContainerBuilder()
 727             .withNodeIdentifier(NodeIdentifier.create(QName.create(barInputQname, "input")))
 728             .withChild(ImmutableNodes.leafNode(barInputQname, barInput))
 729             .build();
 730
 731         NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
 732                 XYZZY_BAR_PATH, domDataTreeIdentifier, payload);
 733
 734         Node childAction = checkBasePartOfActionRequest(actionRequest);
 735
 736         Node childBar = childAction.getFirstChild();
 737         checkNode(childBar, "bar", "bar", URN_EXAMPLE_CONFLICT);
 738
 739         Node childBarId = childBar.getFirstChild();
 740         checkNode(childBarId, "bar-id", "bar-id", URN_EXAMPLE_CONFLICT);
 741
 742         Node childTest = childBarId.getFirstChild();
 743         assertEquals(childTest.getNodeValue(), "test");
 744
 745         Node action = childBar.getLastChild();
 746         checkNode(action, XYZZY_QNAME.getLocalName(), XYZZY_QNAME.getLocalName(),
 747                 XYZZY_QNAME.getNamespace().toString());
 748     }
 749
 750     @Test
 751     public void toActionRequestConflictingInContainerTest() {
 752         QName fooInputQname = QName.create(FOO_QNAME, "foo");
 753
 754         List<PathArgument> nodeIdentifiers = new ArrayList<>();
 755         nodeIdentifiers.add(NodeIdentifier.create(FOO_QNAME));
 756         DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
 757         ContainerNode payload = initInputAction(fooInputQname, "test");
 758
 759         NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
 760                 XYZZY_FOO_PATH, domDataTreeIdentifier, payload);
 761
 762         Node childAction = checkBasePartOfActionRequest(actionRequest);
 763
 764         Node childBar = childAction.getFirstChild();
 765         checkNode(childBar, "foo", "foo", URN_EXAMPLE_CONFLICT);
 766
 767         Node action = childBar.getLastChild();
 768         checkNode(action, XYZZY_QNAME.getLocalName(), XYZZY_QNAME.getLocalName(),
 769                 XYZZY_QNAME.getNamespace().toString());
 770     }
 771
 772     @Test
 773     public void toActionRequestChoiceTest() {
 774         List<PathArgument> nodeIdentifiers = new ArrayList<>();
 775         nodeIdentifiers.add(NodeIdentifier.create(CONFLICT_CHOICE_QNAME));
 776         nodeIdentifiers.add(NodeIdentifier.create(CHOICE_CONT_QNAME));
 777         DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
 778         NormalizedNode payload = initEmptyInputAction(CHOICE_ACTION_QNAME);
 779
 780         NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
 781                 CHOICE_ACTION_PATH, domDataTreeIdentifier, payload);
 782
 783         Node childAction = checkBasePartOfActionRequest(actionRequest);
 784
 785         Node childChoiceCont = childAction.getFirstChild();
 786         checkNode(childChoiceCont, "choice-cont", "choice-cont", URN_EXAMPLE_CONFLICT);
 787
 788         Node action = childChoiceCont.getLastChild();
 789         checkNode(action, CHOICE_ACTION_QNAME.getLocalName(), CHOICE_ACTION_QNAME.getLocalName(),
 790                 CHOICE_ACTION_QNAME.getNamespace().toString());
 791     }
 792
 793     @Test
 794     public void toAugmentedActionRequestListInContainerTest() {
 795         QName nameQname = QName.create(INTERFACE_QNAME, "name");
 796
 797         List<PathArgument> nodeIdentifiers = new ArrayList<>();
 798         nodeIdentifiers.add(NodeIdentifier.create(DEVICE_QNAME));
 799         nodeIdentifiers.add(NodeIdentifier.create(INTERFACE_QNAME));
 800         nodeIdentifiers.add(NodeIdentifierWithPredicates.of(INTERFACE_QNAME, nameQname, "test"));
 801
 802         DOMDataTreeIdentifier domDataTreeIdentifier = prepareDataTreeId(nodeIdentifiers);
 803
 804         NormalizedNode payload = initEmptyInputAction(INTERFACE_QNAME);
 805         NetconfMessage actionRequest = actionNetconfMessageTransformer.toActionRequest(
 806                 DISABLE_INTERFACE_PATH, domDataTreeIdentifier, payload);
 807
 808         Node childAction = checkBasePartOfActionRequest(actionRequest);
 809
 810         Node childDevice = childAction.getFirstChild();
 811         checkNode(childDevice, "device", "device", URN_EXAMPLE_SERVER_FARM);
 812
 813         Node childInterface = childDevice.getFirstChild();
 814         checkNode(childInterface, "interface", "interface", URN_EXAMPLE_SERVER_FARM);
 815
 816         Node childName = childInterface.getFirstChild();
 817         checkNode(childName, "name", "name", nameQname.getNamespace().toString());
 818
 819         Node childTest = childName.getFirstChild();
 820         assertEquals(childTest.getNodeValue(), "test");
 821
 822         Node action = childInterface.getLastChild();
 823         checkNode(action, DISABLE_QNAME.getLocalName(), DISABLE_QNAME.getLocalName(),
 824                 DISABLE_QNAME.getNamespace().toString());
 825     }
 826
 827     @Test
 828     public void toActionResultTest() throws Exception {
 829         var message = new NetconfMessage(XmlUtil.readXmlToDocument("""
 830             <rpc-reply message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
 831               <reset-finished-at xmlns="urn:example:server-farm">now</reset-finished-at>
 832             </rpc-reply>"""));
 833         final var actionResult = actionNetconfMessageTransformer.toActionResult(RESET_SERVER_PATH, message);
 834         assertNotNull(actionResult);
 835         final var containerNode = actionResult.getOutput().orElseThrow();
 836         assertNotNull(containerNode);
 837         assertEquals("now", containerNode.body().iterator().next().body());
 838     }
 839
 840     @Test
 841     public void toActionEmptyBodyWithOutputDefinedResultTest() throws Exception {
 842         final var message = new NetconfMessage(XmlUtil.readXmlToDocument("""
 843             <rpc-reply message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
 844               <ok/>
 845             </rpc-reply>"""));
 846         final var actionResult =
 847             actionNetconfMessageTransformer.toActionResult(CHECK_WITH_OUTPUT_INTERFACE_PATH, message);
 848         assertNotNull(actionResult);
 849         assertTrue(actionResult.getOutput().isEmpty());
 850     }
 851
 852     @Test
 853     public void toActionEmptyBodyWithoutOutputDefinedResultTest() throws Exception {
 854         final var message = new NetconfMessage(XmlUtil.readXmlToDocument("""
 855             <rpc-reply message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
 856               <ok/>
 857             </rpc-reply>"""));
 858         final var actionResult =
 859             actionNetconfMessageTransformer.toActionResult(CHECK_WITHOUT_OUTPUT_INTERFACE_PATH, message);
 860         assertNotNull(actionResult);
 861         assertTrue(actionResult.getOutput().isEmpty());
 862     }
 863
 864     @Test
 865     public void getTwoNonOverlappingFieldsTest() throws IOException, SAXException {
 866         // preparation of the fields
 867         final var parentYiid = YangInstanceIdentifier.of(NetconfState.QNAME);
 868         final var netconfStartTimeField = YangInstanceIdentifier.of(Statistics.QNAME,
 869                 QName.create(Statistics.QNAME, "netconf-start-time"));
 870         final var datastoresField = YangInstanceIdentifier.of(Datastores.QNAME);
 871
 872         // building filter structure and NETCONF message
 873         final var filterStructure = toFilterStructure(
 874             List.of(FieldsFilter.of(parentYiid, List.of(netconfStartTimeField, datastoresField))), SCHEMA);
 875         final var netconfMessage = netconfMessageTransformer.toRpcRequest(Get.QNAME,
 876                 NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, filterStructure));
 877
 878         // testing
 879         assertSimilarXml(netconfMessage, """
 880             <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
 881               <get>
 882                 <filter type="subtree">
 883                   <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
 884                     <statistics>
 885                       <netconf-start-time/>
 886                     </statistics>
 887                     <datastores/>
 888                   </netconf-state>
 889                 </filter>
 890               </get>
 891             </rpc>""");
 892     }
 893
 894     @Test
 895     public void getOverlappingFieldsTest() throws IOException, SAXException {
 896         // preparation of the fields
 897         final var parentYiid = YangInstanceIdentifier.of(NetconfState.QNAME);
 898         final var capabilitiesField = YangInstanceIdentifier.of(Capabilities.QNAME);
 899         final var capabilityField = YangInstanceIdentifier.of(Capabilities.QNAME,
 900                 QName.create(Capabilities.QNAME, "capability"));
 901         final var datastoreField = YangInstanceIdentifier.of(Datastores.QNAME);
 902         final var locksFields = YangInstanceIdentifier.of(
 903             new NodeIdentifier(Datastores.QNAME),
 904             new NodeIdentifier(Datastore.QNAME),
 905             // Note: acts as 'select all'
 906             NodeIdentifierWithPredicates.of(Datastore.QNAME),
 907             new NodeIdentifier(Locks.QNAME));
 908
 909         // building filter structure and NETCONF message
 910         final var filterStructure = toFilterStructure(
 911                 List.of(FieldsFilter.of(parentYiid,
 912                     List.of(capabilitiesField, capabilityField, datastoreField, locksFields))),
 913                 SCHEMA);
 914         final var netconfMessage = netconfMessageTransformer.toRpcRequest(Get.QNAME,
 915                 NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, filterStructure));
 916
 917         // testing
 918         assertSimilarXml(netconfMessage, """
 919             <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
 920               <get>
 921                 <filter type="subtree">
 922                   <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
 923                     <capabilities/>
 924                     <datastores/>
 925                   </netconf-state>
 926                 </filter>
 927               </get>
 928             </rpc>""");
 929     }
 930
 931     @Test
 932     public void getOverlappingFieldsWithEmptyFieldTest() throws IOException, SAXException {
 933         // preparation of the fields
 934         final var parentYiid = YangInstanceIdentifier.of(NetconfState.QNAME);
 935         final var capabilitiesField = YangInstanceIdentifier.of(Capabilities.QNAME);
 936
 937         // building filter structure and NETCONF message
 938         final var filterStructure = toFilterStructure(
 939                 List.of(FieldsFilter.of(parentYiid, List.of(capabilitiesField, YangInstanceIdentifier.of()))),
 940                 SCHEMA);
 941         final var netconfMessage = netconfMessageTransformer.toRpcRequest(Get.QNAME,
 942                 NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, filterStructure));
 943
 944         // testing
 945         assertSimilarXml(netconfMessage, """
 946             <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
 947             <get>
 948             <filter type="subtree">
 949             <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring"/>
 950             </filter>
 951             </get>
 952             </rpc>""");
 953     }
 954
 955     @Test
 956     public void getSpecificFieldsUnderListTest() throws IOException, SAXException {
 957         // preparation of the fields
 958         final var parentYiid = YangInstanceIdentifier.of(
 959             new NodeIdentifier(NetconfState.QNAME),
 960             new NodeIdentifier(Schemas.QNAME),
 961             new NodeIdentifier(Schema.QNAME),
 962             NodeIdentifierWithPredicates.of(Schema.QNAME));
 963         final var versionField = YangInstanceIdentifier.of(
 964                 QName.create(Schema.QNAME, "version"));
 965         final var identifierField = YangInstanceIdentifier.of(
 966                 QName.create(Schema.QNAME, "namespace"));
 967
 968         // building filter structure and NETCONF message
 969         final var filterStructure = toFilterStructure(
 970             List.of(FieldsFilter.of(parentYiid, List.of(versionField, identifierField))), SCHEMA);
 971         final var netconfMessage = netconfMessageTransformer.toRpcRequest(Get.QNAME,
 972                 NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, filterStructure));
 973
 974         // testing
 975         assertSimilarXml(netconfMessage, """
 976             <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
 977               <get>
 978                 <filter type="subtree">
 979                   <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
 980                     <schemas>
 981                       <schema>
 982                         <version/>
 983                         <namespace/>
 984                         <identifier/>
 985                         <format/>
 986                       </schema>
 987                     </schemas>
 988                   </netconf-state>
 989                 </filter>
 990               </get>
 991             </rpc>""");
 992     }
 993
 994     @Test
 995     public void getSpecificFieldsUnderMultipleLists() throws IOException, SAXException {
 996         // preparation of the fields
 997         final var parentYiid = YangInstanceIdentifier.of(NetconfState.QNAME, Datastores.QNAME);
 998         final var partialLockYiid = YangInstanceIdentifier.of(
 999             new NodeIdentifier(Datastore.QNAME),
1000             NodeIdentifierWithPredicates.of(Datastore.QNAME),
1001             new NodeIdentifier(Locks.QNAME),
1002             new NodeIdentifier(QName.create(Locks.QNAME, "lock-type")),
1003             new NodeIdentifier(PartialLock.QNAME),
1004             NodeIdentifierWithPredicates.of(PartialLock.QNAME));
1005         final var lockedTimeField = partialLockYiid.node(QName.create(Locks.QNAME, "locked-time"));
1006         final var lockedBySessionField = partialLockYiid.node(QName.create(Locks.QNAME, "locked-by-session"));
1007
1008         // building filter structure and NETCONF message
1009         final var filterStructure = toFilterStructure(
1010             List.of(FieldsFilter.of(parentYiid, List.of(lockedTimeField, lockedBySessionField))),
1011             SCHEMA);
1012         final var netconfMessage = netconfMessageTransformer.toRpcRequest(Get.QNAME,
1013                 NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, filterStructure));
1014
1015         // testing
1016         assertSimilarXml(netconfMessage, """
1017             <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
1018               <get>
1019                 <filter type="subtree">
1020                   <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
1021                     <datastores>
1022                       <datastore>
1023                         <locks>
1024                           <partial-lock>
1025                             <locked-time/>
1026                             <locked-by-session/>
1027                             <lock-id/>
1028                           </partial-lock>
1029                         </locks>
1030                         <name/>
1031                       </datastore>
1032                     </datastores>
1033                   </netconf-state>
1034                 </filter>
1035               </get>
1036             </rpc>""");
1037     }
1038
1039     @Test
1040     public void getWholeListsUsingFieldsTest() throws IOException, SAXException {
1041         // preparation of the fields
1042         final var parentYiid = YangInstanceIdentifier.of(NetconfState.QNAME);
1043         final var datastoreListField = YangInstanceIdentifier.of(
1044             new NodeIdentifier(Datastores.QNAME),
1045             new NodeIdentifier(Datastore.QNAME),
1046             NodeIdentifierWithPredicates.of(Datastore.QNAME));
1047         final var sessionListField = YangInstanceIdentifier.of(
1048             new NodeIdentifier(Sessions.QNAME),
1049             new NodeIdentifier(Session.QNAME),
1050             NodeIdentifierWithPredicates.of(Session.QNAME));
1051
1052         // building filter structure and NETCONF message
1053         final var filterStructure = toFilterStructure(
1054                 List.of(FieldsFilter.of(parentYiid, List.of(datastoreListField, sessionListField))), SCHEMA);
1055         final var netconfMessage = netconfMessageTransformer.toRpcRequest(Get.QNAME,
1056                 NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, filterStructure));
1057
1058         // testing
1059         assertSimilarXml(netconfMessage, """
1060             <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
1061               <get>
1062                 <filter type="subtree">
1063                   <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
1064                     <datastores>
1065                       <datastore/>
1066                     </datastores>
1067                     <sessions>
1068                       <session/>
1069                     </sessions>
1070                   </netconf-state>
1071                 </filter>
1072               </get>
1073             </rpc>""");
1074     }
1075
1076     @Test
1077     public void getSpecificListEntriesWithSpecificFieldsTest() throws IOException, SAXException {
1078         // preparation of the fields
1079         final var parentYiid = YangInstanceIdentifier.of(NetconfState.QNAME, Sessions.QNAME);
1080         final var sessionId = QName.create(Session.QNAME, "session-id");
1081         final var session1Field = YangInstanceIdentifier.of(
1082             new NodeIdentifier(Session.QNAME),
1083             NodeIdentifierWithPredicates.of(Session.QNAME, sessionId, 1));
1084         final var session2TransportField = YangInstanceIdentifier.of(
1085             new NodeIdentifier(Session.QNAME),
1086             NodeIdentifierWithPredicates.of(Session.QNAME, sessionId, 2),
1087             new NodeIdentifier(QName.create(Session.QNAME, "transport")));
1088
1089         // building filter structure and NETCONF message
1090         final var filterStructure = toFilterStructure(
1091                 List.of(FieldsFilter.of(parentYiid, List.of(session1Field, session2TransportField))), SCHEMA);
1092         final var netconfMessage = netconfMessageTransformer.toRpcRequest(Get.QNAME,
1093                 NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, filterStructure));
1094
1095         // testing
1096         assertSimilarXml(netconfMessage, """
1097             <rpc message-id="m-0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
1098               <get>
1099                 <filter type="subtree">
1100                   <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
1101                     <sessions>
1102                       <session>
1103                         <session-id>1</session-id>
1104                       </session>
1105                       <session>
1106                         <session-id>2</session-id>
1107                         <transport/>
1108                       </session>
1109                     </sessions>
1110                   </netconf-state>
1111                 </filter>
1112               </get>
1113             </rpc>""");
1114     }
1115
1116     @Test
1117     // Proof that YANGTOOLS-1362 works on DOM level
1118     public void testConfigChangeToNotification() throws SAXException, IOException {
1119         final var message = new NetconfMessage(XmlUtil.readXmlToDocument(
1120             "<notification xmlns=\"urn:ietf:params:xml:ns:netconf:notification:1.0\">\n"
1121             + " <eventTime>2021-11-11T11:26:16Z</eventTime> \n"
1122             + "  <netconf-config-change xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-notifications\">\n"
1123             + "     <changed-by> \n"
1124             + "       <username>root</username> \n"
1125             + "       <session-id>3</session-id> \n"
1126             + "     </changed-by> \n"
1127             + "     <datastore>running</datastore> \n"
1128             + "     <edit> \n"
1129             + "        <target xmlns:ncm=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">/ncm:netconf-state"
1130             + "/ncm:datastores/ncm:datastore[ncm:name='running']</target>\n"
1131             + "        <operation>replace</operation> \n"
1132             + "     </edit> \n"
1133             + "  </netconf-config-change> \n"
1134             + "</notification>"));
1135
1136         final var change = netconfMessageTransformer.toNotification(message).getBody();
1137         final var editList = change.getChildByArg(new NodeIdentifier(Edit.QNAME));
1138         assertThat(editList, instanceOf(UnkeyedListNode.class));
1139         final var edits = ((UnkeyedListNode) editList).body();
1140         assertEquals(1, edits.size());
1141         final var edit = edits.iterator().next();
1142         final var target = edit.getChildByArg(new NodeIdentifier(QName.create(Edit.QNAME, "target"))).body();
1143         assertThat(target, instanceOf(YangInstanceIdentifier.class));
1144
1145         final var args = ((YangInstanceIdentifier) target).getPathArguments();
1146         assertEquals(4, args.size());
1147     }
1148
1149     private static void checkAction(final QName actionQname, final Node action , final String inputLocalName,
1150             final String inputNodeName, final String inputValue) {
1151         checkNode(action, actionQname.getLocalName(), actionQname.getLocalName(),
1152                 actionQname.getNamespace().toString());
1153
1154         Node childResetAt = action.getFirstChild();
1155         checkNode(childResetAt, inputLocalName, inputNodeName, actionQname.getNamespace().toString());
1156
1157         Node firstChild = childResetAt.getFirstChild();
1158         assertEquals(firstChild.getNodeValue(), inputValue);
1159     }
1160
1161     private static Node checkBasePartOfActionRequest(final NetconfMessage actionRequest) {
1162         Node baseRpc = actionRequest.getDocument().getFirstChild();
1163         checkNode(baseRpc, "rpc", "rpc", "urn:ietf:params:xml:ns:netconf:base:1.0");
1164         assertTrue(baseRpc.getLocalName().equals("rpc"));
1165         assertTrue(baseRpc.getNodeName().equals("rpc"));
1166
1167         Node messageId = baseRpc.getAttributes().getNamedItem("message-id");
1168         assertNotNull(messageId);
1169         assertTrue(messageId.getNodeValue().contains("m-"));
1170         Node childAction = baseRpc.getFirstChild();
1171
1172         checkNode(childAction, "action", "action", "urn:ietf:params:xml:ns:yang:1");
1173         return childAction;
1174     }
1175
1176     private static DOMDataTreeIdentifier prepareDataTreeId(final List<PathArgument> nodeIdentifiers) {
1177         YangInstanceIdentifier yangInstanceIdentifier =
1178                 YangInstanceIdentifier.builder().append(nodeIdentifiers).build();
1179         DOMDataTreeIdentifier domDataTreeIdentifier =
1180                 DOMDataTreeIdentifier.of(org.opendaylight.mdsal.common.api.LogicalDatastoreType.CONFIGURATION,
1181                         yangInstanceIdentifier);
1182         return domDataTreeIdentifier;
1183     }
1184
1185     private static ContainerNode initInputAction(final QName qname, final String value) {
1186         return ImmutableNodes.newContainerBuilder()
1187             .withNodeIdentifier(NodeIdentifier.create(QName.create(qname, "input")))
1188             .withChild(ImmutableNodes.leafNode(qname, value))
1189             .build();
1190     }
1191
1192     private static ContainerNode initEmptyInputAction(final QName qname) {
1193         return ImmutableNodes.newContainerBuilder()
1194             .withNodeIdentifier(NodeIdentifier.create(QName.create(qname, "input")))
1195             .build();
1196     }
1197
1198     private static void checkNode(final Node childServer, final String expectedLocalName, final String expectedNodeName,
1199             final String expectedNamespace) {
1200         assertNotNull(childServer);
1201         assertEquals(childServer.getLocalName(), expectedLocalName);
1202         assertEquals(childServer.getNodeName(), expectedNodeName);
1203         assertEquals(childServer.getNamespaceURI(), expectedNamespace);
1204     }
1205 }