dom/mdsal-dom-api/src/test/java/org/opendaylight/mdsal/dom/api/AbstractDOMDataTreeServiceTestSuite.java

   1 /*
   2  * Copyright (c) 2015 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.mdsal.dom.api;
   9
  10 import static org.junit.Assert.assertNotNull;
  11
  12 import com.google.common.util.concurrent.ListenableFuture;
  13 import java.net.URI;
  14 import java.util.Collections;
  15 import java.util.concurrent.ExecutionException;
  16 import org.eclipse.jdt.annotation.NonNull;
  17 import org.junit.Test;
  18 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  19 import org.opendaylight.yangtools.yang.common.QName;
  20 import org.opendaylight.yangtools.yang.common.QNameModule;
  21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  23 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
  24
  25 /**
  26  * Abstract test suite demonstrating various access patterns on how a {@link DOMDataTreeService}
  27  * can be used.
  28  */
  29 public abstract class AbstractDOMDataTreeServiceTestSuite {
  30     protected static final QNameModule TEST_MODULE =
  31             QNameModule.create(URI.create("urn:opendaylight:params:xml:ns:yang:controller:md:sal:test:store"));
  32
  33     protected static final YangInstanceIdentifier UNORDERED_CONTAINER_IID = YangInstanceIdentifier.create(
  34         new NodeIdentifier(QName.create(TEST_MODULE, "lists")),
  35         new NodeIdentifier(QName.create(TEST_MODULE, "unordered-container")));
  36     protected static final DOMDataTreeIdentifier UNORDERED_CONTAINER_TREE
  37         = new DOMDataTreeIdentifier(LogicalDatastoreType.OPERATIONAL, UNORDERED_CONTAINER_IID);
  38
  39     /**
  40      * Return a reference to the service used in this test. The instance
  41      * needs to be reused within the same test and must be isolated between
  42      * tests.
  43      *
  44      * @return {@link DOMDataTreeService} instance.
  45      */
  46     protected abstract @NonNull DOMDataTreeService service();
  47
  48     /**
  49      * A simple unbound producer. It write some basic things into the data store based on the
  50      * test model.
  51      *
  52      * @throws DOMDataTreeProducerException when this exceptional condition happens
  53      */
  54     @Test
  55     public final void testBasicProducer() throws DOMDataTreeProducerException, InterruptedException,
  56            ExecutionException {
  57         // Create a producer. It is an AutoCloseable resource, hence the try-with pattern
  58         try (DOMDataTreeProducer prod =
  59                 service().createProducer(Collections.singleton(UNORDERED_CONTAINER_TREE))) {
  60             assertNotNull(prod);
  61
  62             final DOMDataTreeCursorAwareTransaction tx = prod.createTransaction(true);
  63             assertNotNull(tx);
  64
  65             final DOMDataTreeWriteCursor cursor =
  66                     tx.createCursor(new DOMDataTreeIdentifier(
  67                             LogicalDatastoreType.OPERATIONAL, UNORDERED_CONTAINER_IID));
  68             assertNotNull(cursor);
  69             cursor.write(UNORDERED_CONTAINER_IID.getLastPathArgument(), ImmutableContainerNodeBuilder.create().build());
  70             cursor.close();
  71
  72             final ListenableFuture<?> f = tx.commit();
  73             assertNotNull(f);
  74
  75             f.get();
  76         }
  77     }
  78
  79     // TODO: simple listener
  80 }