Bug 6022: Deviation statement is not fully available in the YANG parser output
[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
14 import java.net.URI;
15 import java.text.ParseException;
16 import java.util.Date;
17 import java.util.List;
18 import java.util.Set;
19 import org.junit.BeforeClass;
20 import org.junit.Test;
21 import org.opendaylight.yangtools.yang.common.QName;
22 import org.opendaylight.yangtools.yang.common.QNameModule;
23 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
24 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
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.SchemaPath;
36 import org.opendaylight.yangtools.yang.model.api.Status;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
38 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
39 import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor;
40 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.YangInferencePipeline;
41 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.YangStatementSourceImpl;
42 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.EffectiveSchemaContext;
43
44 public class EffectiveModuleTest {
45
46     private static final YangStatementSourceImpl ROOT_MODULE = new YangStatementSourceImpl(
47             "/semantic-statement-parser/effective-module/root.yang", false);
48     private static final YangStatementSourceImpl IMPORTED_MODULE = new YangStatementSourceImpl(
49             "/semantic-statement-parser/effective-module/imported.yang", false);
50     private static final YangStatementSourceImpl SUBMODULE = new YangStatementSourceImpl(
51             "/semantic-statement-parser/effective-module/submod.yang", false);
52
53     private static final QNameModule ROOT_MODULE_QNAME = QNameModule.create(URI.create("root-ns"),
54             SimpleDateFormatUtil.DEFAULT_DATE_REV);
55
56     private static final QName cont = QName.create(ROOT_MODULE_QNAME, "cont");
57     private static final QName feature1 = QName.create(ROOT_MODULE_QNAME, "feature1");
58
59     private static final SchemaPath contSchemaPath = SchemaPath.create(true, cont);
60     private static final SchemaPath feature1SchemaPath = SchemaPath.create(true, feature1);
61
62     private static Date revision;
63
64     @BeforeClass
65     public static void init() {
66         try {
67             revision = SimpleDateFormatUtil.getRevisionFormat().parse("2000-01-01");
68         } catch (ParseException e) {
69             throw new IllegalArgumentException(e);
70         }
71     }
72
73     @Test
74     public void effectiveBuildTest() throws SourceException, ReactorException {
75         CrossSourceStatementReactor.BuildAction reactor = YangInferencePipeline.RFC6020_REACTOR.newBuild();
76         addSources(reactor, ROOT_MODULE, IMPORTED_MODULE, SUBMODULE);
77         EffectiveSchemaContext result = reactor.buildEffective();
78
79         assertNotNull(result);
80
81         Module rootModule = result.findModuleByName("root", null);
82         assertNotNull(rootModule);
83
84         assertEquals("root-pref", rootModule.getPrefix());
85         assertEquals("1", rootModule.getYangVersion());
86         assertEquals("cisco", rootModule.getOrganization());
87         assertEquals("cisco email", rootModule.getContact());
88
89         final ContainerSchemaNode contSchemaNode = (ContainerSchemaNode) rootModule.getDataChildByName(cont);
90         assertNotNull(contSchemaNode);
91
92         final Set<AugmentationSchema> augmentations = rootModule.getAugmentations();
93         assertEquals(1, augmentations.size());
94         assertEquals(contSchemaPath, augmentations.iterator().next().getTargetPath());
95
96         final Set<ModuleImport> imports = rootModule.getImports();
97         assertEquals(1, imports.size());
98         final ModuleImport importStmt = imports.iterator().next();
99         assertNotNull(importStmt);
100         assertEquals("imported", importStmt.getModuleName());
101         assertEquals(revision, importStmt.getRevision());
102         assertEquals("imp-pref", importStmt.getPrefix());
103
104         final Set<Module> submodules = rootModule.getSubmodules();
105         assertEquals(1, submodules.size());
106         assertEquals("submod", submodules.iterator().next().getName());
107
108         final Set<NotificationDefinition> notifications = rootModule.getNotifications();
109         assertEquals(1, notifications.size());
110         assertEquals("notif1", notifications.iterator().next().getQName().getLocalName());
111
112         final Set<RpcDefinition> rpcs = rootModule.getRpcs();
113         assertEquals(1, rpcs.size());
114         assertEquals("rpc1", rpcs.iterator().next().getQName().getLocalName());
115
116         final Set<Deviation> deviations = rootModule.getDeviations();
117         assertEquals(1, deviations.size());
118         final Deviation deviationStmt = deviations.iterator().next();
119         assertNotNull(deviationStmt);
120         assertEquals(contSchemaPath, deviationStmt.getTargetPath());
121         assertEquals(DeviateKind.ADD, deviationStmt.getDeviates().iterator().next().getDeviateType());
122         assertEquals("deviate reference", deviationStmt.getReference());
123
124         final Set<IdentitySchemaNode> identities = rootModule.getIdentities();
125         assertEquals(1, identities.size());
126         assertEquals("identity1", identities.iterator().next().getQName().getLocalName());
127
128         final Set<FeatureDefinition> features = rootModule.getFeatures();
129         assertEquals(1, features.size());
130         final FeatureDefinition featureStmt = features.iterator().next();
131         assertNotNull(featureStmt);
132         assertEquals(feature1, featureStmt.getQName());
133         assertEquals(feature1SchemaPath, featureStmt.getPath());
134         assertEquals("feature1 description", featureStmt.getDescription());
135         assertEquals("feature1 reference", featureStmt.getReference());
136         assertEquals(Status.CURRENT, featureStmt.getStatus());
137
138         final List<ExtensionDefinition> extensionSchemaNodes = rootModule.getExtensionSchemaNodes();
139         assertEquals(1, extensionSchemaNodes.size());
140         assertEquals("ext1", extensionSchemaNodes.iterator().next().getQName().getLocalName());
141     }
142
143     private static void addSources(final CrossSourceStatementReactor.BuildAction reactor, final YangStatementSourceImpl... sources) {
144         for (YangStatementSourceImpl source : sources) {
145             reactor.addSource(source);
146         }
147     }
148 }