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.DataContainerChild;
  39 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
  40 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  41 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  42 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  43 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  44 import org.opendaylight.yangtools.yang.data.impl.schema.nodes.LazyLeafOperations;
  45
  46 public class CachingCodecTest extends AbstractBindingCodecTest {
  47
  48     private static final NodeIdentifier TOP_LEVEL_LIST_ARG = new NodeIdentifier(TopLevelList.QNAME);
  49     private static final InstanceIdentifier<Top> TOP_PATH = InstanceIdentifier.create(Top.class);
  50     private static final List<TopLevelList> TWO_LIST = createList(2);
  51     private static final List<TopLevelList> THREE_LIST = createList(3);
  52
  53     private static final Top TOP_TWO_LIST_DATA = new TopBuilder().setTopLevelList(TWO_LIST).build();
  54     private static final Top TOP_THREE_LIST_DATA = new TopBuilder().setTopLevelList(THREE_LIST).build();
  55
  56     private static final NodeIdentifier LEAF_ARG = new NodeIdentifier(QName.create(Cont.QNAME, "caching"));
  57     private static final InstanceIdentifier<Cont> CONT_PATH = InstanceIdentifier.create(Cont.class);
  58
  59     private static final Cont CONT_DATA = new ContBuilder().setCaching(new MyType(dataValue())).setNonCaching("test")
  60             .build();
  61     private static final Cont CONT2_DATA = new ContBuilder().setCaching(new MyType(dataValue())).setNonCaching("test2")
  62             .build();
  63
  64     private BindingDataObjectCodecTreeNode<Top> topNode;
  65     private BindingDataObjectCodecTreeNode<Cont> contNode;
  66
  67     private static String dataValue() {
  68         // We are battling interning here
  69         return new StringBuilder("foo").toString();
  70     }
  71
  72     @Override
  73     @Before
  74     public void before() {
  75         super.before();
  76         topNode = registry.getCodecContext().getSubtreeCodec(TOP_PATH);
  77         contNode = registry.getCodecContext().getSubtreeCodec(CONT_PATH);
  78     }
  79
  80     private static List<TopLevelList> createList(final int num) {
  81
  82         final ImmutableList.Builder<TopLevelList> builder = ImmutableList.builder();
  83         for (int i = 0; i < num; i++) {
  84             final TopLevelListKey key = new TopLevelListKey("test-" + i);
  85             builder.add(new TopLevelListBuilder().withKey(key).build());
  86         }
  87         return builder.build();
  88     }
  89
  90     @Test
  91     public void testListCache() {
  92         final BindingNormalizedNodeCachingCodec<Top> cachingCodec = createCachingCodec(TopLevelList.class);
  93         final NormalizedNode<?, ?> first = cachingCodec.serialize(TOP_TWO_LIST_DATA);
  94         final NormalizedNode<?, ?> second = cachingCodec.serialize(TOP_TWO_LIST_DATA);
  95
  96         assertNotSame(first, second);
  97         assertEquals(first, second);
  98         verifyListItemSame(first, second);
  99
 100         final NormalizedNode<?, ?> third = cachingCodec.serialize(TOP_THREE_LIST_DATA);
 101         verifyListItemSame(first, third);
 102         verifyListItemSame(second, third);
 103     }
 104
 105     @Test
 106     public void testTopAndListCache() {
 107         final BindingNormalizedNodeCachingCodec<Top> cachingCodec = createCachingCodec(Top.class, TopLevelList.class);
 108         final NormalizedNode<?, ?> first = cachingCodec.serialize(TOP_TWO_LIST_DATA);
 109         final NormalizedNode<?, ?> second = cachingCodec.serialize(TOP_TWO_LIST_DATA);
 110
 111         assertEquals(first, second);
 112         assertSame(first, second);
 113
 114         final NormalizedNode<?, ?> third = cachingCodec.serialize(TOP_THREE_LIST_DATA);
 115         verifyListItemSame(first, third);
 116     }
 117
 118     @Test
 119     public void testLeafCache() {
 120         // The integers should be distinct
 121         assertNotSame(CONT_DATA.getCaching().getValue(), CONT2_DATA.getCaching().getValue());
 122
 123         final BindingNormalizedNodeCachingCodec<Cont> cachingCodec = createContCachingCodec(Cont.class, MyType.class);
 124         final NormalizedNode<?, ?> first = cachingCodec.serialize(CONT_DATA);
 125         final NormalizedNode<?, ?> second = cachingCodec.serialize(CONT2_DATA);
 126
 127         assertNotEquals(first, second);
 128         verifyLeafItemSame(first, second);
 129     }
 130
 131     @Test
 132     public void testDefaultInvocation() {
 133         final BindingNormalizedNodeCachingCodec<Top> cachingCodec = createCachingCodec(Top.class, TopLevelList.class);
 134
 135         final Top input = new TopBuilder().build();
 136         assertNull(input.getTopLevelList());
 137         assertEquals(ImmutableList.of(), input.nonnullTopLevelList());
 138
 139         final NormalizedNode<?, ?> dom = cachingCodec.serialize(input);
 140         final Top output = cachingCodec.deserialize(dom);
 141         assertTrue(input.equals(output));
 142         assertTrue(output.equals(input));
 143
 144         assertNull(output.getTopLevelList());
 145         assertEquals(ImmutableList.of(), output.nonnullTopLevelList());
 146     }
 147
 148     @SafeVarargs
 149     private final BindingNormalizedNodeCachingCodec<Top> createCachingCodec(
 150             final Class<? extends DataObject>... classes) {
 151         return topNode.createCachingCodec(ImmutableSet.copyOf(classes));
 152     }
 153
 154     @SafeVarargs
 155     private final BindingNormalizedNodeCachingCodec<Cont> createContCachingCodec(
 156             final Class<? extends BindingObject>... classes) {
 157         return contNode.createCachingCodec(ImmutableSet.copyOf(classes));
 158     }
 159
 160     private static void verifyListItemSame(final NormalizedNode<?, ?> firstTop, final NormalizedNode<?, ?> secondTop) {
 161         final Collection<MapEntryNode> initialNodes = getListItems(firstTop).getValue();
 162         final MapNode secondMap = getListItems(secondTop);
 163
 164         for (final MapEntryNode initial : initialNodes) {
 165             final MapEntryNode second = secondMap.getChild(initial.getIdentifier()).get();
 166             assertEquals(initial, second);
 167             assertSame(initial, second);
 168         }
 169     }
 170
 171     private static MapNode getListItems(final NormalizedNode<?, ?> top) {
 172         return (MapNode) ((DataContainerNode<?>) top).getChild(TOP_LEVEL_LIST_ARG).get();
 173     }
 174
 175     private static void verifyLeafItemSame(final NormalizedNode<?, ?> firstCont,
 176             final NormalizedNode<?, ?> secondCont) {
 177         final DataContainerChild<?, ?> first = ((DataContainerNode<?>) firstCont).getChild(LEAF_ARG).get();
 178         assertTrue(first instanceof LeafNode);
 179
 180         final DataContainerChild<?, ?> second = ((DataContainerNode<?>) secondCont).getChild(LEAF_ARG).get();
 181         assertTrue(second instanceof LeafNode);
 182
 183         if (LazyLeafOperations.isEnabled()) {
 184             // The leaf nodes are transient, but the values should be the same
 185             assertEquals(first, second);
 186             assertSame(first.getValue(), second.getValue());
 187         } else {
 188             assertSame(first, second);
 189         }
 190     }
 191 }