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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
|
/*-
* ============LICENSE_START=======================================================
* SDC
* ================================================================================
* Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* 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.
* ============LICENSE_END=========================================================
*/
package org.onap.sdc.backend.ci.tests.utils.general;
import static org.testng.AssertJUnit.assertTrue;
import com.aventstack.extentreports.Status;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileWriter;
import java.io.FilenameFilter;
import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.EnumMap;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.zip.ZipEntry;
import java.util.zip.ZipException;
import java.util.zip.ZipFile;
import org.apache.commons.io.FileUtils;
import org.onap.sdc.backend.ci.tests.datatypes.enums.XnfTypeEnum;
import org.openecomp.sdc.be.model.DataTypeDefinition;
import org.onap.sdc.backend.ci.tests.api.ComponentBaseTest;
import org.openecomp.sdc.common.util.GeneralUtility;
import org.yaml.snakeyaml.Yaml;
public class FileHandling {
// ------------------yaml parser methods----------------------------
public static Map<?, ?> parseYamlFile(String filePath) throws Exception {
Yaml yaml = new Yaml();
File file = new File(filePath);
InputStream inputStream = new FileInputStream(file);
Map<?, ?> map = (Map<?, ?>) yaml.load(inputStream);
return map;
}
/**
* The method return map fetched objects by pattern from yaml file
* @param yamlFile
* @param pattern
* @return
* @throws Exception
*/
public static Map<String, Object> parseYamlFileToMapByPattern(File yamlFile, String pattern) throws Exception {
Map<?, ?> yamlFileToMap = FileHandling.parseYamlFile(yamlFile.toString());
Map<String, Object> objectMap = getObjectMapByPattern(yamlFileToMap, pattern);
return objectMap;
}
@SuppressWarnings("unchecked")
public static Map<String, Object> getObjectMapByPattern(Map<?, ?> parseUpdetedEnvFile, String pattern) {
Map<String, Object> objectMap = null;
Object objectUpdetedEnvFile = parseUpdetedEnvFile.get(pattern);
if(objectUpdetedEnvFile instanceof HashMap){
objectMap = (Map<String, Object>) objectUpdetedEnvFile;
}
return objectMap;
}
public static Map<String, DataTypeDefinition> parseDataTypesYaml(String filePath) throws Exception {
@SuppressWarnings("unchecked")
Map<String, DataTypeDefinition> dataTypesMap = (Map<String, DataTypeDefinition>) parseYamlFile(filePath);
return dataTypesMap;
}
// -------------------------------------------------------------------------------------------------
/**
* @param folder, folder name under "Files" folder
* @return path to given folder from perspective of working directory or sdc-vnfs repository
*/
public static String getFilePath(String folder) {
// return folder from perspective of working directory ( in general for nightly run from Linux, should already contain "Files" directory )
return FileHandling.getBasePath() + "src/test/resources/Files" + File.separator + folder + File.separator;
}
public static String getBasePath() {
return System.getProperty("user.dir") + File.separator;
}
public static String getSdcVnfsPath() {
return getBasePath() + Paths.get("..", "..", "sdc-vnfs").toString();
}
public static String getDriversPath() {
return getBasePath() + "src" + File.separator + "test" + File.separator + "resources"
+ File.separator + "ci" + File.separator + "drivers" + File.separator;
}
public static String getResourcesFilesPath() {
return getSdcVnfsPath()+ File.separator + "ui-tests" + File.separator + "Files" + File.separator;
}
public static String getResourcesEnvFilesPath() {
return getBasePath() + File.separator + "src" + File.separator + "test" + File.separator + "resources"
+ File.separator + "Files" + File.separator + "ResourcesEnvFiles" +File.separator;
}
public static String getCiFilesPath() {
return getBasePath() + "src" + File.separator + "test" + File.separator + "resources"
+ File.separator + "ci";
}
public static String getConfFilesPath() {
return getCiFilesPath() + File.separator + "conf" + File.separator;
}
private static EnumMap<XnfTypeEnum, String> XNF_REPOSITORY_PATHS_MAP = new EnumMap<>(Map.of(
XnfTypeEnum.PNF, getPnfRepositoryPath(),
XnfTypeEnum.CNF, getCnfRepositoryPath(),
XnfTypeEnum.VNF, getVnfRepositoryPath(),
XnfTypeEnum.ETSI, getEtsiRepositoryPath()
));
public static String getVnfRepositoryPath() {
return getFilePath("VNFs");
}
private static String getPnfRepositoryPath() {
return getFilePath("PNFs");
}
private static String getCnfRepositoryPath() {
return getFilePath("CNFs");
}
private static String getEtsiRepositoryPath() { return getFilePath("ETSI"); }
public static String getXnfRepositoryPath(XnfTypeEnum xnfTypeEnum) {
return XNF_REPOSITORY_PATHS_MAP.get(xnfTypeEnum);
}
public static String getPortMirroringRepositoryPath() {
return getFilePath("PortMirroring");
}
public static File getConfigFile(String configFileName) throws Exception {
File configFile = new File(FileHandling.getBasePath() + File.separator + "conf" + File.separator + configFileName);
if (!configFile.exists()) {
configFile = new File(FileHandling.getConfFilesPath() + configFileName);
}
return configFile;
}
public static Object[] filterFileNamesFromFolder(String filepath, String extension) {
try {
File dir = new File(filepath);
List<String> filenames = new ArrayList<String>();
FilenameFilter extensionFilter = new FilenameFilter() {
public boolean accept(File dir, String name) {
return name.endsWith(extension);
}
};
if (dir.isDirectory()) {
for (File file : dir.listFiles(extensionFilter)) {
filenames.add(file.getName());
}
return filenames.toArray();
}
} catch (Exception e) {
e.printStackTrace();
}
return null;
}
public static List<String> filterFileNamesListFromFolder(String filepath, String extension) {
List<String> filenames = new ArrayList<String>();
try {
File dir = new File(filepath);
FilenameFilter extensionFilter = new FilenameFilter() {
public boolean accept(File dir, String name) {
return name.endsWith(extension);
}
};
if (dir.isDirectory()) {
for (File file : dir.listFiles(extensionFilter)) {
filenames.add(file.getName());
}
return filenames;
}
} catch (Exception e) {
e.printStackTrace();
}
return filenames;
}
public static String[] getArtifactsFromZip(String filepath, String zipFilename){
try {
ZipFile zipFile = new ZipFile(filepath + File.separator + zipFilename);
Enumeration<? extends ZipEntry> entries = zipFile.entries();
String[] artifactNames = new String[zipFile.size() - 1];
int i = 0;
while(entries.hasMoreElements()){
ZipEntry nextElement = entries.nextElement();
if (!nextElement.isDirectory()){
if (!nextElement.getName().equals("MANIFEST.json")){
String name = nextElement.getName();
artifactNames[i++] = name;
}
}
}
zipFile.close();
return artifactNames;
} catch(ZipException zipEx) {
System.err.println("Error in zip file named : " + zipFilename);
zipEx.printStackTrace();
} catch (IOException e) {
System.err.println("Unhandled exception : ");
e.printStackTrace();
}
return null;
}
public static List<String> getFileNamesFromZip(String zipFileLocation){
try{
ZipFile zipFile = new ZipFile(zipFileLocation);
Enumeration<? extends ZipEntry> entries = zipFile.entries();
List<String> artifactNames = new ArrayList<>();
int i = 0;
while(entries.hasMoreElements()){
ZipEntry nextElement = entries.nextElement();
if (!nextElement.isDirectory()){
String name = nextElement.getName();
artifactNames.add(name);
}
}
zipFile.close();
return artifactNames;
}
catch(ZipException zipEx){
System.err.println("Error in zip file named : " + zipFileLocation);
zipEx.printStackTrace();
} catch (IOException e) {
System.err.println("Unhandled exception : ");
e.printStackTrace();
}
return null;
}
public static List<String> getZipFileNamesFromFolder(String filepath) {
List<String> fileNamesListFromFolder = filterFileNamesListFromFolder(filepath, ".zip");
fileNamesListFromFolder.addAll(filterFileNamesListFromFolder(filepath, ".csar"));
return fileNamesListFromFolder;
}
public static int countFilesInZipFile(String[] artifactsArr, String reqExtension){
int fileCounter = 0;
for (String artifact : artifactsArr){
String extensionFile = artifact.substring(artifact.lastIndexOf(".") + 1 , artifact.length());
if (extensionFile.equals(reqExtension)){
fileCounter++;
}
}
return fileCounter;
}
/**
* @param dirPath
* @return last modified file name from dirPath directory
*/
public static synchronized File getLastModifiedFileNameFromDir(String dirPath){
File dir = new File(dirPath);
File[] files = dir.listFiles();
if (files == null) {
assertTrue("File not found under directory " + dirPath, false);
return null;
}
File lastModifiedFile = files[0];
for (int i = 1; i < files.length; i++) {
if(files[i].isDirectory()) {
continue;
}
if (lastModifiedFile.lastModified() < files[i].lastModified()) {
lastModifiedFile = files[i];
}
}
return lastModifiedFile;
}
public static void deleteDirectory(String directoryPath) {
File dir = new File(directoryPath);
try {
FileUtils.cleanDirectory(dir);
} catch (IllegalArgumentException e) {
System.out.println("Failed to clean " + dir);
} catch (IOException e) {
System.out.println("Failed to clean " + dir);
}
}
public static void createDirectory(String directoryPath) {
File directory = new File(String.valueOf(directoryPath));
if (! directory.exists()){
directory.mkdirs();
}
}
/**
* The method append data to existing file, if file not exists - create it
* @param pathToFile
* @param text
* @param leftSpaceCount
* @throws IOException
*/
public static synchronized void writeToFile(File pathToFile, Object text, Integer leftSpaceCount) throws IOException{
BufferedWriter bw = null;
FileWriter fw = null;
if(!pathToFile.exists()){
createEmptyFile(pathToFile);
}
try {
fw = new FileWriter(pathToFile, true);
bw = new BufferedWriter(fw);
StringBuilder sb = new StringBuilder();
if(leftSpaceCount > 0 ){
for(int i = 0; i < leftSpaceCount; i++){
sb.append(" ");
}
}
bw.write(sb.toString() + text);
bw.newLine();
bw.close();
fw.close();
} catch (Exception e) {
ComponentBaseTest.getExtendTest().log(Status.INFO, "Unable to write to flie " + pathToFile);
}
}
public static String getCreateDirByName(String dirName) {
File dir = new File(dirName);
dir.mkdir();
if(!dir.exists()) {
}
return dir.getPath();
}
public static boolean isFileDownloaded(String downloadPath, String fileName) {
boolean flag = false;
File dir = new File(downloadPath);
File[] dir_contents = dir.listFiles();
for (int i = 0; i < dir_contents.length; i++) {
if (dir_contents[i].getName().equals(fileName))
return flag = true;
}
return flag;
}
public static String getMD5OfFile(File file) throws IOException {
String content = FileUtils.readFileToString(file);
String md5 = GeneralUtility.calculateMD5Base64EncodedByString(content);
return md5;
}
public static File createEmptyFile(String fileToCreate) {
File file= new File(fileToCreate);
try {
if(file.exists()){
deleteFile(file);
}
file.createNewFile();
ComponentBaseTest.getExtendTest().log(Status.INFO, "Create file " + fileToCreate);
} catch (IOException e) {
ComponentBaseTest.getExtendTest().log(Status.INFO, "Failed to create file " + fileToCreate);
e.printStackTrace();
}
return file;
}
public static File createEmptyFile(File fileToCreate) {
try {
if(fileToCreate.exists()){
deleteFile(fileToCreate);
}
fileToCreate.createNewFile();
ComponentBaseTest.getExtendTest().log(Status.INFO, "Create file " + fileToCreate);
} catch (IOException e) {
ComponentBaseTest.getExtendTest().log(Status.INFO, "Failed to create file " + fileToCreate);
e.printStackTrace();
}
return fileToCreate;
}
public static void deleteFile(File file){
try{
if(file.exists()){
file.deleteOnExit();
ComponentBaseTest.getExtendTest().log(Status.INFO, "File " + file.getName() + "has been deleted");
}else{
ComponentBaseTest.getExtendTest().log(Status.INFO, "Failed to delete file " + file.getName());
}
}catch(Exception e){
e.printStackTrace();
}
}
/**
* get file list from directory by extension array
* @param directory
* @param okFileExtensions
* @return
*/
public static List<File> getHeatAndHeatEnvArtifactsFromZip(File directory, String[] okFileExtensions){
List<File> fileList = new ArrayList<>();
File[] files = directory.listFiles();
for (String extension : okFileExtensions){
for(File file : files){
if (file.getName().toLowerCase().endsWith(extension)){
fileList.add(file);
}
}
}
return fileList;
}
public static String getKeyByValueFromPropertyFormatFile(String fullPath, String key) {
Properties prop = new Properties();
InputStream input = null;
String value = null;
try {
input = new FileInputStream(fullPath);
prop.load(input);
value = (prop.getProperty(key));
} catch (IOException ex) {
ex.printStackTrace();
} finally {
if (input != null) {
try {
input.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
return value.replaceAll("\"","");
}
public static void overWriteExistindDir(String outputCsar) throws IOException {
String basePath = getBasePath();
String csarDir = FileHandling.getCreateDirByName("target/outputCsar");
FileUtils.cleanDirectory(new File(csarDir));
}
}
|