parser/yang-parser-rfc7950/src/test/java/org/opendaylight/yangtools/yang/stmt/YangParserSimpleTest.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.assertFalse;
  12 import static org.junit.Assert.assertNotNull;
  13 import static org.junit.Assert.assertTrue;
  14 import static org.opendaylight.yangtools.yang.stmt.StmtTestUtils.assertPathEquals;
  15
  16 import java.util.ArrayList;
  17 import java.util.Collection;
  18 import java.util.List;
  19 import java.util.Optional;
  20 import org.junit.Before;
  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.Revision;
  25 import org.opendaylight.yangtools.yang.common.XMLNamespace;
  26 import org.opendaylight.yangtools.yang.model.api.AnydataSchemaNode;
  27 import org.opendaylight.yangtools.yang.model.api.AnyxmlSchemaNode;
  28 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  29 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  30 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  31 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  32 import org.opendaylight.yangtools.yang.model.api.Module;
  33 import org.opendaylight.yangtools.yang.model.api.MustDefinition;
  34 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  35 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  36 import org.opendaylight.yangtools.yang.model.api.Status;
  37 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  38 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  39
  40 public class YangParserSimpleTest {
  41     private static final QNameModule SN = QNameModule.create(XMLNamespace.of("urn:opendaylight:simple-nodes"),
  42         Revision.of("2013-07-30"));
  43     private static final QName SN_NODES = QName.create(SN, "nodes");
  44     private static final SchemaPath SN_NODES_PATH = SchemaPath.create(true, SN_NODES);
  45
  46     private SchemaContext context;
  47     private Module testModule;
  48
  49     @Before
  50     public void init() throws Exception {
  51         context = TestUtils.loadModules(getClass().getResource("/simple-test").toURI());
  52         testModule = TestUtils.findModule(context, "simple-nodes").get();
  53     }
  54
  55     @Test
  56     public void testParseAnyXml() {
  57         final AnyxmlSchemaNode data = (AnyxmlSchemaNode) testModule.getDataChildByName(
  58             QName.create(testModule.getQNameModule(), "data"));
  59         assertNotNull("'anyxml data not found'", data);
  60         assertFalse(data.equals(null));
  61         assertEquals("RegularAnyxmlEffectiveStatement{qname=(urn:opendaylight:simple-nodes?revision=2013-07-30)data}",
  62                 data.toString());
  63
  64         // test SchemaNode args
  65         assertEquals(QName.create(SN, "data"), data.getQName());
  66         assertEquals(Optional.of("anyxml desc"), data.getDescription());
  67         assertEquals(Optional.of("data ref"), data.getReference());
  68         assertEquals(Status.OBSOLETE, data.getStatus());
  69         assertEquals(0, data.getUnknownSchemaNodes().size());
  70         // test DataSchemaNode args
  71         assertFalse(data.isAugmenting());
  72         assertEquals(Optional.of(Boolean.FALSE), data.effectiveConfig());
  73
  74         assertTrue(data.isMandatory());
  75         assertEquals("class != 'wheel'", data.getWhenCondition().orElseThrow().toString());
  76         final Collection<? extends MustDefinition> mustConstraints = data.getMustConstraints();
  77         assertEquals(2, mustConstraints.size());
  78
  79         final String must1 = "ifType != 'ethernet' or (ifType = 'ethernet' and ifMTU = 1500)";
  80         final String must2 = "ifType != 'atm' or (ifType = 'atm' and ifMTU <= 17966 and ifMTU >= 64)";
  81
  82         boolean found1 = false;
  83         boolean found2 = false;
  84         for (final MustDefinition must : mustConstraints) {
  85             if (must1.equals(must.getXpath().toString())) {
  86                 found1 = true;
  87                 assertEquals(Optional.of("An ethernet MTU must be 1500"), must.getErrorMessage());
  88             } else if (must2.equals(must.getXpath().toString())) {
  89                 found2 = true;
  90                 assertEquals(Optional.of("An atm MTU must be  64 .. 17966"), must.getErrorMessage());
  91                 assertEquals(Optional.of("anyxml data error-app-tag"), must.getErrorAppTag());
  92                 assertEquals(Optional.of("an error occured in data"), must.getDescription());
  93                 assertEquals(Optional.of("data must ref"), must.getReference());
  94             }
  95         }
  96         assertTrue(found1);
  97         assertTrue(found2);
  98     }
  99
 100     @Test
 101     public void testParseAnyData() {
 102         final AnydataSchemaNode anydata = (AnydataSchemaNode) testModule.findDataChildByName(
 103                 QName.create(testModule.getQNameModule(), "data2")).orElse(null);
 104
 105         assertNotNull("'anydata data not found'", anydata);
 106         assertEquals("RegularAnydataEffectiveStatement{qname=(urn:opendaylight:simple-nodes?revision=2013-07-30)data2}",
 107                 anydata.toString());
 108
 109         // test SchemaNode args
 110         assertEquals(QName.create(SN, "data2"), anydata.getQName());
 111         assertEquals(Optional.of("anydata desc"), anydata.getDescription());
 112         assertEquals(Optional.of("data ref"), anydata.getReference());
 113         assertEquals(Status.OBSOLETE, anydata.getStatus());
 114         assertEquals(0, anydata.getUnknownSchemaNodes().size());
 115         // test DataSchemaNode args
 116         assertFalse(anydata.isAugmenting());
 117         assertEquals(Optional.of(Boolean.FALSE), anydata.effectiveConfig());
 118
 119         assertTrue(anydata.isMandatory());
 120         assertTrue(anydata.getWhenCondition().isPresent());
 121         assertEquals("class != 'wheel'", anydata.getWhenCondition().orElseThrow().toString());
 122         final Collection<? extends MustDefinition> mustConstraints = anydata.getMustConstraints();
 123         assertEquals(2, mustConstraints.size());
 124
 125         final String must1 = "ifType != 'ethernet' or (ifType = 'ethernet' and ifMTU = 1500)";
 126         final String must2 = "ifType != 'atm' or (ifType = 'atm' and ifMTU <= 17966 and ifMTU >= 64)";
 127
 128         boolean found1 = false;
 129         boolean found2 = false;
 130         for (final MustDefinition must : mustConstraints) {
 131             if (must1.equals(must.getXpath().toString())) {
 132                 found1 = true;
 133                 assertEquals(Optional.of("An ethernet MTU must be 1500"), must.getErrorMessage());
 134             } else if (must2.equals(must.getXpath().toString())) {
 135                 found2 = true;
 136                 assertEquals(Optional.of("An atm MTU must be  64 .. 17966"), must.getErrorMessage());
 137                 assertEquals(Optional.of("anydata data error-app-tag"), must.getErrorAppTag());
 138                 assertEquals(Optional.of("an error occured in data"), must.getDescription());
 139                 assertEquals(Optional.of("data must ref"), must.getReference());
 140             }
 141         }
 142         assertTrue(found1);
 143         assertTrue(found2);
 144     }
 145
 146     @Test
 147     public void testParseContainer() {
 148         final ContainerSchemaNode nodes = (ContainerSchemaNode) testModule
 149                 .getDataChildByName(QName.create(testModule.getQNameModule(), "nodes"));
 150         // test SchemaNode args
 151         assertEquals(SN_NODES, nodes.getQName());
 152         assertPathEquals(SN_NODES_PATH, nodes);
 153         assertEquals(Optional.of("nodes collection"), nodes.getDescription());
 154         assertEquals(Optional.of("nodes ref"), nodes.getReference());
 155         assertEquals(Status.CURRENT, nodes.getStatus());
 156         assertEquals(0, nodes.getUnknownSchemaNodes().size());
 157         // test DataSchemaNode args
 158         assertFalse(nodes.isAugmenting());
 159         assertEquals(Optional.of(Boolean.FALSE), nodes.effectiveConfig());
 160
 161         // constraints
 162         assertEquals("class != 'wheel'", nodes.getWhenCondition().orElseThrow().toString());
 163         final Collection<? extends MustDefinition> mustConstraints = nodes.getMustConstraints();
 164         assertEquals(2, mustConstraints.size());
 165
 166         final String must1 = "ifType != 'atm' or (ifType = 'atm' and ifMTU <= 17966 and ifMTU >= 64)";
 167         final String errMsg1 = "An atm MTU must be  64 .. 17966";
 168         final String must2 = "ifId != 0";
 169
 170         boolean found1 = false;
 171         boolean found2 = false;
 172         for (final MustDefinition must : mustConstraints) {
 173             if (must1.equals(must.getXpath().toString())) {
 174                 found1 = true;
 175                 assertEquals(Optional.of(errMsg1), must.getErrorMessage());
 176             } else if (must2.equals(must.getXpath().toString())) {
 177                 found2 = true;
 178                 assertFalse(must.getErrorMessage().isPresent());
 179                 assertFalse(must.getErrorAppTag().isPresent());
 180                 assertFalse(must.getDescription().isPresent());
 181                 assertFalse(must.getReference().isPresent());
 182             }
 183         }
 184         assertTrue(found1);
 185         assertTrue(found2);
 186
 187         assertTrue(nodes.isPresenceContainer());
 188
 189         // typedef
 190         final Collection<? extends TypeDefinition<?>> typedefs = nodes.getTypeDefinitions();
 191         assertEquals(1, typedefs.size());
 192         final TypeDefinition<?> nodesType = typedefs.iterator().next();
 193         final QName typedefQName = QName.create(SN, "nodes-type");
 194         assertEquals(typedefQName, nodesType.getQName());
 195         assertFalse(nodesType.getDescription().isPresent());
 196         assertFalse(nodesType.getReference().isPresent());
 197         assertEquals(Status.CURRENT, nodesType.getStatus());
 198         assertEquals(0, nodesType.getUnknownSchemaNodes().size());
 199
 200         // child nodes
 201         // total size = 8: defined 6, inserted by uses 2
 202         assertEquals(8, nodes.getChildNodes().size());
 203         final LeafListSchemaNode added = (LeafListSchemaNode)nodes.getDataChildByName(QName.create(
 204             testModule.getQNameModule(), "added"));
 205         assertPathEquals(createPath("nodes", "added"), added);
 206         assertEquals(createPath("mytype").getLastComponent(), added.getType().getQName());
 207
 208         final ListSchemaNode links = (ListSchemaNode) nodes.getDataChildByName(QName.create(
 209             testModule.getQNameModule(), "links"));
 210         assertFalse(links.isUserOrdered());
 211
 212         final Collection<? extends GroupingDefinition> groupings = nodes.getGroupings();
 213         assertEquals(1, groupings.size());
 214         final GroupingDefinition nodeGroup = groupings.iterator().next();
 215         assertEquals(QName.create(SN, "node-group"), nodeGroup.getQName());
 216
 217         final Collection<? extends UsesNode> uses = nodes.getUses();
 218         assertEquals(1, uses.size());
 219         final UsesNode use = uses.iterator().next();
 220         assertEquals(nodeGroup, use.getSourceGrouping());
 221     }
 222
 223
 224     private static final XMLNamespace NS = XMLNamespace.of("urn:opendaylight:simple-nodes");
 225
 226     private static SchemaPath createPath(final String... names) {
 227         final Revision rev = Revision.of("2013-07-30");
 228         final List<QName> path = new ArrayList<>();
 229         for (final String name : names) {
 230             path.add(QName.create(NS, rev, name));
 231         }
 232         return SchemaPath.create(path, true);
 233     }
 234
 235 }