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