replicate/mdsal-replicate-netty/src/test/java/org/opendaylight/mdsal/replicate/netty/IntegrationTest.java

   1 /*
   2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. 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.mdsal.replicate.netty;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.mockito.ArgumentMatchers.any;
  12 import static org.mockito.ArgumentMatchers.eq;
  13 import static org.mockito.Mockito.doReturn;
  14 import static org.mockito.Mockito.mock;
  15 import static org.mockito.Mockito.timeout;
  16 import static org.mockito.Mockito.verify;
  17
  18 import java.net.Inet4Address;
  19 import java.time.Duration;
  20 import java.util.concurrent.ExecutionException;
  21 import org.junit.After;
  22 import org.junit.Before;
  23 import org.junit.Test;
  24 import org.junit.runner.RunWith;
  25 import org.mockito.ArgumentCaptor;
  26 import org.mockito.junit.MockitoJUnitRunner;
  27 import org.opendaylight.mdsal.binding.api.DataBroker;
  28 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  29 import org.opendaylight.mdsal.binding.dom.adapter.test.AbstractDataBrokerTest;
  30 import org.opendaylight.mdsal.common.api.CommitInfo;
  31 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  32 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  33 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  34 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
  35 import org.opendaylight.mdsal.eos.dom.simple.SimpleDOMEntityOwnershipService;
  36 import org.opendaylight.mdsal.singleton.dom.impl.EOSClusterSingletonServiceProvider;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.core.general.entity.rev150930.Entity;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.core.general.entity.rev150930.EntityBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.core.general.entity.rev150930.EntityKey;
  40 import org.opendaylight.yangtools.concepts.Registration;
  41 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  42 import org.opendaylight.yangtools.yang.common.QName;
  43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  44 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  45 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  46 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  47 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  48 import org.opendaylight.yangtools.yang.data.api.schema.SystemMapNode;
  49 import org.opendaylight.yangtools.yang.data.api.schema.builder.CollectionNodeBuilder;
  50 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  51 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  52 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  53
  54 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  55 public class IntegrationTest extends AbstractDataBrokerTest {
  56     private static final int TEST_PORT = 4000;
  57
  58     private static final QName ENTITY_QNAME = Entity.QNAME;
  59     private static final QName ENTITY_NAME_QNAME = QName.create(ENTITY_QNAME, "name");
  60
  61     private AbstractBootstrapSupport support;
  62     private EOSClusterSingletonServiceProvider css;
  63
  64     @Before
  65     public void before() {
  66         support = AbstractBootstrapSupport.create();
  67         css = new EOSClusterSingletonServiceProvider(new SimpleDOMEntityOwnershipService());
  68     }
  69
  70     @After
  71     public void after() throws Exception {
  72         support.close();
  73         css.close();
  74     }
  75
  76     /**
  77      * Connect the Source and Sink. Verify that the initial state returned from Source was empty. After that make some
  78      * changes to the Source's datastore and verify that they were all replicated to the Sink
  79      */
  80     @Test
  81     public void testSourceToSink() throws InterruptedException, ExecutionException {
  82         // Make sure to start source...
  83         final Registration source = NettyReplicationSource.createSource(support, getDomBroker(), css, true, TEST_PORT,
  84             Duration.ZERO, 5);
  85         // ... and give it some time start up and open up the port
  86         Thread.sleep(1000);
  87
  88         // Mocking for sink...
  89         final DOMTransactionChain sinkChain = mock(DOMTransactionChain.class);
  90         final DOMDataTreeWriteTransaction sinkTx = mock(DOMDataTreeWriteTransaction.class);
  91         doReturn(CommitInfo.emptyFluentFuture()).when(sinkTx).commit();
  92         doReturn(sinkTx).when(sinkChain).newWriteOnlyTransaction();
  93         final DOMDataBroker sinkBroker = mock(DOMDataBroker.class);
  94         doReturn(sinkChain).when(sinkBroker).createMergingTransactionChain();
  95
  96         // Kick of the sink ...
  97         final Registration sink = NettyReplicationSink.createSink(support, sinkBroker, css, true,
  98             Inet4Address.getLoopbackAddress(), TEST_PORT, Duration.ZERO, Duration.ZERO, 3);
  99         // ... and sync on it starting up
 100
 101         // verify the connection was established and MSG_EMPTY_DATA was transferred
 102         verify(sinkBroker, timeout(1000)).createMergingTransactionChain();
 103         verify(sinkTx, timeout(1000)).put(eq(LogicalDatastoreType.CONFIGURATION), eq(YangInstanceIdentifier.of()),
 104             any(ContainerNode.class));
 105
 106         // generate some deltas
 107         final int deltaCount = 5;
 108         generateModification(getDataBroker(), deltaCount);
 109
 110         // verify that all the deltas were transferred and committed + 1 invocation from receiving MSG_EMPTY_DATA
 111         verify(sinkChain, timeout(2000).times(deltaCount + 1)).newWriteOnlyTransaction();
 112         verify(sinkTx, timeout(2000).times(deltaCount + 1)).commit();
 113
 114         sink.close();
 115         source.close();
 116     }
 117
 118     /**
 119      * Add some data first and then start replication. Only 1 change is expected to return from the Source and it
 120      * should contain the initial state of the Source's datastore.
 121      */
 122     @Test
 123     public void testReplicateInitialState() throws InterruptedException, ExecutionException {
 124         // add some data to datastore
 125         final int deltaCount = 5;
 126         generateModification(getDataBroker(), deltaCount);
 127
 128         // Make sure to start source...
 129         final Registration source = NettyReplicationSource.createSource(support, getDomBroker(), css, true, TEST_PORT,
 130             Duration.ZERO, 5);
 131         // ... and give it some time start up and open up the port
 132         Thread.sleep(1000);
 133
 134         // Mocking for sink...
 135         final DOMTransactionChain sinkChain = mock(DOMTransactionChain.class);
 136         final DOMDataTreeWriteTransaction sinkTx = mock(DOMDataTreeWriteTransaction.class);
 137         doReturn(CommitInfo.emptyFluentFuture()).when(sinkTx).commit();
 138         doReturn(sinkTx).when(sinkChain).newWriteOnlyTransaction();
 139         final DOMDataBroker sinkBroker = mock(DOMDataBroker.class);
 140         doReturn(sinkChain).when(sinkBroker).createMergingTransactionChain();
 141
 142         // Kick of the sink ...
 143         final Registration sink = NettyReplicationSink.createSink(support, sinkBroker, css, true,
 144             Inet4Address.getLoopbackAddress(), TEST_PORT, Duration.ZERO, Duration.ZERO, 3);
 145         // ... and sync on it starting up
 146
 147         // verify the connection was established and MSG_EMPTY_DATA was transferred
 148         verify(sinkBroker, timeout(1000)).createMergingTransactionChain();
 149         verify(sinkChain, timeout(2000).times(1)).newWriteOnlyTransaction();
 150
 151         // verify that the initial data invoked onDataTreeChanged() and was transferred to sink
 152         ArgumentCaptor<NormalizedNode> dataCaptor = ArgumentCaptor.forClass(NormalizedNode.class);
 153         verify(sinkTx, timeout(2000).times(1)).put(any(), any(), dataCaptor.capture());
 154         // verify that the initial state contains everything
 155         NormalizedNode capturedInitialState = dataCaptor.getAllValues().iterator().next();
 156         NormalizedNode expectedEntityState = generateNormalizedNodeForEntities(deltaCount);
 157         assertEquals(expectedEntityState, capturedInitialState);
 158
 159         verify(sinkTx, timeout(2000).times(1)).commit();
 160
 161         sink.close();
 162         source.close();
 163     }
 164
 165     private static ContainerNode generateNormalizedNodeForEntities(final int amount) {
 166         final CollectionNodeBuilder<MapEntryNode, SystemMapNode> builder = ImmutableNodes.mapNodeBuilder(ENTITY_QNAME);
 167         for (int i = 0; i < amount; i++) {
 168             builder.withChild(ImmutableNodes.mapEntry(ENTITY_QNAME, ENTITY_NAME_QNAME, "testEntity" + i));
 169         }
 170
 171         return Builders.containerBuilder()
 172                 .withNodeIdentifier(new NodeIdentifier(SchemaContext.NAME))
 173                 .withChild(builder.build())
 174                 .build();
 175     }
 176
 177     private static void generateModification(final DataBroker broker, final int amount)
 178             throws InterruptedException, ExecutionException {
 179         for (int i = 0; i < amount; i++) {
 180             final WriteTransaction writeTransaction = broker.newWriteOnlyTransaction();
 181             final EntityKey key = new EntityKey("testEntity" + i);
 182
 183             writeTransaction.put(LogicalDatastoreType.CONFIGURATION,
 184                 InstanceIdentifier.builder(Entity.class, key).build(), new EntityBuilder().withKey(key).build());
 185             writeTransaction.commit().get();
 186         }
 187     }
 188 }