binding2/mdsal-binding2-generator-impl/src/test/java/org/opendaylight/mdsal/binding/javav2/generator/impl/BindingGeneratorImplTest.java

   1 /*
   2  * Copyright (c) 2017 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.mdsal.binding.javav2.generator.impl;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertNotNull;
  12 import static org.junit.Assert.assertTrue;
  13 import static org.junit.Assert.fail;
  14
  15 import java.util.ArrayList;
  16 import java.util.List;
  17 import org.junit.Test;
  18 import org.opendaylight.mdsal.binding.javav2.generator.api.BindingGenerator;
  19 import org.opendaylight.mdsal.binding.javav2.model.api.Enumeration;
  20 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedProperty;
  21 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedTransferObject;
  22 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedType;
  23 import org.opendaylight.mdsal.binding.javav2.model.api.MethodSignature;
  24 import org.opendaylight.mdsal.binding.javav2.model.api.Type;
  25 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTOBuilder;
  26 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  27 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  28
  29 public class BindingGeneratorImplTest {
  30
  31     @Test
  32     public void genTypesTypeDefTest() throws Exception {
  33         final BindingGeneratorImpl bg = new BindingGeneratorImpl(false);
  34         final SchemaContext schemaContext = YangParserTestUtils.parseYangSource("/generator/test-typedef.yang");
  35         final List<Type> generateTypes = bg.generateTypes(schemaContext);
  36         assertNotNull(generateTypes);
  37         for (final Type genType : generateTypes) {
  38             if (genType.getName().equals("MyInnerCont") && genType.getPackageName()
  39                     .equals("org.opendaylight.mdsal.gen.javav2.urn.test.simple.test.rev170206.data.asteriskmy_cont")) {
  40                 final GeneratedType gt = (GeneratedType) genType;
  41                 for (final MethodSignature methodSignature : gt.getMethodDefinitions()) {
  42                     if (methodSignature.getName().equals("getMyLeaf2")) {
  43                         assertEquals(methodSignature.getReturnType().getName(), "MyType");
  44                     }
  45                 }
  46             }
  47         }
  48     }
  49
  50     @Test
  51     public void generatedTypesEnumTest() throws Exception {
  52         final BindingGenerator bg = new BindingGeneratorImpl(false);
  53         final SchemaContext context = YangParserTestUtils.parseYangSource("/generator/apple-test.yang");
  54         final List<Type> generateTypes = bg.generateTypes(context);
  55         assertNotNull(generateTypes);
  56         assertTrue(!generateTypes.isEmpty());
  57         for (final Type type : generateTypes) {
  58             if (type.getName().equals("Apple") && type.getPackageName()
  59                     .equals("org.opendaylight.mdsal.gen.javav2.urn.test.simple.apple.rev170503.data")) {
  60                 final GeneratedType gt = (GeneratedType) type;
  61                 final Enumeration enumeration = gt.getEnumerations().get(0);
  62                 assertEquals("Apple1", enumeration.getName());
  63                 assertEquals("org.opendaylight.mdsal.gen.javav2.urn.test.simple.apple.rev170503.data.Apple",
  64                         enumeration.getPackageName());
  65                 assertEquals("apple", enumeration.getValues().get(0).getName());
  66                 assertEquals("APPLE", enumeration.getValues().get(0).getMappedName());
  67                 assertEquals("apple1", enumeration.getValues().get(1).getName());
  68                 assertEquals("APPLE1", enumeration.getValues().get(1).getMappedName());
  69             }
  70         }
  71     }
  72
  73     @Test
  74     public void generatedTypesUsesEnumLeafTest() throws Exception {
  75         final BindingGenerator bg = new BindingGeneratorImpl(false);
  76         final List<String> sources = new ArrayList<>();
  77         sources.add("/uses-statement/test-uses-leaf-innertype-base.yang");
  78         sources.add("/uses-statement/test-uses-leaf-innertype.yang");
  79         final SchemaContext context = YangParserTestUtils.parseYangSources(sources);
  80         final List<Type> generateTypes = bg.generateTypes(context);
  81         assertNotNull(generateTypes);
  82         assertTrue(!generateTypes.isEmpty());
  83         for (final Type type : generateTypes) {
  84             if (type.getName().equals("MyCont") && type.getPackageName()
  85                     .equals("org.opendaylight.mdsal.gen.javav2.urn.test.uses.leaf.innertype.base.rev170809.data")) {
  86                 final GeneratedType gt = (GeneratedType) type;
  87                 final MethodSignature methodSignature = gt.getMethodDefinitions().get(0);
  88                 assertEquals("ErrorType", methodSignature.getReturnType().getName());
  89             }
  90
  91             if (type.getName().equals("MyCont") && type.getPackageName()
  92                     .equals("org.opendaylight.mdsal.gen.javav2.urn.test.uses.leaf.innertype.rev170809.data")) {
  93                 final GeneratedType gt = (GeneratedType) type;
  94                 final MethodSignature methodSignature = gt.getMethodDefinitions().get(0);
  95                 assertEquals("ErrorType", methodSignature.getReturnType().getName());
  96             }
  97         }
  98     }
  99
 100     @Test
 101     public void generatedTypesTest() throws Exception {
 102         final BindingGenerator bg = new BindingGeneratorImpl(false);
 103         final SchemaContext context = YangParserTestUtils.parseYangSource("/generator/test-list.yang");
 104         final List<Type> generateTypes = bg.generateTypes(context);
 105
 106         assertNotNull(generateTypes);
 107         assertTrue(!generateTypes.isEmpty());
 108         assertEquals(3, generateTypes.size());
 109         final int[] test_i = { 0 };
 110         for (final Type t : generateTypes) {
 111             if (t instanceof GeneratedTransferObject) {
 112                 final GeneratedTransferObject genTransferObj = (GeneratedTransferObject) t;
 113                 assertBaseGeneratedType(genTransferObj, "MyListKey",
 114                         "org.opendaylight.mdsal.gen.javav2.urn.test.simple.test.list.rev170314.key.my_list");
 115                 assertEquals(3, genTransferObj.getProperties().size());
 116                 int test_j = 0;
 117                 for (final GeneratedProperty generatedProperty : genTransferObj.getProperties()) {
 118                     switch (generatedProperty.getName()) {
 119                         case "keyReservedWord":
 120                             assertEquals("String", generatedProperty.getReturnType().getName());
 121                             test_j++;
 122                             break;
 123                         case "key1":
 124                             assertEquals("String", generatedProperty.getReturnType().getName());
 125                             test_j++;
 126                             break;
 127                         case "key2":
 128                             assertEquals("String", generatedProperty.getReturnType().getName());
 129                             test_j++;
 130                             break;
 131                         default:
 132                             fail();
 133                     }
 134                 }
 135                 assertEquals(3, test_j);
 136                 test_i[0] += 1;
 137             } else {
 138                 testActualType((GeneratedType) t, test_i);
 139             }
 140         }
 141         assertEquals(3, test_i[0]);
 142     }
 143
 144     @Test
 145     public void generateTypesDescriptionsTest() throws Exception {
 146         final BindingGenerator bg = new BindingGeneratorImpl(true);
 147         final SchemaContext context = YangParserTestUtils.parseYangSources("/base/with_import/");
 148         assertNotNull(context);
 149
 150         final List<Type> generateTypes = bg.generateTypes(context, context.getModules());
 151         assertNotNull(generateTypes);
 152         assertTrue(!generateTypes.isEmpty());
 153
 154         for (final Type type : generateTypes) {
 155             if (type.getName().equals("TestData")) {
 156                 final String description = ((GeneratedType) type).getDescription().get();
 157                 description
 158                         .contains("    import test-import { prefix \"imported-test\"; revision-date 2017-04-21; }\n\n");
 159                 description.contains("    revision 2017-02-06;\n\n");
 160                 description.contains("    typedef my-type {\n        type int8;\n    }");
 161                 description.contains("    container *my-cont {\n    }\n");
 162             }
 163         }
 164     }
 165
 166     @Test
 167     public void generateTypesIdentityTest() throws Exception {
 168         final BindingGenerator bg = new BindingGeneratorImpl(true);
 169         final SchemaContext context = YangParserTestUtils.parseYangSources("/identity/");
 170         assertNotNull(context);
 171
 172         final List<Type> generateTypes = bg.generateTypes(context, context.getModules());
 173         assertNotNull(generateTypes);
 174         assertTrue(!generateTypes.isEmpty());
 175         for (final Type type : generateTypes) {
 176             if (type.getFullyQualifiedName()
 177                     .equals("org.opendaylight.mdsal.gen.javav2.identity3.module.rev170708.ident.Iden1")) {
 178                 final GeneratedTransferObject genTO = (GeneratedTransferObject)type;
 179                 assertEquals("org.opendaylight.mdsal.gen.javav2.identity3.module.rev170708.ident.Iden2",
 180                         genTO.getSuperType().getFullyQualifiedName());
 181
 182             }
 183             if (type.getFullyQualifiedName()
 184                     .equals("org.opendaylight.mdsal.gen.javav2.identity3.module.rev170708.ident.Iden2")) {
 185                 final GeneratedTransferObject genTO = (GeneratedTransferObject)type;
 186                 assertEquals("org.opendaylight.mdsal.gen.javav2.identity.import_.rev170602.ident.Iden1",
 187                         genTO.getSuperType().getFullyQualifiedName());
 188
 189             }
 190             if (type.getFullyQualifiedName()
 191                     .equals("org.opendaylight.mdsal.gen.javav2.identity3.module.rev170708.ident.Iden3")) {
 192                 final GeneratedTransferObject genTO = (GeneratedTransferObject)type;
 193                 assertEquals("org.opendaylight.mdsal.gen.javav2.identity3.module.rev170708.ident.Iden1",
 194                         genTO.getSuperType().getFullyQualifiedName());
 195
 196             }
 197         }
 198     }
 199
 200     private void testActualType(final GeneratedType t, final int[] test_i) {
 201         MethodSignature methodSignature = null;
 202         switch (t.getName()) {
 203             case "TestListData":
 204                 assertEquals("org.opendaylight.mdsal.gen.javav2.urn.test.simple.test.list.rev170314",
 205                         t.getPackageName());
 206                 methodSignature = t.getMethodDefinitions().get(0);
 207                 assertMethod(t, "getMyList", "List", "java.util", methodSignature);
 208                 test_i[0] += 1;
 209                 break;
 210             case "MyListKey":
 211                 assertEquals("org.opendaylight.mdsal.gen.javav2.urn.test.simple.test.list.rev170314.key.my_list",
 212                         t.getPackageName());
 213                 methodSignature = t.getMethodDefinitions().get(0);
 214                 assertMethod(t, "getKey", "String", "java.lang", methodSignature);
 215                 test_i[0] += 1;
 216                 break;
 217             case "MyListKey1":
 218                 assertEquals("org.opendaylight.mdsal.gen.javav2.urn.test.simple.test.list.rev170314.key.my_list",
 219                         t.getPackageName());
 220                 methodSignature = t.getMethodDefinitions().get(0);
 221                 assertMethod(t, "getKey1", "String", "java.lang", methodSignature);
 222                 test_i[0] += 1;
 223                 break;
 224             case "MyListKey2":
 225                 assertEquals("org.opendaylight.mdsal.gen.javav2.urn.test.simple.test.list.rev170314.key.my_list",
 226                         t.getPackageName());
 227                 methodSignature = t.getMethodDefinitions().get(0);
 228                 assertMethod(t, "getKey2", "String", "java.lang", methodSignature);
 229                 test_i[0] += 1;
 230                 break;
 231             case "MyListFoo":
 232                 assertEquals("org.opendaylight.mdsal.gen.javav2.urn.test.simple.test.list.rev170314.data.my_list",
 233                         t.getPackageName());
 234                 methodSignature = t.getMethodDefinitions().get(0);
 235                 assertMethod(t, "getFoo", "String", "java.lang", methodSignature);
 236                 test_i[0] += 1;
 237                 break;
 238             case "MyList":
 239                 assertEquals("org.opendaylight.mdsal.gen.javav2.urn.test.simple.test.list.rev170314.data",
 240                         t.getPackageName());
 241                 assertEquals(5, t.getMethodDefinitions().size());
 242                 int test_j = 0;
 243                 for (final MethodSignature m : t.getMethodDefinitions()) {
 244                     switch (m.getName()) {
 245                         case "getKey":
 246                                 assertMethod(t, "getKey", "MyListKey",
 247                                         "org.opendaylight.mdsal.gen.javav2.urn.test.simple.test.list.rev170314.key.my_list",
 248                                         m);
 249                             test_j++;
 250                             break;
 251                         case "getKey1":
 252                             assertMethod(t, "getKey1", "String","java.lang", m);
 253                             test_j++;
 254                             break;
 255                         case "getKey2":
 256                             assertMethod(t, "getKey2", "String","java.lang", m);
 257                             test_j++;
 258                             break;
 259                         case "getFoo":
 260                             assertMethod(t, "getFoo", "String","java.lang", m);
 261                             test_j++;
 262                             break;
 263                         case "getKeyReservedWord":
 264                             assertMethod(t, "getKeyReservedWord", "String","java.lang", m);
 265                             test_j++;
 266                             break;
 267                         default:
 268                             fail();
 269                     }
 270                 }
 271                 assertEquals(5, test_j);
 272                 test_i[0] += 1;
 273                 break;
 274             default:
 275                 fail();
 276         }
 277     }
 278
 279     private void assertBaseGeneratedType(final GeneratedType genType, final String name, final String packageName) {
 280         assertEquals(name, genType.getName());
 281
 282     }
 283
 284     private void assertMethod(final GeneratedType definingTypeExpected, final String nameExpected,
 285             final String typeNameExpected, final String typePackageNameExpected,
 286             final MethodSignature methodSignature) {
 287         assertEquals(definingTypeExpected, methodSignature.getDefiningType());
 288         assertEquals(nameExpected, methodSignature.getName());
 289         assertEquals(typeNameExpected, methodSignature.getReturnType().getName());
 290         assertEquals(typePackageNameExpected, methodSignature.getReturnType().getPackageName());
 291     }
 292
 293 }