opendaylight/md-sal/sal-inmemory-datastore/src/test/java/org/opendaylight/controller/md/sal/dom/store/impl/DefaultDataChangeListenerTestSuite.java

   1 /*
   2  * Copyright (c) 2014 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.md.sal.dom.store.impl;
   9
  10 import org.junit.Test;
  11
  12 /**
  13  * Base template for a test suite for testing DataChangeListener functionality.
  14  */
  15 public abstract class DefaultDataChangeListenerTestSuite extends AbstractDataChangeListenerTest {
  16
  17     protected static final String FOO_SIBLING = "foo-sibling";
  18
  19     /**
  20      * Callback invoked when the test suite can modify task parameters.
  21      *
  22      * @param task Update task configuration as needed
  23      */
  24     protected abstract void customizeTask(DatastoreTestTask task);
  25
  26     @Test
  27     public final void putTopLevelOneNested() throws Exception {
  28
  29         DatastoreTestTask task = newTestTask().test(writeOneTopMultipleNested(FOO, BAR));
  30         customizeTask(task);
  31         task.run();
  32         putTopLevelOneNested(task);
  33     }
  34
  35     protected abstract void putTopLevelOneNested(DatastoreTestTask task) throws Exception;
  36
  37     @Test
  38     public final void existingTopWriteSibling() throws Exception {
  39         DatastoreTestTask task = newTestTask().setup(writeOneTopMultipleNested(FOO)).test(
  40             tx -> tx.write(path(FOO_SIBLING), topLevelList(FOO_SIBLING).build()));
  41         customizeTask(task);
  42         task.run();
  43         existingTopWriteSibling(task);
  44     }
  45
  46     protected abstract void existingTopWriteSibling(DatastoreTestTask task) throws Exception;
  47
  48     @Test
  49     public final void existingTopWriteTwoNested() throws Exception {
  50         DatastoreTestTask task = newTestTask().setup(writeOneTopMultipleNested(FOO)).test(
  51             tx -> {
  52                 tx.write(path(FOO,BAR), nestedList(BAR).build());
  53                 tx.write(path(FOO,BAZ), nestedList(BAZ).build());
  54             });
  55         customizeTask(task);
  56         task.run();
  57         existingTopWriteTwoNested(task);
  58     }
  59
  60     protected abstract void existingTopWriteTwoNested(DatastoreTestTask task) throws Exception;
  61
  62
  63     @Test
  64     public final void existingOneNestedWriteAdditionalNested() throws Exception {
  65         DatastoreTestTask task = newTestTask().setup(writeOneTopMultipleNested(FOO, BAR)).test(
  66             tx -> tx.write(path(FOO,BAZ), nestedList(BAZ).build()));
  67         customizeTask(task);
  68         task.run();
  69         existingOneNestedWriteAdditionalNested(task);
  70     }
  71
  72     protected abstract void existingOneNestedWriteAdditionalNested(DatastoreTestTask task) throws Exception;
  73
  74     @Test
  75     public final void replaceTopLevelNestedChanged() throws Exception {
  76         DatastoreTestTask task = newTestTask().setup(writeOneTopMultipleNested(FOO, BAR)).test(
  77                 writeOneTopMultipleNested(FOO, BAZ));
  78         customizeTask(task);
  79         task.run();
  80         replaceTopLevelNestedChanged(task);
  81     }
  82
  83     protected abstract void replaceTopLevelNestedChanged(DatastoreTestTask task) throws Exception;
  84
  85     @Test
  86     public final void putTopLevelWithTwoNested() throws Exception {
  87
  88         DatastoreTestTask task = newTestTask().test(writeOneTopMultipleNested(FOO, BAR, BAZ));
  89         customizeTask(task);
  90         task.run();
  91         putTopLevelWithTwoNested(task);
  92     }
  93
  94     protected abstract void putTopLevelWithTwoNested(DatastoreTestTask task) throws Exception;
  95
  96     @Test
  97     public final void twoNestedExistsOneIsDeleted() throws Exception {
  98
  99         DatastoreTestTask task = newTestTask().setup(writeOneTopMultipleNested(FOO, BAR, BAZ)).test(
 100                 deleteNested(FOO, BAZ));
 101         customizeTask(task);
 102         task.run();
 103         twoNestedExistsOneIsDeleted(task);
 104     }
 105
 106     protected abstract void twoNestedExistsOneIsDeleted(DatastoreTestTask task) throws Exception;
 107
 108     @Test
 109     public final void nestedListExistsRootDeleted() throws Exception {
 110
 111         DatastoreTestTask task = newTestTask().cleanup(null).setup(writeOneTopMultipleNested(FOO, BAR, BAZ))
 112                 .test(DatastoreTestTask.simpleDelete(TOP_LEVEL));
 113         customizeTask(task);
 114         task.run();
 115         nestedListExistsRootDeleted(task);
 116     }
 117
 118     protected abstract void nestedListExistsRootDeleted(DatastoreTestTask task) throws Exception;
 119 }