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