2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.stmt.yin;
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertNotNull;
12 import static org.junit.Assert.assertNull;
14 import java.util.Iterator;
15 import java.util.Optional;
16 import org.junit.Test;
17 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
18 import org.opendaylight.yangtools.yang.model.api.Module;
20 public class YinFileExtensionStmtTest extends AbstractYinModulesTest {
23 public void testExtensions() {
24 Module testModule = context.findModules("config").iterator().next();
25 assertNotNull(testModule);
27 var extensions = testModule.getExtensionSchemaNodes();
28 assertEquals(5, extensions.size());
30 Iterator<? extends ExtensionDefinition> extIterator = extensions.iterator();
31 ExtensionDefinition extension = extIterator.next();
32 assertEquals("name", extension.getArgument());
33 assertEquals("java-class", extension.getQName().getLocalName());
34 assertEquals(Optional.of("YANG language extension carrying the fully-qualified name of\n"
35 + "a Java class. Code generation tools use the provided reference\n"
36 + "to tie a specific construct to its Java representation."), extension.getDescription());
38 extension = extIterator.next();
39 assertEquals("name", extension.getArgument());
40 assertEquals("required-identity", extension.getQName().getLocalName());
41 assertEquals(Optional.of("YANG language extension which indicates that a particular\n"
42 + "leafref, which points to a identityref, should additionally\n"
43 + "require the target node is actually set to a descendant to\n"
44 + "of a particular identity.\n"
46 + "This is a workaround to two YANG deficiencies:\n"
47 + "1) not being able to leafref instances of identityref\n"
48 + "2) not being able to refine an identityref\n"
50 + "This extension takes one argument, name, which MUST be the name\n"
51 + "of an identity. Furthermore, that identity MUST be based,\n"
52 + "directly or indirectly, on the identity, which is referenced by\n"
53 + "the leaf reference, which is annotated with this extension."), extension.getDescription());
55 extension = extIterator.next();
56 assertNull(extension.getArgument());
57 assertEquals("inner-state-bean", extension.getQName().getLocalName());
58 assertEquals(Optional.of("YANG language extension which indicates that a particular\n"
59 + "list located under module's state should be treated as a list\n"
60 + "of child state beans instead of just an ordinary list attribute"), extension.getDescription());
62 extension = extIterator.next();
63 assertEquals("name", extension.getArgument());
64 assertEquals("provided-service", extension.getQName().getLocalName());
65 assertEquals(Optional.of("YANG language extension which indicates that a particular\n"
66 + "module provides certain service. This extension can be placed\n"
67 + "on identities that are based on module-type. Zero or more services\n"
68 + "can be provided.\n"
69 + "This extension takes one argument - name - which MUST be the name\n"
70 + "of an identity. Furthermore, this identity MUST be based on\n"
71 + "service-type."), extension.getDescription());
73 extension = extIterator.next();
74 assertEquals("java-prefix", extension.getArgument());
75 assertEquals("java-name-prefix", extension.getQName().getLocalName());
76 assertEquals(Optional.of("YANG language extension carrying java simple class name prefix\n"
77 + "that will be taken into account when generating java code from\n"
78 + "identities that are based on module-type."), extension.getDescription());