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

   1 /*
   2  * Copyright (c) 2016 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.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertThrows;
  12 import static org.junit.Assert.assertTrue;
  13 import static org.mockito.ArgumentMatchers.any;
  14 import static org.mockito.ArgumentMatchers.argThat;
  15 import static org.mockito.ArgumentMatchers.eq;
  16 import static org.mockito.Mockito.verify;
  17 import static org.mockito.Mockito.when;
  18
  19 import java.io.IOException;
  20 import java.io.InputStream;
  21 import java.net.InetSocketAddress;
  22 import java.util.ArrayList;
  23 import java.util.List;
  24 import java.util.Optional;
  25 import java.util.concurrent.ExecutionException;
  26 import org.custommonkey.xmlunit.Diff;
  27 import org.custommonkey.xmlunit.XMLUnit;
  28 import org.junit.Before;
  29 import org.junit.Test;
  30 import org.junit.runner.RunWith;
  31 import org.mockito.ArgumentMatcher;
  32 import org.mockito.Mock;
  33 import org.mockito.junit.MockitoJUnitRunner;
  34 import org.opendaylight.netconf.api.EffectiveOperation;
  35 import org.opendaylight.netconf.api.messages.NetconfMessage;
  36 import org.opendaylight.netconf.api.xml.XmlUtil;
  37 import org.opendaylight.netconf.client.mdsal.AbstractTestModelTest;
  38 import org.opendaylight.netconf.client.mdsal.api.RemoteDeviceCommunicator;
  39 import org.opendaylight.netconf.client.mdsal.api.RemoteDeviceId;
  40 import org.opendaylight.netconf.client.mdsal.spi.NetconfDeviceRpc;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.Commit;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.CopyConfig;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.DiscardChanges;
  44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.EditConfig;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.Get;
  46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.GetConfig;
  47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.Lock;
  48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.Unlock;
  49 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.Validate;
  50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.get.config.output.Data;
  51 import org.opendaylight.yangtools.yang.common.QName;
  52 import org.opendaylight.yangtools.yang.common.QNameModule;
  53 import org.opendaylight.yangtools.yang.common.Revision;
  54 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  55 import org.opendaylight.yangtools.yang.common.XMLNamespace;
  56 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  57 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  58 import org.opendaylight.yangtools.yang.data.api.schema.MountPointContext;
  59 import org.opendaylight.yangtools.yang.data.spi.node.ImmutableNodes;
  60 import org.w3c.dom.Document;
  61 import org.w3c.dom.Element;
  62 import org.w3c.dom.NamedNodeMap;
  63 import org.xml.sax.SAXException;
  64
  65 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  66 public class NetconfBaseOpsTest extends AbstractTestModelTest {
  67     private static final QNameModule TEST_MODULE = QNameModule.create(
  68             XMLNamespace.of("test:namespace"), Revision.of("2013-07-22"));
  69
  70     private static final QName CONTAINER_C_QNAME = QName.create(TEST_MODULE, "c");
  71     private static final NodeIdentifier CONTAINER_C_NID = NodeIdentifier.create(CONTAINER_C_QNAME);
  72     private static final QName LEAF_A_QNAME = QName.create(TEST_MODULE, "a");
  73     private static final NodeIdentifier LEAF_A_NID = NodeIdentifier.create(LEAF_A_QNAME);
  74     private static final QName LEAF_B_QNAME = QName.create(TEST_MODULE, "b");
  75     private static final NodeIdentifier LEAF_B_NID = NodeIdentifier.create(LEAF_B_QNAME);
  76     private static final QName CONTAINER_D_QNAME = QName.create(TEST_MODULE, "d");
  77     private static final NodeIdentifier CONTAINER_D_NID = NodeIdentifier.create(CONTAINER_D_QNAME);
  78     private static final QName LEAF_X_QNAME = QName.create(TEST_MODULE, "x");
  79     private static final NodeIdentifier LEAF_X_NID = NodeIdentifier.create(LEAF_X_QNAME);
  80
  81     private static final QName CONTAINER_E_QNAME = QName.create(TEST_MODULE, "e");
  82     private static final NodeIdentifier CONTAINER_E_NID = NodeIdentifier.create(CONTAINER_E_QNAME);
  83     private static final QName LEAF_Z_QNAME = QName.create(TEST_MODULE, "z");
  84     private static final NodeIdentifier LEAF_Z_NID = NodeIdentifier.create(LEAF_Z_QNAME);
  85
  86     static {
  87         XMLUnit.setIgnoreWhitespace(true);
  88         XMLUnit.setIgnoreComments(true);
  89     }
  90
  91     @Mock
  92     private RemoteDeviceCommunicator listener;
  93     private NetconfRpcFutureCallback callback;
  94     private NetconfBaseOps baseOps;
  95
  96     @Before
  97     public void setUp() throws Exception {
  98         final var okStream = NetconfBaseOpsTest.class.getResourceAsStream("/netconfMessages/rpc-reply_ok.xml");
  99         final var dataStream = NetconfBaseOpsTest.class.getResourceAsStream("/netconfMessages/rpc-reply_get.xml");
 100         final var ok = new NetconfMessage(XmlUtil.readXmlToDocument(okStream));
 101         final var data = new NetconfMessage(XmlUtil.readXmlToDocument(dataStream));
 102         when(listener.sendRequest(any(), eq(GetConfig.QNAME))).thenReturn(RpcResultBuilder.success(data).buildFuture());
 103         when(listener.sendRequest(any(), eq(Get.QNAME))).thenReturn(RpcResultBuilder.success(data).buildFuture());
 104         when(listener.sendRequest(any(), eq(EditConfig.QNAME))).thenReturn(RpcResultBuilder.success(ok).buildFuture());
 105         when(listener.sendRequest(any(), eq(CopyConfig.QNAME))).thenReturn(RpcResultBuilder.success(ok).buildFuture());
 106         when(listener.sendRequest(any(), eq(DiscardChanges.QNAME)))
 107                 .thenReturn(RpcResultBuilder.success(ok).buildFuture());
 108         when(listener.sendRequest(any(), eq(Validate.QNAME))).thenReturn(RpcResultBuilder.success(ok).buildFuture());
 109         when(listener.sendRequest(any(), eq(Lock.QNAME))).thenReturn(RpcResultBuilder.success(ok).buildFuture());
 110         when(listener.sendRequest(any(), eq(Unlock.QNAME))).thenReturn(RpcResultBuilder.success(ok).buildFuture());
 111         when(listener.sendRequest(any(), eq(Commit.QNAME))).thenReturn(RpcResultBuilder.success(ok).buildFuture());
 112         final var rpc = new NetconfDeviceRpc(SCHEMA_CONTEXT, listener, new NetconfMessageTransformer(
 113             MountPointContext.of(SCHEMA_CONTEXT), true, BASE_SCHEMAS.baseSchema()));
 114         callback = new NetconfRpcFutureCallback("prefix",
 115             new RemoteDeviceId("device-1", InetSocketAddress.createUnresolved("localhost", 17830)));
 116         baseOps = new NetconfBaseOps(rpc, MountPointContext.of(SCHEMA_CONTEXT));
 117     }
 118
 119     @Test
 120     public void testLock() throws Exception {
 121         baseOps.lock(callback, NetconfMessageTransformUtil.NETCONF_CANDIDATE_NODEID);
 122         verifyMessageSent("lock", Lock.QNAME);
 123     }
 124
 125     @Test
 126     public void testLockCandidate() throws Exception {
 127         baseOps.lockCandidate(callback);
 128         verifyMessageSent("lock", Lock.QNAME);
 129     }
 130
 131     @Test
 132     public void testUnlock() throws Exception {
 133         baseOps.unlock(callback, NetconfMessageTransformUtil.NETCONF_CANDIDATE_NODEID);
 134         verifyMessageSent("unlock", Unlock.QNAME);
 135     }
 136
 137     @Test
 138     public void testUnlockCandidate() throws Exception {
 139         baseOps.unlockCandidate(callback);
 140         verifyMessageSent("unlock", Unlock.QNAME);
 141     }
 142
 143     @Test
 144     public void testLockRunning() throws Exception {
 145         baseOps.lockRunning(callback);
 146         verifyMessageSent("lock-running", Lock.QNAME);
 147     }
 148
 149     @Test
 150     public void testUnlockRunning() throws Exception {
 151         baseOps.unlockRunning(callback);
 152         verifyMessageSent("unlock-running", Unlock.QNAME);
 153     }
 154
 155     @Test
 156     public void testDiscardChanges() throws Exception {
 157         baseOps.discardChanges(callback);
 158         verifyMessageSent("discardChanges", DiscardChanges.QNAME);
 159     }
 160
 161     @Test
 162     public void testCommit() throws Exception {
 163         baseOps.commit(callback);
 164         verifyMessageSent("commit", Commit.QNAME);
 165     }
 166
 167     @Test
 168     public void testValidateCandidate() throws Exception {
 169         baseOps.validateCandidate(callback);
 170         verifyMessageSent("validate", Validate.QNAME);
 171     }
 172
 173     @Test
 174     public void testValidateRunning() throws Exception {
 175         baseOps.validateRunning(callback);
 176         verifyMessageSent("validate-running", Validate.QNAME);
 177     }
 178
 179
 180     @Test
 181     public void testCopyConfig() throws Exception {
 182         baseOps.copyConfig(callback, NetconfMessageTransformUtil.NETCONF_RUNNING_NODEID,
 183                 NetconfMessageTransformUtil.NETCONF_CANDIDATE_NODEID);
 184         verifyMessageSent("copy-config", CopyConfig.QNAME);
 185     }
 186
 187     @Test
 188     public void testCopyRunningToCandidate() throws Exception {
 189         baseOps.copyRunningToCandidate(callback);
 190         verifyMessageSent("copy-config", CopyConfig.QNAME);
 191     }
 192
 193     @Test
 194     public void testGetConfigRunningData() throws Exception {
 195         final var dataOpt = baseOps.getConfigRunningData(callback, Optional.of(YangInstanceIdentifier.of())).get();
 196         assertTrue(dataOpt.isPresent());
 197         assertEquals(Data.QNAME, dataOpt.orElseThrow().name().getNodeType());
 198     }
 199
 200     @Test
 201     public void testGetData() throws Exception {
 202         final var dataOpt = baseOps.getData(callback, Optional.of(YangInstanceIdentifier.of())).get();
 203         assertTrue(dataOpt.isPresent());
 204         assertEquals(Data.QNAME, dataOpt.orElseThrow().name().getNodeType());
 205     }
 206
 207     @Test
 208     public void testGetConfigRunning() throws Exception {
 209         baseOps.getConfigRunning(callback, Optional.empty());
 210         verifyMessageSent("getConfig", GetConfig.QNAME);
 211     }
 212
 213     @Test
 214     public void testGetConfigCandidate() throws Exception {
 215         baseOps.getConfigCandidate(callback, Optional.empty());
 216         verifyMessageSent("getConfig_candidate", GetConfig.QNAME);
 217     }
 218
 219     @Test
 220     public void testGetConfigCandidateWithFilter() throws Exception {
 221         baseOps.getConfigCandidate(callback, Optional.of(YangInstanceIdentifier.of(CONTAINER_C_QNAME)));
 222         verifyMessageSent("getConfig_candidate-filter", GetConfig.QNAME);
 223     }
 224
 225     @Test
 226     public void testGet() throws Exception {
 227         baseOps.get(callback, Optional.empty());
 228         verifyMessageSent("get", Get.QNAME);
 229     }
 230
 231     @Test
 232     public void testEditConfigCandidate() throws Exception {
 233         baseOps.editConfigCandidate(callback, baseOps.createEditConfigStructure(
 234             Optional.of(ImmutableNodes.leafNode(LEAF_A_NID, "leaf-value")),
 235             Optional.of(EffectiveOperation.REPLACE), YangInstanceIdentifier.builder()
 236             .node(CONTAINER_C_QNAME)
 237             .node(LEAF_A_NID)
 238             .build()), true);
 239         verifyMessageSent("edit-config-test-module", EditConfig.QNAME);
 240     }
 241
 242     @Test
 243     public void testDeleteContainerNodeCandidate() throws Exception {
 244         baseOps.editConfigCandidate(callback, baseOps.createEditConfigStructure(Optional.empty(),
 245             Optional.of(EffectiveOperation.DELETE), YangInstanceIdentifier.of(CONTAINER_C_QNAME)), true);
 246         verifyMessageSent("edit-config-delete-container-node-candidate", EditConfig.QNAME);
 247     }
 248
 249     @Test
 250     public void testDeleteLeafNodeCandidate() throws Exception {
 251         baseOps.editConfigCandidate(callback, baseOps.createEditConfigStructure(Optional.empty(),
 252             Optional.of(EffectiveOperation.DELETE),
 253             YangInstanceIdentifier.builder().node(CONTAINER_C_QNAME).node(LEAF_A_NID).build()), true);
 254         verifyMessageSent("edit-config-delete-leaf-node-candidate", EditConfig.QNAME);
 255     }
 256
 257     @Test
 258     public void testEditConfigRunning() throws Exception {
 259         baseOps.editConfigRunning(callback, baseOps.createEditConfigStructure(
 260             Optional.of(ImmutableNodes.leafNode(LEAF_A_NID, "leaf-value")),
 261             Optional.of(EffectiveOperation.REPLACE),
 262             YangInstanceIdentifier.builder().node(CONTAINER_C_NID).node(LEAF_A_NID).build()),
 263             EffectiveOperation.MERGE, true);
 264         verifyMessageSent("edit-config-test-module-running", EditConfig.QNAME);
 265     }
 266
 267     @Test
 268     public void testGetWithFields() throws ExecutionException, InterruptedException {
 269         final YangInstanceIdentifier path = YangInstanceIdentifier.of(CONTAINER_C_NID);
 270         final YangInstanceIdentifier leafAField = YangInstanceIdentifier.of(LEAF_A_NID);
 271         final YangInstanceIdentifier leafBField = YangInstanceIdentifier.of(LEAF_B_NID);
 272
 273         baseOps.getData(callback, Optional.of(path), List.of(leafAField, leafBField)).get();
 274         verify(listener).sendRequest(msg("/netconfMessages/get-fields-request.xml"), eq(Get.QNAME));
 275     }
 276
 277     @Test
 278     public void testGetConfigWithFields() throws ExecutionException, InterruptedException {
 279         final YangInstanceIdentifier path = YangInstanceIdentifier.of(CONTAINER_C_NID);
 280         final YangInstanceIdentifier leafAField = YangInstanceIdentifier.of(LEAF_A_NID);
 281         final YangInstanceIdentifier leafBField = YangInstanceIdentifier.of(LEAF_B_NID);
 282
 283         baseOps.getConfigRunningData(callback, Optional.of(path), List.of(leafAField, leafBField)).get();
 284         verify(listener).sendRequest(msg("/netconfMessages/get-config-fields-request.xml"), eq(GetConfig.QNAME));
 285     }
 286
 287     @Test
 288     public void testGetDataWithoutFields() {
 289         assertThrows(ExecutionException.class, () -> baseOps.getData(callback,
 290                 Optional.of(YangInstanceIdentifier.of()), List.of()).get());
 291     }
 292
 293     @Test
 294     public void getConfigRunningDataWithoutFields() {
 295         assertThrows(ExecutionException.class, () -> baseOps.getConfigRunningData(callback,
 296                 Optional.of(YangInstanceIdentifier.of()), List.of()).get());
 297     }
 298
 299     @Test
 300     public void testGetWithFieldsAndEmptyParentPath() throws ExecutionException, InterruptedException {
 301         final YangInstanceIdentifier leafAField = YangInstanceIdentifier.of(CONTAINER_C_NID, LEAF_A_NID);
 302         final YangInstanceIdentifier leafXField = YangInstanceIdentifier.of(
 303                 CONTAINER_C_NID, CONTAINER_D_NID, LEAF_X_NID);
 304         final YangInstanceIdentifier leafZField = YangInstanceIdentifier.of(CONTAINER_E_NID, LEAF_Z_NID);
 305
 306         baseOps.getData(callback, Optional.of(YangInstanceIdentifier.of()),
 307                 List.of(leafAField, leafXField, leafZField)).get();
 308         verify(listener).sendRequest(msg("/netconfMessages/get-with-multiple-subtrees.xml"), eq(Get.QNAME));
 309     }
 310
 311     @Test
 312     public void testGetConfigWithFieldsAndEmptyParentPath() throws ExecutionException, InterruptedException {
 313         final YangInstanceIdentifier leafAField = YangInstanceIdentifier.of(CONTAINER_C_NID, LEAF_A_NID);
 314         final YangInstanceIdentifier leafXField = YangInstanceIdentifier.of(
 315                 CONTAINER_C_NID, CONTAINER_D_NID, LEAF_X_NID);
 316         final YangInstanceIdentifier leafZField = YangInstanceIdentifier.of(CONTAINER_E_NID, LEAF_Z_NID);
 317
 318         baseOps.getConfigRunningData(callback, Optional.of(YangInstanceIdentifier.of()),
 319                 List.of(leafAField, leafXField, leafZField)).get();
 320         verify(listener).sendRequest(msg("/netconfMessages/get-config-with-multiple-subtrees.xml"),
 321                 eq(GetConfig.QNAME));
 322     }
 323
 324     @Test
 325     public void testGetWithRootFieldsAndEmptyParentPath() throws ExecutionException, InterruptedException {
 326         final YangInstanceIdentifier contCField = YangInstanceIdentifier.of(CONTAINER_C_NID);
 327         final YangInstanceIdentifier contDField = YangInstanceIdentifier.of(CONTAINER_E_NID);
 328
 329         baseOps.getData(callback, Optional.of(YangInstanceIdentifier.of()), List.of(contCField, contDField)).get();
 330         verify(listener).sendRequest(msg("/netconfMessages/get-with-multiple-root-subtrees.xml"), eq(Get.QNAME));
 331     }
 332
 333     private void verifyMessageSent(final String fileName, final QName name) {
 334         final String path = "/netconfMessages/" + fileName + ".xml";
 335         verify(listener).sendRequest(msg(path), eq(name));
 336     }
 337
 338     private static NetconfMessage msg(final String name) {
 339         final InputStream stream = NetconfBaseOpsTest.class.getResourceAsStream(name);
 340         try {
 341             return argThat(new NetconfMessageMatcher(XmlUtil.readXmlToDocument(stream)));
 342         } catch (SAXException | IOException e) {
 343             throw new IllegalStateException("Failed to read xml file " + name, e);
 344         }
 345     }
 346
 347     private static class NetconfMessageMatcher implements ArgumentMatcher<NetconfMessage> {
 348
 349         private final Document expected;
 350
 351         NetconfMessageMatcher(final Document expected) {
 352             this.expected = removeAttrs(expected);
 353         }
 354
 355         @Override
 356         public boolean matches(final NetconfMessage message) {
 357             final Document actualDoc = removeAttrs(message.getDocument());
 358             actualDoc.normalizeDocument();
 359             expected.normalizeDocument();
 360             final Diff diff = XMLUnit.compareXML(expected, actualDoc);
 361             return diff.similar();
 362         }
 363
 364         private static Document removeAttrs(final Document input) {
 365             final Document copy = XmlUtil.newDocument();
 366             copy.appendChild(copy.importNode(input.getDocumentElement(), true));
 367             final Element element = copy.getDocumentElement();
 368             final List<String> attrNames = new ArrayList<>();
 369             final NamedNodeMap attributes = element.getAttributes();
 370             for (int i = 0; i < attributes.getLength(); i++) {
 371                 final String nodeName = attributes.item(i).getNodeName();
 372                 if ("xmlns".equals(nodeName)) {
 373                     continue;
 374                 }
 375                 attrNames.add(nodeName);
 376             }
 377             attrNames.forEach(element::removeAttribute);
 378             return copy;
 379         }
 380     }
 381
 382 }