parser/yang-parser-rfc7950/src/test/java/org/opendaylight/yangtools/yang/stmt/TypesResolutionTest.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.junit.Assert.fail;
  15 import static org.opendaylight.yangtools.yang.stmt.StmtTestUtils.sourceForResource;
  16
  17 import com.google.common.collect.Iterables;
  18 import com.google.common.collect.Range;
  19 import java.util.Collection;
  20 import java.util.Iterator;
  21 import java.util.List;
  22 import java.util.Optional;
  23 import org.junit.BeforeClass;
  24 import org.junit.Test;
  25 import org.opendaylight.yangtools.yang.common.QName;
  26 import org.opendaylight.yangtools.yang.common.Revision;
  27 import org.opendaylight.yangtools.yang.common.Uint32;
  28 import org.opendaylight.yangtools.yang.common.XMLNamespace;
  29 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
  30 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  31 import org.opendaylight.yangtools.yang.model.api.Module;
  32 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  33 import org.opendaylight.yangtools.yang.model.api.Status;
  34 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  35 import org.opendaylight.yangtools.yang.model.api.stmt.UnrecognizedStatement;
  36 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
  37 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition.Bit;
  38 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
  39 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition.EnumPair;
  40 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
  41 import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
  42 import org.opendaylight.yangtools.yang.model.api.type.LengthConstraint;
  43 import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint;
  44 import org.opendaylight.yangtools.yang.model.api.type.StringTypeDefinition;
  45 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
  46 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.RFC7950Reactors;
  47 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
  48 import org.opendaylight.yangtools.yang.parser.spi.meta.SomeModifiersUnresolvedException;
  49 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  50 import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor.BuildAction;
  51
  52 public class TypesResolutionTest {
  53     private static SchemaContext CONTEXT;
  54
  55     @BeforeClass
  56     public static void beforeClass() throws Exception {
  57         CONTEXT = TestUtils.parseYangSource(
  58             "/types/custom-types-test@2012-04-04.yang",
  59             "/ietf/iana-timezones@2012-07-09.yang",
  60             "/ietf/ietf-inet-types@2010-09-24.yang",
  61             "/ietf/ietf-yang-types@2010-09-24.yang");
  62         assertEquals(4, CONTEXT.getModules().size());
  63     }
  64
  65     @Test
  66     public void testIPVersion() {
  67         Module tested = CONTEXT.findModules("ietf-inet-types").iterator().next();
  68         Collection<? extends TypeDefinition<?>> typedefs = tested.getTypeDefinitions();
  69         assertEquals(14, typedefs.size());
  70
  71         TypeDefinition<?> type = TestUtils.findTypedef(typedefs, "ip-version");
  72         assertTrue(type.getDescription().get().contains("This value represents the version of the IP protocol."));
  73         assertTrue(type.getReference().get().contains("RFC 2460: Internet Protocol, Version 6 (IPv6) Specification"));
  74
  75         EnumTypeDefinition enumType = (EnumTypeDefinition) type.getBaseType();
  76         List<EnumPair> values = enumType.getValues();
  77         assertEquals(3, values.size());
  78
  79         EnumPair value0 = values.get(0);
  80         assertEquals("unknown", value0.getName());
  81         assertEquals(0, value0.getValue());
  82         assertEquals(Optional.of("An unknown or unspecified version of the Internet protocol."),
  83             value0.getDescription());
  84
  85         EnumPair value1 = values.get(1);
  86         assertEquals("ipv4", value1.getName());
  87         assertEquals(1, value1.getValue());
  88         assertEquals(Optional.of("The IPv4 protocol as defined in RFC 791."), value1.getDescription());
  89
  90         EnumPair value2 = values.get(2);
  91         assertEquals("ipv6", value2.getName());
  92         assertEquals(2, value2.getValue());
  93         assertEquals(Optional.of("The IPv6 protocol as defined in RFC 2460."), value2.getDescription());
  94     }
  95
  96     @Test
  97     public void testEnumeration() {
  98         Module tested = CONTEXT.findModules("custom-types-test").iterator().next();
  99         Collection<? extends TypeDefinition<?>> typedefs = tested.getTypeDefinitions();
 100
 101         TypeDefinition<?> type = TestUtils.findTypedef(typedefs, "ip-version");
 102         EnumTypeDefinition enumType = (EnumTypeDefinition) type.getBaseType();
 103         List<EnumPair> values = enumType.getValues();
 104         assertEquals(4, values.size());
 105
 106         EnumPair value0 = values.get(0);
 107         assertEquals("unknown", value0.getName());
 108         assertEquals(0, value0.getValue());
 109         assertEquals(Optional.of("An unknown or unspecified version of the Internet protocol."),
 110             value0.getDescription());
 111
 112         EnumPair value1 = values.get(1);
 113         assertEquals("ipv4", value1.getName());
 114         assertEquals(19, value1.getValue());
 115         assertEquals(Optional.of("The IPv4 protocol as defined in RFC 791."), value1.getDescription());
 116
 117         EnumPair value2 = values.get(2);
 118         assertEquals("ipv6", value2.getName());
 119         assertEquals(7, value2.getValue());
 120         assertEquals(Optional.of("The IPv6 protocol as defined in RFC 2460."), value2.getDescription());
 121
 122         EnumPair value3 = values.get(3);
 123         assertEquals("default", value3.getName());
 124         assertEquals(20, value3.getValue());
 125         assertEquals(Optional.of("default ip"), value3.getDescription());
 126     }
 127
 128     @Test
 129     public void testIpAddress() {
 130         Module tested = CONTEXT.findModules("ietf-inet-types").iterator().next();
 131         Collection<? extends TypeDefinition<?>> typedefs = tested.getTypeDefinitions();
 132         TypeDefinition<?> type = TestUtils.findTypedef(typedefs, "ip-address");
 133         UnionTypeDefinition baseType = (UnionTypeDefinition) type.getBaseType();
 134         List<TypeDefinition<?>> unionTypes = baseType.getTypes();
 135
 136         StringTypeDefinition ipv4 = (StringTypeDefinition) unionTypes.get(0);
 137         assertNotNull(ipv4.getBaseType());
 138         String expectedPattern = "^(?:(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}"
 139                 + "([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])" + "(%[\\p{N}\\p{L}]+)?)$";
 140         assertEquals(expectedPattern, ipv4.getPatternConstraints().get(0).getJavaPatternString());
 141
 142         StringTypeDefinition ipv6 = (StringTypeDefinition) unionTypes.get(1);
 143         assertNotNull(ipv6.getBaseType());
 144         List<PatternConstraint> ipv6Patterns = ipv6.getPatternConstraints();
 145         expectedPattern = "^(?:((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}"
 146                 + "((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|" + "(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\\.){3}"
 147                 + "(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))" + "(%[\\p{N}\\p{L}]+)?)$";
 148         assertEquals(expectedPattern, ipv6Patterns.get(0).getJavaPatternString());
 149
 150         expectedPattern = "^(?:(([^:]+:){6}(([^:]+:[^:]+)|(.*\\..*)))|" + "((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)"
 151                 + "(%.+)?)$";
 152         assertEquals(expectedPattern, ipv6Patterns.get(1).getJavaPatternString());
 153     }
 154
 155     @Test
 156     public void testDomainName() {
 157         Module tested = CONTEXT.findModules("ietf-inet-types").iterator().next();
 158         Collection<? extends TypeDefinition<?>> typedefs = tested.getTypeDefinitions();
 159         StringTypeDefinition type = (StringTypeDefinition) TestUtils.findTypedef(typedefs, "domain-name");
 160         assertNotNull(type.getBaseType());
 161         List<PatternConstraint> patterns = type.getPatternConstraints();
 162         assertEquals(1, patterns.size());
 163         String expectedPattern = "^(?:((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*"
 164                 + "([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?)" + "|\\.)$";
 165         assertEquals(expectedPattern, patterns.get(0).getJavaPatternString());
 166
 167         LengthConstraint lengths = type.getLengthConstraint().get();
 168         assertEquals(1, lengths.getAllowedRanges().asRanges().size());
 169         Range<Integer> length = lengths.getAllowedRanges().span();
 170         assertEquals(Integer.valueOf(1), length.lowerEndpoint());
 171         assertEquals(Integer.valueOf(253), length.upperEndpoint());
 172     }
 173
 174     @Test
 175     public void testInstanceIdentifier1() {
 176         Module tested = CONTEXT.findModules("custom-types-test").iterator().next();
 177         LeafSchemaNode leaf = (LeafSchemaNode) tested.getDataChildByName(
 178                 QName.create(tested.getQNameModule(), "inst-id-leaf1"));
 179         InstanceIdentifierTypeDefinition leafType = (InstanceIdentifierTypeDefinition) leaf.getType();
 180         assertFalse(leafType.requireInstance());
 181         assertEquals(1,
 182             leaf.asEffectiveStatement().getDeclared().declaredSubstatements(UnrecognizedStatement.class).size());
 183     }
 184
 185     @Test
 186     public void testInstanceIdentifier2() {
 187         Module tested = CONTEXT.findModules("custom-types-test").iterator().next();
 188         LeafSchemaNode leaf = (LeafSchemaNode) tested.getDataChildByName(
 189                 QName.create(tested.getQNameModule(), "inst-id-leaf2"));
 190         InstanceIdentifierTypeDefinition leafType = (InstanceIdentifierTypeDefinition) leaf.getType();
 191         assertFalse(leafType.requireInstance());
 192     }
 193
 194     @Test
 195     public void testIdentity() {
 196         Module tested = CONTEXT.findModules("custom-types-test").iterator().next();
 197         Collection<? extends IdentitySchemaNode> identities = tested.getIdentities();
 198         assertEquals(5, identities.size());
 199         IdentitySchemaNode cryptoAlg = null;
 200         IdentitySchemaNode cryptoBase = null;
 201         IdentitySchemaNode cryptoId = null;
 202         for (IdentitySchemaNode id : identities) {
 203             if (id.getQName().getLocalName().equals("crypto-alg")) {
 204                 cryptoAlg = id;
 205             } else if ("crypto-base".equals(id.getQName().getLocalName())) {
 206                 cryptoBase = id;
 207             } else if ("crypto-id".equals(id.getQName().getLocalName())) {
 208                 cryptoId = id;
 209             }
 210         }
 211         assertNotNull(cryptoAlg);
 212         IdentitySchemaNode baseIdentity = Iterables.getOnlyElement(cryptoAlg.getBaseIdentities());
 213         assertEquals("crypto-base", baseIdentity.getQName().getLocalName());
 214         assertEquals(0, CONTEXT.getDerivedIdentities(cryptoAlg).size());
 215         assertEquals(0, baseIdentity.getBaseIdentities().size());
 216
 217         assertNotNull(cryptoBase);
 218         assertTrue(cryptoBase.getBaseIdentities().isEmpty());
 219         assertEquals(3, CONTEXT.getDerivedIdentities(cryptoBase).size());
 220
 221         assertNotNull(cryptoId);
 222         assertEquals(1,
 223             cryptoId.asEffectiveStatement().getDeclared().declaredSubstatements(UnrecognizedStatement.class).size());
 224     }
 225
 226     @Test
 227     public void testBitsType1() {
 228         Module tested = CONTEXT.findModules("custom-types-test").iterator().next();
 229         LeafSchemaNode leaf = (LeafSchemaNode) tested.getDataChildByName(
 230                 QName.create(tested.getQNameModule(), "mybits"));
 231         BitsTypeDefinition leafType = (BitsTypeDefinition) leaf.getType();
 232         Iterator<? extends Bit> bits = leafType.getBits().iterator();
 233
 234         Bit bit1 = bits.next();
 235         assertEquals("disable-nagle", bit1.getName());
 236         assertEquals(Uint32.ZERO, bit1.getPosition());
 237
 238         Bit bit2 = bits.next();
 239         assertEquals("auto-sense-speed", bit2.getName());
 240         assertEquals(Uint32.ONE, bit2.getPosition());
 241
 242         Bit bit3 = bits.next();
 243         assertEquals("only-10-Mb", bit3.getName());
 244         assertEquals(Uint32.TWO, bit3.getPosition());
 245
 246         assertFalse(bits.hasNext());
 247     }
 248
 249     @Test
 250     public void testBitsType2() {
 251         Module tested = CONTEXT.findModules("custom-types-test").iterator().next();
 252         Collection<? extends TypeDefinition<?>> typedefs = tested.getTypeDefinitions();
 253         TypeDefinition<?> testedType = TestUtils.findTypedef(typedefs, "access-operations-type");
 254
 255         BitsTypeDefinition bitsType = (BitsTypeDefinition) testedType.getBaseType();
 256         Iterator<? extends Bit> bits = bitsType.getBits().iterator();
 257
 258         Bit bit0 = bits.next();
 259         assertEquals("create", bit0.getName());
 260         assertEquals(Uint32.ZERO, bit0.getPosition());
 261
 262         Bit bit1 = bits.next();
 263         assertEquals("delete", bit1.getName());
 264         assertEquals(Uint32.valueOf(365), bit1.getPosition());
 265
 266         Bit bit2 = bits.next();
 267         assertEquals("read", bit2.getName());
 268         assertEquals(Uint32.valueOf(500), bit2.getPosition());
 269
 270         Bit bit3 = bits.next();
 271         assertEquals("update", bit3.getName());
 272         assertEquals(Uint32.valueOf(501), bit3.getPosition());
 273
 274         Bit bit4 = bits.next();
 275         assertEquals("exec", bit4.getName());
 276         assertEquals(Uint32.valueOf(502), bit4.getPosition());
 277
 278         assertFalse(bits.hasNext());
 279     }
 280
 281     @Test
 282     public void testIanaTimezones() {
 283         Module tested = CONTEXT.findModules("iana-timezones").iterator().next();
 284         Collection<? extends TypeDefinition<?>> typedefs = tested.getTypeDefinitions();
 285         TypeDefinition<?> testedType = TestUtils.findTypedef(typedefs, "iana-timezone");
 286
 287         String expectedDesc = "A timezone location as defined by the IANA timezone";
 288         assertTrue(testedType.getDescription().get().contains(expectedDesc));
 289         assertFalse(testedType.getReference().isPresent());
 290         assertEquals(Status.CURRENT, testedType.getStatus());
 291
 292         QName testedTypeQName = testedType.getQName();
 293         assertEquals(XMLNamespace.of("urn:ietf:params:xml:ns:yang:iana-timezones"), testedTypeQName.getNamespace());
 294         assertEquals(Revision.ofNullable("2012-07-09"), testedTypeQName.getRevision());
 295         assertEquals("iana-timezone", testedTypeQName.getLocalName());
 296
 297         EnumTypeDefinition enumType = (EnumTypeDefinition) testedType.getBaseType();
 298         List<EnumPair> values = enumType.getValues();
 299         // 0-414
 300         assertEquals(415, values.size());
 301
 302         EnumPair enum168 = values.get(168);
 303         assertEquals("America/Danmarkshavn", enum168.getName());
 304         assertEquals(168, enum168.getValue());
 305         assertEquals(Optional.of("east coast, north of Scoresbysund"), enum168.getDescription());
 306
 307         EnumPair enum374 = values.get(374);
 308         assertEquals("America/Indiana/Winamac", enum374.getName());
 309         assertEquals(374, enum374.getValue());
 310         assertEquals(Optional.of("Eastern Time - Indiana - Pulaski County"), enum374.getDescription());
 311     }
 312
 313     @Test
 314     public void testObjectId128() {
 315         Module tested = CONTEXT.findModules("ietf-yang-types").iterator().next();
 316         Collection<? extends TypeDefinition<?>> typedefs = tested.getTypeDefinitions();
 317         StringTypeDefinition testedType = (StringTypeDefinition) TestUtils.findTypedef(typedefs,
 318                 "object-identifier-128");
 319
 320         List<PatternConstraint> patterns = testedType.getPatternConstraints();
 321         assertEquals(1, patterns.size());
 322         PatternConstraint pattern = patterns.get(0);
 323         assertEquals("^(?:\\d*(\\.\\d*){1,127})$", pattern.getJavaPatternString());
 324
 325         QName testedTypeQName = testedType.getQName();
 326         assertEquals(XMLNamespace.of("urn:ietf:params:xml:ns:yang:ietf-yang-types"), testedTypeQName.getNamespace());
 327         assertEquals(Revision.ofNullable("2010-09-24"), testedTypeQName.getRevision());
 328         assertEquals("object-identifier-128", testedTypeQName.getLocalName());
 329
 330         StringTypeDefinition testedTypeBase = testedType.getBaseType();
 331         patterns = testedTypeBase.getPatternConstraints();
 332         assertEquals(1, patterns.size());
 333
 334         pattern = patterns.get(0);
 335         assertEquals("^(?:(([0-1](\\.[1-3]?[0-9]))|(2\\.(0|([1-9]\\d*))))(\\.(0|([1-9]\\d*)))*)$",
 336                 pattern.getJavaPatternString());
 337
 338         QName testedTypeBaseQName = testedTypeBase.getQName();
 339         assertEquals(XMLNamespace.of("urn:ietf:params:xml:ns:yang:ietf-yang-types"),
 340             testedTypeBaseQName.getNamespace());
 341         assertEquals(Revision.ofNullable("2010-09-24"), testedTypeBaseQName.getRevision());
 342         assertEquals("object-identifier", testedTypeBaseQName.getLocalName());
 343     }
 344
 345     @Test
 346     public void testIdentityref() {
 347         Module tested = CONTEXT.findModules("custom-types-test").iterator().next();
 348         Collection<? extends TypeDefinition<?>> typedefs = tested.getTypeDefinitions();
 349         TypeDefinition<?> testedType = TestUtils.findTypedef(typedefs, "service-type-ref");
 350         IdentityrefTypeDefinition baseType = (IdentityrefTypeDefinition) testedType.getBaseType();
 351         QName identity = baseType.getIdentities().iterator().next().getQName();
 352         assertEquals(XMLNamespace.of("urn:custom.types.demo"), identity.getNamespace());
 353         assertEquals(Revision.ofNullable("2012-04-16"), identity.getRevision());
 354         assertEquals("service-type", identity.getLocalName());
 355
 356         LeafSchemaNode type = (LeafSchemaNode) tested.getDataChildByName(QName.create(tested.getQNameModule(), "type"));
 357         assertNotNull(type);
 358     }
 359
 360     @Test
 361     public void testUnionWithExt() throws ReactorException {
 362         final SchemaContext result = RFC7950Reactors.defaultReactor().newBuild()
 363                 .addSource(sourceForResource("/types/union-with-ext/extdef.yang"))
 364                 .addSource(sourceForResource("/types/union-with-ext/unionbug.yang"))
 365                 .addSource(sourceForResource("/ietf/ietf-inet-types@2010-09-24.yang"))
 366                 .buildEffective();
 367         assertNotNull(result);
 368     }
 369
 370     @Test
 371     public void testUnionWithBits() throws ReactorException {
 372         final SchemaContext result = RFC7950Reactors.defaultReactor().newBuild()
 373                 .addSource(sourceForResource("/types/union-with-bits/union-bits-model.yang"))
 374                 .buildEffective();
 375         assertNotNull(result);
 376     }
 377
 378     @Test
 379     public void testUnionInList() {
 380         BuildAction reactor = RFC7950Reactors.defaultReactor().newBuild()
 381                 .addSource(sourceForResource("/types/union-in-list/unioninlisttest.yang"));
 382
 383         try {
 384             final SchemaContext result = reactor.buildEffective();
 385             fail("effective build should fail due to union in list; this is not allowed");
 386         } catch (ReactorException e) {
 387             assertEquals(SomeModifiersUnresolvedException.class, e.getClass());
 388             assertTrue(e.getCause() instanceof SourceException);
 389             assertTrue(e.getCause().getMessage().startsWith("union is not a YANG statement or use of extension"));
 390         }
 391     }
 392 }