2 * Copyright (c) 2016 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.yanglib.impl;
10 import static org.junit.Assert.assertEquals;
11 import static org.mockito.ArgumentMatchers.any;
12 import static org.mockito.ArgumentMatchers.eq;
13 import static org.mockito.Mockito.doNothing;
14 import static org.mockito.Mockito.doReturn;
15 import static org.mockito.Mockito.times;
16 import static org.mockito.Mockito.verify;
17 import static org.mockito.Mockito.verifyZeroInteractions;
18 import static org.mockito.Mockito.when;
19 import static org.opendaylight.mdsal.common.api.CommitInfo.emptyFluentFuture;
22 import java.io.IOException;
23 import java.util.ArrayList;
24 import java.util.Collections;
25 import java.util.HashMap;
26 import java.util.List;
28 import org.apache.commons.io.FileUtils;
29 import org.junit.AfterClass;
30 import org.junit.Before;
31 import org.junit.BeforeClass;
32 import org.junit.Test;
33 import org.mockito.ArgumentCaptor;
34 import org.mockito.Mock;
35 import org.mockito.MockitoAnnotations;
36 import org.opendaylight.mdsal.binding.api.DataBroker;
37 import org.opendaylight.mdsal.binding.api.WriteTransaction;
38 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.ModulesState;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.ModulesStateBuilder;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.RevisionIdentifier;
43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.RevisionUtils;
44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.module.list.CommonLeafs.Revision;
45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.module.list.Module;
46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.module.list.ModuleBuilder;
47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.module.list.ModuleKey;
48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.YangIdentifier;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.yanglib.impl.rev141210.YanglibConfig;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.yanglib.impl.rev141210.YanglibConfigBuilder;
51 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
52 import org.opendaylight.yangtools.yang.common.Uint32;
53 import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
54 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
55 import org.opendaylight.yangtools.yang.model.repo.api.YinSchemaSourceRepresentation;
56 import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource;
57 import org.opendaylight.yangtools.yang.parser.impl.YangParserFactoryImpl;
58 import org.opendaylight.yangtools.yang.parser.rfc7950.repo.ASTSchemaSource;
60 public class YangLibProviderTest {
61 private static final File CACHE_DIR = new File("target/yanglib");
64 private DataBroker dataBroker;
67 private WriteTransaction writeTransaction;
69 private YangLibProvider yangLibProvider;
72 public static void staticSetup() {
73 if (!CACHE_DIR.exists() && !CACHE_DIR.mkdirs()) {
74 throw new RuntimeException("Failed to create " + CACHE_DIR);
79 public static void staticCleanup() {
80 FileUtils.deleteQuietly(CACHE_DIR);
85 MockitoAnnotations.initMocks(this);
88 if (CACHE_DIR.exists()) {
89 FileUtils.cleanDirectory(CACHE_DIR);
91 } catch (IOException e) {
95 final YanglibConfig yanglibConfig = new YanglibConfigBuilder().setBindingAddr("www.fake.com")
96 .setBindingPort(Uint32.valueOf(300)).setCacheFolder(CACHE_DIR.getAbsolutePath()).build();
97 yangLibProvider = new YangLibProvider(yanglibConfig, dataBroker, new YangParserFactoryImpl());
101 public void testSchemaSourceRegistered() {
102 yangLibProvider.init();
103 when(dataBroker.newWriteOnlyTransaction()).thenReturn(writeTransaction);
104 doNothing().when(writeTransaction)
105 .merge(eq(LogicalDatastoreType.OPERATIONAL), eq(InstanceIdentifier.create(ModulesState.class)), any());
107 List<PotentialSchemaSource<?>> list = new ArrayList<>();
109 PotentialSchemaSource.create(
110 RevisionSourceIdentifier.create("no-revision"),
111 YangTextSchemaSource.class, PotentialSchemaSource.Costs.IMMEDIATE.getValue()));
114 PotentialSchemaSource.create(
115 RevisionSourceIdentifier.create("with-revision",
116 org.opendaylight.yangtools.yang.common.Revision.of("2016-04-28")),
117 YangTextSchemaSource.class, PotentialSchemaSource.Costs.IMMEDIATE.getValue()));
119 doReturn(emptyFluentFuture()).when(writeTransaction).commit();
120 yangLibProvider.schemaSourceRegistered(list);
122 Map<ModuleKey, Module> newModulesList = new HashMap<>();
124 Module newModule = new ModuleBuilder()
125 .setName(new YangIdentifier("no-revision"))
126 .setRevision(RevisionUtils.emptyRevision())
127 .setSchema(new Uri("http://www.fake.com:300/yanglib/schemas/no-revision/"))
130 newModulesList.put(newModule.key(), newModule);
132 newModule = new ModuleBuilder()
133 .setName(new YangIdentifier("with-revision"))
134 .setRevision(new Revision(new RevisionIdentifier("2016-04-28")))
135 .setSchema(new Uri("http://www.fake.com:300/yanglib/schemas/with-revision/2016-04-28"))
138 newModulesList.put(newModule.key(), newModule);
140 verify(dataBroker).newWriteOnlyTransaction();
141 verify(writeTransaction).merge(eq(LogicalDatastoreType.OPERATIONAL),
142 eq(InstanceIdentifier.create(ModulesState.class)),
143 eq(new ModulesStateBuilder().setModule(newModulesList).build()));
144 verify(writeTransaction).commit();
148 public void testFilteringNonYangSchemaSourceRegistered() {
149 yangLibProvider.init();
151 // test empty list of schema sources registered
152 List<PotentialSchemaSource<?>> potentialSources = Collections.emptyList();
153 yangLibProvider.schemaSourceRegistered(potentialSources);
155 verifyZeroInteractions(dataBroker, writeTransaction);
157 // test list of non yang schema sources registered
158 // expected behavior is to do nothing
159 potentialSources = new ArrayList<>();
160 potentialSources.add(
161 PotentialSchemaSource.create(
162 RevisionSourceIdentifier.create("yin-source-representation"),
163 YinSchemaSourceRepresentation.class, PotentialSchemaSource.Costs.IMMEDIATE.getValue()));
165 potentialSources.add(
166 PotentialSchemaSource.create(
167 RevisionSourceIdentifier.create("asts-schema-source"),
168 ASTSchemaSource.class, PotentialSchemaSource.Costs.IMMEDIATE.getValue()));
170 yangLibProvider.schemaSourceRegistered(potentialSources);
171 verifyZeroInteractions(dataBroker, writeTransaction);
173 // add yang schema source to list
174 potentialSources.add(
175 PotentialSchemaSource.create(
176 RevisionSourceIdentifier.create("yang-schema-source"),
177 YangTextSchemaSource.class, PotentialSchemaSource.Costs.IMMEDIATE.getValue()));
179 when(dataBroker.newWriteOnlyTransaction()).thenReturn(writeTransaction);
180 doReturn(emptyFluentFuture()).when(writeTransaction).commit();
181 yangLibProvider.schemaSourceRegistered(potentialSources);
182 verify(dataBroker).newWriteOnlyTransaction();
184 ArgumentCaptor<ModulesState> modulesStateCaptor = ArgumentCaptor.forClass(ModulesState.class);
185 verify(writeTransaction).merge(eq(LogicalDatastoreType.OPERATIONAL),
186 eq(InstanceIdentifier.create(ModulesState.class)), modulesStateCaptor.capture());
187 assertEquals(modulesStateCaptor.getValue().getModule().size(), 1);
188 verify(writeTransaction).commit();
192 public void testNonYangSchemaSourceUnregistered() {
193 yangLibProvider.init();
195 final PotentialSchemaSource<YinSchemaSourceRepresentation> nonYangSource =
196 PotentialSchemaSource.create(
197 RevisionSourceIdentifier.create("yin-source-representation"),
198 YinSchemaSourceRepresentation.class, PotentialSchemaSource.Costs.IMMEDIATE.getValue());
200 yangLibProvider.schemaSourceUnregistered(nonYangSource);
202 // expected behaviour is to do nothing if non yang based source is unregistered
203 verifyZeroInteractions(dataBroker, writeTransaction);
207 public void testSchemaSourceUnregistered() {
208 yangLibProvider.init();
210 when(dataBroker.newWriteOnlyTransaction()).thenReturn(writeTransaction);
211 doNothing().when(writeTransaction)
212 .delete(eq(LogicalDatastoreType.OPERATIONAL), any(InstanceIdentifier.class));
214 doReturn(emptyFluentFuture()).when(writeTransaction).commit();
216 PotentialSchemaSource<YangTextSchemaSource> yangUnregistererSource =
217 PotentialSchemaSource.create(
218 RevisionSourceIdentifier.create("unregistered-yang-schema-without-revision"),
219 YangTextSchemaSource.class, PotentialSchemaSource.Costs.LOCAL_IO.getValue());
221 yangLibProvider.schemaSourceUnregistered(yangUnregistererSource);
223 verify(dataBroker).newWriteOnlyTransaction();
224 verify(writeTransaction).delete(eq(LogicalDatastoreType.OPERATIONAL),
225 eq(InstanceIdentifier.create(ModulesState.class)
227 new ModuleKey(new YangIdentifier("unregistered-yang-schema-without-revision"),
228 RevisionUtils.emptyRevision()))));
230 verify(writeTransaction).commit();
232 yangUnregistererSource =
233 PotentialSchemaSource.create(
234 RevisionSourceIdentifier.create("unregistered-yang-with-revision",
235 org.opendaylight.yangtools.yang.common.Revision.of("2016-04-28")),
236 YangTextSchemaSource.class, PotentialSchemaSource.Costs.LOCAL_IO.getValue());
238 yangLibProvider.schemaSourceUnregistered(yangUnregistererSource);
240 verify(dataBroker, times(2)).newWriteOnlyTransaction();
241 verify(writeTransaction).delete(eq(LogicalDatastoreType.OPERATIONAL),
242 eq(InstanceIdentifier.create(ModulesState.class)
244 new ModuleKey(new YangIdentifier("unregistered-yang-with-revision"),
245 new Revision(new RevisionIdentifier("2016-04-28"))))));
247 verify(writeTransaction, times(2)).commit();