aboutsummaryrefslogtreecommitdiffstats
path: root/utils/src/test/java/org/onap/policy/common/utils/resources/ResourceUtilsTest.java
blob: 2991009f10410fdd750bce9d3122f9698bdbdf26 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2018 Ericsson. All rights reserved.
 *  Modifications Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
 *  Modifications Copyright (C) 2020 Nordix Foundation.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.common.utils.resources;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;

import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Set;

import org.junit.After;
import org.junit.Before;
import org.junit.Test;

/**
 * The Class ResourceUtilsTest.
 *
 * @author Liam Fallon (liam.fallon@ericsson.com)
 */
public class ResourceUtilsTest {
    private File tmpDir = null;
    private File tmpEmptyFile = null;
    private File tmpUsedFile = null;

    private String jarDirResource = null;
    private String jarFileResource = null;

    private static final String RESOURCES_PATH = "src/test/resources/";
    private static final String PATH_DIR_RESOURCE = "testdir";
    private static final String PATH_FILE_RESOURCE = "testdir/testfile.xml";

    private static final String NON_EXISTENT_RESOURCE = "somewhere/over/the/rainbow";
    private static final String INVALID_RESOURCE = "@%%%\\\\_:::DESD";

    /**
     * Setup resource utils test.
     *
     * @throws IOException Signals that an I/O exception has occurred.
     */
    @Before
    public void setupResourceUtilsTest() throws IOException {
        tmpDir = new File(System.getProperty("java.io.tmpdir"));
        tmpEmptyFile = File.createTempFile(this.getClass().getName(), ".tmp");
        tmpUsedFile = File.createTempFile(this.getClass().getName(), ".tmp");

        jarDirResource = "META-INF";
        jarFileResource = "META-INF/MANIFEST.MF";

        try (final FileWriter fileWriter = new FileWriter(tmpUsedFile)) {
            fileWriter.write("Bluebirds fly over the rainbow");
        }
    }

    /**
     * Cleandown resource utils test.
     */
    @After
    public void cleandownResourceUtilsTest() {
        tmpEmptyFile.delete();
        tmpUsedFile.delete();
    }

    /**
     * Test get url resource.
     */
    @Test
    public void testgetUrlResource() {
        URL theUrl = ResourceUtils.getUrlResource(tmpDir.getAbsolutePath());
        assertNull(theUrl);

        theUrl = ResourceUtils.getUrlResource(tmpEmptyFile.getAbsolutePath());
        assertNull(theUrl);

        theUrl = ResourceUtils.getUrlResource(tmpUsedFile.getAbsolutePath());
        assertNull(theUrl);

        theUrl = ResourceUtils.getUrlResource(jarDirResource);
        assertNotNull(theUrl);

        theUrl = ResourceUtils.getUrlResource(jarFileResource);
        assertNotNull(theUrl);

        theUrl = ResourceUtils.getUrlResource(PATH_DIR_RESOURCE);
        assertNotNull(theUrl);

        theUrl = ResourceUtils.getUrlResource(PATH_FILE_RESOURCE);
        assertNotNull(theUrl);

        theUrl = ResourceUtils.getUrlResource("file:///" + PATH_DIR_RESOURCE);
        assertNotNull(theUrl);

        theUrl = ResourceUtils.getLocalFile(RESOURCES_PATH + PATH_DIR_RESOURCE);
        assertNotNull(theUrl);

        theUrl = ResourceUtils.getLocalFile(RESOURCES_PATH + PATH_FILE_RESOURCE);
        assertNotNull(theUrl);

        theUrl = ResourceUtils.getUrlResource(NON_EXISTENT_RESOURCE);
        assertNull(theUrl);

        theUrl = ResourceUtils.getUrlResource(INVALID_RESOURCE);
        assertNull(theUrl);

        theUrl = ResourceUtils.getUrlResource(null);
        assertNull(theUrl);
    }

    /**
     * Test get local file.
     */
    @Test
    public void testGetLocalFile() {
        URL theUrl = ResourceUtils.getLocalFile(tmpDir.getAbsolutePath());
        assertNotNull(theUrl);

        theUrl = ResourceUtils.getLocalFile(tmpEmptyFile.getAbsolutePath());
        assertNotNull(theUrl);

        theUrl = ResourceUtils.getLocalFile(tmpUsedFile.getAbsolutePath());
        assertNotNull(theUrl);

        theUrl = ResourceUtils.getLocalFile(jarDirResource);
        assertNull(theUrl);

        theUrl = ResourceUtils.getLocalFile(jarFileResource);
        assertNull(theUrl);

        theUrl = ResourceUtils.getLocalFile(PATH_DIR_RESOURCE);
        assertNull(theUrl);

        theUrl = ResourceUtils.getLocalFile(PATH_FILE_RESOURCE);
        assertNull(theUrl);

        theUrl = ResourceUtils.getLocalFile(RESOURCES_PATH + PATH_DIR_RESOURCE);
        assertNotNull(theUrl);

        theUrl = ResourceUtils.getLocalFile(RESOURCES_PATH + PATH_FILE_RESOURCE);
        assertNotNull(theUrl);

        theUrl = ResourceUtils.getLocalFile(NON_EXISTENT_RESOURCE);
        assertNull(theUrl);

        theUrl = ResourceUtils.getLocalFile(INVALID_RESOURCE);
        assertNull(theUrl);

        theUrl = ResourceUtils.getLocalFile("file:///");
        assertNotNull(theUrl);

        theUrl = ResourceUtils.getLocalFile("file:///testdir/testfile.xml");
        assertNull(theUrl);

        theUrl = ResourceUtils.getLocalFile(null);
        assertNull(theUrl);
    }

    /**
     * Test get resource as stream.
     */
    @Test
    public void testGetResourceAsStream() {
        InputStream theStream = ResourceUtils.getResourceAsStream(tmpDir.getAbsolutePath());
        assertNotNull(theStream);

        theStream = ResourceUtils.getResourceAsStream(tmpEmptyFile.getAbsolutePath());
        assertNotNull(theStream);

        theStream = ResourceUtils.getResourceAsStream(tmpUsedFile.getAbsolutePath());
        assertNotNull(theStream);

        theStream = ResourceUtils.getResourceAsStream(jarDirResource);
        assertNotNull(theStream);

        theStream = ResourceUtils.getResourceAsStream(jarFileResource);
        assertNotNull(theStream);

        theStream = ResourceUtils.getResourceAsStream(PATH_DIR_RESOURCE);
        assertNotNull(theStream);

        theStream = ResourceUtils.getResourceAsStream(PATH_FILE_RESOURCE);
        assertNotNull(theStream);

        theStream = ResourceUtils.getResourceAsStream(RESOURCES_PATH + PATH_DIR_RESOURCE);
        assertNotNull(theStream);

        theStream = ResourceUtils.getResourceAsStream(RESOURCES_PATH + PATH_FILE_RESOURCE);
        assertNotNull(theStream);

        theStream = ResourceUtils.getResourceAsStream(NON_EXISTENT_RESOURCE);
        assertNull(theStream);

        theStream = ResourceUtils.getResourceAsStream(INVALID_RESOURCE);
        assertNull(theStream);

        theStream = ResourceUtils.getResourceAsStream(null);
        assertNull(theStream);

        theStream = ResourceUtils.getResourceAsStream("");
        assertNotNull(theStream);
    }

    /**
     * Test get resource as string.
     */
    @Test
    public void testGetResourceAsString() {
        String theString = ResourceUtils.getResourceAsString(tmpDir.getAbsolutePath());
        assertNotNull(theString);

        theString = ResourceUtils.getResourceAsString(tmpEmptyFile.getAbsolutePath());
        assertTrue(theString.equals(""));

        theString = ResourceUtils.getResourceAsString(tmpUsedFile.getAbsolutePath());
        assertTrue(theString.equals("Bluebirds fly over the rainbow"));

        theString = ResourceUtils.getResourceAsString(jarFileResource);
        assertNotNull(theString);

        theString = ResourceUtils.getResourceAsString(PATH_DIR_RESOURCE);
        assertNotNull(theString);

        theString = ResourceUtils.getResourceAsString(PATH_FILE_RESOURCE);
        assertNotNull(theString);

        theString = ResourceUtils.getResourceAsString(RESOURCES_PATH + PATH_DIR_RESOURCE);
        assertNotNull(theString);

        theString = ResourceUtils.getResourceAsString(RESOURCES_PATH + PATH_FILE_RESOURCE);
        assertNotNull(theString);

        theString = ResourceUtils.getResourceAsString(NON_EXISTENT_RESOURCE);
        assertNull(theString);

        theString = ResourceUtils.getResourceAsString(INVALID_RESOURCE);
        assertNull(theString);

        theString = ResourceUtils.getResourceAsString(null);
        assertNull(theString);

        theString = ResourceUtils.getResourceAsString("");

        assertEquals("logback-test.xml\nMETA-INF\norg\ntestdir\n", theString);

    }

    @Test
    public void testgetUrl4Resource() {
        URL theUrl = ResourceUtils.getUrl4Resource(tmpDir.getAbsolutePath());
        assertNotNull(theUrl);

        theUrl = ResourceUtils.getUrl4Resource(tmpEmptyFile.getAbsolutePath());
        assertNotNull(theUrl);

        theUrl = ResourceUtils.getUrl4Resource(tmpUsedFile.getAbsolutePath());
        assertNotNull(theUrl);

        theUrl = ResourceUtils.getUrl4Resource(jarDirResource);
        assertNotNull(theUrl);

        theUrl = ResourceUtils.getUrl4Resource(jarFileResource);
        assertNotNull(theUrl);

        theUrl = ResourceUtils.getUrl4Resource(PATH_DIR_RESOURCE);
        assertNotNull(theUrl);

        theUrl = ResourceUtils.getUrl4Resource(PATH_FILE_RESOURCE);
        assertNotNull(theUrl);

        theUrl = ResourceUtils.getUrl4Resource(RESOURCES_PATH + PATH_DIR_RESOURCE);
        assertNotNull(theUrl);

        theUrl = ResourceUtils.getUrl4Resource(RESOURCES_PATH + PATH_FILE_RESOURCE);
        assertNotNull(theUrl);

        theUrl = ResourceUtils.getUrl4Resource(NON_EXISTENT_RESOURCE);
        assertNull(theUrl);

        theUrl = ResourceUtils.getUrl4Resource(INVALID_RESOURCE);
        assertNull(theUrl);
    }

    @Test
    public void testGetFilePath4Resource() {
        assertNull(ResourceUtils.getFilePath4Resource(null));
        assertEquals("/something/else", ResourceUtils.getFilePath4Resource("/something/else"));
        assertTrue(ResourceUtils.getFilePath4Resource("xml/example.xml").endsWith("xml/example.xml"));
        assertTrue(ResourceUtils.getFilePath4Resource("com/google").endsWith("com/google"));
    }

    @Test
    public void testGetDirectoryContents() throws MalformedURLException {
        assertTrue(ResourceUtils.getDirectoryContents(null).isEmpty());
        assertTrue(ResourceUtils.getDirectoryContents("idontexist").isEmpty());
        assertTrue(ResourceUtils.getDirectoryContents("logback-test.xml").isEmpty());

        Set<String> resultD0 = ResourceUtils.getDirectoryContents("testdir");
        assertEquals(1, resultD0.size());
        assertEquals("testdir/testfile.xml", resultD0.iterator().next());

        Set<String> resultD1 = ResourceUtils.getDirectoryContents("org/onap/policy/common");
        assertTrue(resultD1.size() > 0);
        assertEquals("org/onap/policy/common/utils/", resultD1.iterator().next());

        Set<String> resultD2 = ResourceUtils.getDirectoryContents("org/onap/policy/common/utils/coder");
        assertTrue(resultD2.size() >= 15);
        assertEquals("org/onap/policy/common/utils/coder/CoderExceptionTest.class", resultD2.iterator().next());

        Set<String> resultJ0 = ResourceUtils.getDirectoryContents("com");
        assertEquals(189, resultJ0.size());
        assertEquals("com/google/", resultJ0.iterator().next());

        Set<String> resultJ1 = ResourceUtils.getDirectoryContents("com/google/gson/util");
        assertEquals(1, resultJ1.size());
        assertEquals("com/google/gson/util/VersionUtils.class", resultJ1.iterator().next());

        URL dummyUrl = new URL("http://even/worse");
        assertTrue(ResourceUtils.getDirectoryContentsJar(dummyUrl, "nonexistantdirectory").isEmpty());

    }
}