From 039a2d6a589a3d02ecdfb1f0d8e5f5304c5a722a Mon Sep 17 00:00:00 2001 From: Robert Varga Date: Sat, 16 Aug 2014 02:23:50 +0200 Subject: [PATCH] BUG-1493: Add test suite documentation This patch adds some sorely needed documentation. Change-Id: I2cdf5122ba861b083203f82336300736e824ca3d Signed-off-by: Robert Varga --- .../store/impl/AbstractDataChangeListenerTest.java | 12 ++++++++++-- .../impl/DefaultDataChangeListenerTestSuite.java | 8 ++++++++ 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/opendaylight/md-sal/sal-inmemory-datastore/src/test/java/org/opendaylight/controller/md/sal/dom/store/impl/AbstractDataChangeListenerTest.java b/opendaylight/md-sal/sal-inmemory-datastore/src/test/java/org/opendaylight/controller/md/sal/dom/store/impl/AbstractDataChangeListenerTest.java index 76a9354d1a..0e064cd504 100644 --- a/opendaylight/md-sal/sal-inmemory-datastore/src/test/java/org/opendaylight/controller/md/sal/dom/store/impl/AbstractDataChangeListenerTest.java +++ b/opendaylight/md-sal/sal-inmemory-datastore/src/test/java/org/opendaylight/controller/md/sal/dom/store/impl/AbstractDataChangeListenerTest.java @@ -7,8 +7,11 @@ */ package org.opendaylight.controller.md.sal.dom.store.impl; +import com.google.common.util.concurrent.MoreExecutors; + import java.util.Collection; import java.util.Map; + import org.junit.After; import org.junit.Assert; import org.junit.Before; @@ -36,8 +39,6 @@ import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContaine import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder; import org.opendaylight.yangtools.yang.model.api.SchemaContext; -import com.google.common.util.concurrent.MoreExecutors; - public abstract class AbstractDataChangeListenerTest { protected static final YangInstanceIdentifier TOP_LEVEL = YangInstanceIdentifier @@ -74,6 +75,13 @@ public abstract class AbstractDataChangeListenerTest { } } + /** + * Create a new test task. The task will operate on the backed database, + * and will use the proper background executor service. + * + * @return Test task initialized to clean up {@value #TOP_LEVEL} and its + * children. + */ public final DatastoreTestTask newTestTask() { return new DatastoreTestTask(datastore, dclExecutorService).cleanup(DatastoreTestTask .simpleDelete(TOP_LEVEL)); diff --git a/opendaylight/md-sal/sal-inmemory-datastore/src/test/java/org/opendaylight/controller/md/sal/dom/store/impl/DefaultDataChangeListenerTestSuite.java b/opendaylight/md-sal/sal-inmemory-datastore/src/test/java/org/opendaylight/controller/md/sal/dom/store/impl/DefaultDataChangeListenerTestSuite.java index 84337de419..af58f63331 100644 --- a/opendaylight/md-sal/sal-inmemory-datastore/src/test/java/org/opendaylight/controller/md/sal/dom/store/impl/DefaultDataChangeListenerTestSuite.java +++ b/opendaylight/md-sal/sal-inmemory-datastore/src/test/java/org/opendaylight/controller/md/sal/dom/store/impl/DefaultDataChangeListenerTestSuite.java @@ -13,10 +13,18 @@ import org.junit.Test; import org.opendaylight.controller.md.sal.dom.store.impl.DatastoreTestTask.WriteTransactionCustomizer; import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction; +/** + * Base template for a test suite for testing DataChangeListener functionality. + */ public abstract class DefaultDataChangeListenerTestSuite extends AbstractDataChangeListenerTest { protected static final String FOO_SIBLING = "foo-sibling"; + /** + * Callback invoked when the test suite can modify task parameters. + * + * @param task Update task configuration as needed + */ abstract protected void customizeTask(DatastoreTestTask task); @Test -- 2.36.6