b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 1 | /* |
Brian O'Connor | 0f7908b | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Laboratory |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package org.onosproject.yangutils.utils.io.impl; |
| 18 | |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 19 | import java.lang.reflect.Constructor; |
| 20 | import java.lang.reflect.InvocationTargetException; |
| 21 | |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 22 | import org.junit.Rule; |
| 23 | import org.junit.Test; |
| 24 | import org.junit.rules.ExpectedException; |
| 25 | |
| 26 | import static org.hamcrest.core.Is.is; |
| 27 | import static org.hamcrest.core.IsNot.not; |
| 28 | import static org.junit.Assert.assertThat; |
| 29 | import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.getJavaDoc; |
| 30 | import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.BUILDER_CLASS; |
| 31 | import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.BUILDER_INTERFACE; |
| 32 | import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.BUILD_METHOD; |
| 33 | import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.CONSTRUCTOR; |
| 34 | import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.DEFAULT_CONSTRUCTOR; |
| 35 | import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.GETTER_METHOD; |
| 36 | import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.IMPL_CLASS; |
| 37 | import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.INTERFACE; |
| 38 | import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.PACKAGE_INFO; |
| 39 | import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.SETTER_METHOD; |
| 40 | import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.TYPE_DEF_SETTER_METHOD; |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 41 | |
| 42 | /** |
| 43 | * Tests the java doc that is generated. |
| 44 | */ |
| 45 | public final class JavaDocGenTest { |
| 46 | |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 47 | private static final String TEST_NAME = "testName"; |
| 48 | private static final String END_STRING = " */\n"; |
| 49 | |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 50 | @Rule |
| 51 | public ExpectedException thrown = ExpectedException.none(); |
| 52 | |
| 53 | /** |
| 54 | * This test case checks the content recieved for the builder class java doc. |
| 55 | */ |
| 56 | @Test |
| 57 | public void builderClassGenerationTest() { |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 58 | String builderClassJavaDoc = getJavaDoc(BUILDER_CLASS, TEST_NAME, false); |
Gaurav Agrawal | 97a5e1c | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 59 | assertThat(true, is(builderClassJavaDoc.contains("Represents the builder implementation of") |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 60 | && builderClassJavaDoc.contains(END_STRING))); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 61 | } |
| 62 | |
| 63 | /** |
| 64 | * This test case checks the content recieved for the builder interface ge java doc. |
| 65 | */ |
| 66 | @Test |
| 67 | public void builderInterfaceGenerationTest() { |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 68 | String builderInterfaceJavaDoc = getJavaDoc(BUILDER_INTERFACE, TEST_NAME, false); |
| 69 | assertThat(true, |
| 70 | is(builderInterfaceJavaDoc.contains("Builder for") && builderInterfaceJavaDoc.contains(END_STRING))); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 71 | } |
| 72 | |
| 73 | /** |
| 74 | * This test case checks the content recieved for the build java doc. |
| 75 | */ |
| 76 | @Test |
| 77 | public void buildGenerationTest() { |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 78 | String buildDoc = getJavaDoc(BUILD_METHOD, TEST_NAME, false); |
| 79 | assertThat(true, is(buildDoc.contains("Builds object of") && buildDoc.contains(END_STRING))); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 80 | } |
| 81 | |
| 82 | /** |
| 83 | * A private constructor is tested. |
| 84 | * |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 85 | * @throws SecurityException if any security violation is observed |
| 86 | * @throws NoSuchMethodException if when the method is not found |
| 87 | * @throws IllegalArgumentException if there is illegal argument found |
| 88 | * @throws InstantiationException if instantiation is provoked for the private constructor |
| 89 | * @throws IllegalAccessException if instance is provoked or a method is provoked |
| 90 | * @throws InvocationTargetException when an exception occurs by the method or constructor |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 91 | */ |
| 92 | @Test |
| 93 | public void callPrivateConstructors() throws SecurityException, NoSuchMethodException, IllegalArgumentException, |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 94 | InstantiationException, IllegalAccessException, InvocationTargetException { |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 95 | |
| 96 | Class<?>[] classesToConstruct = {JavaDocGen.class }; |
| 97 | for (Class<?> clazz : classesToConstruct) { |
| 98 | Constructor<?> constructor = clazz.getDeclaredConstructor(); |
| 99 | constructor.setAccessible(true); |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 100 | assertThat(null, not(constructor.newInstance())); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 101 | } |
| 102 | } |
| 103 | |
| 104 | /** |
| 105 | * This test case checks the content recieved for the constructor java doc. |
| 106 | */ |
| 107 | @Test |
| 108 | public void constructorGenerationTest() { |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 109 | String constructorDoc = getJavaDoc(CONSTRUCTOR, TEST_NAME, false); |
| 110 | assertThat(true, |
| 111 | is(constructorDoc.contains("Creates an instance of ") && constructorDoc.contains("builder object of") |
| 112 | && constructorDoc.contains("@param") && constructorDoc.contains("*/\n"))); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 113 | } |
| 114 | |
| 115 | /** |
| 116 | * This test case checks the content recieved for the default constructor java doc. |
| 117 | */ |
| 118 | @Test |
| 119 | public void defaultConstructorGenerationTest() { |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 120 | String defaultConstructorDoc = getJavaDoc(DEFAULT_CONSTRUCTOR, TEST_NAME, false); |
| 121 | assertThat(true, is(defaultConstructorDoc.contains("Creates an instance of ") |
| 122 | && defaultConstructorDoc.contains(END_STRING))); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 123 | } |
| 124 | |
| 125 | /** |
| 126 | * This test case checks the content recieved for the getter java doc. |
| 127 | */ |
| 128 | @Test |
| 129 | public void getterGenerationTest() { |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 130 | String getterJavaDoc = getJavaDoc(GETTER_METHOD, TEST_NAME, false); |
| 131 | assertThat(true, is(getterJavaDoc.contains("Returns the attribute") && getterJavaDoc.contains(END_STRING))); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 132 | } |
| 133 | |
| 134 | /** |
| 135 | * This test case checks the content recieved for the impl class java doc. |
| 136 | */ |
| 137 | @Test |
| 138 | public void implClassGenerationTest() { |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 139 | String implClassJavaDoc = getJavaDoc(IMPL_CLASS, TEST_NAME, false); |
| 140 | assertThat(true, |
Gaurav Agrawal | 97a5e1c | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 141 | is(implClassJavaDoc.contains("Represents the implementation of") |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 142 | && implClassJavaDoc.contains(END_STRING))); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 143 | } |
| 144 | |
| 145 | /** |
| 146 | * This test case checks the content recieved for the interface java doc. |
| 147 | */ |
| 148 | @Test |
| 149 | public void interfaceGenerationTest() { |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 150 | String interfaceJavaDoc = getJavaDoc(INTERFACE, TEST_NAME, false); |
| 151 | assertThat(true, |
Gaurav Agrawal | 97a5e1c | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 152 | is(interfaceJavaDoc.contains("Abstraction of an entity which represents the functionality of") |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 153 | && interfaceJavaDoc.contains(END_STRING))); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 154 | } |
| 155 | |
| 156 | /** |
| 157 | * This test case checks the content recieved for the package info java doc. |
| 158 | */ |
| 159 | @Test |
| 160 | public void packageInfoGenerationTest() { |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 161 | String packageInfo = getJavaDoc(PACKAGE_INFO, TEST_NAME, false); |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 162 | assertThat(true, is(packageInfo.contains("Implementation of YANG node") && packageInfo.contains(END_STRING))); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 163 | } |
| 164 | |
| 165 | /** |
| 166 | * This test case checks the content recieved for the setter java doc. |
| 167 | */ |
| 168 | @Test |
| 169 | public void setterGenerationTest() { |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 170 | String setterJavaDoc = getJavaDoc(SETTER_METHOD, TEST_NAME, false); |
| 171 | assertThat(true, |
| 172 | is(setterJavaDoc.contains("Returns the builder object of") && setterJavaDoc.contains(END_STRING))); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 173 | } |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 174 | |
| 175 | /** |
| 176 | * This test case checks the content received for the typedef setter java doc. |
| 177 | */ |
| 178 | @Test |
| 179 | public void typeDefSetterGenerationTest() { |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 180 | String typeDefSetter = getJavaDoc(TYPE_DEF_SETTER_METHOD, TEST_NAME, false); |
| 181 | assertThat(true, is(typeDefSetter.contains("Sets the value of") && typeDefSetter.contains(END_STRING))); |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 182 | } |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 183 | } |