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.Assert.assertFalse;
  11 import static org.junit.Assert.assertSame;
  12 import static org.junit.Assert.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.Before;
  25 import org.junit.Test;
  26 import org.junit.runner.RunWith;
  27 import org.mockito.ArgumentCaptor;
  28 import org.mockito.Captor;
  29 import org.mockito.Mock;
  30 import org.mockito.junit.MockitoJUnitRunner;
  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.node.topology.rev231121.NetconfNode;
  40 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  41 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  43 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  44 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  45 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  46 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  47 import org.opendaylight.yangtools.yang.common.Empty;
  48 import org.opendaylight.yangtools.yang.common.Uint32;
  49
  50 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  51 public class NetconfDeviceTopologyAdapterTest {
  52     private static final KeyedInstanceIdentifier<Topology, TopologyKey> TEST_TOPOLOGY_ID =
  53         // FIXME: do not use this constant
  54         NetconfNodeUtils.DEFAULT_TOPOLOGY_IID;
  55     private final RemoteDeviceId id = new RemoteDeviceId("test", new InetSocketAddress("localhost", 22));
  56
  57     @Mock
  58     private DataBroker mockBroker;
  59     @Mock
  60     private TransactionChain mockChain;
  61     @Mock
  62     private WriteTransaction mockTx;
  63     @Captor
  64     private ArgumentCaptor<FutureCallback<Empty>> listeners;
  65
  66     private NetconfDeviceTopologyAdapter adapter;
  67
  68     @Before
  69     public void before() {
  70         doReturn(mockTx).when(mockChain).newWriteOnlyTransaction();
  71         // FIXME: exact match
  72         doNothing().when(mockTx).put(eq(LogicalDatastoreType.OPERATIONAL), any(InstanceIdentifier.class),
  73             any(Node.class));
  74         doReturn("test transaction").when(mockTx).getIdentifier();
  75         doReturn(CommitInfo.emptyFluentFuture()).when(mockTx).commit();
  76
  77         doReturn(mockChain).when(mockBroker).createMergingTransactionChain();
  78         doNothing().when(mockChain).addCallback(listeners.capture());
  79         adapter = new NetconfDeviceTopologyAdapter(mockBroker, TEST_TOPOLOGY_ID, id);
  80     }
  81
  82     @Test
  83     public void replaceChainIfFailed() {
  84         doNothing().when(mockChain).close();
  85         doReturn("mockChain").when(mockChain).toString();
  86         adapter.onFailure(new Exception("chain failed"));
  87         verify(mockBroker, times(2)).createMergingTransactionChain();
  88     }
  89
  90     @Test
  91     public void testFailedDevice() {
  92         // FIXME: exact match
  93         doNothing().when(mockTx).put(eq(LogicalDatastoreType.OPERATIONAL), any(InstanceIdentifier.class),
  94             any(NetconfNode.class));
  95
  96         adapter.setDeviceAsFailed(null);
  97
  98         verify(mockChain, times(2)).newWriteOnlyTransaction();
  99         // FIXME: LogicationDataStoreStype, concrete identifier, concreate (or captured/asserted) data
 100         verify(mockTx, times(1)).put(any(LogicalDatastoreType.class), any(InstanceIdentifier.class),
 101             any(Node.class));
 102     }
 103
 104     @Test
 105     public void testDeviceUpdate() throws Exception {
 106         // FIXME: exact match
 107         doNothing().when(mockTx).put(eq(LogicalDatastoreType.OPERATIONAL), any(InstanceIdentifier.class),
 108             any(NetconfNode.class));
 109         adapter.updateDeviceData(true, NetconfDeviceCapabilities.empty(), new SessionIdType(Uint32.ONE));
 110
 111         verify(mockChain, times(2)).newWriteOnlyTransaction();
 112         verify(mockTx, times(1)).put(any(LogicalDatastoreType.class), any(InstanceIdentifier.class), any(Node.class));
 113         verify(mockTx, times(1)).put(any(LogicalDatastoreType.class), any(InstanceIdentifier.class), any(Node.class));
 114     }
 115
 116     @Test
 117     public void testRemoveDeviceConfiguration() throws Exception {
 118         // FIXME: exact match
 119         doNothing().when(mockTx).delete(eq(LogicalDatastoreType.OPERATIONAL), any(InstanceIdentifier.class));
 120         doNothing().when(mockChain).close();
 121
 122         final var future = adapter.shutdown();
 123         verify(mockChain, times(2)).newWriteOnlyTransaction();
 124         verify(mockTx).delete(LogicalDatastoreType.OPERATIONAL,
 125             TEST_TOPOLOGY_ID.child(Node.class, new NodeKey(new NodeId(id.name()))));
 126         verify(mockTx, times(2)).commit();
 127         verify(mockChain).close();
 128
 129         assertFalse(future.isDone());
 130
 131         // Idempotent
 132         assertSame(future, adapter.shutdown());
 133
 134         // future completes
 135         listeners.getValue().onSuccess(Empty.value());
 136         assertSame(Empty.value(), Futures.getDone(future));
 137     }
 138
 139     @Test
 140     public void testShutdownCompletion() throws Exception {
 141         // FIXME: exact match
 142         doNothing().when(mockTx).delete(eq(LogicalDatastoreType.OPERATIONAL), any(InstanceIdentifier.class));
 143         doNothing().when(mockChain).close();
 144
 145         final var future = adapter.shutdown();
 146         verify(mockChain, times(2)).newWriteOnlyTransaction();
 147         verify(mockTx).delete(LogicalDatastoreType.OPERATIONAL,
 148             TEST_TOPOLOGY_ID.child(Node.class, new NodeKey(new NodeId(id.name()))));
 149         verify(mockTx, times(2)).commit();
 150         verify(mockChain).close();
 151
 152         assertFalse(future.isDone());
 153
 154         // Idempotent
 155         assertSame(future, adapter.shutdown());
 156
 157         // future completes
 158         final var cause = new Throwable();
 159         listeners.getValue().onFailure(cause);
 160         final var ex = assertThrows(ExecutionException.class, () -> Futures.getDone(future));
 161         assertSame(cause, ex.getCause());
 162     }
 163 }