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     private static final Logger LOG = LoggerFactory.getLogger(DataBrokerFailuresImpl.class);
  42
  43     private final DataBroker delegate;
  44     private volatile @Nullable ReadFailedException readException;
  45     private volatile @Nullable TransactionCommitFailedException commitException;
  46     private final AtomicInteger howManyFailingReads = new AtomicInteger();
  47     private final AtomicInteger howManyFailingCommits = new AtomicInteger();
  48     private boolean commitAndThrowException = false;
  49
  50     public DataBrokerFailuresImpl(final DataBroker delegate) {
  51         this.delegate = delegate;
  52     }
  53
  54     @Override
  55     protected DataBroker delegate() {
  56         return delegate;
  57     }
  58
  59     @Override
  60     public void failReads(final ReadFailedException exception) {
  61         unfailReads();
  62         readException = requireNonNull(exception, "exception == null");
  63     }
  64
  65     @Override
  66     public void failReads(final int howManyTimes, final ReadFailedException exception) {
  67         unfailReads();
  68         howManyFailingReads.set(howManyTimes);
  69         readException = requireNonNull(exception, "exception == null");
  70     }
  71
  72     @Override
  73     public void failCommits(final TransactionCommitFailedException exception) {
  74         unfailCommits();
  75         this.commitException = requireNonNull(exception, "exception == null");
  76     }
  77
  78     @Override
  79     public void failCommits(final int howManyTimes, final TransactionCommitFailedException exception) {
  80         howManyFailingCommits.set(howManyTimes);
  81         this.commitException = requireNonNull(exception, "exception == null");
  82     }
  83
  84     @Override
  85     public void unfailReads() {
  86         readException = null;
  87         howManyFailingReads.set(-1);
  88     }
  89
  90     @Override
  91     public void unfailCommits() {
  92         this.commitException = null;
  93         howManyFailingCommits.set(-1);
  94         this.commitAndThrowException = false;
  95     }
  96
  97     @Override
  98     public void failButCommitAnyway() {
  99         unfailCommits();
 100         this.commitException = new TransactionCommitFailedException("caused by simulated AskTimeoutException");
 101         this.commitAndThrowException = true;
 102     }
 103
 104     private FluentFuture<? extends CommitInfo> handleCommit(
 105             final Supplier<FluentFuture<? extends CommitInfo>> commitMethod) {
 106         if (howManyFailingCommits.decrementAndGet() == -1) {
 107             commitException = null;
 108         }
 109         if (commitException == null) {
 110             return commitMethod.get();
 111         }
 112
 113         if (commitAndThrowException) {
 114             try {
 115                 commitMethod.get().get();
 116             } catch (InterruptedException | ExecutionException e) {
 117                 LOG.warn("Exception while waiting for committed transaction", e);
 118             }
 119         }
 120         return FluentFuture.from(Futures.immediateFailedFuture(commitException));
 121     }
 122
 123     public <T extends DataObject> FluentFuture<Optional<T>> handleRead(
 124             final BiFunction<LogicalDatastoreType, InstanceIdentifier<T>, FluentFuture<Optional<T>>> readMethod,
 125             final LogicalDatastoreType store, final InstanceIdentifier<T> path) {
 126         if (howManyFailingReads.decrementAndGet() == -1) {
 127             readException = null;
 128         }
 129         if (readException == null) {
 130             return readMethod.apply(store, path);
 131         }
 132         return FluentFuture.from(Futures.immediateFailedFuture(readException));
 133     }
 134
 135     @Override
 136     public ReadWriteTransaction newReadWriteTransaction() {
 137         return new ForwardingReadWriteTransaction(delegate.newReadWriteTransaction()) {
 138             @Override
 139             public <T extends DataObject> FluentFuture<Optional<T>> read(final LogicalDatastoreType store,
 140                     final InstanceIdentifier<T> path) {
 141                 return handleRead(super::read, store, path);
 142             }
 143
 144             @Override
 145             public FluentFuture<? extends CommitInfo> commit() {
 146                 return handleCommit(super::commit);
 147             }
 148         };
 149     }
 150
 151     @Override
 152     public WriteTransaction newWriteOnlyTransaction() {
 153         return new ForwardingWriteTransaction(delegate.newWriteOnlyTransaction()) {
 154             @Override
 155             public FluentFuture<? extends CommitInfo> commit() {
 156                 return handleCommit(super::commit);
 157             }
 158         };
 159     }
 160
 161 }