Bug 8829: Ignore error when initializing dsbenchmark
[controller.git] / benchmark / dsbenchmark / src / main / java / org / opendaylight / dsbenchmark / DsbenchmarkProvider.java
index 56e3899d2dc172df03933216d006efa10717db94..229eddfa0c75d64cad49e3b443b93627c1b7a6c4 100644 (file)
@@ -7,18 +7,16 @@
  */
 package org.opendaylight.dsbenchmark;
 
+import com.google.common.util.concurrent.Futures;
 import java.util.Collections;
 import java.util.concurrent.Future;
 import java.util.concurrent.atomic.AtomicReference;
-
 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
-import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderContext;
-import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.RpcRegistration;
-import org.opendaylight.controller.sal.binding.api.BindingAwareProvider;
+import org.opendaylight.dsbenchmark.listener.DsbenchmarkListenerProvider;
 import org.opendaylight.dsbenchmark.simpletx.SimpletxBaDelete;
 import org.opendaylight.dsbenchmark.simpletx.SimpletxBaRead;
 import org.opendaylight.dsbenchmark.simpletx.SimpletxBaWrite;
@@ -47,57 +45,63 @@ import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.google.common.util.concurrent.Futures;
-
-public class DsbenchmarkProvider implements BindingAwareProvider, DsbenchmarkService, AutoCloseable {
+public class DsbenchmarkProvider implements DsbenchmarkService, AutoCloseable {
 
     private static final Logger LOG = LoggerFactory.getLogger(DsbenchmarkProvider.class);
-    private final AtomicReference<ExecStatus> execStatus = new AtomicReference<ExecStatus>( ExecStatus.Idle );
-
-    private static final InstanceIdentifier<TestExec> TEST_EXEC_IID = InstanceIdentifier.builder(TestExec.class).build();
-    private static final InstanceIdentifier<TestStatus> TEST_STATUS_IID = InstanceIdentifier.builder(TestStatus.class).build();
-    private final DOMDataBroker domDataBroker;
-    private final DataBroker bindingDataBroker;
-    private RpcRegistration<DsbenchmarkService> dstReg;
-    private DataBroker dataBroker;
+    private static final InstanceIdentifier<TestExec> TEST_EXEC_IID =
+            InstanceIdentifier.builder(TestExec.class).build();
+    private static final InstanceIdentifier<TestStatus> TEST_STATUS_IID =
+            InstanceIdentifier.builder(TestStatus.class).build();
+
+    private final AtomicReference<ExecStatus> execStatus = new AtomicReference<>(ExecStatus.Idle);
+    private final DsbenchmarkListenerProvider listenerProvider = new DsbenchmarkListenerProvider();
+    private final DOMDataBroker domDataBroker;  // Async DOM Broker for use with all DOM operations
+    private final DataBroker txChainDataBroker; // Async Binding-Aware Broker for use in tx chains; initialized to
+                                                // ping-pong broker in default config (see default-config.xml and
+                                                // dsbenchmark-impl.yang)
+    private final DataBroker simpleTxDataBroker;      // "Legacy" OSGI Data Broker for use in simple transactions
 
     private long testsCompleted = 0;
 
-    public DsbenchmarkProvider(DOMDataBroker domDataBroker, DataBroker bindingDataBroker) {
-        // We have to get the DOMDataBroker via the constructor,
-        // since we can't get it from the session
+    public DsbenchmarkProvider(final DOMDataBroker domDataBroker, final DataBroker txChainDataBroker,
+            final DataBroker simpleTxDataBroker) {
         this.domDataBroker = domDataBroker;
-        this.bindingDataBroker = bindingDataBroker;
+        this.txChainDataBroker = txChainDataBroker;
+        this.simpleTxDataBroker = simpleTxDataBroker;
     }
 
-    @Override
-    public void onSessionInitiated(ProviderContext session) {
-        this.dataBroker = session.getSALService(DataBroker.class);
-        this.dstReg = session.addRpcImplementation( DsbenchmarkService.class, this );
-        setTestOperData(this.execStatus.get(), testsCompleted);
+    public void init() {
+        listenerProvider.setDataBroker(simpleTxDataBroker);
+
+        try {
+            // We want to set the initial operation status so users can detect we are ready to start test.
+            setTestOperData(this.execStatus.get(), testsCompleted);
+        } catch (final Exception e) {
+            // TODO: Use a singleton service to make sure the initial write is performed only once.
+            LOG.warn("Working around Bugs 8829 and 6793 by ignoring exception from setTestOperData: {}", e);
+        }
 
-        LOG.info("DsbenchmarkProvider Session Initiated");
+        LOG.info("DsbenchmarkProvider initiated");
     }
 
     @Override
-    public void close() throws Exception {
-        dstReg.close();
-        LOG.info("DsbenchmarkProvider Closed");
+    public void close() {
+        LOG.info("DsbenchmarkProvider closed");
     }
 
     @Override
     public Future<RpcResult<Void>> cleanupStore() {
         cleanupTestStore();
-        LOG.info("Data Store cleaned up");
-        return Futures.immediateFuture( RpcResultBuilder.<Void> success().build() );
+        LOG.debug("Data Store cleaned up");
+        return Futures.immediateFuture(RpcResultBuilder.<Void>success().build());
     }
 
     @Override
-    public Future<RpcResult<StartTestOutput>> startTest(StartTestInput input) {
+    public Future<RpcResult<StartTestOutput>> startTest(final StartTestInput input) {
         LOG.info("Starting the data store benchmark test, input: {}", input);
 
         // Check if there is a test in progress
-        if ( execStatus.compareAndSet(ExecStatus.Idle, ExecStatus.Executing) == false ) {
+        if (execStatus.compareAndSet(ExecStatus.Idle, ExecStatus.Executing) == false) {
             LOG.info("Test in progress");
             return RpcResultBuilder.success(new StartTestOutputBuilder()
                     .setStatus(StartTestOutput.Status.TESTINPROGRESS)
@@ -110,6 +114,9 @@ public class DsbenchmarkProvider implements BindingAwareProvider, DsbenchmarkSer
         // Get the appropriate writer based on operation type and data format
         DatastoreAbstractWriter dsWriter = getDatastoreWriter(input);
 
+        // Create listeners on OPERATIONAL and CONFIG test data subtrees
+        listenerProvider.createAndRegisterListeners(input.getListeners().intValue());
+
         long startTime, endTime, listCreateTime, execTime;
 
         startTime = System.nanoTime();
@@ -126,45 +133,51 @@ public class DsbenchmarkProvider implements BindingAwareProvider, DsbenchmarkSer
 
             this.testsCompleted++;
 
-        } catch ( Exception e ) {
-            LOG.error( "Test error: {}", e.toString());
-            execStatus.set( ExecStatus.Idle );
+        } catch (final Exception e) {
+            LOG.error("Test error: {}", e.toString());
+            execStatus.set(ExecStatus.Idle);
             return RpcResultBuilder.success(new StartTestOutputBuilder()
                     .setStatus(StartTestOutput.Status.FAILED)
                     .build()).buildFuture();
         }
 
         LOG.info("Test finished");
-        setTestOperData( ExecStatus.Idle, testsCompleted);
+        setTestOperData(ExecStatus.Idle, testsCompleted);
         execStatus.set(ExecStatus.Idle);
 
+        // Get the number of data change events and cleanup the data change listeners
+        long numDataChanges = listenerProvider.getDataChangeCount();
+        long numEvents = listenerProvider.getEventCountAndDestroyListeners();
+
         StartTestOutput output = new StartTestOutputBuilder()
                 .setStatus(StartTestOutput.Status.OK)
                 .setListBuildTime(listCreateTime)
                 .setExecTime(execTime)
                 .setTxOk((long)dsWriter.getTxOk())
+                .setNtfOk(numEvents)
+                .setDataChangeEventsOk(numDataChanges)
                 .setTxError((long)dsWriter.getTxError())
                 .build();
 
         return RpcResultBuilder.success(output).buildFuture();
     }
 
-    private void setTestOperData( ExecStatus sts, long tstCompl ) {
+    private void setTestOperData(final ExecStatus sts, final long tstCompl) {
         TestStatus status = new TestStatusBuilder()
                 .setExecStatus(sts)
                 .setTestsCompleted(tstCompl)
                 .build();
 
-        WriteTransaction tx = dataBroker.newWriteOnlyTransaction();
+        WriteTransaction tx = simpleTxDataBroker.newWriteOnlyTransaction();
         tx.put(LogicalDatastoreType.OPERATIONAL, TEST_STATUS_IID, status);
 
         try {
             tx.submit().checkedGet();
-        } catch (TransactionCommitFailedException e) {
+        } catch (final TransactionCommitFailedException e) {
             throw new IllegalStateException(e);
         }
 
-        LOG.info("DataStore test oper status populated: {}", status);
+        LOG.debug("DataStore test oper status populated: {}", status);
     }
 
     private void cleanupTestStore() {
@@ -172,25 +185,36 @@ public class DsbenchmarkProvider implements BindingAwareProvider, DsbenchmarkSer
                 .setOuterList(Collections.<OuterList>emptyList())
                 .build();
 
-        WriteTransaction tx = dataBroker.newWriteOnlyTransaction();
+        WriteTransaction tx = simpleTxDataBroker.newWriteOnlyTransaction();
         tx.put(LogicalDatastoreType.CONFIGURATION, TEST_EXEC_IID, data);
         try {
             tx.submit().checkedGet();
-            LOG.info("DataStore test data cleaned up");
-        } catch (TransactionCommitFailedException e) {
-            LOG.info("Failed to cleanup DataStore test data");
+            LOG.debug("DataStore config test data cleaned up");
+        } catch (final TransactionCommitFailedException e) {
+            LOG.info("Failed to cleanup DataStore configtest data");
+            throw new IllegalStateException(e);
+        }
+
+        tx = simpleTxDataBroker.newWriteOnlyTransaction();
+        tx.put(LogicalDatastoreType.OPERATIONAL, TEST_EXEC_IID, data);
+        try {
+            tx.submit().checkedGet();
+            LOG.debug("DataStore operational test data cleaned up");
+        } catch (final TransactionCommitFailedException e) {
+            LOG.info("Failed to cleanup DataStore operational test data");
             throw new IllegalStateException(e);
         }
 
     }
 
-    private DatastoreAbstractWriter getDatastoreWriter(StartTestInput input) {
+    private DatastoreAbstractWriter getDatastoreWriter(final StartTestInput input) {
 
         final DatastoreAbstractWriter retVal;
 
         StartTestInput.TransactionType txType = input.getTransactionType();
         StartTestInput.Operation oper = input.getOperation();
         StartTestInput.DataFormat dataFormat = input.getDataFormat();
+        StartTestInput.DataStore dataStore = input.getDataStore();
         int outerListElem = input.getOuterElements().intValue();
         int innerListElem = input.getInnerElements().intValue();
         int writesPerTx = input.getPutsPerTx().intValue();
@@ -199,50 +223,50 @@ public class DsbenchmarkProvider implements BindingAwareProvider, DsbenchmarkSer
             if (txType == StartTestInput.TransactionType.SIMPLETX) {
                 if (dataFormat == StartTestInput.DataFormat.BINDINGAWARE) {
                     if (StartTestInput.Operation.DELETE == oper) {
-                        retVal = new SimpletxBaDelete(this.dataBroker, outerListElem,
-                                innerListElem,writesPerTx);
+                        retVal = new SimpletxBaDelete(this.simpleTxDataBroker, outerListElem,
+                                innerListElem,writesPerTx, dataStore);
                     } else if (StartTestInput.Operation.READ == oper) {
-                        retVal = new SimpletxBaRead(this.dataBroker, outerListElem,
-                                innerListElem,writesPerTx);
+                        retVal = new SimpletxBaRead(this.simpleTxDataBroker, outerListElem,
+                                innerListElem, writesPerTx, dataStore);
                     } else {
-                        retVal = new SimpletxBaWrite(this.dataBroker, oper, outerListElem,
-                                innerListElem,writesPerTx);
+                        retVal = new SimpletxBaWrite(this.simpleTxDataBroker, oper, outerListElem,
+                                innerListElem, writesPerTx, dataStore);
                     }
                 } else {
                     if (StartTestInput.Operation.DELETE == oper) {
                         retVal = new SimpletxDomDelete(this.domDataBroker, outerListElem,
-                                innerListElem, writesPerTx);
+                                innerListElem, writesPerTx, dataStore);
                     } else if (StartTestInput.Operation.READ == oper) {
                         retVal = new SimpletxDomRead(this.domDataBroker, outerListElem,
-                                innerListElem, writesPerTx);
+                                innerListElem, writesPerTx, dataStore);
                     } else {
                         retVal = new SimpletxDomWrite(this.domDataBroker, oper, outerListElem,
-                                innerListElem,writesPerTx);
+                                innerListElem, writesPerTx, dataStore);
                     }
                 }
             } else {
                 if (dataFormat == StartTestInput.DataFormat.BINDINGAWARE) {
                     if (StartTestInput.Operation.DELETE == oper) {
-                        retVal = new TxchainBaDelete(this.bindingDataBroker, outerListElem,
-                                innerListElem, writesPerTx);
+                        retVal = new TxchainBaDelete(this.txChainDataBroker, outerListElem,
+                                innerListElem, writesPerTx, dataStore);
                     } else if (StartTestInput.Operation.READ == oper) {
-                        retVal = new TxchainBaRead(this.bindingDataBroker,outerListElem,
-                                innerListElem,writesPerTx);
+                        retVal = new TxchainBaRead(this.txChainDataBroker,outerListElem,
+                                innerListElem,writesPerTx, dataStore);
                     } else {
-                        retVal = new TxchainBaWrite(this.bindingDataBroker, oper, outerListElem,
-                                innerListElem,writesPerTx);
+                        retVal = new TxchainBaWrite(this.txChainDataBroker, oper, outerListElem,
+                                innerListElem, writesPerTx, dataStore);
                     }
                 } else {
                     if (StartTestInput.Operation.DELETE == oper) {
                         retVal = new TxchainDomDelete(this.domDataBroker, outerListElem,
-                                innerListElem, writesPerTx);
+                                innerListElem, writesPerTx, dataStore);
                     } else if (StartTestInput.Operation.READ == oper) {
                         retVal = new TxchainDomRead(this.domDataBroker, outerListElem,
-                                innerListElem, writesPerTx);
+                                innerListElem, writesPerTx, dataStore);
 
                     } else {
                         retVal = new TxchainDomWrite(this.domDataBroker, oper, outerListElem,
-                                innerListElem,writesPerTx);
+                                innerListElem,writesPerTx, dataStore);
                     }
                 }
             }