binding/mdsal-binding-dom-codec/src/test/java/org/opendaylight/mdsal/binding/dom/codec/test/CachingCodecTest.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.binding.dom.codec.test;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertNotEquals;
  12 import static org.junit.Assert.assertNotSame;
  13 import static org.junit.Assert.assertNull;
  14 import static org.junit.Assert.assertSame;
  15 import static org.junit.Assert.assertTrue;
  16
  17 import com.google.common.collect.ImmutableList;
  18 import com.google.common.collect.ImmutableSet;
  19 import java.util.Collection;
  20 import java.util.List;
  21 import org.junit.Before;
  22 import org.junit.Test;
  23 import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
  24 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeCachingCodec;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.test.binding.rev140701.Top;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.test.binding.rev140701.TopBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.test.binding.rev140701.two.level.list.TopLevelList;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.test.binding.rev140701.two.level.list.TopLevelListBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.test.binding.rev140701.two.level.list.TopLevelListKey;
  30 import org.opendaylight.yang.gen.v1.urn.test.leaf.caching.codec.rev190201.Cont;
  31 import org.opendaylight.yang.gen.v1.urn.test.leaf.caching.codec.rev190201.ContBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.test.leaf.caching.codec.rev190201.MyType;
  33 import org.opendaylight.yangtools.yang.binding.BindingObject;
  34 import org.opendaylight.yangtools.yang.binding.DataObject;
  35 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  36 import org.opendaylight.yangtools.yang.common.QName;
  37 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  38 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
  39 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  40 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  41 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  42
  43 public class CachingCodecTest extends AbstractBindingCodecTest {
  44
  45     private static final NodeIdentifier TOP_LEVEL_LIST_ARG = new NodeIdentifier(TopLevelList.QNAME);
  46     private static final InstanceIdentifier<Top> TOP_PATH = InstanceIdentifier.create(Top.class);
  47     private static final List<TopLevelList> TWO_LIST = createList(2);
  48     private static final List<TopLevelList> THREE_LIST = createList(3);
  49
  50     private static final Top TOP_TWO_LIST_DATA = new TopBuilder().setTopLevelList(TWO_LIST).build();
  51     private static final Top TOP_THREE_LIST_DATA = new TopBuilder().setTopLevelList(THREE_LIST).build();
  52
  53     private static final NodeIdentifier LEAF_ARG = new NodeIdentifier(QName.create(Cont.QNAME, "caching"));
  54     private static final InstanceIdentifier<Cont> CONT_PATH = InstanceIdentifier.create(Cont.class);
  55     private static final Cont CONT_DATA = new ContBuilder().setCaching(new MyType(1)).setNonCaching("test").build();
  56     private static final Cont CONT2_DATA = new ContBuilder().setCaching(new MyType(1)).setNonCaching("test2").build();
  57
  58     private BindingDataObjectCodecTreeNode<Top> topNode;
  59     private BindingDataObjectCodecTreeNode<Cont> contNode;
  60
  61     @Override
  62     @Before
  63     public void before() {
  64         super.before();
  65         topNode = registry.getCodecContext().getSubtreeCodec(TOP_PATH);
  66         contNode = registry.getCodecContext().getSubtreeCodec(CONT_PATH);
  67     }
  68
  69     private static List<TopLevelList> createList(final int num) {
  70
  71         final ImmutableList.Builder<TopLevelList> builder = ImmutableList.builder();
  72         for (int i = 0; i < num; i++) {
  73             final TopLevelListKey key = new TopLevelListKey("test-" + i);
  74             builder.add(new TopLevelListBuilder().withKey(key).build());
  75         }
  76         return builder.build();
  77     }
  78
  79     @Test
  80     public void testListCache() {
  81         final BindingNormalizedNodeCachingCodec<Top> cachingCodec = createCachingCodec(TopLevelList.class);
  82         final NormalizedNode<?, ?> first = cachingCodec.serialize(TOP_TWO_LIST_DATA);
  83         final NormalizedNode<?, ?> second = cachingCodec.serialize(TOP_TWO_LIST_DATA);
  84
  85         assertNotSame(first, second);
  86         assertEquals(first, second);
  87         verifyListItemSame(first, second);
  88
  89         final NormalizedNode<?, ?> third = cachingCodec.serialize(TOP_THREE_LIST_DATA);
  90         verifyListItemSame(first, third);
  91         verifyListItemSame(second, third);
  92     }
  93
  94     @Test
  95     public void testTopAndListCache() {
  96         final BindingNormalizedNodeCachingCodec<Top> cachingCodec = createCachingCodec(Top.class, TopLevelList.class);
  97         final NormalizedNode<?, ?> first = cachingCodec.serialize(TOP_TWO_LIST_DATA);
  98         final NormalizedNode<?, ?> second = cachingCodec.serialize(TOP_TWO_LIST_DATA);
  99
 100         assertEquals(first, second);
 101         assertSame(first, second);
 102
 103         final NormalizedNode<?, ?> third = cachingCodec.serialize(TOP_THREE_LIST_DATA);
 104         verifyListItemSame(first, third);
 105     }
 106
 107     @Test
 108     public void testLeafCache() {
 109         final BindingNormalizedNodeCachingCodec<Cont> cachingCodec = createContCachingCodec(Cont.class, MyType.class);
 110         final NormalizedNode<?, ?> first = cachingCodec.serialize(CONT_DATA);
 111         final NormalizedNode<?, ?> second = cachingCodec.serialize(CONT2_DATA);
 112
 113         assertNotEquals(first, second);
 114         verifyLeafItemSame(first, second);
 115     }
 116
 117     @Test
 118     public void testDefaultInvocation() {
 119         final BindingNormalizedNodeCachingCodec<Top> cachingCodec = createCachingCodec(Top.class, TopLevelList.class);
 120
 121         final Top input = new TopBuilder().build();
 122         assertNull(input.getTopLevelList());
 123         assertEquals(ImmutableList.of(), input.nonnullTopLevelList());
 124
 125         final NormalizedNode<?, ?> dom = cachingCodec.serialize(input);
 126         final Top output = cachingCodec.deserialize(dom);
 127         assertTrue(input.equals(output));
 128         assertTrue(output.equals(input));
 129
 130         assertNull(output.getTopLevelList());
 131         assertEquals(ImmutableList.of(), output.nonnullTopLevelList());
 132     }
 133
 134     @SafeVarargs
 135     private final BindingNormalizedNodeCachingCodec<Top> createCachingCodec(
 136             final Class<? extends DataObject>... classes) {
 137         return topNode.createCachingCodec(ImmutableSet.copyOf(classes));
 138     }
 139
 140     @SafeVarargs
 141     private final BindingNormalizedNodeCachingCodec<Cont> createContCachingCodec(
 142             final Class<? extends BindingObject>... classes) {
 143         return contNode.createCachingCodec(ImmutableSet.copyOf(classes));
 144     }
 145
 146     private static void verifyListItemSame(final NormalizedNode<?, ?> firstTop, final NormalizedNode<?, ?> secondTop) {
 147         final Collection<MapEntryNode> initialNodes = getListItems(firstTop).getValue();
 148         final MapNode secondMap = getListItems(secondTop);
 149
 150         for (final MapEntryNode initial : initialNodes) {
 151             final MapEntryNode second = secondMap.getChild(initial.getIdentifier()).get();
 152             assertEquals(initial, second);
 153             assertSame(initial, second);
 154         }
 155     }
 156
 157     private static MapNode getListItems(final NormalizedNode<?, ?> top) {
 158         return (MapNode) ((DataContainerNode<?>) top).getChild(TOP_LEVEL_LIST_ARG).get();
 159     }
 160
 161     private static void verifyLeafItemSame(final NormalizedNode<?, ?> firstCont,
 162             final NormalizedNode<?, ?> secondCont) {
 163         assertSame(((DataContainerNode<?>) firstCont).getChild(LEAF_ARG).get(),
 164                 ((DataContainerNode<?>) secondCont).getChild(LEAF_ARG).get());
 165     }
 166 }