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.io.File; |
| 20 | import java.io.IOException; |
Bharat saraswal | c34b944 | 2016-03-28 15:50:13 +0530 | [diff] [blame] | 21 | import java.lang.reflect.Constructor; |
| 22 | import java.lang.reflect.InvocationTargetException; |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 23 | |
Bharat saraswal | c2d3be1 | 2016-06-16 00:29:12 +0530 | [diff] [blame^] | 24 | import org.apache.commons.io.FileUtils; |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 25 | import org.apache.maven.project.MavenProject; |
Bharat saraswal | c34b944 | 2016-03-28 15:50:13 +0530 | [diff] [blame] | 26 | import org.junit.Rule; |
| 27 | import org.junit.Test; |
| 28 | import org.junit.rules.ExpectedException; |
Bharat saraswal | 715d3fc | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 29 | import org.onosproject.yangutils.translator.tojava.utils.YangPluginConfig; |
Bharat saraswal | c34b944 | 2016-03-28 15:50:13 +0530 | [diff] [blame] | 30 | import org.onosproject.yangutils.utils.UtilConstants; |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 31 | import org.sonatype.plexus.build.incremental.BuildContext; |
| 32 | import org.sonatype.plexus.build.incremental.DefaultBuildContext; |
| 33 | |
Bharat saraswal | c2d3be1 | 2016-06-16 00:29:12 +0530 | [diff] [blame^] | 34 | import static org.apache.commons.io.FileUtils.deleteDirectory; |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 35 | import static org.hamcrest.core.Is.is; |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 36 | import static org.hamcrest.core.IsNot.not; |
Bharat saraswal | c34b944 | 2016-03-28 15:50:13 +0530 | [diff] [blame] | 37 | import static org.junit.Assert.assertThat; |
| 38 | import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.addPackageInfo; |
Bharat saraswal | c2d3be1 | 2016-06-16 00:29:12 +0530 | [diff] [blame^] | 39 | import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.addToCompilationRoot; |
VinodKumarS-Huawei | 6266db3 | 2016-05-10 17:58:57 +0530 | [diff] [blame] | 40 | import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.deleteDirectory; |
Bharat saraswal | c34b944 | 2016-03-28 15:50:13 +0530 | [diff] [blame] | 41 | import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.createDirectories; |
| 42 | import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.trimAtLast; |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 43 | |
| 44 | /** |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 45 | * Unit tests for YANG IO utils. |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 46 | */ |
| 47 | public final class YangIoUtilsTest { |
| 48 | |
Bharat saraswal | c34b944 | 2016-03-28 15:50:13 +0530 | [diff] [blame] | 49 | private static final String BASE_DIR = "target/UnitTestCase"; |
| 50 | private static final String CREATE_PATH = BASE_DIR + File.separator + "dir1/dir2/dir3/dir4/"; |
| 51 | private static final String CHECK_STRING = "one, two, three, four, five, six"; |
| 52 | private static final String TRIM_STRING = "one, two, three, four, five, "; |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 53 | private static final String CHECK1 = "check1"; |
| 54 | private static final String PKG_INFO = "package-info.java"; |
| 55 | private static final String PATH = "src/main/yangmodel/"; |
| 56 | private static final String MSG = "Exception occured while creating package info file."; |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 57 | |
Bharat saraswal | c34b944 | 2016-03-28 15:50:13 +0530 | [diff] [blame] | 58 | /** |
| 59 | * Expected exceptions. |
| 60 | */ |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 61 | @Rule |
| 62 | public ExpectedException thrown = ExpectedException.none(); |
| 63 | |
| 64 | /** |
| 65 | * This test case checks whether the package-info file is created. |
Bharat saraswal | c34b944 | 2016-03-28 15:50:13 +0530 | [diff] [blame] | 66 | * |
| 67 | * @throws IOException when fails to do IO operations for test case |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 68 | */ |
| 69 | @Test |
| 70 | public void addPackageInfoTest() throws IOException { |
| 71 | |
Bharat saraswal | c34b944 | 2016-03-28 15:50:13 +0530 | [diff] [blame] | 72 | File dirPath = new File(CREATE_PATH); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 73 | dirPath.mkdirs(); |
Bharat saraswal | 715d3fc | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 74 | addPackageInfo(dirPath, CHECK1, CREATE_PATH, false, getStubPluginConfig()); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 75 | File filePath = new File(dirPath + File.separator + PKG_INFO); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 76 | assertThat(filePath.isFile(), is(true)); |
Bharat saraswal | c2d3be1 | 2016-06-16 00:29:12 +0530 | [diff] [blame^] | 77 | FileUtils.deleteDirectory(dirPath); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 78 | } |
| 79 | |
| 80 | /** |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 81 | * This test case checks with an additional info in the path. |
Bharat saraswal | c34b944 | 2016-03-28 15:50:13 +0530 | [diff] [blame] | 82 | * |
| 83 | * @throws IOException when fails to do IO operations for test case |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 84 | */ |
| 85 | @Test |
| 86 | public void addPackageInfoWithPathTest() throws IOException { |
| 87 | |
Bharat saraswal | c34b944 | 2016-03-28 15:50:13 +0530 | [diff] [blame] | 88 | File dirPath = new File(CREATE_PATH); |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 89 | dirPath.mkdirs(); |
Bharat saraswal | 715d3fc | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 90 | addPackageInfo(dirPath, CHECK1, PATH + CREATE_PATH, false, getStubPluginConfig()); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 91 | File filePath = new File(dirPath + File.separator + PKG_INFO); |
| 92 | assertThat(filePath.isFile(), is(true)); |
Bharat saraswal | c2d3be1 | 2016-06-16 00:29:12 +0530 | [diff] [blame^] | 93 | FileUtils.deleteDirectory(dirPath); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 94 | } |
| 95 | |
| 96 | /** |
| 97 | * This test case checks with a child node. |
| 98 | * |
| 99 | * @throws IOException when fails to do IO operations for test case |
| 100 | */ |
| 101 | @Test |
| 102 | public void addPackageInfoWithChildNode() throws IOException { |
| 103 | |
| 104 | File dirPath = new File(CREATE_PATH); |
| 105 | dirPath.mkdirs(); |
Bharat saraswal | 715d3fc | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 106 | addPackageInfo(dirPath, CHECK1, PATH + CREATE_PATH, true, getStubPluginConfig()); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 107 | File filePath = new File(dirPath + File.separator + PKG_INFO); |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 108 | assertThat(filePath.isFile(), is(true)); |
Bharat saraswal | c2d3be1 | 2016-06-16 00:29:12 +0530 | [diff] [blame^] | 109 | FileUtils.deleteDirectory(dirPath); |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 110 | } |
| 111 | |
| 112 | /** |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 113 | * This test case checks whether the package-info file is created when invalid path is given. |
Bharat saraswal | c34b944 | 2016-03-28 15:50:13 +0530 | [diff] [blame] | 114 | * |
| 115 | * @throws IOException when fails to do IO operations for test case |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 116 | */ |
| 117 | @Test |
| 118 | public void addPackageInfoWithEmptyPathTest() throws IOException { |
| 119 | |
b.janani | e6d43af | 2016-03-04 12:29:05 +0530 | [diff] [blame] | 120 | File dirPath = new File("invalid/check"); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 121 | thrown.expect(IOException.class); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 122 | thrown.expectMessage(MSG); |
Bharat saraswal | 715d3fc | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 123 | addPackageInfo(dirPath, CHECK1, CREATE_PATH, false, getStubPluginConfig()); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 124 | File filePath1 = new File(dirPath + File.separator + PKG_INFO); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 125 | assertThat(filePath1.isFile(), is(false)); |
Bharat saraswal | c2d3be1 | 2016-06-16 00:29:12 +0530 | [diff] [blame^] | 126 | FileUtils.deleteDirectory(dirPath); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 127 | } |
| 128 | |
| 129 | /** |
| 130 | * A private constructor is tested. |
| 131 | * |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 132 | * @throws SecurityException if any security violation is observed |
| 133 | * @throws NoSuchMethodException if when the method is not found |
| 134 | * @throws IllegalArgumentException if there is illegal argument found |
| 135 | * @throws InstantiationException if instantiation is provoked for the private constructor |
| 136 | * @throws IllegalAccessException if instance is provoked or a method is provoked |
| 137 | * @throws InvocationTargetException when an exception occurs by the method or constructor |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 138 | */ |
| 139 | @Test |
Bharat saraswal | 715d3fc | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 140 | public void callPrivateConstructors() |
| 141 | throws SecurityException, NoSuchMethodException, IllegalArgumentException, |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 142 | InstantiationException, IllegalAccessException, InvocationTargetException { |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 143 | |
| 144 | Class<?>[] classesToConstruct = {YangIoUtils.class }; |
| 145 | for (Class<?> clazz : classesToConstruct) { |
| 146 | Constructor<?> constructor = clazz.getDeclaredConstructor(); |
| 147 | constructor.setAccessible(true); |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 148 | assertThat(null, not(constructor.newInstance())); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 149 | } |
| 150 | } |
| 151 | |
| 152 | /** |
| 153 | * This test case checks if the directory is cleaned. |
Bharat saraswal | c34b944 | 2016-03-28 15:50:13 +0530 | [diff] [blame] | 154 | * |
| 155 | * @throws IOException when fails to do IO operations for test case |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 156 | */ |
| 157 | @Test |
| 158 | public void cleanGeneratedDirTest() throws IOException { |
| 159 | |
Bharat saraswal | c34b944 | 2016-03-28 15:50:13 +0530 | [diff] [blame] | 160 | File baseDirPath = new File(BASE_DIR); |
| 161 | File createNewDir = new File(BASE_DIR + File.separator + UtilConstants.YANG_GEN_DIR); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 162 | createNewDir.mkdirs(); |
| 163 | File createFile = new File(createNewDir + File.separator + "check1.java"); |
| 164 | createFile.createNewFile(); |
VinodKumarS-Huawei | 6266db3 | 2016-05-10 17:58:57 +0530 | [diff] [blame] | 165 | deleteDirectory(baseDirPath.getAbsolutePath()); |
Bharat saraswal | c2d3be1 | 2016-06-16 00:29:12 +0530 | [diff] [blame^] | 166 | FileUtils.deleteDirectory(createNewDir); |
| 167 | FileUtils.deleteDirectory(baseDirPath); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 168 | } |
| 169 | |
| 170 | /** |
| 171 | * This test case checks the cleaning method when an invalid path is provided. |
Bharat saraswal | c34b944 | 2016-03-28 15:50:13 +0530 | [diff] [blame] | 172 | * |
| 173 | * @throws IOException when fails to do IO operations for test case |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 174 | */ |
| 175 | @Test |
| 176 | public void cleanWithInvalidDirTest() throws IOException { |
| 177 | |
Bharat saraswal | c34b944 | 2016-03-28 15:50:13 +0530 | [diff] [blame] | 178 | File baseDirPath = new File(BASE_DIR + "invalid"); |
VinodKumarS-Huawei | 6266db3 | 2016-05-10 17:58:57 +0530 | [diff] [blame] | 179 | deleteDirectory(baseDirPath.getAbsolutePath()); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 180 | } |
| 181 | |
| 182 | /** |
| 183 | * This test case tests whether the directories are getting created. |
| 184 | */ |
| 185 | @Test |
Bharat saraswal | c2d3be1 | 2016-06-16 00:29:12 +0530 | [diff] [blame^] | 186 | public void createDirectoryTest() throws IOException { |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 187 | |
Bharat saraswal | c34b944 | 2016-03-28 15:50:13 +0530 | [diff] [blame] | 188 | File dirPath = createDirectories(CREATE_PATH); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 189 | assertThat(dirPath.isDirectory(), is(true)); |
Bharat saraswal | c2d3be1 | 2016-06-16 00:29:12 +0530 | [diff] [blame^] | 190 | FileUtils.deleteDirectory(dirPath); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 191 | } |
| 192 | |
| 193 | /** |
Bharat saraswal | c34b944 | 2016-03-28 15:50:13 +0530 | [diff] [blame] | 194 | * This test case checks whether the source is getting added. |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 195 | */ |
| 196 | @Test |
Bharat saraswal | c2d3be1 | 2016-06-16 00:29:12 +0530 | [diff] [blame^] | 197 | public void testForAddSource() throws IOException { |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 198 | |
| 199 | MavenProject project = new MavenProject(); |
| 200 | BuildContext context = new DefaultBuildContext(); |
Bharat saraswal | c34b944 | 2016-03-28 15:50:13 +0530 | [diff] [blame] | 201 | File sourceDir = new File(BASE_DIR + File.separator + "yang"); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 202 | sourceDir.mkdirs(); |
Bharat saraswal | c2d3be1 | 2016-06-16 00:29:12 +0530 | [diff] [blame^] | 203 | addToCompilationRoot(sourceDir.toString(), project, context); |
| 204 | FileUtils.deleteDirectory(sourceDir); |
Bharat saraswal | c34b944 | 2016-03-28 15:50:13 +0530 | [diff] [blame] | 205 | } |
| 206 | |
Bharat saraswal | 715d3fc | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 207 | /** |
Bharat saraswal | c34b944 | 2016-03-28 15:50:13 +0530 | [diff] [blame] | 208 | * Unit test case for trim at last method. |
| 209 | */ |
| 210 | @Test |
| 211 | public void testForTrimAtLast() { |
| 212 | |
| 213 | String test = trimAtLast(CHECK_STRING, "six"); |
| 214 | assertThat(test.contains(TRIM_STRING), is(true)); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 215 | } |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 216 | |
Bharat saraswal | 715d3fc | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 217 | /** |
| 218 | * Returns stub pluginConfig. |
| 219 | * |
| 220 | * @return stub pluginConfig |
| 221 | */ |
| 222 | private YangPluginConfig getStubPluginConfig() { |
| 223 | YangPluginConfig pluginConfig = new YangPluginConfig(); |
| 224 | pluginConfig.setConflictResolver(null); |
| 225 | return pluginConfig; |
| 226 | } |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 227 | } |