2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.binding.data.codec.test;
9 import static org.junit.Assert.assertNotNull;
11 import com.google.common.base.Preconditions;
12 import java.util.HashSet;
13 import java.util.Map.Entry;
15 import javassist.ClassPool;
16 import org.junit.Before;
17 import org.junit.Test;
18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.test.augment.rev140709.TreeComplexUsesAugment;
19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.test.augment.rev140709.TreeLeafOnlyAugment;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.test.augment.rev140709.TreeLeafOnlyAugmentBuilder;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.test.binding.rev140701.Top;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.test.binding.rev140701.two.level.list.TopLevelList;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.test.binding.rev140701.two.level.list.TopLevelListBuilder;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.test.binding.rev140701.two.level.list.TopLevelListKey;
25 import org.opendaylight.yangtools.binding.data.codec.gen.impl.StreamWriterGenerator;
26 import org.opendaylight.yangtools.binding.data.codec.impl.BindingNormalizedNodeCodecRegistry;
27 import org.opendaylight.yangtools.binding.data.codec.impl.MissingClassInLoadingStrategyException;
28 import org.opendaylight.yangtools.sal.binding.generator.impl.GeneratedClassLoadingStrategy;
29 import org.opendaylight.yangtools.sal.binding.generator.impl.ModuleInfoBackedContext;
30 import org.opendaylight.yangtools.sal.binding.generator.util.BindingRuntimeContext;
31 import org.opendaylight.yangtools.sal.binding.generator.util.JavassistUtils;
32 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
33 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
35 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
36 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
39 * This sets of tests are designed in way, that schema context contains models for all
40 * augmentations, but backing class loading strategy is not aware of some of the classes, and
41 * becames aware of them after codec was used.
43 * Idea of this suite is to test that codecs will work even if situation like this happens.
46 public class AugmentationClassDiscoveredAfterCodecTest {
48 private SchemaContext schemaContext;
49 private BindingRuntimeContext runtimeContext;
50 private ClassExcludingClassLoadingStrategy mockedContext;
51 private BindingNormalizedNodeCodecRegistry registry;
55 final ModuleInfoBackedContext ctx = ModuleInfoBackedContext.create();
56 ctx.addModuleInfos(BindingReflections.loadModuleInfos());
57 mockedContext = new ClassExcludingClassLoadingStrategy(ctx);
58 schemaContext = ctx.tryToCreateSchemaContext().get();
59 runtimeContext = BindingRuntimeContext.create(mockedContext, schemaContext);
60 final JavassistUtils utils = JavassistUtils.forClassPool(ClassPool.getDefault());
61 registry = new BindingNormalizedNodeCodecRegistry(StreamWriterGenerator.create(utils));
62 registry.onBindingRuntimeContextUpdated(runtimeContext);
65 private static final TopLevelListKey TOP_FOO_KEY = new TopLevelListKey("foo");
66 private static final InstanceIdentifier<TopLevelList> BA_TOP_LEVEL_LIST = InstanceIdentifier.builder(Top.class)
67 .child(TopLevelList.class, TOP_FOO_KEY).build();
68 private static final InstanceIdentifier<TreeLeafOnlyAugment> BA_TREE_LEAF_ONLY = BA_TOP_LEVEL_LIST
69 .augmentation(TreeLeafOnlyAugment.class);
73 @Test(expected = MissingClassInLoadingStrategyException.class)
74 public void testCorrectExceptionThrown() {
75 materializeWithExclusions(TreeLeafOnlyAugment.class, TreeComplexUsesAugment.class);
76 registry.toYangInstanceIdentifier(BA_TREE_LEAF_ONLY);
81 public void testUsingBindingInstanceIdentifier() {
82 materializeWithExclusions(TreeLeafOnlyAugment.class, TreeComplexUsesAugment.class);
83 mockedContext.includeClass(TreeLeafOnlyAugment.class);
84 final YangInstanceIdentifier domYY = registry.toYangInstanceIdentifier(BA_TREE_LEAF_ONLY);
89 public void testUsingBindingData() {
90 materializeWithExclusions(TreeLeafOnlyAugment.class, TreeComplexUsesAugment.class);
91 mockedContext.includeClass(TreeLeafOnlyAugment.class);
92 final TopLevelList data =
93 new TopLevelListBuilder()
95 .addAugmentation(TreeLeafOnlyAugment.class,
96 new TreeLeafOnlyAugmentBuilder().setSimpleValue("foo").build()).build();
97 final Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> domData =
98 registry.toNormalizedNode(BA_TOP_LEVEL_LIST, data);
99 assertNotNull(domData);
103 private void materializeWithExclusions(final Class<?>... clzToExclude) {
104 for (final Class<?> clz : clzToExclude) {
105 mockedContext.excludeClass(clz);
107 registry.toYangInstanceIdentifier(BA_TOP_LEVEL_LIST);
110 private static class ClassExcludingClassLoadingStrategy extends GeneratedClassLoadingStrategy {
112 private final Set<String> exclusions = new HashSet<>();
113 private final GeneratedClassLoadingStrategy delegate;
115 void excludeClass(final Class<?> clz) {
116 exclusions.add(clz.getName());
119 void includeClass(final Class<?> clz) {
120 exclusions.remove(clz.getName());
123 protected ClassExcludingClassLoadingStrategy(final GeneratedClassLoadingStrategy delegate) {
124 this.delegate = Preconditions.checkNotNull(delegate);
128 public Class<?> loadClass(final String fullyQualifiedName) throws ClassNotFoundException {
129 if (exclusions.contains(fullyQualifiedName)) {
130 throw new ClassNotFoundException(String.format("Class %s is not available for test reasons.",
131 fullyQualifiedName));
133 return delegate.loadClass(fullyQualifiedName);