binding/mdsal-binding-java-api-generator/src/test/java/org/opendaylight/mdsal/binding/java/api/generator/BuilderGeneratorTest.java

   1 /*
   2  * Copyright (c) 2016 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.java.api.generator;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.mockito.Mockito.doReturn;
  12 import static org.mockito.Mockito.mock;
  13 import static org.mockito.Mockito.spy;
  14
  15 import java.lang.reflect.Field;
  16 import java.util.ArrayList;
  17 import java.util.Collection;
  18 import java.util.List;
  19 import org.junit.Test;
  20 import org.opendaylight.mdsal.binding.model.api.GeneratedProperty;
  21 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
  22 import org.opendaylight.mdsal.binding.model.api.MethodSignature;
  23 import org.opendaylight.mdsal.binding.model.api.Type;
  24
  25 public class BuilderGeneratorTest {
  26
  27     private static final String PROPERTIES_FIELD_NAME = "properties";
  28     private static final String TEST = "test";
  29
  30     @Test
  31     public void basicTest() {
  32         assertEquals("", new BuilderGenerator().generate(mock(Type.class)));
  33     }
  34
  35     @Test
  36     public void builderTemplateGenerateToStringWithPropertyTest() {
  37         final GeneratedType genType = mockGenType("get" + TEST);
  38
  39         assertEquals("@Override\n" +
  40                 "public java.lang.String toString() {\n" +
  41                 "    final MoreObjects.ToStringHelper helper = MoreObjects.toStringHelper(\"test\");\n" +
  42                 "    CodeHelpers.appendValue(helper, \"_test\", _test);\n" +
  43                 "    return helper.toString();\n" +
  44                 "}\n", genToString(genType).toString());
  45     }
  46
  47     @Test
  48     public void builderTemplateGenerateToStringWithoutAnyPropertyTest() throws Exception {
  49         assertEquals("@Override\n" +
  50                 "public java.lang.String toString() {\n" +
  51                 "    final MoreObjects.ToStringHelper helper = MoreObjects.toStringHelper(\"test\");\n" +
  52                 "    return helper.toString();\n" +
  53                 "}\n", genToString(mockGenType(TEST)).toString());
  54     }
  55
  56     @Test
  57     public void builderTemplateGenerateToStringWithMorePropertiesTest() throws Exception {
  58         assertEquals("@Override\n" +
  59                 "public java.lang.String toString() {\n" +
  60                 "    final MoreObjects.ToStringHelper helper = MoreObjects.toStringHelper(\"test\");\n" +
  61                 "    CodeHelpers.appendValue(helper, \"_test1\", _test1);\n" +
  62                 "    CodeHelpers.appendValue(helper, \"_test2\", _test2);\n" +
  63                 "    return helper.toString();\n" +
  64                 "}\n", genToString(mockGenTypeMoreMeth("get" + TEST)).toString());
  65     }
  66
  67     @Test
  68     public void builderTemplateGenerateToStringWithoutPropertyWithAugmentTest() throws Exception {
  69         assertEquals("@Override\n" +
  70                 "public java.lang.String toString() {\n" +
  71                 "    final MoreObjects.ToStringHelper helper = MoreObjects.toStringHelper(\"test\");\n" +
  72                 "    CodeHelpers.appendValue(helper, \"augmentation\", augmentation.values()); \n" +
  73                 "    return helper.toString();\n" +
  74                 "}\n", genToString(mockAugment(mockGenType(TEST))).toString());
  75     }
  76
  77     @Test
  78     public void builderTemplateGenerateToStringWithPropertyWithAugmentTest() throws Exception {
  79         assertEquals("@Override\n" +
  80                 "public java.lang.String toString() {\n" +
  81                 "    final MoreObjects.ToStringHelper helper = MoreObjects.toStringHelper(\"test\");\n" +
  82                 "    CodeHelpers.appendValue(helper, \"_test\", _test);\n" +
  83                 "    CodeHelpers.appendValue(helper, \"augmentation\", augmentation.values()); \n" +
  84                 "    return helper.toString();\n" +
  85                 "}\n", genToString(mockAugment(mockGenType("get" + TEST))).toString());
  86     }
  87
  88     @Test
  89     public void builderTemplateGenerateToStringWithMorePropertiesWithAugmentTest() throws Exception {
  90         assertEquals("@Override\n" +
  91                 "public java.lang.String toString() {\n" +
  92                 "    final MoreObjects.ToStringHelper helper = MoreObjects.toStringHelper(\"test\");\n" +
  93                 "    CodeHelpers.appendValue(helper, \"_test1\", _test1);\n" +
  94                 "    CodeHelpers.appendValue(helper, \"_test2\", _test2);\n" +
  95                 "    CodeHelpers.appendValue(helper, \"augmentation\", augmentation.values()); \n" +
  96                 "    return helper.toString();\n" +
  97                 "}\n", genToString(mockAugment(mockGenTypeMoreMeth("get" + TEST))).toString());
  98     }
  99
 100     private static GeneratedType mockAugment(final GeneratedType genType) {
 101         final List<Type> impls = new ArrayList<>();
 102         final Type impl = mock(Type.class);
 103         doReturn("org.opendaylight.yangtools.yang.binding.Augmentable").when(impl).getFullyQualifiedName();
 104         impls.add(impl);
 105         doReturn(impls).when(genType).getImplements();
 106         return genType;
 107     }
 108
 109     private static GeneratedType mockGenTypeMoreMeth(final String methodeName) {
 110         final GeneratedType genType = spy(GeneratedType.class);
 111         doReturn(TEST).when(genType).getName();
 112         doReturn(TEST).when(genType).getPackageName();
 113
 114         final List<MethodSignature> listMethodSign = new ArrayList<>();
 115         for (int i = 0; i < 2; i++) {
 116             final MethodSignature methSign = mockMethSign(methodeName + (i + 1));
 117             listMethodSign.add(methSign);
 118         }
 119         doReturn(listMethodSign).when(genType).getMethodDefinitions();
 120
 121         final List<Type> impls = new ArrayList<>();
 122         doReturn(impls).when(genType).getImplements();
 123         return genType;
 124     }
 125
 126     @SuppressWarnings("unchecked")
 127     private static CharSequence genToString(final GeneratedType genType) {
 128         try {
 129             final BuilderTemplate bt = new BuilderTemplate(genType);
 130             final Field propertiesField = bt.getClass().getDeclaredField(PROPERTIES_FIELD_NAME);
 131             propertiesField.setAccessible(true);
 132             return bt.generateToString((Collection<GeneratedProperty>) propertiesField.get(bt));
 133         } catch (IllegalArgumentException | IllegalAccessException | NoSuchFieldException | SecurityException e) {
 134             throw new RuntimeException(e);
 135         }
 136     }
 137
 138     private static GeneratedType mockGenType(final String methodeName) {
 139         final GeneratedType genType = spy(GeneratedType.class);
 140         doReturn(TEST).when(genType).getName();
 141         doReturn(TEST).when(genType).getPackageName();
 142
 143         final List<MethodSignature> listMethodSign = new ArrayList<>();
 144         final MethodSignature methSign = mockMethSign(methodeName);
 145         listMethodSign.add(methSign);
 146         doReturn(listMethodSign).when(genType).getMethodDefinitions();
 147
 148         final List<Type> impls = new ArrayList<>();
 149         doReturn(impls).when(genType).getImplements();
 150         return genType;
 151     }
 152
 153     private static MethodSignature mockMethSign(final String methodeName) {
 154         final MethodSignature methSign = mock(MethodSignature.class);
 155         doReturn(methodeName).when(methSign).getName();
 156         final Type methType = mock(Type.class);
 157         doReturn(TEST).when(methType).getName();
 158         doReturn(TEST).when(methType).getPackageName();
 159         doReturn(methType).when(methSign).getReturnType();
 160         return methSign;
 161     }
 162 }