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 static 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",
  57             name));
  58         enumeration = enumerationBuilder.toInstance(enumerationBuilder);
  59     }
  60
  61     @Test(expected = NullPointerException.class)
  62     public void testAddNullAnnotation() {
  63         assertNull(enumerationBuilder.addAnnotation(null));
  64     }
  65
  66     @Test(expected = NullPointerException.class)
  67     public void testAddNullAnnotationPackage() {
  68         assertNull(enumerationBuilder.addAnnotation(null, "test"));
  69     }
  70
  71     @Test(expected = NullPointerException.class)
  72     public void testAddNullAnnotationName() {
  73         assertNull(enumerationBuilder.addAnnotation(packageName, null));
  74     }
  75
  76     @Test
  77     public void testEnumerationBuilder() {
  78         assertEquals(packageName + "." + name, enumerationBuilder.getFullyQualifiedName());
  79         assertEquals(name , enumerationBuilder.getName());
  80         assertEquals(packageName, enumerationBuilder.getPackageName());
  81
  82         assertNotEquals(enumerationBuilder, null);
  83         assertEquals(enumerationBuilder, enumerationBuilder);
  84         assertNotEquals(enumerationBuilder, "string");
  85         assertNotEquals(enumerationBuilder, enumerationBuilderOtherName);
  86         assertNotEquals(enumerationBuilder, enumerationBuilderOtherPackage);
  87         assertEquals(enumerationBuilder,enumerationBuilderSame);
  88     }
  89
  90     @Test
  91     public void testEnumeration() {
  92         assertEquals(name, enumeration.getName());
  93         assertEquals(packageName, enumeration.getPackageName());
  94         assertEquals(null, enumeration.getComment());
  95         assertEquals(enumerationBuilder, enumeration.getParentType());
  96         assertEquals(DESCRIPTION, enumeration.getDescription());
  97         assertEquals(moduleName, enumeration.getModuleName());
  98         assertEquals(packageName + '.' + name, enumeration.getFullyQualifiedName());
  99         assertEquals(reference, enumeration.getReference());
 100         assertEquals(Collections.singletonList(qname), enumeration.getSchemaPath());
 101         assertEquals(Collections.emptyList(), enumeration.getEnclosedTypes());
 102         assertEquals(Collections.emptyList(), enumeration.getEnumerations());
 103         assertEquals(Collections.emptyList(), enumeration.getMethodDefinitions());
 104         assertEquals(Collections.emptyList(), enumeration.getConstantDefinitions());
 105         assertEquals(Collections.emptyList(), enumeration.getProperties());
 106         assertEquals(Collections.emptyList(), enumeration.getImplements());
 107         assertNotNull(enumeration.getValues());
 108         assertNotNull(enumeration.getAnnotations());
 109
 110         assertFalse(enumeration.isAbstract());
 111         assertNotEquals(enumeration, null);
 112         assertEquals(enumeration, enumeration);
 113         assertNotEquals(enumeration, "string");
 114
 115         final Enumeration enumerationOtherPackage = enumerationBuilderOtherPackage
 116                 .toInstance(enumerationBuilderOtherPackage);
 117         assertNotEquals(enumeration, enumerationOtherPackage);
 118
 119         final Enumeration enumerationOtherName = enumerationBuilderOtherName.toInstance(enumerationBuilderOtherName);
 120         assertNotEquals(enumeration, enumerationOtherName);
 121
 122         enumerationBuilderSame.addValue(valueName, valueName, value, Status.CURRENT, valueDescription, null);
 123         final Enumeration enumerationSame = enumerationBuilderSame.toInstance(enumerationBuilderSame);
 124         assertEquals(enumeration, enumerationSame);
 125
 126         final CodegenEnumerationBuilder enumerationBuilderSame1 = new CodegenEnumerationBuilder(
 127             JavaTypeName.create(packageName, name));
 128         final Enumeration enumerationSame1 = enumerationBuilderSame1.toInstance(enumerationBuilderSame1);
 129         enumerationBuilderSame1.addValue(valueName, valueName, 14, Status.CURRENT, valueDescription, null);
 130         // Enums are equal thanks to same package name and local name
 131         assertEquals(enumeration, enumerationSame1);
 132     }
 133
 134     @Test
 135     public void testEnumerationToString() {
 136         final String formattedString = "public enum " + name + " {\n"
 137                 + "\t TestValue " + "(12 );\n"
 138                 + "}";
 139         final String s = "Enumeration [packageName=" + packageName + ", definingType=" + packageName + "." + name
 140                 + ", name=" + name + ", values=[EnumPair [name=TestValue, mappedName=TestValue, value=12]]]";
 141
 142         assertEquals(s, enumeration.toString());
 143         assertEquals(formattedString, enumeration.toFormattedString());
 144
 145         assertEquals("EnumerationBuilderImpl [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 }