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
  12 import com.google.common.util.concurrent.FluentFuture;
  13 import com.google.common.util.concurrent.ListenableFuture;
  14 import com.google.common.util.concurrent.SettableFuture;
  15 import java.util.LinkedHashSet;
  16 import java.util.Set;
  17 import java.util.SplittableRandom;
  18 import java.util.concurrent.ConcurrentHashMap;
  19 import java.util.concurrent.ExecutionException;
  20 import java.util.concurrent.TimeUnit;
  21 import java.util.concurrent.TimeoutException;
  22 import java.util.concurrent.atomic.AtomicLong;
  23 import org.eclipse.jdt.annotation.NonNull;
  24 import org.opendaylight.mdsal.common.api.CommitInfo;
  25 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  26 import org.opendaylight.mdsal.common.api.OptimisticLockFailedException;
  27 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  28 import org.opendaylight.mdsal.dom.api.DOMDataTreeTransaction;
  29 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  30 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
  31 import org.opendaylight.mdsal.dom.api.DOMTransactionChainListener;
  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.ErrorType;
  36 import org.opendaylight.yangtools.yang.common.RpcResult;
  37 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  40 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  41 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  42 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  43 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  44 import org.opendaylight.yangtools.yang.data.impl.schema.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 DOMTransactionChainListener {
  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(this);
  57         }
  58
  59         @Override
  60         DOMDataTreeWriteTransaction createTransaction() {
  61             return transactionChain.newWriteOnlyTransaction();
  62         }
  63
  64         @Override
  65         int nextInt(final int bound) {
  66             return random.nextInt(bound);
  67         }
  68
  69         @Override
  70         public void onTransactionChainFailed(final DOMTransactionChain chain, final DOMDataTreeTransaction transaction,
  71                 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 onTransactionChainSuccessful(final DOMTransactionChain chain) {
  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 = ImmutableNodes.mapEntryBuilder(ID_INT, ID, id)
 135                 .withChild(ImmutableNodes.mapNodeBuilder(ITEM).build())
 136                 .build();
 137         final YangInstanceIdentifier idListItem = ID_INT_YID.node(entry.getIdentifier());
 138
 139         final ContainerNode containerNode = Builders.containerBuilder()
 140                 .withNodeIdentifier(new NodeIdentifier(ID_INTS))
 141                 .withChild(ImmutableNodes.mapNodeBuilder(ID_INT).build())
 142                 .build();
 143
 144         DOMDataTreeWriteTransaction tx = domDataBroker.newWriteOnlyTransaction();
 145         // write only the top list
 146         tx.merge(LogicalDatastoreType.CONFIGURATION, ID_INTS_YID, containerNode);
 147         try {
 148             tx.commit().get(INIT_TX_TIMEOUT_SECONDS, TimeUnit.SECONDS);
 149         } catch (InterruptedException | TimeoutException e) {
 150             LOG.error("Error writing top-level path {}: {}", ID_INTS_YID, containerNode, e);
 151             return RpcResultBuilder.<WriteTransactionsOutput>failed().withError(ErrorType.APPLICATION,
 152                 String.format("Could not start write transactions - error writing top-level path %s:  %s",
 153                     ID_INTS_YID, containerNode), e).buildFuture();
 154         } catch (ExecutionException e) {
 155             final Throwable cause = e.getCause();
 156             if (cause instanceof OptimisticLockFailedException) {
 157                 // when multiple write-transactions are executed concurrently we need to ignore this.
 158                 // If we get optimistic lock here it means id-ints already exists and we can continue.
 159                 LOG.debug("Got an optimistic lock when writing initial top level list element.", e);
 160             } else {
 161                 LOG.error("Error writing top-level path {}: {}", ID_INTS_YID, containerNode, e);
 162                 return RpcResultBuilder.<WriteTransactionsOutput>failed().withError(ErrorType.APPLICATION,
 163                     String.format("Could not start write transactions - error writing top-level path %s:  %s",
 164                         ID_INTS_YID, containerNode), e).buildFuture();
 165             }
 166         }
 167
 168         tx = domDataBroker.newWriteOnlyTransaction();
 169         tx.merge(LogicalDatastoreType.CONFIGURATION, idListItem, entry);
 170
 171         try {
 172             tx.commit().get(INIT_TX_TIMEOUT_SECONDS, TimeUnit.SECONDS);
 173         } catch (InterruptedException | ExecutionException | TimeoutException e) {
 174             LOG.error("Error writing top-level path {}: {}", idListItem, entry, e);
 175             return RpcResultBuilder.<WriteTransactionsOutput>failed().withError(ErrorType.APPLICATION,
 176                 String.format("Could not start write transactions - error writing list entry path %s: %s",
 177                     idListItem, entry), e).buildFuture();
 178         }
 179
 180         LOG.debug("Filling the item list with initial values.");
 181
 182         final YangInstanceIdentifier itemListId = idListItem.node(ITEM);
 183         tx = domDataBroker.newWriteOnlyTransaction();
 184         final MapNode itemListNode = ImmutableNodes.mapNodeBuilder(ITEM).build();
 185         tx.put(LogicalDatastoreType.CONFIGURATION, itemListId, itemListNode);
 186
 187         try {
 188             tx.commit().get(INIT_TX_TIMEOUT_SECONDS, TimeUnit.SECONDS);
 189         } catch (InterruptedException | ExecutionException | TimeoutException e) {
 190             LOG.error("Error filling initial item list path {}: {}", itemListId, itemListNode, e);
 191             return RpcResultBuilder.<WriteTransactionsOutput>failed().withError(ErrorType.APPLICATION,
 192                 String.format("Could not start write transactions - error filling initial item list path %s: %s",
 193                     itemListId, itemListNode), e).buildFuture();
 194         }
 195
 196         final WriteTransactionsHandler handler;
 197         if (input.getChainedTransactions()) {
 198             handler = new Chained(domDataBroker, idListItem, input);
 199         } else {
 200             handler = new Simple(domDataBroker, idListItem, input);
 201         }
 202
 203         handler.doStart();
 204
 205         LOG.info("Write transactions successfully started");
 206         return handler.completionFuture;
 207     }
 208
 209     @Override
 210     FluentFuture<? extends @NonNull CommitInfo> execWrite(final long txId) {
 211         final int i = nextInt(MAX_ITEM + 1);
 212
 213         final YangInstanceIdentifier entryId =
 214                 idListItem.node(ITEM).node(YangInstanceIdentifier.NodeIdentifierWithPredicates.of(ITEM, NUMBER, i));
 215
 216         final DOMDataTreeWriteTransaction tx = createTransaction();
 217
 218         if (usedValues.contains(i)) {
 219             LOG.debug("Deleting item: {}", i);
 220             deleteTx.incrementAndGet();
 221             tx.delete(LogicalDatastoreType.CONFIGURATION, entryId);
 222             usedValues.remove(i);
 223
 224         } else {
 225             LOG.debug("Inserting item: {}", i);
 226             insertTx.incrementAndGet();
 227             final MapEntryNode entry = ImmutableNodes.mapEntry(ITEM, NUMBER, i);
 228             tx.put(LogicalDatastoreType.CONFIGURATION, entryId, entry);
 229             usedValues.add(i);
 230         }
 231
 232         return tx.commit();
 233     }
 234
 235     @Override
 236     void runFailed(final Throwable cause, final long txId) {
 237         completionFuture.set(RpcResultBuilder.<WriteTransactionsOutput>failed()
 238             .withError(ErrorType.APPLICATION, "Commit failed for tx # " + txId, cause).build());
 239     }
 240
 241     @Override
 242     void runSuccessful(final long allTx) {
 243         final WriteTransactionsOutput output = new WriteTransactionsOutputBuilder()
 244                 .setAllTx(allTx)
 245                 .setInsertTx(insertTx.get())
 246                 .setDeleteTx(deleteTx.get())
 247                 .build();
 248
 249         completionFuture.set(RpcResultBuilder.<WriteTransactionsOutput>success()
 250                 .withResult(output).build());
 251     }
 252
 253     @Override
 254     void runTimedOut(final String cause) {
 255         completionFuture.set(RpcResultBuilder.<WriteTransactionsOutput>failed()
 256             .withError(ErrorType.APPLICATION, cause).build());
 257     }
 258
 259     abstract DOMDataTreeWriteTransaction createTransaction();
 260
 261     abstract int nextInt(int bound);
 262 }