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