apps/netconf-topology/src/test/java/org/opendaylight/netconf/topology/spi/NetconfDeviceTopologyAdapterTest.java

   1 /*
   2  * Copyright (c) 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.topology.spi;
   9
  10 import static org.junit.jupiter.api.Assertions.assertFalse;
  11 import static org.junit.jupiter.api.Assertions.assertSame;
  12 import static org.junit.jupiter.api.Assertions.assertThrows;
  13 import static org.mockito.ArgumentMatchers.any;
  14 import static org.mockito.ArgumentMatchers.eq;
  15 import static org.mockito.Mockito.doNothing;
  16 import static org.mockito.Mockito.doReturn;
  17 import static org.mockito.Mockito.times;
  18 import static org.mockito.Mockito.verify;
  19
  20 import com.google.common.util.concurrent.FutureCallback;
  21 import com.google.common.util.concurrent.Futures;
  22 import java.net.InetSocketAddress;
  23 import java.util.concurrent.ExecutionException;
  24 import org.junit.jupiter.api.BeforeEach;
  25 import org.junit.jupiter.api.Test;
  26 import org.junit.jupiter.api.extension.ExtendWith;
  27 import org.mockito.ArgumentCaptor;
  28 import org.mockito.Captor;
  29 import org.mockito.Mock;
  30 import org.mockito.junit.jupiter.MockitoExtension;
  31 import org.opendaylight.mdsal.binding.api.DataBroker;
  32 import org.opendaylight.mdsal.binding.api.TransactionChain;
  33 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  34 import org.opendaylight.mdsal.common.api.CommitInfo;
  35 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  36 import org.opendaylight.netconf.client.mdsal.NetconfDeviceCapabilities;
  37 import org.opendaylight.netconf.client.mdsal.api.RemoteDeviceId;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.SessionIdType;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev240611.credentials.credentials.LoginPwUnencryptedBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev240611.credentials.credentials.login.pw.unencrypted.LoginPasswordUnencryptedBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev240611.NetconfNode;
  42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  43 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  44 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  45 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  46 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  47 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  48 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  49 import org.opendaylight.yangtools.yang.common.Empty;
  50 import org.opendaylight.yangtools.yang.common.Uint32;
  51
  52 @ExtendWith(MockitoExtension.class)
  53 class NetconfDeviceTopologyAdapterTest {
  54     private static final KeyedInstanceIdentifier<Topology, TopologyKey> TEST_TOPOLOGY_ID =
  55         // FIXME: do not use this constant
  56         NetconfNodeUtils.DEFAULT_TOPOLOGY_IID;
  57     private final RemoteDeviceId id = new RemoteDeviceId("test", new InetSocketAddress("localhost", 22));
  58
  59     @Mock
  60     private DataBroker mockBroker;
  61     @Mock
  62     private TransactionChain mockChain;
  63     @Mock
  64     private WriteTransaction mockTx;
  65     @Captor
  66     private ArgumentCaptor<FutureCallback<Empty>> listeners;
  67
  68     private NetconfDeviceTopologyAdapter adapter;
  69
  70     @BeforeEach
  71     void before() {
  72         doReturn(mockTx).when(mockChain).newWriteOnlyTransaction();
  73         // FIXME: exact match
  74         doNothing().when(mockTx).put(eq(LogicalDatastoreType.OPERATIONAL), any(InstanceIdentifier.class),
  75             any(Node.class));
  76         doReturn("test transaction").when(mockTx).getIdentifier();
  77         doReturn(CommitInfo.emptyFluentFuture()).when(mockTx).commit();
  78
  79         doReturn(mockChain).when(mockBroker).createMergingTransactionChain();
  80         doNothing().when(mockChain).addCallback(listeners.capture());
  81         adapter = new NetconfDeviceTopologyAdapter(mockBroker, TEST_TOPOLOGY_ID, id, new LoginPwUnencryptedBuilder()
  82             .setLoginPasswordUnencrypted(new LoginPasswordUnencryptedBuilder()
  83                 .setUsername("testuser")
  84                 .setPassword("testpassword")
  85                 .build())
  86             .build());
  87     }
  88
  89     @Test
  90     void replaceChainIfFailed() {
  91         doNothing().when(mockChain).close();
  92         doReturn("mockChain").when(mockChain).toString();
  93         adapter.onFailure(new Exception("chain failed"));
  94         verify(mockBroker, times(2)).createMergingTransactionChain();
  95     }
  96
  97     @Test
  98     void testFailedDevice() {
  99         // FIXME: exact match
 100         doNothing().when(mockTx).put(eq(LogicalDatastoreType.OPERATIONAL), any(InstanceIdentifier.class),
 101             any(NetconfNode.class));
 102
 103         adapter.setDeviceAsFailed(null);
 104
 105         verify(mockChain, times(2)).newWriteOnlyTransaction();
 106         // FIXME: LogicationDataStoreStype, concrete identifier, concreate (or captured/asserted) data
 107         verify(mockTx, times(1)).put(any(LogicalDatastoreType.class), any(InstanceIdentifier.class),
 108             any(Node.class));
 109     }
 110
 111     @Test
 112     void testDeviceUpdate() throws Exception {
 113         // FIXME: exact match
 114         doNothing().when(mockTx).put(eq(LogicalDatastoreType.OPERATIONAL), any(InstanceIdentifier.class),
 115             any(NetconfNode.class));
 116         adapter.updateDeviceData(true, NetconfDeviceCapabilities.empty(), new SessionIdType(Uint32.ONE));
 117
 118         verify(mockChain, times(2)).newWriteOnlyTransaction();
 119         verify(mockTx, times(1)).put(any(LogicalDatastoreType.class), any(InstanceIdentifier.class), any(Node.class));
 120         verify(mockTx, times(1)).put(any(LogicalDatastoreType.class), any(InstanceIdentifier.class), any(Node.class));
 121     }
 122
 123     @Test
 124     void testRemoveDeviceConfiguration() throws Exception {
 125         // FIXME: exact match
 126         doNothing().when(mockTx).delete(eq(LogicalDatastoreType.OPERATIONAL), any(InstanceIdentifier.class));
 127         doNothing().when(mockChain).close();
 128
 129         final var future = adapter.shutdown();
 130         verify(mockChain, times(2)).newWriteOnlyTransaction();
 131         verify(mockTx).delete(LogicalDatastoreType.OPERATIONAL,
 132             TEST_TOPOLOGY_ID.child(Node.class, new NodeKey(new NodeId(id.name()))));
 133         verify(mockTx, times(2)).commit();
 134         verify(mockChain).close();
 135
 136         assertFalse(future.isDone());
 137
 138         // Idempotent
 139         assertSame(future, adapter.shutdown());
 140
 141         // future completes
 142         listeners.getValue().onSuccess(Empty.value());
 143         assertSame(Empty.value(), Futures.getDone(future));
 144     }
 145
 146     @Test
 147     void testShutdownCompletion() throws Exception {
 148         // FIXME: exact match
 149         doNothing().when(mockTx).delete(eq(LogicalDatastoreType.OPERATIONAL), any(InstanceIdentifier.class));
 150         doNothing().when(mockChain).close();
 151
 152         final var future = adapter.shutdown();
 153         verify(mockChain, times(2)).newWriteOnlyTransaction();
 154         verify(mockTx).delete(LogicalDatastoreType.OPERATIONAL,
 155             TEST_TOPOLOGY_ID.child(Node.class, new NodeKey(new NodeId(id.name()))));
 156         verify(mockTx, times(2)).commit();
 157         verify(mockChain).close();
 158
 159         assertFalse(future.isDone());
 160
 161         // Idempotent
 162         assertSame(future, adapter.shutdown());
 163
 164         // future completes
 165         final var cause = new Throwable();
 166         listeners.getValue().onFailure(cause);
 167         final var ex = assertThrows(ExecutionException.class, () -> Futures.getDone(future));
 168         assertSame(cause, ex.getCause());
 169     }
 170 }