binding/mdsal-binding-generator-util/src/test/java/org/opendaylight/mdsal/binding/model/util/generated/type/builder/EnumerationBuilderImplTest.java

   1 /*
   2  * Copyright (c) 2014 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.model.util.generated.type.builder;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertFalse;
  12 import static org.junit.Assert.assertNotEquals;
  13 import static org.junit.Assert.assertNotNull;
  14 import static org.junit.Assert.assertNull;
  15
  16 import java.util.Collections;
  17 import org.junit.Before;
  18 import org.junit.Test;
  19 import org.opendaylight.mdsal.binding.model.api.Enumeration;
  20 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
  21 import org.opendaylight.yangtools.yang.common.QName;
  22 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  23 import org.opendaylight.yangtools.yang.model.api.Status;
  24 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
  25 import org.opendaylight.yangtools.yang.model.util.type.BaseTypes;
  26 import org.opendaylight.yangtools.yang.model.util.type.EnumPairBuilder;
  27
  28 public class EnumerationBuilderImplTest {
  29
  30     private final QName qName = QName.create("TestQName", "2014-10-10", "TestLocalQName");
  31     private final String DESCRIPTION = "Test description of Enum";
  32     private final String packageName = "org.opendaylight.test";
  33     private final String name = "TestName";
  34     private final String moduleName = "TestModuleName";
  35     private final String reference = "TestRef";
  36     private final String valueName = "TestValue";
  37     private final String valueDescription = "Value used for test";
  38     private final int value = 12;
  39     private Enumeration enumeration;
  40     private CodegenEnumerationBuilder enumerationBuilder;
  41     private CodegenEnumerationBuilder enumerationBuilderSame;
  42     private CodegenEnumerationBuilder enumerationBuilderOtherName;
  43     private CodegenEnumerationBuilder enumerationBuilderOtherPackage;
  44
  45     @Before
  46     public void setup() {
  47         enumerationBuilder = new CodegenEnumerationBuilder(JavaTypeName.create(packageName, name));
  48         enumerationBuilder.setDescription(DESCRIPTION);
  49         enumerationBuilder.setModuleName(moduleName);
  50         enumerationBuilder.setReference(reference);
  51         enumerationBuilder.setSchemaPath(SchemaPath.create(true, qName));
  52         enumerationBuilder.addValue(valueName, valueName, value, Status.CURRENT, valueDescription, null);
  53         enumerationBuilder.addAnnotation(packageName, "TestAnnotation");
  54         enumerationBuilderSame = new CodegenEnumerationBuilder(JavaTypeName.create(packageName, name));
  55         enumerationBuilderOtherName = new CodegenEnumerationBuilder(JavaTypeName.create(packageName, "SomeOtherName"));
  56         enumerationBuilderOtherPackage = new CodegenEnumerationBuilder(JavaTypeName.create("org.opendaylight.other", name));
  57         enumeration = enumerationBuilder.toInstance(enumerationBuilder);
  58     }
  59
  60     @Test(expected = IllegalArgumentException.class)
  61     public void testAddNullAnnotation() {
  62         assertNull(enumerationBuilder.addAnnotation(null));
  63     }
  64
  65     @Test(expected = NullPointerException.class)
  66     public void testAddNullAnnotationPackage() {
  67         assertNull(enumerationBuilder.addAnnotation(null, "test"));
  68     }
  69
  70     @Test(expected = NullPointerException.class)
  71     public void testAddNullAnnotationName() {
  72         assertNull(enumerationBuilder.addAnnotation(packageName, null));
  73     }
  74
  75     @Test
  76     public void testEnumerationBuilder() {
  77         assertEquals(packageName + "." + name, enumerationBuilder.getFullyQualifiedName());
  78         assertEquals(name , enumerationBuilder.getName());
  79         assertEquals(packageName, enumerationBuilder.getPackageName());
  80
  81         assertNotEquals(enumerationBuilder, null);
  82         assertEquals(enumerationBuilder, enumerationBuilder);
  83         assertNotEquals(enumerationBuilder, "string");
  84         assertNotEquals(enumerationBuilder, enumerationBuilderOtherName);
  85         assertNotEquals(enumerationBuilder, enumerationBuilderOtherPackage);
  86         assertEquals(enumerationBuilder,enumerationBuilderSame);
  87     }
  88
  89     @Test
  90     public void testEnumeration() {
  91         assertEquals(name, enumeration.getName());
  92         assertEquals(packageName, enumeration.getPackageName());
  93         assertEquals(null, enumeration.getComment());
  94         assertEquals(enumerationBuilder, enumeration.getParentType());
  95         assertEquals(DESCRIPTION, enumeration.getDescription());
  96         assertEquals(moduleName, enumeration.getModuleName());
  97         assertEquals(packageName + '.' + name, enumeration.getFullyQualifiedName());
  98         assertEquals(reference, enumeration.getReference());
  99         assertEquals(Collections.singletonList(qName), enumeration.getSchemaPath());
 100         assertEquals(Collections.EMPTY_LIST, enumeration.getEnclosedTypes());
 101         assertEquals(Collections.EMPTY_LIST, enumeration.getEnumerations());
 102         assertEquals(Collections.EMPTY_LIST, enumeration.getMethodDefinitions());
 103         assertEquals(Collections.EMPTY_LIST, enumeration.getConstantDefinitions());
 104         assertEquals(Collections.EMPTY_LIST, enumeration.getProperties());
 105         assertEquals(Collections.EMPTY_LIST, enumeration.getImplements());
 106         assertNotNull(enumeration.getValues());
 107         assertNotNull(enumeration.getAnnotations());
 108
 109         assertFalse(enumeration.isAbstract());
 110         assertNotEquals(enumeration, null);
 111         assertEquals(enumeration, enumeration);
 112         assertNotEquals(enumeration, "string");
 113
 114         final Enumeration enumerationOtherPackage = enumerationBuilderOtherPackage.toInstance(enumerationBuilderOtherPackage);
 115         assertNotEquals(enumeration, enumerationOtherPackage);
 116
 117         final Enumeration enumerationOtherName = enumerationBuilderOtherName.toInstance(enumerationBuilderOtherName);
 118         assertNotEquals(enumeration, enumerationOtherName);
 119
 120         enumerationBuilderSame.addValue(valueName, valueName, value, Status.CURRENT, valueDescription, null);
 121         final Enumeration enumerationSame = enumerationBuilderSame.toInstance(enumerationBuilderSame);
 122         assertEquals(enumeration, enumerationSame);
 123
 124         final CodegenEnumerationBuilder enumerationBuilderSame1 = new CodegenEnumerationBuilder(
 125             JavaTypeName.create(packageName, name));
 126         final Enumeration enumerationSame1 = enumerationBuilderSame1.toInstance(enumerationBuilderSame1);
 127         enumerationBuilderSame1.addValue(valueName, valueName, 14, Status.CURRENT, valueDescription, null);
 128         // Enums are equal thanks to same package name and local name
 129         assertEquals(enumeration, enumerationSame1);
 130     }
 131
 132     @Test
 133     public void testEnumerationToString() {
 134         final String formattedString =
 135                 "public enum " + name + " {\n" +
 136                 "\t TestValue " + "(12 );\n" +
 137                 "}";
 138         final String s = "Enumeration [packageName=" + packageName + ", definingType=" + packageName + "." + name
 139                 + ", name=" + name + ", values=[EnumPair [name=TestValue, mappedName=TestValue, value=12]]]";
 140
 141         assertEquals(s, enumeration.toString());
 142         assertEquals(formattedString, enumeration.toFormattedString());
 143
 144         assertEquals("EnumerationBuilderImpl " +
 145                 "[packageName=org.opendaylight.test, name=TestName, " +
 146                 "values=[EnumPair [name=TestValue, mappedName=TestValue, value=12]]]",
 147                 enumerationBuilder.toString());
 148     }
 149
 150     @Test
 151     public void testUpdateEnumPairsFromEnumTypeDef() {
 152         final EnumTypeDefinition enumTypeDefinition = BaseTypes.enumerationTypeBuilder(SchemaPath.SAME)
 153                 .addEnum(EnumPairBuilder.create("SomeName", 42).setDescription("Some Other Description")
 154                     .setReference("Some other reference").build()).build();
 155         enumerationBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDefinition);
 156     }
 157 }