binding/mdsal-binding-test-utils/src/main/java/org/opendaylight/mdsal/binding/testutils/DataBrokerFailuresImpl.java

   1 /*
   2  * Copyright (c) 2017 Red Hat, 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.mdsal.binding.testutils;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.util.concurrent.FluentFuture;
  13 import com.google.common.util.concurrent.Futures;
  14 import java.util.Optional;
  15 import java.util.concurrent.ExecutionException;
  16 import java.util.concurrent.atomic.AtomicInteger;
  17 import java.util.function.BiFunction;
  18 import java.util.function.Supplier;
  19 import org.eclipse.jdt.annotation.Nullable;
  20 import org.opendaylight.mdsal.binding.api.DataBroker;
  21 import org.opendaylight.mdsal.binding.api.ReadWriteTransaction;
  22 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  23 import org.opendaylight.mdsal.binding.spi.ForwardingDataBroker;
  24 import org.opendaylight.mdsal.binding.spi.ForwardingReadWriteTransaction;
  25 import org.opendaylight.mdsal.binding.spi.ForwardingWriteTransaction;
  26 import org.opendaylight.mdsal.common.api.CommitInfo;
  27 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  28 import org.opendaylight.mdsal.common.api.ReadFailedException;
  29 import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
  30 import org.opendaylight.yangtools.yang.binding.DataObject;
  31 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  32 import org.slf4j.Logger;
  33 import org.slf4j.LoggerFactory;
  34
  35 /**
  36  * DataBroker with methods to simulate failures, useful for tests.
  37  *
  38  * @author Michael Vorburger.ch
  39  */
  40 public class DataBrokerFailuresImpl extends ForwardingDataBroker implements DataBrokerFailures {
  41
  42     private static final Logger LOG = LoggerFactory.getLogger(DataBrokerFailuresImpl.class);
  43
  44     private final DataBroker delegate;
  45     private volatile @Nullable ReadFailedException readException;
  46     private volatile @Nullable TransactionCommitFailedException commitException;
  47     private final AtomicInteger howManyFailingReads = new AtomicInteger();
  48     private final AtomicInteger howManyFailingCommits = new AtomicInteger();
  49     private boolean commitAndThrowException = false;
  50
  51     public DataBrokerFailuresImpl(DataBroker delegate) {
  52         this.delegate = delegate;
  53     }
  54
  55     @Override
  56     protected DataBroker delegate() {
  57         return delegate;
  58     }
  59
  60     @Override
  61     public void failReads(ReadFailedException exception) {
  62         unfailReads();
  63         readException = requireNonNull(exception, "exception == null");
  64     }
  65
  66     @Override
  67     public void failReads(int howManyTimes, ReadFailedException exception) {
  68         unfailReads();
  69         howManyFailingReads.set(howManyTimes);
  70         readException = requireNonNull(exception, "exception == null");
  71     }
  72
  73     @Override
  74     public void failCommits(TransactionCommitFailedException exception) {
  75         unfailCommits();
  76         this.commitException = requireNonNull(exception, "exception == null");
  77     }
  78
  79     @Override
  80     public void failCommits(int howManyTimes, TransactionCommitFailedException exception) {
  81         howManyFailingCommits.set(howManyTimes);
  82         this.commitException = requireNonNull(exception, "exception == null");
  83     }
  84
  85     @Override
  86     public void unfailReads() {
  87         readException = null;
  88         howManyFailingReads.set(-1);
  89     }
  90
  91     @Override
  92     public void unfailCommits() {
  93         this.commitException = null;
  94         howManyFailingCommits.set(-1);
  95         this.commitAndThrowException = false;
  96     }
  97
  98     @Override
  99     public void failButCommitAnyway() {
 100         unfailCommits();
 101         this.commitException = new TransactionCommitFailedException("caused by simulated AskTimeoutException");
 102         this.commitAndThrowException = true;
 103     }
 104
 105     private FluentFuture<? extends CommitInfo> handleCommit(Supplier<FluentFuture<? extends CommitInfo>> commitMethod) {
 106         if (howManyFailingCommits.decrementAndGet() == -1) {
 107             commitException = null;
 108         }
 109         if (commitException == null) {
 110             return commitMethod.get();
 111         } else {
 112             if (commitAndThrowException) {
 113                 try {
 114                     commitMethod.get().get();
 115                 } catch (InterruptedException | ExecutionException e) {
 116                     LOG.warn("Exception while waiting for committed transaction", e);
 117                 }
 118             }
 119             return FluentFuture.from(Futures.immediateFailedFuture(commitException));
 120         }
 121     }
 122
 123     public <T extends DataObject> FluentFuture<Optional<T>> handleRead(
 124             BiFunction<LogicalDatastoreType, InstanceIdentifier<T>, FluentFuture<Optional<T>>> readMethod,
 125             LogicalDatastoreType store, InstanceIdentifier<T> path) {
 126         if (howManyFailingReads.decrementAndGet() == -1) {
 127             readException = null;
 128         }
 129         if (readException == null) {
 130             return readMethod.apply(store, path);
 131         } else {
 132             return FluentFuture.from(Futures.immediateFailedFuture(readException));
 133         }
 134     }
 135
 136     @Override
 137     public ReadWriteTransaction newReadWriteTransaction() {
 138         return new ForwardingReadWriteTransaction(delegate.newReadWriteTransaction()) {
 139             @Override
 140             public <T extends DataObject> FluentFuture<Optional<T>> read(LogicalDatastoreType store,
 141                     InstanceIdentifier<T> path) {
 142                 return handleRead(super::read, store, path);
 143             }
 144
 145             @Override
 146             public FluentFuture<? extends CommitInfo> commit() {
 147                 return handleCommit(super::commit);
 148             }
 149         };
 150     }
 151
 152     @Override
 153     public WriteTransaction newWriteOnlyTransaction() {
 154         return new ForwardingWriteTransaction(delegate.newWriteOnlyTransaction()) {
 155             @Override
 156             public FluentFuture<? extends CommitInfo> commit() {
 157                 return handleCommit(super::commit);
 158             }
 159         };
 160     }
 161
 162 }