opendaylight/md-sal/samples/clustering-test-app/provider/src/main/java/org/opendaylight/controller/clustering/it/provider/impl/WriteTransactionsHandler.java

   1 /*
   2  * Copyright (c) 2017 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.controller.clustering.it.provider.impl;
   9
  10 import static java.util.Objects.requireNonNull;
  11 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.mapEntryBuilder;
  12
  13 import com.google.common.util.concurrent.FluentFuture;
  14 import com.google.common.util.concurrent.FutureCallback;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import com.google.common.util.concurrent.SettableFuture;
  17 import java.util.LinkedHashSet;
  18 import java.util.Set;
  19 import java.util.SplittableRandom;
  20 import java.util.concurrent.ConcurrentHashMap;
  21 import java.util.concurrent.ExecutionException;
  22 import java.util.concurrent.TimeUnit;
  23 import java.util.concurrent.TimeoutException;
  24 import java.util.concurrent.atomic.AtomicLong;
  25 import org.eclipse.jdt.annotation.NonNull;
  26 import org.opendaylight.mdsal.common.api.CommitInfo;
  27 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  28 import org.opendaylight.mdsal.common.api.OptimisticLockFailedException;
  29 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  30 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  31 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
  32 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.WriteTransactionsInput;
  33 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.WriteTransactionsOutput;
  34 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.WriteTransactionsOutputBuilder;
  35 import org.opendaylight.yangtools.yang.common.Empty;
  36 import org.opendaylight.yangtools.yang.common.ErrorType;
  37 import org.opendaylight.yangtools.yang.common.RpcResult;
  38 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  40 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  41 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  42 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  43 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  44 import org.opendaylight.yangtools.yang.data.spi.node.ImmutableNodes;
  45 import org.slf4j.Logger;
  46 import org.slf4j.LoggerFactory;
  47
  48 public abstract class WriteTransactionsHandler extends AbstractTransactionHandler {
  49     private static final class Chained extends WriteTransactionsHandler implements FutureCallback<Empty> {
  50         private final SplittableRandom random = new SplittableRandom();
  51         private final DOMTransactionChain transactionChain;
  52
  53         Chained(final DOMDataBroker dataBroker, final YangInstanceIdentifier idListItem,
  54             final WriteTransactionsInput input) {
  55             super(idListItem, input);
  56             transactionChain = dataBroker.createTransactionChain();
  57             transactionChain.addCallback(this);
  58         }
  59
  60         @Override
  61         DOMDataTreeWriteTransaction createTransaction() {
  62             return transactionChain.newWriteOnlyTransaction();
  63         }
  64
  65         @Override
  66         int nextInt(final int bound) {
  67             return random.nextInt(bound);
  68         }
  69
  70         @Override
  71         public void onFailure(final Throwable cause) {
  72             // This is expected to happen frequently in isolation testing.
  73             LOG.debug("Transaction chain failed.", cause);
  74             // Do not return RPC here, rely on transaction failure to call runFailed.
  75         }
  76
  77         @Override
  78         public void onSuccess(final Empty result) {
  79             LOG.debug("Transaction chain closed successfully.");
  80         }
  81     }
  82
  83     private static final class Simple extends WriteTransactionsHandler {
  84         private final LinkedHashSet<Integer> previousNumbers = new LinkedHashSet<>();
  85         private final SplittableRandom random = new SplittableRandom();
  86         private final DOMDataBroker dataBroker;
  87
  88         Simple(final DOMDataBroker dataBroker, final YangInstanceIdentifier idListItem,
  89             final WriteTransactionsInput input) {
  90             super(idListItem, input);
  91             this.dataBroker = requireNonNull(dataBroker);
  92         }
  93
  94         @Override
  95         DOMDataTreeWriteTransaction createTransaction() {
  96             return dataBroker.newWriteOnlyTransaction();
  97         }
  98
  99         @Override
 100         int nextInt(final int bound) {
 101             int nextInt;
 102             do {
 103                 nextInt = random.nextInt(bound);
 104             } while (previousNumbers.contains(nextInt));
 105
 106             if (previousNumbers.size() > 100000) {
 107                 previousNumbers.iterator().remove();
 108             }
 109             previousNumbers.add(nextInt);
 110
 111             return nextInt;
 112         }
 113     }
 114
 115     private static final Logger LOG = LoggerFactory.getLogger(WriteTransactionsHandler.class);
 116
 117     final SettableFuture<RpcResult<WriteTransactionsOutput>> completionFuture = SettableFuture.create();
 118     private final Set<Integer> usedValues = ConcurrentHashMap.newKeySet();
 119     private final YangInstanceIdentifier idListItem;
 120
 121     private final AtomicLong insertTx = new AtomicLong();
 122     private final AtomicLong deleteTx = new AtomicLong();
 123
 124     WriteTransactionsHandler(final YangInstanceIdentifier idListItem, final WriteTransactionsInput input) {
 125         super(input);
 126         this.idListItem = requireNonNull(idListItem);
 127     }
 128
 129     public static ListenableFuture<RpcResult<WriteTransactionsOutput>> start(final DOMDataBroker domDataBroker,
 130             final WriteTransactionsInput input) {
 131         LOG.info("Starting write transactions with input {}", input);
 132
 133         final String id = input.getId();
 134         final MapEntryNode entry = mapEntryBuilder(ID_INT, ID, id)
 135                 .withChild(ImmutableNodes.newSystemMapBuilder()
 136                     .withNodeIdentifier(new NodeIdentifier(ITEM))
 137                     .build())
 138                 .build();
 139         final YangInstanceIdentifier idListItem = ID_INT_YID.node(entry.name());
 140
 141         final ContainerNode containerNode = ImmutableNodes.newContainerBuilder()
 142                 .withNodeIdentifier(new NodeIdentifier(ID_INTS))
 143                 .withChild(ImmutableNodes.newSystemMapBuilder()
 144                     .withNodeIdentifier(new NodeIdentifier(ID_INT))
 145                     .build())
 146                 .build();
 147
 148         DOMDataTreeWriteTransaction tx = domDataBroker.newWriteOnlyTransaction();
 149         // write only the top list
 150         tx.merge(LogicalDatastoreType.CONFIGURATION, ID_INTS_YID, containerNode);
 151         try {
 152             tx.commit().get(INIT_TX_TIMEOUT_SECONDS, TimeUnit.SECONDS);
 153         } catch (InterruptedException | TimeoutException e) {
 154             LOG.error("Error writing top-level path {}: {}", ID_INTS_YID, containerNode, e);
 155             return RpcResultBuilder.<WriteTransactionsOutput>failed().withError(ErrorType.APPLICATION,
 156                 String.format("Could not start write transactions - error writing top-level path %s:  %s",
 157                     ID_INTS_YID, containerNode), e).buildFuture();
 158         } catch (ExecutionException e) {
 159             final Throwable cause = e.getCause();
 160             if (cause instanceof OptimisticLockFailedException) {
 161                 // when multiple write-transactions are executed concurrently we need to ignore this.
 162                 // If we get optimistic lock here it means id-ints already exists and we can continue.
 163                 LOG.debug("Got an optimistic lock when writing initial top level list element.", e);
 164             } else {
 165                 LOG.error("Error writing top-level path {}: {}", ID_INTS_YID, containerNode, e);
 166                 return RpcResultBuilder.<WriteTransactionsOutput>failed().withError(ErrorType.APPLICATION,
 167                     String.format("Could not start write transactions - error writing top-level path %s:  %s",
 168                         ID_INTS_YID, containerNode), e).buildFuture();
 169             }
 170         }
 171
 172         tx = domDataBroker.newWriteOnlyTransaction();
 173         tx.merge(LogicalDatastoreType.CONFIGURATION, idListItem, entry);
 174
 175         try {
 176             tx.commit().get(INIT_TX_TIMEOUT_SECONDS, TimeUnit.SECONDS);
 177         } catch (InterruptedException | ExecutionException | TimeoutException e) {
 178             LOG.error("Error writing top-level path {}: {}", idListItem, entry, e);
 179             return RpcResultBuilder.<WriteTransactionsOutput>failed().withError(ErrorType.APPLICATION,
 180                 String.format("Could not start write transactions - error writing list entry path %s: %s",
 181                     idListItem, entry), e).buildFuture();
 182         }
 183
 184         LOG.debug("Filling the item list with initial values.");
 185
 186         final YangInstanceIdentifier itemListId = idListItem.node(ITEM);
 187         tx = domDataBroker.newWriteOnlyTransaction();
 188         final MapNode itemListNode = ImmutableNodes.newSystemMapBuilder()
 189             .withNodeIdentifier(new NodeIdentifier(ITEM))
 190             .build();
 191         tx.put(LogicalDatastoreType.CONFIGURATION, itemListId, itemListNode);
 192
 193         try {
 194             tx.commit().get(INIT_TX_TIMEOUT_SECONDS, TimeUnit.SECONDS);
 195         } catch (InterruptedException | ExecutionException | TimeoutException e) {
 196             LOG.error("Error filling initial item list path {}: {}", itemListId, itemListNode, e);
 197             return RpcResultBuilder.<WriteTransactionsOutput>failed().withError(ErrorType.APPLICATION,
 198                 String.format("Could not start write transactions - error filling initial item list path %s: %s",
 199                     itemListId, itemListNode), e).buildFuture();
 200         }
 201
 202         final WriteTransactionsHandler handler;
 203         if (input.getChainedTransactions()) {
 204             handler = new Chained(domDataBroker, idListItem, input);
 205         } else {
 206             handler = new Simple(domDataBroker, idListItem, input);
 207         }
 208
 209         handler.doStart();
 210
 211         LOG.info("Write transactions successfully started");
 212         return handler.completionFuture;
 213     }
 214
 215     @Override
 216     FluentFuture<? extends @NonNull CommitInfo> execWrite(final long txId) {
 217         final int i = nextInt(MAX_ITEM + 1);
 218
 219         final YangInstanceIdentifier entryId =
 220                 idListItem.node(ITEM).node(YangInstanceIdentifier.NodeIdentifierWithPredicates.of(ITEM, NUMBER, i));
 221
 222         final DOMDataTreeWriteTransaction tx = createTransaction();
 223
 224         if (usedValues.contains(i)) {
 225             LOG.debug("Deleting item: {}", i);
 226             deleteTx.incrementAndGet();
 227             tx.delete(LogicalDatastoreType.CONFIGURATION, entryId);
 228             usedValues.remove(i);
 229
 230         } else {
 231             LOG.debug("Inserting item: {}", i);
 232             insertTx.incrementAndGet();
 233             tx.put(LogicalDatastoreType.CONFIGURATION, entryId, mapEntryBuilder(ITEM, NUMBER, i).build());
 234             usedValues.add(i);
 235         }
 236
 237         return tx.commit();
 238     }
 239
 240     @Override
 241     void runFailed(final Throwable cause, final long txId) {
 242         completionFuture.set(RpcResultBuilder.<WriteTransactionsOutput>failed()
 243             .withError(ErrorType.APPLICATION, "Commit failed for tx # " + txId, cause).build());
 244     }
 245
 246     @Override
 247     void runSuccessful(final long allTx) {
 248         final WriteTransactionsOutput output = new WriteTransactionsOutputBuilder()
 249                 .setAllTx(allTx)
 250                 .setInsertTx(insertTx.get())
 251                 .setDeleteTx(deleteTx.get())
 252                 .build();
 253
 254         completionFuture.set(RpcResultBuilder.<WriteTransactionsOutput>success()
 255                 .withResult(output).build());
 256     }
 257
 258     @Override
 259     void runTimedOut(final String cause) {
 260         completionFuture.set(RpcResultBuilder.<WriteTransactionsOutput>failed()
 261             .withError(ErrorType.APPLICATION, cause).build());
 262     }
 263
 264     abstract DOMDataTreeWriteTransaction createTransaction();
 265
 266     abstract int nextInt(int bound);
 267 }