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.concepts.SemVer;
26 import org.opendaylight.yangtools.yang.common.QName;
27 import org.opendaylight.yangtools.yang.common.QNameModule;
28 import org.opendaylight.yangtools.yang.common.Revision;
29 import org.opendaylight.yangtools.yang.common.XMLNamespace;
30 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
31 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
32 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
33 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
34 import org.opendaylight.yangtools.yang.model.api.Module;
35 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
36 import org.opendaylight.yangtools.yang.model.api.ModuleLike;
37 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
38 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
39 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
40 import org.opendaylight.yangtools.yang.model.api.Submodule;
41 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
42 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
43 import org.opendaylight.yangtools.yang.model.api.stmt.ImportEffectiveStatement;
44 import org.opendaylight.yangtools.yang.model.spi.AbstractSchemaContext;
45 import org.opendaylight.yangtools.yang.model.util.FilteringSchemaContextProxy.ModuleId;
47 public class SchemaContextProxyTest {
49 private static final URI NAMESPACE = URI.create("urn:opendaylight:params:xml:ns:yang:controller:config");
50 private static final Revision REVISION = Revision.of("2015-01-01");
51 private static final Revision REVISION2 = Revision.of("2015-01-15");
53 private static final String CONFIG_NAME = "config";
54 private static final String ROOT_NAME = "root";
55 private static final String MODULE2_NAME = "module2";
56 private static final String MODULE3_NAME = "module3";
57 private static final String MODULE4_NAME = "module4";
58 private static final String MODULE41_NAME = "module41";
59 private static final String MODULE5_NAME = "module5";
61 private static SchemaContext mockSchema(final Module... modules) {
62 final List<Module> sortedModules = Arrays.asList(modules);
63 sortedModules.sort(AbstractSchemaContext.NAME_REVISION_COMPARATOR);
64 SchemaContext mock = mock(SchemaContext.class);
65 doReturn(ImmutableSet.copyOf(sortedModules)).when(mock).getModules();
76 public void testBasic() {
77 Module moduleConfig = mockModule(CONFIG_NAME);
78 Module module2 = mockModule(MODULE2_NAME);
79 Module module3 = mockModule(MODULE3_NAME);
81 mockModuleImport(module2, moduleConfig);
82 mockModuleImport(module3, module2, moduleConfig);
84 SchemaContext schemaContext = mockSchema(moduleConfig, module2, module3);
86 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null,
88 assertProxyContext(filteringSchemaContextProxy, moduleConfig, module2, module3);
92 * No root or additional modules
98 public void testNull() {
99 Module moduleConfig = mockModule(CONFIG_NAME);
100 Module module2 = mockModule(MODULE2_NAME);
101 Module module3 = mockModule(MODULE3_NAME);
103 mockModuleImport(module2, moduleConfig);
104 mockModuleImport(module3, module2, moduleConfig);
106 SchemaContext schemaContext = mockSchema(moduleConfig, module2, module3);
108 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null, null);
109 assertProxyContext(filteringSchemaContextProxy, null);
119 public void testConfigDifferentRevisions() {
120 Module moduleConfigNullRevision = mockModule(CONFIG_NAME, null);
121 Module moduleConfig = mockModule(CONFIG_NAME, REVISION);
122 Module moduleConfig2 = mockModule(CONFIG_NAME, REVISION2);
123 Module module2 = mockModule(MODULE2_NAME);
124 Module module3 = mockModule(MODULE3_NAME);
126 mockModuleImport(module2, moduleConfig);
127 mockModuleImport(module3, module2, moduleConfigNullRevision);
129 SchemaContext schemaContext = mockSchema(moduleConfig, moduleConfig2, module2, module3);
131 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null,
133 assertProxyContext(filteringSchemaContextProxy, moduleConfig, moduleConfig2, module2, module3);
143 public void testBasicNullRevision() throws Exception {
144 final Module moduleConfig = mockModule(CONFIG_NAME, Revision.of("2013-04-05"));
145 final Module module2 = mockModule(MODULE2_NAME, Revision.of("2014-06-17"));
146 final Module module20 = mockModule(MODULE2_NAME, null);
147 final Module module3 = mockModule(MODULE3_NAME, Revision.of("2014-06-12"));
148 final Module module30 = mockModule(MODULE3_NAME, null);
150 mockModuleImport(module20, moduleConfig);
151 mockModuleImport(module2, moduleConfig);
152 mockModuleImport(module3, module20, moduleConfig);
153 mockModuleImport(module30, module20, moduleConfig);
155 SchemaContext schemaContext = mockSchema(moduleConfig, module2, module3);
157 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null,
160 assertProxyContext(filteringSchemaContextProxy, moduleConfig, module2, module3);
170 public void testBasicMoreRootModules() {
171 final Module moduleConfig = mockModule(CONFIG_NAME);
172 final Module moduleRoot = mockModule(ROOT_NAME);
173 final Module module2 = mockModule(MODULE2_NAME);
174 final Module module3 = mockModule(MODULE3_NAME);
176 mockModuleImport(module2, moduleConfig);
177 mockModuleImport(module3, moduleRoot);
179 SchemaContext schemaContext = mockSchema(moduleConfig, moduleRoot, module2, module3);
181 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null, moduleRoot,
183 assertProxyContext(filteringSchemaContextProxy, moduleRoot, module3, moduleConfig, module2);
193 public void testChainNotDepend() {
194 Module moduleConfig = mockModule(CONFIG_NAME);
195 Module module2 = mockModule(MODULE2_NAME);
196 Module module3 = mockModule(MODULE3_NAME);
198 mockModuleImport(module2, moduleConfig);
199 mockModuleImport(module3, module2);
201 SchemaContext schemaContext = mockSchema(moduleConfig, module2, module3);
203 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null,
205 assertProxyContext(filteringSchemaContextProxy, moduleConfig, module2);
212 * M2 -> M3 -> M4 -> M5
215 public void testChainDependMulti() {
216 Module moduleConfig = mockModule(CONFIG_NAME);
217 Module module2 = mockModule(MODULE2_NAME);
218 Module module3 = mockModule(MODULE3_NAME);
219 Module module4 = mockModule(MODULE4_NAME);
220 Module module5 = mockModule(MODULE5_NAME);
222 mockModuleImport(module2, moduleConfig, module3);
223 mockModuleImport(module3, module4);
224 mockModuleImport(module4, module5);
226 SchemaContext schemaContext = mockSchema(moduleConfig, module2, module3, module4, module5);
228 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null,
230 assertProxyContext(filteringSchemaContextProxy, moduleConfig, module2, module3, module4, module5);
240 public void testChainNotDependMulti() {
241 Module moduleConfig = mockModule(CONFIG_NAME);
242 Module module2 = mockModule(MODULE2_NAME);
243 Module module3 = mockModule(MODULE3_NAME);
244 Module module4 = mockModule(MODULE4_NAME);
246 mockModuleImport(module2, moduleConfig, module3);
247 mockModuleImport(module4, module3);
249 SchemaContext schemaContext = mockSchema(moduleConfig, module2, module3, module4);
251 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null,
253 assertProxyContext(filteringSchemaContextProxy, moduleConfig, module2, module3);
263 public void testChainNotMulti() {
264 final Module moduleConfig = mockModule(CONFIG_NAME);
265 final Module module2 = mockModule(MODULE2_NAME);
266 final Module module3 = mockModule(MODULE3_NAME);
267 final Module module4 = mockModule(MODULE4_NAME);
268 final Module module5 = mockModule(MODULE5_NAME);
270 mockModuleImport(module2, moduleConfig);
271 mockModuleImport(module3, moduleConfig);
272 mockModuleImport(module4, moduleConfig);
273 mockModuleImport(module5, moduleConfig);
275 SchemaContext schemaContext = mockSchema(moduleConfig, module2, module3, module4, module5);
277 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null,
279 assertProxyContext(filteringSchemaContextProxy, moduleConfig, module2, module3, module4, module5);
286 * M2 <- M3 M4=M3(Different revision)
289 public void testBasicRevisionChange() throws Exception {
290 Module moduleConfig = mockModule(CONFIG_NAME);
291 Module module2 = mockModule(MODULE2_NAME);
292 Module module3 = mockModule(MODULE3_NAME);
293 Module module4 = mockModule(MODULE3_NAME, Revision.of("2015-10-10"));
295 mockModuleImport(module2, moduleConfig);
296 mockModuleImport(module3, module2, moduleConfig);
298 SchemaContext schemaContext = mockSchema(moduleConfig, module2, module3, module4);
300 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null,
302 assertProxyContext(filteringSchemaContextProxy, moduleConfig, module2, module3);
308 * M2 -(no revision)-> M3(R2) ... M3(R1)
311 public void testImportNoRevision() {
312 Module moduleConfig = mockModule(CONFIG_NAME, REVISION);
313 Module module2 = mockModule(MODULE2_NAME, REVISION);
315 Module module3 = mockModule(MODULE3_NAME, null);
316 Module module30 = mockModule(MODULE3_NAME, REVISION);
317 Module module31 = mockModule(MODULE3_NAME, REVISION2);
318 mockModuleImport(module2, moduleConfig, module3);
320 SchemaContext schemaContext = mockSchema(moduleConfig, module2, module30, module31);
322 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null,
325 assertProxyContext(filteringSchemaContextProxy, moduleConfig, module2, module31);
337 public void testBasicSubmodule() {
338 Module moduleConfig = mockModule(CONFIG_NAME);
339 Module module2 = mockModule(MODULE2_NAME);
340 Module module3 = mockModule(MODULE3_NAME);
341 Module module4 = mockModule(MODULE4_NAME);
342 Submodule module41 = mockSubmodule(MODULE41_NAME);
344 mockSubmodules(module4, module41);
345 mockModuleImport(module2, moduleConfig, module3);
346 mockModuleImport(module41, moduleConfig);
348 SchemaContext schemaContext = mockSchema(moduleConfig, module2, module3, module4);
350 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, null,
352 assertProxyContext(filteringSchemaContextProxy, moduleConfig, module2, module3, module4);
356 * M2 -> M3 -> M4 -> M5
359 public void testChainAdditionalModules() {
360 Module module2 = mockModule(MODULE2_NAME);
361 Module module3 = mockModule(MODULE3_NAME);
362 Module module4 = mockModule(MODULE4_NAME);
363 Module module5 = mockModule(MODULE5_NAME);
365 mockModuleImport(module2, module3);
366 mockModuleImport(module3, module4);
367 mockModuleImport(module4, module5);
369 SchemaContext schemaContext = mockSchema(module2, module3, module4, module5);
371 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, Set.of(module2),
373 assertProxyContext(filteringSchemaContextProxy, module2, module3, module4, module5);
386 public void testChainAdditionalModulesConfig() {
387 Module moduleConfig = mockModule(CONFIG_NAME);
388 Module module2 = mockModule(MODULE2_NAME);
390 Module module3 = mockModule(MODULE3_NAME);
391 Module module4 = mockModule(MODULE4_NAME);
392 Module module5 = mockModule(MODULE5_NAME);
394 mockModuleImport(module2, moduleConfig);
395 mockModuleImport(module3, module4);
397 SchemaContext schemaContext = mockSchema(moduleConfig, module2, module3, module4, module5);
399 FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, Set.of(module3),
401 assertProxyContext(filteringSchemaContextProxy, moduleConfig, module2, module3, module4);
405 public void testGetDataDefinitions() {
406 final Module moduleConfig = mockModule(CONFIG_NAME);
407 final SchemaContext schemaContext = mockSchema(moduleConfig);
408 final FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, Set.of(),
411 final ContainerSchemaNode mockedContainer = mock(ContainerSchemaNode.class);
412 doReturn(Set.of(mockedContainer)).when(moduleConfig).getChildNodes();
414 final Collection<? extends DataSchemaNode> dataDefinitions =
415 filteringSchemaContextProxy.getDataDefinitions();
416 assertTrue(dataDefinitions.contains(mockedContainer));
420 public void testGetNotifications() {
421 final Module moduleConfig = mockModule(CONFIG_NAME);
422 final SchemaContext schemaContext = mockSchema(moduleConfig);
423 final FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, Set.of(),
426 final NotificationDefinition mockedNotification = mock(NotificationDefinition.class);
427 doReturn(Set.of(mockedNotification)).when(moduleConfig).getNotifications();
429 final Collection<? extends NotificationDefinition> schemaContextProxyNotifications =
430 filteringSchemaContextProxy.getNotifications();
431 assertTrue(schemaContextProxyNotifications.contains(mockedNotification));
435 public void testGetOperations() {
436 final Module moduleConfig = mockModule(CONFIG_NAME);
437 final SchemaContext schemaContext = mockSchema(moduleConfig);
438 final FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, Set.of(),
441 final RpcDefinition mockedRpc = mock(RpcDefinition.class);
442 doReturn(Set.of(mockedRpc)).when(moduleConfig).getRpcs();
444 final Collection<? extends RpcDefinition> operations = filteringSchemaContextProxy.getOperations();
445 assertTrue(operations.contains(mockedRpc));
449 public void testGetExtensions() {
450 final Module moduleConfig = mockModule(CONFIG_NAME);
451 final SchemaContext schemaContext = mockSchema(moduleConfig);
452 final FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, Set.of(),
455 final ExtensionDefinition mockedExtension = mock(ExtensionDefinition.class);
456 doReturn(List.of(mockedExtension)).when(moduleConfig).getExtensionSchemaNodes();
458 final Collection<? extends ExtensionDefinition> schemaContextProxyExtensions =
459 filteringSchemaContextProxy.getExtensions();
460 assertTrue(schemaContextProxyExtensions.contains(mockedExtension));
464 public void testGetUnknownSchemaNodes() {
465 final Module moduleConfig = mockModule(CONFIG_NAME);
466 final SchemaContext schemaContext = mockSchema(moduleConfig);
467 final FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, Set.of(),
470 final UnknownSchemaNode mockedUnknownSchemaNode = mock(UnknownSchemaNode.class);
471 doReturn(List.of(mockedUnknownSchemaNode)).when(moduleConfig).getUnknownSchemaNodes();
473 final Collection<? extends UnknownSchemaNode> schemaContextProxyUnknownSchemaNodes =
474 filteringSchemaContextProxy.getUnknownSchemaNodes();
475 assertTrue(schemaContextProxyUnknownSchemaNodes.contains(mockedUnknownSchemaNode));
479 public void testGetTypeDefinitions() {
480 final Module moduleConfig = mockModule(CONFIG_NAME);
481 final SchemaContext schemaContext = mockSchema(moduleConfig);
482 final FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, Set.of(),
485 final TypeDefinition<?> mockedTypeDefinition = mock(TypeDefinition.class);
486 doReturn(Set.of(mockedTypeDefinition)).when(moduleConfig).getTypeDefinitions();
488 final Collection<? extends TypeDefinition<?>> schemaContextProxyTypeDefinitions = filteringSchemaContextProxy
489 .getTypeDefinitions();
490 assertTrue(schemaContextProxyTypeDefinitions.contains(mockedTypeDefinition));
494 public void testGetChildNodes() {
495 final Module moduleConfig = mockModule(CONFIG_NAME);
496 final SchemaContext schemaContext = mockSchema(moduleConfig);
497 final FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, Set.of(),
500 final ContainerSchemaNode mockedContainer = mock(ContainerSchemaNode.class);
501 doReturn(Set.of(mockedContainer)).when(moduleConfig).getChildNodes();
503 final Collection<? extends DataSchemaNode> schemaContextProxyChildNodes =
504 filteringSchemaContextProxy.getChildNodes();
505 assertTrue(schemaContextProxyChildNodes.contains(mockedContainer));
509 public void testGetGroupings() {
510 final Module moduleConfig = mockModule(CONFIG_NAME);
511 final SchemaContext schemaContext = mockSchema(moduleConfig);
512 final FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, Set.of(),
515 final GroupingDefinition mockedGrouping = mock(GroupingDefinition.class);
516 doReturn(Set.of(mockedGrouping)).when(moduleConfig).getGroupings();
518 final Collection<? extends GroupingDefinition> schemaContextProxyGroupings =
519 filteringSchemaContextProxy.getGroupings();
520 assertTrue(schemaContextProxyGroupings.contains(mockedGrouping));
524 public void testGetDataChildByName() {
525 final Module moduleConfig = mockModule(CONFIG_NAME);
526 final SchemaContext schemaContext = mockSchema(moduleConfig);
527 final FilteringSchemaContextProxy filteringSchemaContextProxy = createProxySchemaCtx(schemaContext, Set.of(),
530 final QName qname = QName.create("config-namespace", "2016-08-11", "cont");
531 final ContainerSchemaNode mockedContainer = mock(ContainerSchemaNode.class);
532 doReturn(mockedContainer).when(moduleConfig).dataChildByName(any(QName.class));
534 final DataSchemaNode dataSchemaNode = filteringSchemaContextProxy.getDataChildByName(qname);
535 assertTrue(dataSchemaNode instanceof ContainerSchemaNode);
538 private static void assertProxyContext(final FilteringSchemaContextProxy filteringSchemaContextProxy,
539 final Module... expected) {
541 final Set<Module> modSet = expected != null ? ImmutableSet.copyOf(expected) : Set.of();
542 Set<Module> modSetFiltering = filteringSchemaContextProxy.getModules();
544 assertEquals(modSet, modSetFiltering);
546 //asserting collections
547 if (expected != null) {
548 for (final Module module : expected) {
549 assertEquals(module, filteringSchemaContextProxy.findModule(module.getName(), module.getRevision())
552 Collection<? extends Module> mod = filteringSchemaContextProxy.findModules(module.getNamespace());
553 assertTrue(mod.contains(module));
554 assertEquals(module, filteringSchemaContextProxy.findModule(module.getNamespace(),
555 module.getRevision().orElse(null)).get());
560 private static FilteringSchemaContextProxy createProxySchemaCtx(final SchemaContext schemaContext,
561 final Set<Module> additionalModules, final Module... modules) {
562 Set<Module> modulesSet = modules != null ? ImmutableSet.copyOf(modules) : Set.of();
563 return new FilteringSchemaContextProxy(schemaContext, createModuleIds(modulesSet),
564 createModuleIds(additionalModules));
567 private static Set<ModuleId> createModuleIds(final Set<Module> modules) {
568 Set<ModuleId> moduleIds = new HashSet<>();
569 if (modules != null) {
570 for (Module module : modules) {
571 moduleIds.add(new ModuleId(module.getName(), module.getRevision()));
578 private static void mockSubmodules(final Module mainModule, final Submodule... submodules) {
579 doReturn(Set.of(submodules)).when(mainModule).getSubmodules();
582 private static void mockModuleImport(final ModuleLike importer, final Module... imports) {
583 Set<ModuleImport> mockedImports = new HashSet<>();
584 for (final Module module : imports) {
585 mockedImports.add(new ModuleImport() {
587 public String getModuleName() {
588 return module.getName();
592 public Optional<Revision> getRevision() {
593 return module.getRevision();
597 public String getPrefix() {
598 return module.getName();
602 @Deprecated(since = "8.0.4", forRemoval = true)
603 public Optional<SemVer> getSemanticVersion() {
604 return module.getSemanticVersion();
608 public Optional<String> getDescription() {
609 return module.getDescription();
613 public Optional<String> getReference() {
614 return module.getReference();
618 public String toString() {
619 return String.format("Module: %s, revision:%s", module.getName(), module.getRevision());
623 public ImportEffectiveStatement asEffectiveStatement() {
624 throw new UnsupportedOperationException();
628 doReturn(mockedImports).when(importer).getImports();
631 //mock module with revision
632 private static Module mockModule(final String name, final Revision rev) {
634 final Module mod = mockModule(name);
636 doReturn(QNameModule.create(mod.getNamespace(), rev)).when(mod).getQNameModule();
637 doReturn(Optional.ofNullable(rev)).when(mod).getRevision();
638 doReturn(mod.getQNameModule().toString()).when(mod).toString();
643 //mock module with default revision
644 private static Module mockModule(final String name) {
645 Module mockedModule = mock(Module.class);
646 mockModuleLike(mockedModule, name);
650 private static Submodule mockSubmodule(final String name) {
651 Submodule mockedModule = mock(Submodule.class);
652 mockModuleLike(mockedModule, name);
656 private static void mockModuleLike(final ModuleLike mockedModule, final String name) {
657 doReturn(name).when(mockedModule).getName();
658 doReturn(Optional.of(REVISION)).when(mockedModule).getRevision();
659 final XMLNamespace newNamespace = XMLNamespace.of(NAMESPACE.toString() + ":" + name);
660 doReturn(newNamespace).when(mockedModule).getNamespace();
661 doReturn(QNameModule.create(newNamespace, REVISION)).when(mockedModule).getQNameModule();
662 doReturn(Set.of()).when(mockedModule).getSubmodules();
663 doReturn(mockedModule.getQNameModule().toString()).when(mockedModule).toString();
664 mockModuleImport(mockedModule);