binding/mdsal-binding-dom-codec/src/test/java/org/opendaylight/mdsal/binding/dom/codec/impl/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.impl;
   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.ImmutableMap;
  18 import com.google.common.collect.ImmutableSet;
  19 import java.util.Collection;
  20 import java.util.Map;
  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 Map<TopLevelListKey, TopLevelList> TWO_LIST = createList(2);
  51     private static final Map<TopLevelListKey, 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 = codecContext.getSubtreeCodec(TOP_PATH);
  77         contNode = codecContext.getSubtreeCodec(CONT_PATH);
  78     }
  79
  80     private static Map<TopLevelListKey, TopLevelList> createList(final int num) {
  81         final ImmutableMap.Builder<TopLevelListKey, TopLevelList> builder = ImmutableMap.builder();
  82         for (int i = 0; i < num; i++) {
  83             final TopLevelListKey key = new TopLevelListKey("test-" + i);
  84             builder.put(key, new TopLevelListBuilder().withKey(key).build());
  85         }
  86         return builder.build();
  87     }
  88
  89     @Test
  90     public void testListCache() {
  91         final BindingNormalizedNodeCachingCodec<Top> cachingCodec = createCachingCodec(TopLevelList.class);
  92         final NormalizedNode<?, ?> first = cachingCodec.serialize(TOP_TWO_LIST_DATA);
  93         final NormalizedNode<?, ?> second = cachingCodec.serialize(TOP_TWO_LIST_DATA);
  94
  95         assertNotSame(first, second);
  96         assertEquals(first, second);
  97         verifyListItemSame(first, second);
  98
  99         final NormalizedNode<?, ?> third = cachingCodec.serialize(TOP_THREE_LIST_DATA);
 100         verifyListItemSame(first, third);
 101         verifyListItemSame(second, third);
 102     }
 103
 104     @Test
 105     public void testTopAndListCache() {
 106         final BindingNormalizedNodeCachingCodec<Top> cachingCodec = createCachingCodec(Top.class, TopLevelList.class);
 107         final NormalizedNode<?, ?> first = cachingCodec.serialize(TOP_TWO_LIST_DATA);
 108         final NormalizedNode<?, ?> second = cachingCodec.serialize(TOP_TWO_LIST_DATA);
 109
 110         assertEquals(first, second);
 111         assertSame(first, second);
 112
 113         final NormalizedNode<?, ?> third = cachingCodec.serialize(TOP_THREE_LIST_DATA);
 114         verifyListItemSame(first, third);
 115     }
 116
 117     @Test
 118     public void testLeafCache() {
 119         // The integers should be distinct
 120         assertNotSame(CONT_DATA.getCaching().getValue(), CONT2_DATA.getCaching().getValue());
 121
 122         final BindingNormalizedNodeCachingCodec<Cont> cachingCodec = createContCachingCodec(Cont.class, MyType.class);
 123         final NormalizedNode<?, ?> first = cachingCodec.serialize(CONT_DATA);
 124         final NormalizedNode<?, ?> second = cachingCodec.serialize(CONT2_DATA);
 125
 126         assertNotEquals(first, second);
 127         verifyLeafItemSame(first, second);
 128     }
 129
 130     @Test
 131     public void testDefaultInvocation() {
 132         final BindingNormalizedNodeCachingCodec<Top> cachingCodec = createCachingCodec(Top.class, TopLevelList.class);
 133
 134         final Top input = new TopBuilder().build();
 135         assertNull(input.getTopLevelList());
 136         assertEquals(ImmutableMap.of(), input.nonnullTopLevelList());
 137
 138         final NormalizedNode<?, ?> dom = cachingCodec.serialize(input);
 139         final Top output = cachingCodec.deserialize(dom);
 140         assertTrue(input.equals(output));
 141         assertTrue(output.equals(input));
 142
 143         assertNull(output.getTopLevelList());
 144         assertEquals(ImmutableMap.of(), output.nonnullTopLevelList());
 145     }
 146
 147     @SafeVarargs
 148     private final BindingNormalizedNodeCachingCodec<Top> createCachingCodec(
 149             final Class<? extends DataObject>... classes) {
 150         return topNode.createCachingCodec(ImmutableSet.copyOf(classes));
 151     }
 152
 153     @SafeVarargs
 154     private final BindingNormalizedNodeCachingCodec<Cont> createContCachingCodec(
 155             final Class<? extends BindingObject>... classes) {
 156         return contNode.createCachingCodec(ImmutableSet.copyOf(classes));
 157     }
 158
 159     private static void verifyListItemSame(final NormalizedNode<?, ?> firstTop, final NormalizedNode<?, ?> secondTop) {
 160         final Collection<MapEntryNode> initialNodes = getListItems(firstTop).getValue();
 161         final MapNode secondMap = getListItems(secondTop);
 162
 163         for (final MapEntryNode initial : initialNodes) {
 164             final MapEntryNode second = secondMap.getChild(initial.getIdentifier()).get();
 165             assertEquals(initial, second);
 166             assertSame(initial, second);
 167         }
 168     }
 169
 170     private static MapNode getListItems(final NormalizedNode<?, ?> top) {
 171         return (MapNode) ((DataContainerNode<?>) top).getChild(TOP_LEVEL_LIST_ARG).get();
 172     }
 173
 174     private static void verifyLeafItemSame(final NormalizedNode<?, ?> firstCont,
 175             final NormalizedNode<?, ?> secondCont) {
 176         final DataContainerChild<?, ?> first = ((DataContainerNode<?>) firstCont).getChild(LEAF_ARG).get();
 177         assertTrue(first instanceof LeafNode);
 178
 179         final DataContainerChild<?, ?> second = ((DataContainerNode<?>) secondCont).getChild(LEAF_ARG).get();
 180         assertTrue(second instanceof LeafNode);
 181
 182         if (LazyLeafOperations.isEnabled()) {
 183             // The leaf nodes are transient, but the values should be the same
 184             assertEquals(first, second);
 185             assertSame(first.getValue(), second.getValue());
 186         } else {
 187             assertSame(first, second);
 188         }
 189     }
 190 }