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.yang.model.util;
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertTrue;
12 import static org.mockito.ArgumentMatchers.any;
13 import static org.mockito.Mockito.doReturn;
14 import static org.mockito.Mockito.mock;
16 import com.google.common.collect.ImmutableSet;
18 import java.util.Arrays;
19 import java.util.Collection;
20 import java.util.HashSet;
21 import java.util.List;
22 import java.util.Optional;
24 import org.junit.Test;
25 import org.opendaylight.yangtools.yang.common.QName;
26 import org.opendaylight.yangtools.yang.common.QNameModule;
27 import org.opendaylight.yangtools.yang.common.Revision;
28 import org.opendaylight.yangtools.yang.common.XMLNamespace;
29 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
30 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
31 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
32 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
33 import org.opendaylight.yangtools.yang.model.api.Module;
34 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
35 import org.opendaylight.yangtools.yang.model.api.ModuleLike;
36 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
37 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
38 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
39 import org.opendaylight.yangtools.yang.model.api.Submodule;
40 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
41 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
42 import org.opendaylight.yangtools.yang.model.api.stmt.ImportEffectiveStatement;
43 import org.opendaylight.yangtools.yang.model.spi.AbstractSchemaContext;
44 import org.opendaylight.yangtools.yang.model.util.FilteringSchemaContextProxy.ModuleId;
46 public class SchemaContextProxyTest {
48 private static final URI NAMESPACE = URI.create("urn:opendaylight:params:xml:ns:yang:controller:config");
49 private static final Revision REVISION = Revision.of("2015-01-01");
50 private static final Revision REVISION2 = Revision.of("2015-01-15");
52 private static final String CONFIG_NAME = "config";
53 private static final String ROOT_NAME = "root";
54 private static final String MODULE2_NAME = "module2";
55 private static final String MODULE3_NAME = "module3";
56 private static final String MODULE4_NAME = "module4";
57 private static final String MODULE41_NAME = "module41";
58 private static final String MODULE5_NAME = "module5";
60 private static SchemaContext mockSchema(final Module... modules) {
61 final List<Module> sortedModules = Arrays.asList(modules);
62 sortedModules.sort(AbstractSchemaContext.NAME_REVISION_COMPARATOR);
63 SchemaContext mock = mock(SchemaContext.class);
64 doReturn(ImmutableSet.copyOf(sortedModules)).when(mock).getModules();
75 public void testBasic() {
76 Module moduleConfig = mockModule(CONFIG_NAME);
77 Module module2 = mockModule(MODULE2_NAME);
78 Module module3 = mockModule(MODULE3_NAME);
80 mockModuleImport(module2, moduleConfig);
81 mockModuleImport(module3, module2, moduleConfig);
83 SchemaContext schemaContext = mockSchema(moduleConfig, module2, module3);
85 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null,
87 assertProxyContext(filteringSchemaContextProxy, moduleConfig, module2, module3);
91 * No root or additional modules
97 public void testNull() {
98 Module moduleConfig = mockModule(CONFIG_NAME);
99 Module module2 = mockModule(MODULE2_NAME);
100 Module module3 = mockModule(MODULE3_NAME);
102 mockModuleImport(module2, moduleConfig);
103 mockModuleImport(module3, module2, moduleConfig);
105 SchemaContext schemaContext = mockSchema(moduleConfig, module2, module3);
107 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null, null);
108 assertProxyContext(filteringSchemaContextProxy, null);
118 public void testConfigDifferentRevisions() {
119 Module moduleConfigNullRevision = mockModule(CONFIG_NAME, null);
120 Module moduleConfig = mockModule(CONFIG_NAME, REVISION);
121 Module moduleConfig2 = mockModule(CONFIG_NAME, REVISION2);
122 Module module2 = mockModule(MODULE2_NAME);
123 Module module3 = mockModule(MODULE3_NAME);
125 mockModuleImport(module2, moduleConfig);
126 mockModuleImport(module3, module2, moduleConfigNullRevision);
128 SchemaContext schemaContext = mockSchema(moduleConfig, moduleConfig2, module2, module3);
130 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null,
132 assertProxyContext(filteringSchemaContextProxy, moduleConfig, moduleConfig2, module2, module3);
142 public void testBasicNullRevision() throws Exception {
143 final Module moduleConfig = mockModule(CONFIG_NAME, Revision.of("2013-04-05"));
144 final Module module2 = mockModule(MODULE2_NAME, Revision.of("2014-06-17"));
145 final Module module20 = mockModule(MODULE2_NAME, null);
146 final Module module3 = mockModule(MODULE3_NAME, Revision.of("2014-06-12"));
147 final Module module30 = mockModule(MODULE3_NAME, null);
149 mockModuleImport(module20, moduleConfig);
150 mockModuleImport(module2, moduleConfig);
151 mockModuleImport(module3, module20, moduleConfig);
152 mockModuleImport(module30, module20, moduleConfig);
154 SchemaContext schemaContext = mockSchema(moduleConfig, module2, module3);
156 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null,
159 assertProxyContext(filteringSchemaContextProxy, moduleConfig, module2, module3);
169 public void testBasicMoreRootModules() {
170 final Module moduleConfig = mockModule(CONFIG_NAME);
171 final Module moduleRoot = mockModule(ROOT_NAME);
172 final Module module2 = mockModule(MODULE2_NAME);
173 final Module module3 = mockModule(MODULE3_NAME);
175 mockModuleImport(module2, moduleConfig);
176 mockModuleImport(module3, moduleRoot);
178 SchemaContext schemaContext = mockSchema(moduleConfig, moduleRoot, module2, module3);
180 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null, moduleRoot,
182 assertProxyContext(filteringSchemaContextProxy, moduleRoot, module3, moduleConfig, module2);
192 public void testChainNotDepend() {
193 Module moduleConfig = mockModule(CONFIG_NAME);
194 Module module2 = mockModule(MODULE2_NAME);
195 Module module3 = mockModule(MODULE3_NAME);
197 mockModuleImport(module2, moduleConfig);
198 mockModuleImport(module3, module2);
200 SchemaContext schemaContext = mockSchema(moduleConfig, module2, module3);
202 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null,
204 assertProxyContext(filteringSchemaContextProxy, moduleConfig, module2);
211 * M2 -> M3 -> M4 -> M5
214 public void testChainDependMulti() {
215 Module moduleConfig = mockModule(CONFIG_NAME);
216 Module module2 = mockModule(MODULE2_NAME);
217 Module module3 = mockModule(MODULE3_NAME);
218 Module module4 = mockModule(MODULE4_NAME);
219 Module module5 = mockModule(MODULE5_NAME);
221 mockModuleImport(module2, moduleConfig, module3);
222 mockModuleImport(module3, module4);
223 mockModuleImport(module4, module5);
225 SchemaContext schemaContext = mockSchema(moduleConfig, module2, module3, module4, module5);
227 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null,
229 assertProxyContext(filteringSchemaContextProxy, moduleConfig, module2, module3, module4, module5);
239 public void testChainNotDependMulti() {
240 Module moduleConfig = mockModule(CONFIG_NAME);
241 Module module2 = mockModule(MODULE2_NAME);
242 Module module3 = mockModule(MODULE3_NAME);
243 Module module4 = mockModule(MODULE4_NAME);
245 mockModuleImport(module2, moduleConfig, module3);
246 mockModuleImport(module4, module3);
248 SchemaContext schemaContext = mockSchema(moduleConfig, module2, module3, module4);
250 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null,
252 assertProxyContext(filteringSchemaContextProxy, moduleConfig, module2, module3);
262 public void testChainNotMulti() {
263 final Module moduleConfig = mockModule(CONFIG_NAME);
264 final Module module2 = mockModule(MODULE2_NAME);
265 final Module module3 = mockModule(MODULE3_NAME);
266 final Module module4 = mockModule(MODULE4_NAME);
267 final Module module5 = mockModule(MODULE5_NAME);
269 mockModuleImport(module2, moduleConfig);
270 mockModuleImport(module3, moduleConfig);
271 mockModuleImport(module4, moduleConfig);
272 mockModuleImport(module5, moduleConfig);
274 SchemaContext schemaContext = mockSchema(moduleConfig, module2, module3, module4, module5);
276 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null,
278 assertProxyContext(filteringSchemaContextProxy, moduleConfig, module2, module3, module4, module5);
285 * M2 <- M3 M4=M3(Different revision)
288 public void testBasicRevisionChange() throws Exception {
289 Module moduleConfig = mockModule(CONFIG_NAME);
290 Module module2 = mockModule(MODULE2_NAME);
291 Module module3 = mockModule(MODULE3_NAME);
292 Module module4 = mockModule(MODULE3_NAME, Revision.of("2015-10-10"));
294 mockModuleImport(module2, moduleConfig);
295 mockModuleImport(module3, module2, moduleConfig);
297 SchemaContext schemaContext = mockSchema(moduleConfig, module2, module3, module4);
299 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null,
301 assertProxyContext(filteringSchemaContextProxy, moduleConfig, module2, module3);
307 * M2 -(no revision)-> M3(R2) ... M3(R1)
310 public void testImportNoRevision() {
311 Module moduleConfig = mockModule(CONFIG_NAME, REVISION);
312 Module module2 = mockModule(MODULE2_NAME, REVISION);
314 Module module3 = mockModule(MODULE3_NAME, null);
315 Module module30 = mockModule(MODULE3_NAME, REVISION);
316 Module module31 = mockModule(MODULE3_NAME, REVISION2);
317 mockModuleImport(module2, moduleConfig, module3);
319 SchemaContext schemaContext = mockSchema(moduleConfig, module2, module30, module31);
321 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null,
324 assertProxyContext(filteringSchemaContextProxy, moduleConfig, module2, module31);
336 public void testBasicSubmodule() {
337 Module moduleConfig = mockModule(CONFIG_NAME);
338 Module module2 = mockModule(MODULE2_NAME);
339 Module module3 = mockModule(MODULE3_NAME);
340 Module module4 = mockModule(MODULE4_NAME);
341 Submodule module41 = mockSubmodule(MODULE41_NAME);
343 mockSubmodules(module4, module41);
344 mockModuleImport(module2, moduleConfig, module3);
345 mockModuleImport(module41, moduleConfig);
347 SchemaContext schemaContext = mockSchema(moduleConfig, module2, module3, module4);
349 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null,
351 assertProxyContext(filteringSchemaContextProxy, moduleConfig, module2, module3, module4);
355 * M2 -> M3 -> M4 -> M5
358 public void testChainAdditionalModules() {
359 Module module2 = mockModule(MODULE2_NAME);
360 Module module3 = mockModule(MODULE3_NAME);
361 Module module4 = mockModule(MODULE4_NAME);
362 Module module5 = mockModule(MODULE5_NAME);
364 mockModuleImport(module2, module3);
365 mockModuleImport(module3, module4);
366 mockModuleImport(module4, module5);
368 SchemaContext schemaContext = mockSchema(module2, module3, module4, module5);
370 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, Set.of(module2),
372 assertProxyContext(filteringSchemaContextProxy, module2, module3, module4, module5);
385 public void testChainAdditionalModulesConfig() {
386 Module moduleConfig = mockModule(CONFIG_NAME);
387 Module module2 = mockModule(MODULE2_NAME);
389 Module module3 = mockModule(MODULE3_NAME);
390 Module module4 = mockModule(MODULE4_NAME);
391 Module module5 = mockModule(MODULE5_NAME);
393 mockModuleImport(module2, moduleConfig);
394 mockModuleImport(module3, module4);
396 SchemaContext schemaContext = mockSchema(moduleConfig, module2, module3, module4, module5);
398 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, Set.of(module3),
400 assertProxyContext(filteringSchemaContextProxy, moduleConfig, module2, module3, module4);
404 public void testGetDataDefinitions() {
405 final Module moduleConfig = mockModule(CONFIG_NAME);
406 final SchemaContext schemaContext = mockSchema(moduleConfig);
407 final FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, Set.of(),
410 final ContainerSchemaNode mockedContainer = mock(ContainerSchemaNode.class);
411 doReturn(Set.of(mockedContainer)).when(moduleConfig).getChildNodes();
413 final Collection<? extends DataSchemaNode> dataDefinitions = filteringSchemaContextProxy.getDataDefinitions();
414 assertTrue(dataDefinitions.contains(mockedContainer));
418 public void testGetNotifications() {
419 final Module moduleConfig = mockModule(CONFIG_NAME);
420 final SchemaContext schemaContext = mockSchema(moduleConfig);
421 final FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, Set.of(),
424 final NotificationDefinition mockedNotification = mock(NotificationDefinition.class);
425 doReturn(Set.of(mockedNotification)).when(moduleConfig).getNotifications();
427 final Collection<? extends NotificationDefinition> schemaContextProxyNotifications =
428 filteringSchemaContextProxy.getNotifications();
429 assertTrue(schemaContextProxyNotifications.contains(mockedNotification));
433 public void testGetOperations() {
434 final Module moduleConfig = mockModule(CONFIG_NAME);
435 final SchemaContext schemaContext = mockSchema(moduleConfig);
436 final FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, Set.of(),
439 final RpcDefinition mockedRpc = mock(RpcDefinition.class);
440 doReturn(Set.of(mockedRpc)).when(moduleConfig).getRpcs();
442 final Collection<? extends RpcDefinition> operations = filteringSchemaContextProxy.getOperations();
443 assertTrue(operations.contains(mockedRpc));
447 public void testGetExtensions() {
448 final Module moduleConfig = mockModule(CONFIG_NAME);
449 final SchemaContext schemaContext = mockSchema(moduleConfig);
450 final FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, Set.of(),
453 final ExtensionDefinition mockedExtension = mock(ExtensionDefinition.class);
454 doReturn(List.of(mockedExtension)).when(moduleConfig).getExtensionSchemaNodes();
456 final Collection<? extends ExtensionDefinition> schemaContextProxyExtensions =
457 filteringSchemaContextProxy.getExtensions();
458 assertTrue(schemaContextProxyExtensions.contains(mockedExtension));
462 public void testGetUnknownSchemaNodes() {
463 final Module moduleConfig = mockModule(CONFIG_NAME);
464 final SchemaContext schemaContext = mockSchema(moduleConfig);
465 final FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, Set.of(),
468 final UnknownSchemaNode mockedUnknownSchemaNode = mock(UnknownSchemaNode.class);
469 doReturn(List.of(mockedUnknownSchemaNode)).when(moduleConfig).getUnknownSchemaNodes();
471 final Collection<? extends UnknownSchemaNode> schemaContextProxyUnknownSchemaNodes =
472 filteringSchemaContextProxy.getUnknownSchemaNodes();
473 assertTrue(schemaContextProxyUnknownSchemaNodes.contains(mockedUnknownSchemaNode));
477 public void testGetTypeDefinitions() {
478 final Module moduleConfig = mockModule(CONFIG_NAME);
479 final SchemaContext schemaContext = mockSchema(moduleConfig);
480 final FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, Set.of(),
483 final TypeDefinition<?> mockedTypeDefinition = mock(TypeDefinition.class);
484 doReturn(Set.of(mockedTypeDefinition)).when(moduleConfig).getTypeDefinitions();
486 final Collection<? extends TypeDefinition<?>> schemaContextProxyTypeDefinitions = filteringSchemaContextProxy
487 .getTypeDefinitions();
488 assertTrue(schemaContextProxyTypeDefinitions.contains(mockedTypeDefinition));
492 public void testGetChildNodes() {
493 final Module moduleConfig = mockModule(CONFIG_NAME);
494 final SchemaContext schemaContext = mockSchema(moduleConfig);
495 final FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, Set.of(),
498 final ContainerSchemaNode mockedContainer = mock(ContainerSchemaNode.class);
499 doReturn(Set.of(mockedContainer)).when(moduleConfig).getChildNodes();
501 final Collection<? extends DataSchemaNode> schemaContextProxyChildNodes =
502 filteringSchemaContextProxy.getChildNodes();
503 assertTrue(schemaContextProxyChildNodes.contains(mockedContainer));
507 public void testGetGroupings() {
508 final Module moduleConfig = mockModule(CONFIG_NAME);
509 final SchemaContext schemaContext = mockSchema(moduleConfig);
510 final FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, Set.of(),
513 final GroupingDefinition mockedGrouping = mock(GroupingDefinition.class);
514 doReturn(Set.of(mockedGrouping)).when(moduleConfig).getGroupings();
516 final Collection<? extends GroupingDefinition> schemaContextProxyGroupings =
517 filteringSchemaContextProxy.getGroupings();
518 assertTrue(schemaContextProxyGroupings.contains(mockedGrouping));
522 public void testGetDataChildByName() {
523 final Module moduleConfig = mockModule(CONFIG_NAME);
524 final SchemaContext schemaContext = mockSchema(moduleConfig);
525 final FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, Set.of(),
528 final QName qname = QName.create("config-namespace", "2016-08-11", "cont");
529 final ContainerSchemaNode mockedContainer = mock(ContainerSchemaNode.class);
530 doReturn(mockedContainer).when(moduleConfig).dataChildByName(any(QName.class));
532 final DataSchemaNode dataSchemaNode = filteringSchemaContextProxy.getDataChildByName(qname);
533 assertTrue(dataSchemaNode instanceof ContainerSchemaNode);
536 private static void assertProxyContext(final FilteringSchemaContextProxy filteringSchemaContextProxy,
537 final Module... expected) {
539 final Set<Module> modSet = expected != null ? ImmutableSet.copyOf(expected) : Set.of();
540 Set<Module> modSetFiltering = filteringSchemaContextProxy.getModules();
542 assertEquals(modSet, modSetFiltering);
544 //asserting collections
545 if (expected != null) {
546 for (final Module module : expected) {
547 assertEquals(module, filteringSchemaContextProxy.findModule(module.getName(), module.getRevision())
550 Collection<? extends Module> mod = filteringSchemaContextProxy.findModules(module.getNamespace());
551 assertTrue(mod.contains(module));
552 assertEquals(module, filteringSchemaContextProxy.findModule(module.getNamespace(),
553 module.getRevision().orElse(null)).get());
558 private static FilteringSchemaContextProxy createProxySchemaCtx(final SchemaContext schemaContext,
559 final Set<Module> additionalModules, final Module... modules) {
560 Set<Module> modulesSet = modules != null ? ImmutableSet.copyOf(modules) : Set.of();
561 return new FilteringSchemaContextProxy(schemaContext, createModuleIds(modulesSet),
562 createModuleIds(additionalModules));
565 private static Set<ModuleId> createModuleIds(final Set<Module> modules) {
566 Set<ModuleId> moduleIds = new HashSet<>();
567 if (modules != null) {
568 for (Module module : modules) {
569 moduleIds.add(new ModuleId(module.getName(), module.getRevision()));
576 private static void mockSubmodules(final Module mainModule, final Submodule... submodules) {
577 doReturn(Set.of(submodules)).when(mainModule).getSubmodules();
580 private static void mockModuleImport(final ModuleLike importer, final Module... imports) {
581 Set<ModuleImport> mockedImports = new HashSet<>();
582 for (final Module module : imports) {
583 mockedImports.add(new ModuleImport() {
585 public String getModuleName() {
586 return module.getName();
590 public Optional<Revision> getRevision() {
591 return module.getRevision();
595 public String getPrefix() {
596 return module.getName();
600 public Optional<String> getDescription() {
601 return module.getDescription();
605 public Optional<String> getReference() {
606 return module.getReference();
610 public String toString() {
611 return String.format("Module: %s, revision:%s", module.getName(), module.getRevision());
615 public ImportEffectiveStatement asEffectiveStatement() {
616 throw new UnsupportedOperationException();
620 doReturn(mockedImports).when(importer).getImports();
623 //mock module with revision
624 private static Module mockModule(final String name, final Revision rev) {
626 final Module mod = mockModule(name);
628 doReturn(QNameModule.create(mod.getNamespace(), rev)).when(mod).getQNameModule();
629 doReturn(Optional.ofNullable(rev)).when(mod).getRevision();
630 doReturn(mod.getQNameModule().toString()).when(mod).toString();
635 //mock module with default revision
636 private static Module mockModule(final String name) {
637 Module mockedModule = mock(Module.class);
638 mockModuleLike(mockedModule, name);
642 private static Submodule mockSubmodule(final String name) {
643 Submodule mockedModule = mock(Submodule.class);
644 mockModuleLike(mockedModule, name);
648 private static void mockModuleLike(final ModuleLike mockedModule, final String name) {
649 doReturn(name).when(mockedModule).getName();
650 doReturn(Optional.of(REVISION)).when(mockedModule).getRevision();
651 final XMLNamespace newNamespace = XMLNamespace.of(NAMESPACE.toString() + ":" + name);
652 doReturn(newNamespace).when(mockedModule).getNamespace();
653 doReturn(QNameModule.create(newNamespace, REVISION)).when(mockedModule).getQNameModule();
654 doReturn(Set.of()).when(mockedModule).getSubmodules();
655 doReturn(mockedModule.getQNameModule().toString()).when(mockedModule).toString();
656 mockModuleImport(mockedModule);