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;
26 import java.util.ArrayList;
27 import java.util.Arrays;
28 import java.util.Collections;
29 import java.util.List;
30 import java.util.Optional;
31 import java.util.stream.Collectors;
32 import org.apache.commons.collections4.CollectionUtils;
33 import org.onap.sdc.backend.ci.tests.datatypes.enums.XnfTypeEnum;
34 import org.onap.sdc.backend.ci.tests.utils.general.FileHandling;
35 import org.onap.sdc.backend.ci.tests.utils.general.OnboardingUtils;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
38 import org.testng.annotations.DataProvider;
40 public final class OnboardingDataProviders {
42 private static final Logger LOGGER = LoggerFactory.getLogger(OnboardingDataProviders.class);
43 private static final String VNF_FILE_PATH = FileHandling.getXnfRepositoryPath(XnfTypeEnum.VNF);
45 private OnboardingDataProviders() {
49 @DataProvider(name = "randomVNF_List")
50 private static Object[][] randomVnfList() {
51 final int randomElementNumber = 3; //how many VNFs to onboard randomly
52 final List<String> fileNamesFromFolder = OnboardingUtils.getVnfNamesFileListExcludeToscaParserFailure();
53 final List<String> newRandomFileNamesFromFolder = getRandomElements(randomElementNumber, fileNamesFromFolder);
54 if (CollectionUtils.isEmpty(newRandomFileNamesFromFolder)) {
55 fail("Required number of VNF files not exists under " + VNF_FILE_PATH);
56 return new Object[0][];
58 LOGGER.debug(String.format("There are %s zip file(s) to test", newRandomFileNamesFromFolder.size()));
59 return provideData(newRandomFileNamesFromFolder, VNF_FILE_PATH);
62 @DataProvider(name = "VNF_List", parallel = true)
63 private static Object[][] vnfList() {
64 final List<String> fileNamesFromFolder = OnboardingUtils.getXnfNamesFileList(XnfTypeEnum.VNF);
65 LOGGER.debug(String.format("There are %s package file(s) to test", fileNamesFromFolder.size()));
66 return provideData(fileNamesFromFolder, VNF_FILE_PATH);
69 @DataProvider(name = "PNF_List", parallel = true)
70 private static Object[][] pnfList() {
71 return provideData(OnboardingUtils.getXnfNamesFileList(XnfTypeEnum.PNF),
72 FileHandling.getXnfRepositoryPath(XnfTypeEnum.PNF));
75 @DataProvider(name = "CNF_List", parallel = true)
76 private static Object[][] cnfList() {
77 final List<String> fileNamesFromFolder = OnboardingUtils.getXnfNamesFileList(XnfTypeEnum.CNF);
78 LOGGER.debug(String.format("There are %s package file(s) to test", fileNamesFromFolder.size()));
79 return provideData(fileNamesFromFolder, FileHandling.getXnfRepositoryPath(XnfTypeEnum.CNF));
82 @DataProvider(name = "Invalid_CNF_List", parallel = true)
83 private static Object[][] invalidCnfList() {
84 final List<String> fileNamesFromFolder = OnboardingUtils.getInvalidXnfNamesFileList(XnfTypeEnum.CNF);
85 LOGGER.debug(String.format("There are %s package file(s) to test", fileNamesFromFolder.size()));
86 return provideData(fileNamesFromFolder, FileHandling.getXnfRepositoryPath(XnfTypeEnum.CNF) + File.separator + OnboardingUtils.INVALID_XNFS_SUBPATH);
89 @DataProvider(name = "CNF_Helm_Validator_List", parallel = true)
90 private static Object[][] cnfForHelmValidatorList() {
91 final List<String> fileNamesFromFolder = OnboardingUtils.getXnfNamesFileList(XnfTypeEnum.CNF_HELM);
92 LOGGER.debug(String.format("There are %s package file(s) to test", fileNamesFromFolder.size()));
93 return provideData(fileNamesFromFolder, FileHandling.getXnfRepositoryPath(XnfTypeEnum.CNF_HELM));
96 @DataProvider(name = "CNF_With_Warning_Helm_Validator_List", parallel = true)
97 private static Object[][] cnfWithWarningForHelmValidatorList() {
98 final List<String> fileNamesFromFolder = OnboardingUtils.getXnfNamesWithWarningsFileList(XnfTypeEnum.CNF_HELM);
99 LOGGER.debug(String.format("There are %s package file(s) to test", fileNamesFromFolder.size()));
100 return provideData(fileNamesFromFolder, FileHandling.getXnfRepositoryPath(XnfTypeEnum.CNF_HELM) + File.separator + OnboardingUtils.WITH_WARNINGS_XNFS_SUBPATH);
103 @DataProvider(name = "Invalid_CNF_Helm_Validator_List", parallel = true)
104 private static Object[][] invalidCnfForHelmValidatorList() {
105 final List<String> fileNamesFromFolder = OnboardingUtils.getInvalidXnfNamesFileList(XnfTypeEnum.CNF_HELM);
106 LOGGER.debug(String.format("There are %s package file(s) to test", fileNamesFromFolder.size()));
107 return provideData(fileNamesFromFolder, FileHandling.getXnfRepositoryPath(XnfTypeEnum.CNF_HELM) + File.separator + OnboardingUtils.INVALID_XNFS_SUBPATH);
110 @DataProvider(name = "Single_VNF", parallel = true)
111 private static Object[][] singleVNF() {
112 final List<String> fileNamesFromFolder = OnboardingUtils.getXnfNamesFileList(XnfTypeEnum.VNF);
113 final List<String> newList = new ArrayList<>();
114 newList.add(fileNamesFromFolder.get(0));
115 LOGGER.debug(String.format("There are %s zip file(s) to test", fileNamesFromFolder.size()));
116 return provideData(newList, VNF_FILE_PATH);
119 @DataProvider(name = "softwareInformationPnf", parallel = true)
120 private static Object[][] softwareInformationPnf() {
121 final List<String> pnfPackageFileNameList = OnboardingUtils.getXnfNamesFileList(XnfTypeEnum.PNF);
122 if (CollectionUtils.isEmpty(pnfPackageFileNameList)) {
123 fail("Could not create softwareInformationPnf datasource");
125 final String pnfPackage = "sample-pnf-1.0.1-SNAPSHOT.csar";
126 final Optional<String> softwareInformationPnfPackage = pnfPackageFileNameList.stream()
127 .filter(pnfPackage::equals).findFirst();
128 if (!softwareInformationPnfPackage.isPresent()) {
129 fail(String.format("Could not create softwareInformationPnf datasource, the package '%s' was not found",
133 final String folderPath = FileHandling.getXnfRepositoryPath(XnfTypeEnum.PNF);
134 final Object[][] parametersArray = new Object[1][];
135 parametersArray[0] = new Object[]{folderPath, softwareInformationPnfPackage.get(),
136 Arrays.asList("5gDUv18.05.201", "5gDUv18.06.205")};
137 return parametersArray;
140 @DataProvider(name = "etsiVnfCnfOnboardPackages")
141 private static Object[][] etsiVnf() {
142 final List<String> vnfPackageFileNameList = OnboardingUtils.getXnfNamesFileList(XnfTypeEnum.ETSI);
143 if (CollectionUtils.isEmpty(vnfPackageFileNameList)) {
144 fail("Could not create etsiSingleVnfCnf datasource");
146 final String etsiVnfPackageName = "ETSI-VNF-SAMPLE.csar";
147 final String etsiCnfPackageName = "ETSI-CNF-SAMPLE.csar";
148 final List<String> etsiPackages = vnfPackageFileNameList.stream()
149 .filter(packageName -> packageName.equals(etsiVnfPackageName) || packageName.equals(etsiCnfPackageName))
150 .collect(Collectors.toList());
151 if (CollectionUtils.isEmpty(etsiPackages) || etsiPackages.size() < 2) {
152 fail(String.format("Could not create etsiSingleVnfCnf datasource, one of the package '%s' was not found",
156 final String folderPath = FileHandling.getXnfRepositoryPath(XnfTypeEnum.ETSI);
157 final Object[][] parametersArray = new Object[2][];
158 parametersArray[0] = new Object[]{folderPath, etsiPackages.get(0)};
159 parametersArray[1] = new Object[]{folderPath, etsiPackages.get(1)};
160 return parametersArray;
163 @DataProvider(name = "vfcList")
164 private static Object[][] vfcList() {
165 final List<String> vfcFileNameList = OnboardingUtils.getVfcFilenameList();
166 if (CollectionUtils.isEmpty(vfcFileNameList)) {
167 fail("Could not create vfcList datasource");
169 final String vfc1 = "1-VFC-NetworkFunction.yaml";
170 final String vfc2 = "2-VFC-NetworkService.yaml";
171 final List<String> vfcFiles = vfcFileNameList.stream()
172 .filter(filename -> filename.equals(vfc1) || filename.equals(vfc2))
173 .collect(Collectors.toList());
174 Collections.sort(vfcFiles);
175 if (CollectionUtils.isEmpty(vfcFiles) || vfcFiles.size() < 2) {
176 fail(String.format("Could not create vfcList datasource, one of the vfc file '%s' was not found", vfcFiles));
179 final String folderPath = FileHandling.getXnfRepositoryPath(XnfTypeEnum.VFC);
180 final Object[][] parametersArray = new Object[2][];
181 parametersArray[0] = new Object[]{folderPath, vfcFiles.get(0)};
182 parametersArray[1] = new Object[]{folderPath, vfcFiles.get(1)};
183 return parametersArray;
186 private static Object[][] provideData(final List<String> fileNamesFromFolder, final String folderPath) {
187 final Object[][] parametersArray = new Object[fileNamesFromFolder.size()][];
189 for (final Object obj : fileNamesFromFolder) {
190 parametersArray[index++] = new Object[]{folderPath, obj};
192 return parametersArray;
195 public static List<String> getRandomElements(final int randomElementNumber,
196 final List<String> fileNamesFromFolder) {
197 if (fileNamesFromFolder.isEmpty() || fileNamesFromFolder.size() < randomElementNumber) {
198 return Collections.emptyList();
200 final List<Integer> indexList = new ArrayList<>();
201 final List<String> newRandomFileNamesFromFolder = new ArrayList<>();
202 for (int i = 0; i < fileNamesFromFolder.size(); i++) {
205 Collections.shuffle(indexList);
206 final Integer[] randomArray = indexList.subList(0, randomElementNumber)
207 .toArray(new Integer[randomElementNumber]);
208 for (final Integer randomNumber : randomArray) {
209 newRandomFileNamesFromFolder.add(fileNamesFromFolder.get(randomNumber));
211 return newRandomFileNamesFromFolder;