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