2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019 Nordix Foundation
4 * Copyright (C) 2021 Nokia. All rights reserved.
5 * ================================================================================
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.sdc.backend.ci.tests.data.providers;
23 import static org.testng.Assert.fail;
25 import java.util.ArrayList;
26 import java.util.Arrays;
27 import java.util.Collections;
28 import java.util.List;
29 import java.util.Optional;
30 import java.util.stream.Collectors;
31 import org.apache.commons.collections4.CollectionUtils;
32 import org.onap.sdc.backend.ci.tests.datatypes.enums.XnfTypeEnum;
33 import org.onap.sdc.backend.ci.tests.utils.general.FileHandling;
34 import org.onap.sdc.backend.ci.tests.utils.general.OnboardingUtils;
35 import org.slf4j.Logger;
36 import org.slf4j.LoggerFactory;
37 import org.testng.annotations.DataProvider;
39 public final class OnboardingDataProviders {
41 private static final Logger LOGGER = LoggerFactory.getLogger(OnboardingDataProviders.class);
42 private static final String VNF_FILE_PATH = FileHandling.getXnfRepositoryPath(XnfTypeEnum.VNF);
44 private OnboardingDataProviders() {
48 @DataProvider(name = "randomVNF_List")
49 private static Object[][] randomVnfList() {
50 final int randomElementNumber = 3; //how many VNFs to onboard randomly
51 final List<String> fileNamesFromFolder = OnboardingUtils.getVnfNamesFileListExcludeToscaParserFailure();
52 final List<String> newRandomFileNamesFromFolder = getRandomElements(randomElementNumber, fileNamesFromFolder);
53 if (CollectionUtils.isEmpty(newRandomFileNamesFromFolder)) {
54 fail("Required number of VNF files not exists under " + VNF_FILE_PATH);
55 return new Object[0][];
57 LOGGER.debug(String.format("There are %s zip file(s) to test", newRandomFileNamesFromFolder.size()));
58 return provideData(newRandomFileNamesFromFolder, VNF_FILE_PATH);
61 @DataProvider(name = "VNF_List", parallel = true)
62 private static Object[][] vnfList() {
63 final List<String> fileNamesFromFolder = OnboardingUtils.getXnfNamesFileList(XnfTypeEnum.VNF);
64 LOGGER.debug(String.format("There are %s package file(s) to test", fileNamesFromFolder.size()));
65 return provideData(fileNamesFromFolder, VNF_FILE_PATH);
68 @DataProvider(name = "PNF_List", parallel = true)
69 private static Object[][] pnfList() {
70 return provideData(OnboardingUtils.getXnfNamesFileList(XnfTypeEnum.PNF),
71 FileHandling.getXnfRepositoryPath(XnfTypeEnum.PNF));
74 @DataProvider(name = "CNF_List", parallel = true)
75 private static Object[][] cnfList() {
76 final List<String> fileNamesFromFolder = OnboardingUtils.getXnfNamesFileList(XnfTypeEnum.CNF);
77 LOGGER.debug(String.format("There are %s package file(s) to test", fileNamesFromFolder.size()));
78 return provideData(fileNamesFromFolder, FileHandling.getXnfRepositoryPath(XnfTypeEnum.CNF));
81 @DataProvider(name = "Invalid_CNF_List", parallel = true)
82 private static Object[][] invalidCnfList() {
83 final List<String> fileNamesFromFolder = OnboardingUtils.getInvalidXnfNamesFileList(XnfTypeEnum.CNF);
84 LOGGER.debug(String.format("There are %s package file(s) to test", fileNamesFromFolder.size()));
85 return provideData(fileNamesFromFolder, FileHandling.getXnfRepositoryPath(XnfTypeEnum.CNF));
88 @DataProvider(name = "Single_VNF", parallel = true)
89 private static Object[][] singleVNF() {
90 final List<String> fileNamesFromFolder = OnboardingUtils.getXnfNamesFileList(XnfTypeEnum.VNF);
91 final List<String> newList = new ArrayList<>();
92 newList.add(fileNamesFromFolder.get(0));
93 LOGGER.debug(String.format("There are %s zip file(s) to test", fileNamesFromFolder.size()));
94 return provideData(newList, VNF_FILE_PATH);
97 @DataProvider(name = "softwareInformationPnf", parallel = true)
98 private static Object[][] softwareInformationPnf() {
99 final List<String> pnfPackageFileNameList = OnboardingUtils.getXnfNamesFileList(XnfTypeEnum.PNF);
100 if (CollectionUtils.isEmpty(pnfPackageFileNameList)) {
101 fail("Could not create softwareInformationPnf datasource");
103 final String pnfPackage = "sample-pnf-1.0.1-SNAPSHOT.csar";
104 final Optional<String> softwareInformationPnfPackage = pnfPackageFileNameList.stream()
105 .filter(pnfPackage::equals).findFirst();
106 if (!softwareInformationPnfPackage.isPresent()) {
107 fail(String.format("Could not create softwareInformationPnf datasource, the package '%s' was not found",
111 final String folderPath = FileHandling.getXnfRepositoryPath(XnfTypeEnum.PNF);
112 final Object[][] parametersArray = new Object[1][];
113 parametersArray[0] = new Object[]{folderPath, softwareInformationPnfPackage.get(),
114 Arrays.asList("5gDUv18.05.201", "5gDUv18.06.205")};
115 return parametersArray;
118 @DataProvider(name = "etsiVnfCnfOnboardPackages")
119 private static Object[][] etsiVnf() {
120 final List<String> vnfPackageFileNameList = OnboardingUtils.getXnfNamesFileList(XnfTypeEnum.ETSI);
121 if (CollectionUtils.isEmpty(vnfPackageFileNameList)) {
122 fail("Could not create etsiSingleVnfCnf datasource");
124 final String etsiVnfPackageName = "ETSI-VNF-SAMPLE.csar";
125 final String etsiCnfPackageName = "ETSI-CNF-SAMPLE.csar";
126 final List<String> etsiPackages = vnfPackageFileNameList.stream()
127 .filter(packageName -> packageName.equals(etsiVnfPackageName) || packageName.equals(etsiCnfPackageName))
128 .collect(Collectors.toList());
129 if (CollectionUtils.isEmpty(etsiPackages) || etsiPackages.size() < 2) {
130 fail(String.format("Could not create etsiSingleVnfCnf datasource, one of the package '%s' was not found",
134 final String folderPath = FileHandling.getXnfRepositoryPath(XnfTypeEnum.ETSI);
135 final Object[][] parametersArray = new Object[2][];
136 parametersArray[0] = new Object[]{folderPath, etsiPackages.get(0)};
137 parametersArray[1] = new Object[]{folderPath, etsiPackages.get(1)};
138 return parametersArray;
141 @DataProvider(name = "vfcList")
142 private static Object[][] vfcList() {
143 final List<String> vfcFileNameList = OnboardingUtils.getVfcFilenameList();
144 if (CollectionUtils.isEmpty(vfcFileNameList)) {
145 fail("Could not create vfcList datasource");
147 final String vfc1 = "1-VFC-NetworkFunction.yaml";
148 final String vfc2 = "2-VFC-NetworkService.yaml";
149 final List<String> vfcFiles = vfcFileNameList.stream()
150 .filter(filename -> filename.equals(vfc1) || filename.equals(vfc2))
151 .collect(Collectors.toList());
152 Collections.sort(vfcFiles);
153 if (CollectionUtils.isEmpty(vfcFiles) || vfcFiles.size() < 2) {
154 fail(String.format("Could not create vfcList datasource, one of the vfc file '%s' was not found", vfcFiles));
157 final String folderPath = FileHandling.getXnfRepositoryPath(XnfTypeEnum.VFC);
158 final Object[][] parametersArray = new Object[2][];
159 parametersArray[0] = new Object[]{folderPath, vfcFiles.get(0)};
160 parametersArray[1] = new Object[]{folderPath, vfcFiles.get(1)};
161 return parametersArray;
164 private static Object[][] provideData(final List<String> fileNamesFromFolder, final String folderPath) {
165 final Object[][] parametersArray = new Object[fileNamesFromFolder.size()][];
167 for (final Object obj : fileNamesFromFolder) {
168 parametersArray[index++] = new Object[]{folderPath, obj};
170 return parametersArray;
173 public static List<String> getRandomElements(final int randomElementNumber,
174 final List<String> fileNamesFromFolder) {
175 if (fileNamesFromFolder.isEmpty() || fileNamesFromFolder.size() < randomElementNumber) {
176 return Collections.emptyList();
178 final List<Integer> indexList = new ArrayList<>();
179 final List<String> newRandomFileNamesFromFolder = new ArrayList<>();
180 for (int i = 0; i < fileNamesFromFolder.size(); i++) {
183 Collections.shuffle(indexList);
184 final Integer[] randomArray = indexList.subList(0, randomElementNumber)
185 .toArray(new Integer[randomElementNumber]);
186 for (final Integer randomNumber : randomArray) {
187 newRandomFileNamesFromFolder.add(fileNamesFromFolder.get(randomNumber));
189 return newRandomFileNamesFromFolder;