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