code-generator/binding-java-api-generator/src/test/java/org/opendaylight/yangtools/sal/java/api/generator/test/TypedefCompilationTest.java

   1 /*
   2  * Copyright (c) 2013 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.sal.java.api.generator.test;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertFalse;
  12 import static org.junit.Assert.assertTrue;
  13 import static org.opendaylight.yangtools.sal.java.api.generator.test.CompilationTestUtils.BASE_PKG;
  14 import static org.opendaylight.yangtools.sal.java.api.generator.test.CompilationTestUtils.COMPILER_OUTPUT_PATH;
  15 import static org.opendaylight.yangtools.sal.java.api.generator.test.CompilationTestUtils.FS;
  16 import static org.opendaylight.yangtools.sal.java.api.generator.test.CompilationTestUtils.GENERATOR_OUTPUT_PATH;
  17 import static org.opendaylight.yangtools.sal.java.api.generator.test.CompilationTestUtils.NS_FOO;
  18 import static org.opendaylight.yangtools.sal.java.api.generator.test.CompilationTestUtils.assertContainsConstructor;
  19 import static org.opendaylight.yangtools.sal.java.api.generator.test.CompilationTestUtils.assertContainsDefaultMethods;
  20 import static org.opendaylight.yangtools.sal.java.api.generator.test.CompilationTestUtils.assertContainsField;
  21 import static org.opendaylight.yangtools.sal.java.api.generator.test.CompilationTestUtils.assertContainsFieldWithValue;
  22 import static org.opendaylight.yangtools.sal.java.api.generator.test.CompilationTestUtils.assertContainsGetLengthOrRange;
  23 import static org.opendaylight.yangtools.sal.java.api.generator.test.CompilationTestUtils.assertContainsMethod;
  24 import static org.opendaylight.yangtools.sal.java.api.generator.test.CompilationTestUtils.assertContainsRestrictionCheck;
  25 import static org.opendaylight.yangtools.sal.java.api.generator.test.CompilationTestUtils.assertFilesCount;
  26 import static org.opendaylight.yangtools.sal.java.api.generator.test.CompilationTestUtils.cleanUp;
  27 import static org.opendaylight.yangtools.sal.java.api.generator.test.CompilationTestUtils.getSourceFiles;
  28 import static org.opendaylight.yangtools.sal.java.api.generator.test.CompilationTestUtils.testCompilation;
  29
  30 import com.google.common.collect.Range;
  31 import java.io.File;
  32 import java.lang.reflect.Constructor;
  33 import java.lang.reflect.Method;
  34 import java.math.BigDecimal;
  35 import java.net.URL;
  36 import java.net.URLClassLoader;
  37 import java.util.ArrayList;
  38 import java.util.HashSet;
  39 import java.util.List;
  40 import org.junit.Test;
  41 import org.opendaylight.yangtools.sal.binding.model.api.Type;
  42 import org.opendaylight.yangtools.sal.java.api.generator.GeneratorJavaFile;
  43 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  44
  45 /**
  46  * Test correct code generation.
  47  *
  48  */
  49 public class TypedefCompilationTest extends BaseCompilationTest {
  50     private static final String VAL = "_value";
  51     private static final String GET_VAL = "getValue";
  52     private static final String UNITS = "_UNITS";
  53
  54     @Test
  55     public void test() throws Exception {
  56         final File sourcesOutputDir = new File(GENERATOR_OUTPUT_PATH + FS + "typedef");
  57         assertTrue("Failed to create test file '" + sourcesOutputDir + "'", sourcesOutputDir.mkdir());
  58         final File compiledOutputDir = new File(COMPILER_OUTPUT_PATH + FS + "typedef");
  59         assertTrue("Failed to create test file '" + compiledOutputDir + "'", compiledOutputDir.mkdir());
  60
  61         final List<File> sourceFiles = getSourceFiles("/compilation/typedef");
  62         final SchemaContext context = parser.parseFiles(sourceFiles);
  63         final List<Type> types = bindingGenerator.generateTypes(context);
  64         final GeneratorJavaFile generator = new GeneratorJavaFile(new HashSet<>(types));
  65         generator.generateToFile(sourcesOutputDir);
  66
  67         File parent = new File(sourcesOutputDir, NS_FOO);
  68         File bitsExt = new File(parent, "BitsExt.java");
  69         File int32Ext0 = new File(parent, "Int32Ext0.java");
  70         File int32Ext1 = new File(parent, "Int32Ext1.java");
  71         File int32Ext2 = new File(parent, "Int32Ext2.java");
  72         File myDecimalType = new File(parent, "MyDecimalType.java");
  73         File stringExt1 = new File(parent, "StringExt1.java");
  74         File stringExt2 = new File(parent, "StringExt2.java");
  75         File stringExt3 = new File(parent, "StringExt3.java");
  76         File unionExt1 = new File(parent, "UnionExt1.java");
  77         File unionExt2 = new File(parent, "UnionExt2.java");
  78         File unionExt3 = new File(parent, "UnionExt3.java");
  79         File unionExt4 = new File(parent, "UnionExt4.java");
  80         assertTrue(bitsExt.exists());
  81         assertTrue(int32Ext0.exists());
  82         assertTrue(int32Ext1.exists());
  83         assertTrue(int32Ext2.exists());
  84         assertTrue(myDecimalType.exists());
  85         assertTrue(stringExt1.exists());
  86         assertTrue(stringExt2.exists());
  87         assertTrue(stringExt3.exists());
  88         assertTrue(unionExt1.exists());
  89         assertTrue(unionExt2.exists());
  90         assertTrue(unionExt3.exists());
  91         assertTrue(unionExt4.exists());
  92         assertFilesCount(parent, 30);
  93
  94         // Test if sources are compilable
  95         testCompilation(sourcesOutputDir, compiledOutputDir);
  96
  97         String pkg = BASE_PKG + ".urn.opendaylight.foo.rev131008";
  98         ClassLoader loader = new URLClassLoader(new URL[] { compiledOutputDir.toURI().toURL() });
  99         Class<?> bitsExtClass = Class.forName(pkg + ".BitsExt", true, loader);
 100         Class<?> int32Ext1Class = Class.forName(pkg + ".Int32Ext1", true, loader);
 101         Class<?> int32Ext2Class = Class.forName(pkg + ".Int32Ext2", true, loader);
 102         Class<?> myDecimalTypeClass = Class.forName(pkg + ".MyDecimalType", true, loader);
 103         Class<?> stringExt1Class = Class.forName(pkg + ".StringExt1", true, loader);
 104         Class<?> stringExt2Class = Class.forName(pkg + ".StringExt2", true, loader);
 105         Class<?> stringExt3Class = Class.forName(pkg + ".StringExt3", true, loader);
 106         Class<?> unionExt1Class = Class.forName(pkg + ".UnionExt1", true, loader);
 107         Class<?> unionExt2Class = Class.forName(pkg + ".UnionExt2", true, loader);
 108         Class<?> unionExt3Class = Class.forName(pkg + ".UnionExt3", true, loader);
 109         Class<?> unionExt4Class = Class.forName(pkg + ".UnionExt4", true, loader);
 110
 111         // typedef bits-ext
 112         assertFalse(bitsExtClass.isInterface());
 113         assertContainsField(bitsExtClass, "_pc", Boolean.class);
 114         assertContainsField(bitsExtClass, "_bpc", Boolean.class);
 115         assertContainsField(bitsExtClass, "_dpc", Boolean.class);
 116         assertContainsField(bitsExtClass, "_lbpc", Boolean.class);
 117         assertContainsField(bitsExtClass, "_spc", Boolean.class);
 118         assertContainsField(bitsExtClass, "_sfmof", Boolean.class);
 119         assertContainsField(bitsExtClass, "_sfapc", Boolean.class);
 120         assertContainsFieldWithValue(bitsExtClass, "serialVersionUID", Long.TYPE, -2922917845344851623L, Boolean.class,
 121                 Boolean.class, Boolean.class, Boolean.class, Boolean.class, Boolean.class, Boolean.class);
 122         assertEquals(8, bitsExtClass.getDeclaredFields().length);
 123         Constructor<?> expectedConstructor = assertContainsConstructor(bitsExtClass, Boolean.class, Boolean.class,
 124                 Boolean.class, Boolean.class, Boolean.class, Boolean.class, Boolean.class);
 125         assertContainsConstructor(bitsExtClass, bitsExtClass);
 126         assertEquals(2, bitsExtClass.getConstructors().length);
 127         Method defInst = assertContainsMethod(bitsExtClass, bitsExtClass, "getDefaultInstance", String.class);
 128         assertContainsDefaultMethods(bitsExtClass);
 129         assertEquals(11, bitsExtClass.getDeclaredMethods().length);
 130
 131         Object obj = expectedConstructor.newInstance(null, null, null, null, null, new Boolean("true"), null);
 132         assertEquals(obj, defInst.invoke(null, "sfmof"));
 133
 134         // typedef int32-ext1
 135         assertFalse(int32Ext1Class.isInterface());
 136         assertContainsField(int32Ext1Class, VAL, Integer.class);
 137         assertContainsFieldWithValue(int32Ext1Class, "serialVersionUID", Long.TYPE, 5351634010010233292L, Integer.class);
 138         assertEquals(2, int32Ext1Class.getDeclaredFields().length);
 139         expectedConstructor = assertContainsConstructor(int32Ext1Class, Integer.class);
 140         assertContainsConstructor(int32Ext1Class, int32Ext1Class);
 141         assertEquals(2, int32Ext1Class.getConstructors().length);
 142         assertContainsDefaultMethods(int32Ext1Class);
 143         assertContainsMethod(int32Ext1Class, Integer.class, GET_VAL);
 144         defInst = assertContainsMethod(int32Ext1Class, int32Ext1Class, "getDefaultInstance", String.class);
 145         assertContainsGetLengthOrRange(int32Ext1Class, false);
 146         assertEquals(6, int32Ext1Class.getDeclaredMethods().length);
 147
 148         List<Range<Integer>> rangeConstraints = new ArrayList<>();
 149         rangeConstraints.add(Range.closed(new Integer("2"), new Integer("2147483647")));
 150         Object arg = new Integer("1");
 151         String expectedMsg = String.format("Invalid range: %s, expected: %s.", arg, rangeConstraints);
 152         assertContainsRestrictionCheck(expectedConstructor, expectedMsg, arg);
 153         obj = expectedConstructor.newInstance(new Integer("159"));
 154         assertEquals(obj, defInst.invoke(null, "159"));
 155
 156         // typedef int32-ext2
 157         assertFalse(int32Ext2Class.isInterface());
 158         assertContainsFieldWithValue(int32Ext2Class, UNITS, String.class, "mile", Integer.class);
 159         assertContainsFieldWithValue(int32Ext2Class, "serialVersionUID", Long.TYPE, 317831889060130988L, Integer.class);
 160         assertEquals(2, int32Ext2Class.getDeclaredFields().length);
 161         expectedConstructor = assertContainsConstructor(int32Ext2Class, Integer.class);
 162         assertContainsConstructor(int32Ext2Class, int32Ext2Class);
 163         assertContainsConstructor(int32Ext2Class, int32Ext1Class);
 164         assertEquals(3, int32Ext2Class.getDeclaredConstructors().length);
 165         assertContainsMethod(int32Ext2Class, String.class, "toString");
 166         defInst = assertContainsMethod(int32Ext2Class, int32Ext2Class, "getDefaultInstance", String.class);
 167         assertContainsGetLengthOrRange(int32Ext2Class, false);
 168         assertEquals(3, int32Ext2Class.getDeclaredMethods().length);
 169
 170         rangeConstraints.clear();
 171         rangeConstraints.add(Range.closed(new Integer("3"), new Integer("9")));
 172         rangeConstraints.add(Range.closed(new Integer("11"), new Integer("2147483647")));
 173         arg = new Integer("10");
 174         expectedMsg = String.format("Invalid range: %s, expected: %s.", arg, rangeConstraints);
 175         assertContainsRestrictionCheck(expectedConstructor, expectedMsg, arg);
 176         obj = expectedConstructor.newInstance(new Integer("2147483647"));
 177         assertEquals(obj, defInst.invoke(null, "2147483647"));
 178
 179         // typedef string-ext1
 180         assertFalse(stringExt1Class.isInterface());
 181         assertContainsField(stringExt1Class, VAL, String.class);
 182         assertContainsField(stringExt1Class, "patterns", List.class);
 183         assertContainsField(stringExt1Class, "PATTERN_CONSTANTS", List.class);
 184         assertContainsFieldWithValue(stringExt1Class, "serialVersionUID", Long.TYPE, 6943827552297110991L, String.class);
 185         assertEquals(4, stringExt1Class.getDeclaredFields().length);
 186         expectedConstructor = assertContainsConstructor(stringExt1Class, String.class);
 187         assertContainsConstructor(stringExt1Class, stringExt1Class);
 188         assertEquals(2, stringExt1Class.getDeclaredConstructors().length);
 189         assertContainsMethod(stringExt1Class, String.class, GET_VAL);
 190         defInst = assertContainsMethod(stringExt1Class, stringExt1Class, "getDefaultInstance", String.class);
 191         assertContainsDefaultMethods(stringExt1Class);
 192         assertContainsGetLengthOrRange(stringExt1Class, true);
 193         assertEquals(6, stringExt1Class.getDeclaredMethods().length);
 194
 195         List<Range<Integer>> lengthConstraints = new ArrayList<>();
 196         lengthConstraints.add(Range.closed(5, 11));
 197         arg = "abcd";
 198         expectedMsg = String.format("Invalid length: %s, expected: %s.", arg, lengthConstraints);
 199         assertContainsRestrictionCheck(expectedConstructor, expectedMsg, arg);
 200         obj = expectedConstructor.newInstance("hello world");
 201         assertEquals(obj, defInst.invoke(null, "hello world"));
 202
 203         // typedef string-ext2
 204         assertFalse(stringExt2Class.isInterface());
 205         assertContainsFieldWithValue(stringExt2Class, "serialVersionUID", Long.TYPE, 8100233177432072092L, String.class);
 206         assertEquals(1, stringExt2Class.getDeclaredFields().length);
 207         expectedConstructor = assertContainsConstructor(stringExt2Class, String.class);
 208         assertContainsConstructor(stringExt2Class, stringExt2Class);
 209         assertContainsConstructor(stringExt2Class, stringExt1Class);
 210         assertEquals(3, stringExt2Class.getDeclaredConstructors().length);
 211         assertContainsGetLengthOrRange(stringExt2Class, true);
 212         defInst = assertContainsMethod(stringExt2Class, stringExt2Class, "getDefaultInstance", String.class);
 213         assertEquals(2, stringExt2Class.getDeclaredMethods().length);
 214
 215         lengthConstraints.clear();
 216         lengthConstraints.add(Range.closed(6, 10));
 217         arg = "abcde";
 218         expectedMsg = String.format("Invalid length: %s, expected: %s.", arg, lengthConstraints);
 219         assertContainsRestrictionCheck(expectedConstructor, expectedMsg, arg);
 220         obj = expectedConstructor.newInstance("helloWorld");
 221         assertEquals(obj, defInst.invoke(null, "helloWorld"));
 222
 223         // typedef string-ext3
 224         assertFalse(stringExt3Class.isInterface());
 225         assertContainsFieldWithValue(stringExt3Class, "serialVersionUID", Long.TYPE, -2751063130555484180L, String.class);
 226         assertEquals(1, stringExt3Class.getDeclaredFields().length);
 227         expectedConstructor = assertContainsConstructor(stringExt3Class, String.class);
 228         assertContainsConstructor(stringExt3Class, stringExt3Class);
 229         assertContainsConstructor(stringExt3Class, stringExt2Class);
 230         assertEquals(3, stringExt3Class.getDeclaredConstructors().length);
 231         defInst = assertContainsMethod(stringExt3Class, stringExt3Class, "getDefaultInstance", String.class);
 232         assertEquals(1, stringExt3Class.getDeclaredMethods().length);
 233
 234         obj = expectedConstructor.newInstance("helloWorld");
 235         assertEquals(obj, defInst.invoke(null, "helloWorld"));
 236
 237         // typedef my-decimal-type
 238         assertFalse(myDecimalTypeClass.isInterface());
 239         assertContainsField(myDecimalTypeClass, VAL, BigDecimal.class);
 240         assertContainsFieldWithValue(myDecimalTypeClass, "serialVersionUID", Long.TYPE, 3143735729419861095L, BigDecimal.class);
 241         assertEquals(2, myDecimalTypeClass.getDeclaredFields().length);
 242         assertContainsMethod(myDecimalTypeClass, BigDecimal.class, "getValue");
 243         expectedConstructor = assertContainsConstructor(myDecimalTypeClass, BigDecimal.class);
 244         assertContainsConstructor(myDecimalTypeClass, myDecimalTypeClass);
 245         assertEquals(2, myDecimalTypeClass.getDeclaredConstructors().length);
 246         assertContainsMethod(myDecimalTypeClass, BigDecimal.class, GET_VAL);
 247         assertContainsDefaultMethods(myDecimalTypeClass);
 248         defInst = assertContainsMethod(myDecimalTypeClass, myDecimalTypeClass, "getDefaultInstance", String.class);
 249         assertContainsGetLengthOrRange(myDecimalTypeClass, false);
 250         assertEquals(6, myDecimalTypeClass.getDeclaredMethods().length);
 251
 252         List<Range<BigDecimal>> decimalRangeConstraints = new ArrayList<>();
 253         decimalRangeConstraints.add(Range.closed(new BigDecimal("1.5"), new BigDecimal("5.5")));
 254         arg = new BigDecimal("1.4");
 255         expectedMsg = String.format("Invalid range: %s, expected: %s.", arg, decimalRangeConstraints);
 256         assertContainsRestrictionCheck(expectedConstructor, expectedMsg, arg);
 257         obj = expectedConstructor.newInstance(new BigDecimal("3.14"));
 258         assertEquals(obj, defInst.invoke(null, "3.14"));
 259
 260         // typedef union-ext1
 261         assertFalse(unionExt1Class.isInterface());
 262         assertContainsField(unionExt1Class, "_int16", Short.class);
 263         assertContainsField(unionExt1Class, "_int32", Integer.class);
 264         assertContainsFieldWithValue(unionExt1Class, "serialVersionUID", Long.TYPE, -5610530488718168882L, Short.class);
 265         assertEquals(4, unionExt1Class.getDeclaredFields().length);
 266         assertContainsMethod(unionExt1Class, Short.class, "getInt16");
 267         assertContainsMethod(unionExt1Class, Integer.class, "getInt32");
 268         assertContainsConstructor(unionExt1Class, Short.class);
 269         assertContainsConstructor(unionExt1Class, Integer.class);
 270         assertContainsConstructor(unionExt1Class, unionExt1Class);
 271         assertEquals(4, unionExt1Class.getDeclaredConstructors().length);
 272         assertContainsDefaultMethods(unionExt1Class);
 273
 274         // typedef union-ext2
 275         assertFalse(unionExt2Class.isInterface());
 276         assertContainsFieldWithValue(unionExt2Class, "serialVersionUID", Long.TYPE, -8833407459073585206L, Short.class);
 277         assertEquals(1, unionExt2Class.getDeclaredFields().length);
 278         assertEquals(0, unionExt2Class.getDeclaredMethods().length);
 279         assertContainsConstructor(unionExt2Class, Short.class);
 280         assertContainsConstructor(unionExt2Class, Integer.class);
 281         assertContainsConstructor(unionExt2Class, unionExt2Class);
 282         assertContainsConstructor(unionExt2Class, unionExt1Class);
 283         assertEquals(5, unionExt2Class.getDeclaredConstructors().length);
 284
 285         // typedef union-ext3
 286         assertFalse(unionExt3Class.isInterface());
 287         assertContainsField(unionExt3Class, "_string", String.class);
 288         assertContainsField(unionExt3Class, "_unionExt2", unionExt2Class);
 289         assertContainsFieldWithValue(unionExt3Class, UNITS, String.class, "object id", String.class);
 290         assertContainsFieldWithValue(unionExt3Class, "serialVersionUID", Long.TYPE, 4347887914884631036L, String.class);
 291         assertEquals(5, unionExt3Class.getDeclaredFields().length);
 292         assertContainsMethod(unionExt3Class, String.class, "getString");
 293         assertContainsMethod(unionExt3Class, unionExt2Class, "getUnionExt2");
 294         assertContainsConstructor(unionExt3Class, String.class);
 295         assertContainsConstructor(unionExt3Class, unionExt2Class);
 296         assertContainsConstructor(unionExt3Class, unionExt3Class);
 297         assertEquals(4, unionExt3Class.getDeclaredConstructors().length);
 298         assertContainsDefaultMethods(unionExt3Class);
 299
 300         // typedef union-ext4
 301         assertFalse(unionExt4Class.isInterface());
 302         assertContainsField(unionExt4Class, "_unionExt3", unionExt3Class);
 303         assertContainsField(unionExt4Class, "_int32Ext2", int32Ext2Class);
 304         assertContainsField(unionExt4Class, "_empty", Boolean.class);
 305         assertContainsField(unionExt4Class, "_myDecimalType", myDecimalTypeClass);
 306         assertContainsFieldWithValue(unionExt4Class, "serialVersionUID", Long.TYPE, 4299836385615211130L, Boolean.class);
 307         assertEquals(6, unionExt4Class.getDeclaredFields().length);
 308         assertContainsMethod(unionExt4Class, unionExt3Class, "getUnionExt3");
 309         assertContainsMethod(unionExt4Class, int32Ext2Class, "getInt32Ext2");
 310         assertContainsMethod(unionExt4Class, Boolean.class, "isEmpty");
 311         assertContainsMethod(unionExt4Class, myDecimalTypeClass, "getMyDecimalType");
 312         assertContainsConstructor(unionExt4Class, unionExt3Class);
 313         assertContainsConstructor(unionExt4Class, int32Ext2Class);
 314         assertContainsConstructor(unionExt4Class, Boolean.class);
 315         assertContainsConstructor(unionExt4Class, myDecimalTypeClass);
 316         assertContainsConstructor(unionExt4Class, unionExt4Class);
 317         assertEquals(6, unionExt4Class.getDeclaredConstructors().length);
 318         assertContainsDefaultMethods(unionExt4Class);
 319
 320         cleanUp(sourcesOutputDir, compiledOutputDir);
 321     }
 322
 323 }