Separate out Module and Submodule interfaces
[yangtools.git] / yang / yang-parser-rfc7950 / src / test / java / org / opendaylight / yangtools / yang / stmt / EffectiveModuleTest.java
1 /*
2  * Copyright (c) 2016 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.yangtools.yang.stmt;
9
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertNotNull;
12 import static org.opendaylight.yangtools.yang.stmt.StmtTestUtils.sourceForResource;
13
14 import java.net.URI;
15 import java.util.Collection;
16 import java.util.Optional;
17 import org.junit.Test;
18 import org.opendaylight.yangtools.yang.common.QName;
19 import org.opendaylight.yangtools.yang.common.QNameModule;
20 import org.opendaylight.yangtools.yang.common.Revision;
21 import org.opendaylight.yangtools.yang.common.YangVersion;
22 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
23 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
24 import org.opendaylight.yangtools.yang.model.api.DeviateKind;
25 import org.opendaylight.yangtools.yang.model.api.Deviation;
26 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
27 import org.opendaylight.yangtools.yang.model.api.FeatureDefinition;
28 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
29 import org.opendaylight.yangtools.yang.model.api.Module;
30 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
31 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
32 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
33 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
34 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
35 import org.opendaylight.yangtools.yang.model.api.Status;
36 import org.opendaylight.yangtools.yang.model.api.Submodule;
37 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
38 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.RFC7950Reactors;
39 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
40 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
41 import org.opendaylight.yangtools.yang.parser.spi.source.StatementStreamSource;
42
43 public class EffectiveModuleTest {
44
45     private static final StatementStreamSource ROOT_MODULE = sourceForResource(
46             "/semantic-statement-parser/effective-module/root.yang");
47     private static final StatementStreamSource IMPORTED_MODULE = sourceForResource(
48             "/semantic-statement-parser/effective-module/imported.yang");
49     private static final StatementStreamSource SUBMODULE = sourceForResource(
50             "/semantic-statement-parser/effective-module/submod.yang");
51
52     private static final QNameModule ROOT_MODULE_QNAME = QNameModule.create(URI.create("root-ns"));
53
54     private static final QName CONT = QName.create(ROOT_MODULE_QNAME, "cont");
55     private static final QName FEATURE1 = QName.create(ROOT_MODULE_QNAME, "feature1");
56
57     private static final SchemaPath FEATURE1_SCHEMA_PATH = SchemaPath.create(true, FEATURE1);
58
59     private static final Revision REVISION = Revision.of("2000-01-01");
60
61     @Test
62     public void effectiveBuildTest() throws SourceException, ReactorException {
63         SchemaContext result = RFC7950Reactors.defaultReactor().newBuild()
64                 .addSources(ROOT_MODULE, IMPORTED_MODULE, SUBMODULE)
65                 .buildEffective();
66
67         assertNotNull(result);
68
69         Module rootModule = result.findModules("root").iterator().next();
70         assertNotNull(rootModule);
71
72         assertEquals("root-pref", rootModule.getPrefix());
73         assertEquals(YangVersion.VERSION_1, rootModule.getYangVersion());
74         assertEquals(Optional.of("cisco"), rootModule.getOrganization());
75         assertEquals(Optional.of("cisco email"), rootModule.getContact());
76
77         final ContainerSchemaNode contSchemaNode = (ContainerSchemaNode) rootModule.getDataChildByName(CONT);
78         assertNotNull(contSchemaNode);
79
80         final Collection<? extends AugmentationSchemaNode> augmentations = rootModule.getAugmentations();
81         assertEquals(1, augmentations.size());
82         assertEquals(Absolute.of(CONT), augmentations.iterator().next().getTargetPath());
83
84         final Collection<? extends ModuleImport> imports = rootModule.getImports();
85         assertEquals(1, imports.size());
86         final ModuleImport importStmt = imports.iterator().next();
87         assertNotNull(importStmt);
88         assertEquals("imported", importStmt.getModuleName());
89         assertEquals(Optional.of(REVISION), importStmt.getRevision());
90         assertEquals("imp-pref", importStmt.getPrefix());
91
92         final Collection<? extends Submodule> submodules = rootModule.getSubmodules();
93         assertEquals(1, submodules.size());
94         assertEquals("submod", submodules.iterator().next().getName());
95
96         final Collection<? extends NotificationDefinition> notifications = rootModule.getNotifications();
97         assertEquals(1, notifications.size());
98         assertEquals("notif1", notifications.iterator().next().getQName().getLocalName());
99
100         final Collection<? extends RpcDefinition> rpcs = rootModule.getRpcs();
101         assertEquals(1, rpcs.size());
102         assertEquals("rpc1", rpcs.iterator().next().getQName().getLocalName());
103
104         final Collection<? extends Deviation> deviations = rootModule.getDeviations();
105         assertEquals(1, deviations.size());
106         final Deviation deviationStmt = deviations.iterator().next();
107         assertNotNull(deviationStmt);
108         final QNameModule importedModuleQName = QNameModule.create(URI.create("imported"), REVISION);
109         final QName importedContQName = QName.create(importedModuleQName, "cont");
110         assertEquals(Absolute.of(importedContQName), deviationStmt.getTargetPath());
111         assertEquals(DeviateKind.ADD, deviationStmt.getDeviates().iterator().next().getDeviateType());
112         assertEquals(Optional.of("deviate reference"), deviationStmt.getReference());
113
114         final Collection<? extends IdentitySchemaNode> identities = rootModule.getIdentities();
115         assertEquals(1, identities.size());
116         assertEquals("identity1", identities.iterator().next().getQName().getLocalName());
117
118         final Collection<? extends FeatureDefinition> features = rootModule.getFeatures();
119         assertEquals(1, features.size());
120         final FeatureDefinition featureStmt = features.iterator().next();
121         assertNotNull(featureStmt);
122         assertEquals(FEATURE1, featureStmt.getQName());
123         assertEquals(FEATURE1_SCHEMA_PATH, featureStmt.getPath());
124         assertEquals(Optional.of("feature1 description"), featureStmt.getDescription());
125         assertEquals(Optional.of("feature1 reference"), featureStmt.getReference());
126         assertEquals(Status.CURRENT, featureStmt.getStatus());
127
128         final Collection<? extends ExtensionDefinition> extensionSchemaNodes = rootModule.getExtensionSchemaNodes();
129         assertEquals(1, extensionSchemaNodes.size());
130         assertEquals("ext1", extensionSchemaNodes.iterator().next().getQName().getLocalName());
131     }
132 }