2 * Copyright 2017 Huawei Technologies Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 package org.onap.vnfsdk.marketplace.wrapper;
18 import java.io.BufferedInputStream;
20 import java.io.FileInputStream;
21 import java.io.IOException;
22 import java.io.InputStream;
23 import java.util.ArrayList;
24 import java.util.List;
25 import java.util.concurrent.Callable;
26 import java.util.concurrent.ExecutorService;
27 import java.util.concurrent.Executors;
29 import javax.ws.rs.core.HttpHeaders;
30 import javax.ws.rs.core.MediaType;
31 import javax.ws.rs.core.Response;
32 import javax.ws.rs.core.Response.Status;
34 import org.apache.commons.io.IOUtils;
35 import org.apache.commons.lang3.StringUtils;
36 import org.glassfish.jersey.media.multipart.FormDataContentDisposition;
37 import org.onap.vnfsdk.marketplace.common.CommonConstant;
38 import org.onap.vnfsdk.marketplace.common.FileUtil;
39 import org.onap.vnfsdk.marketplace.common.JsonUtil;
40 import org.onap.vnfsdk.marketplace.common.RestUtil;
41 import org.onap.vnfsdk.marketplace.common.ToolUtil;
42 import org.onap.vnfsdk.marketplace.db.entity.PackageData;
43 import org.onap.vnfsdk.marketplace.db.exception.MarketplaceResourceException;
44 import org.onap.vnfsdk.marketplace.db.resource.PackageManager;
45 import org.onap.vnfsdk.marketplace.db.util.MarketplaceDbUtil;
46 import org.onap.vnfsdk.marketplace.entity.request.PackageBasicInfo;
47 import org.onap.vnfsdk.marketplace.entity.response.PackageMeta;
48 import org.onap.vnfsdk.marketplace.entity.response.UploadPackageResponse;
49 import org.onap.vnfsdk.marketplace.filemanage.FileManagerFactory;
50 import org.onap.vnfsdk.marketplace.onboarding.entity.OnBoardingOperResult;
51 import org.onap.vnfsdk.marketplace.onboarding.entity.OnBoardingResult;
52 import org.onap.vnfsdk.marketplace.onboarding.entity.OnBoardingSteps;
53 import org.onap.vnfsdk.marketplace.onboarding.entity.OnBoradingRequest;
54 import org.onap.vnfsdk.marketplace.onboarding.hooks.functiontest.FunctionTestExceutor;
55 import org.onap.vnfsdk.marketplace.onboarding.hooks.functiontest.FunctionTestHook;
56 import org.onap.vnfsdk.marketplace.onboarding.hooks.validatelifecycle.ValidateLifecycleTestResponse;
57 import org.onap.vnfsdk.marketplace.onboarding.onboardmanager.OnBoardingHandler;
58 import org.slf4j.Logger;
59 import org.slf4j.LoggerFactory;
61 import net.sf.json.JSONObject;
63 public class PackageWrapper {
64 private static PackageWrapper packageWrapper;
65 private static final Logger LOG = LoggerFactory.getLogger(PackageWrapper.class);
68 * get PackageWrapper instance.
69 * @return package wrapper instance
71 public static PackageWrapper getInstance() {
72 if (packageWrapper == null) {
73 packageWrapper = new PackageWrapper();
75 return packageWrapper;
78 public Response updateValidateStatus(InputStream inputStream) throws IOException
80 String reqParam = IOUtils.toString(inputStream);
81 LOG.info("updateValidateStatus request param:"+reqParam);
82 if(StringUtils.isBlank(reqParam)) {
83 LOG.error("The updateValidateStatus request params can't be null");
84 return Response.status(Status.EXPECTATION_FAILED).build();
87 ValidateLifecycleTestResponse lyfValidateResp = JsonUtil.fromJson(reqParam, ValidateLifecycleTestResponse.class);
88 if(!checkOperationSucess(lyfValidateResp))
90 return Response.status(Status.EXPECTATION_FAILED).build();
93 String funcTestResponse = FunctionTestExceutor.executeFunctionTest(reqParam);
94 if(null == funcTestResponse)
96 return Response.status(Status.EXPECTATION_FAILED).build();
99 JSONObject funcTestRspObject = JSONObject.fromObject(funcTestResponse);
100 if(!funcTestRspObject.get("status").equals(CommonConstant.SUCCESS_STR))
102 return Response.status(Status.EXPECTATION_FAILED).build();
105 JSONObject result = new JSONObject();
106 result.put("msg","SUCCESS");
107 return Response.ok(ToolUtil.objectToString(result), MediaType.APPLICATION_JSON).build();
110 private boolean checkOperationSucess(ValidateLifecycleTestResponse lyfValidateResp)
112 boolean bOperStatus = false;
113 if(null == lyfValidateResp)
115 LOG.error("ValidateLifecycleTestResponse is NUll !!!");
118 if(lyfValidateResp.getLifecycle_status().equalsIgnoreCase(CommonConstant.SUCCESS_STR)
119 && lyfValidateResp.getValidate_status().equalsIgnoreCase(CommonConstant.SUCCESS_STR))
121 LOG.error("Lifecycle/Validation Response failed :" + lyfValidateResp.getLifecycle_status() + File.separator + lyfValidateResp.getValidate_status());
128 * query package list by condition.
129 * @param name package name
130 * @param provider package provider
131 * @param version package version
132 * @param deletionPending package deletionPending
133 * @param type package type
136 public Response queryPackageListByCond(String name, String provider, String version,
137 String deletionPending, String type) {
138 ArrayList<PackageData> dbresult = new ArrayList<>();
139 List<PackageMeta> result = new ArrayList<>();
140 LOG.info("query package info.name:" + name + " provider:" + provider + " version" + version
141 + " deletionPending" + deletionPending + " type:" + type);
144 PackageManager.getInstance().queryPackage(name, provider, version, deletionPending, type);
145 result = PackageWrapperUtil.packageDataList2PackageMetaList(dbresult);
146 return Response.ok(ToolUtil.objectToString(result)).build();
147 } catch (MarketplaceResourceException e1) {
148 LOG.error("query package by csarId from db error ! ", e1);
149 return RestUtil.getRestException(e1.getMessage());
154 * query package by id.
155 * @param csarId package id
158 public Response queryPackageById(String csarId) {
159 PackageData dbResult = PackageWrapperUtil.getPackageInfoById(csarId);
160 PackageMeta result = PackageWrapperUtil.packageData2PackageMeta(dbResult);
161 return Response.ok(ToolUtil.objectToString(result)).build();
166 * @param uploadedInputStream inputStream
167 * @param fileDetail package detail
168 * @param head http header
170 * @throws Exception e
172 public Response uploadPackage(InputStream uploadedInputStream,
173 FormDataContentDisposition fileDetail, String details, HttpHeaders head) throws IOException, MarketplaceResourceException
175 LOG.info("Upload/Reupload request Received !!!!");
177 String packageId = MarketplaceDbUtil.generateId();
178 return handlePackageUpload(packageId,uploadedInputStream, fileDetail, details, head);
182 * Interface for Uploading package
184 * @param uploadedInputStream
189 * @throws IOException
190 * @throws MarketplaceResourceException
192 private Response handlePackageUpload(String packageId,InputStream uploadedInputStream, FormDataContentDisposition fileDetail,
193 String details, HttpHeaders head) throws IOException, MarketplaceResourceException
195 boolean bResult = handleDataValidate(packageId,uploadedInputStream,fileDetail);
198 LOG.error("Validation of Input received for Package Upload failed !!!");
199 return Response.status(Status.EXPECTATION_FAILED).build();
202 String fileName = "temp_"+ packageId + ".csar";
203 if (null != fileDetail)
205 LOG.info("the fileDetail = " + ToolUtil.objectToString(fileDetail));
207 fileName = ToolUtil.processFileName(fileDetail.getFileName());
210 String localDirName = ToolUtil.getTempDir(CommonConstant.CATALOG_CSAR_DIR_NAME, fileName);
212 String contentRange = null;
215 contentRange = head.getHeaderString(CommonConstant.HTTP_HEADER_CONTENT_RANGE);
217 LOG.info("store package chunk file, fileName:" + fileName + ",contentRange:" + contentRange);
218 if (ToolUtil.isEmptyString(contentRange))
220 int fileSize = uploadedInputStream.available();
221 contentRange = "0-" + fileSize + "/" + fileSize;
224 String fileLocation = ToolUtil.storeChunkFileInLocal(localDirName, fileName, uploadedInputStream);
225 LOG.info("the fileLocation when upload package is :" + fileLocation);
227 uploadedInputStream.close();
229 PackageBasicInfo basicInfo = PackageWrapperUtil.getPacageBasicInfo(fileLocation);
230 UploadPackageResponse result = new UploadPackageResponse();
231 Boolean isEnd = PackageWrapperUtil.isUploadEnd(contentRange);
234 PackageMeta packageMeta = PackageWrapperUtil.getPackageMeta(packageId,fileName, fileLocation, basicInfo, details);
236 String path = basicInfo.getType().toString() + File.separator + basicInfo.getProvider() + File.separator + packageMeta.getCsarId() + File.separator + fileName.replace(".csar", "") + File.separator + basicInfo.getVersion();
238 String dowloadUri = File.separator + path + File.separator;
239 packageMeta.setDownloadUri(dowloadUri);
241 LOG.info("dest path is : " + path);
242 LOG.info("packageMeta = " + ToolUtil.objectToString(packageMeta));
244 PackageData packageData = PackageWrapperUtil.getPackageData(packageMeta);
246 String destPath = File.separator + path + File.separator + File.separator;
247 boolean uploadResult = FileManagerFactory.createFileManager().upload(localDirName, destPath);
250 OnBoradingRequest oOnboradingRequest = new OnBoradingRequest();
251 oOnboradingRequest.setCsarId(packageId);
252 oOnboradingRequest.setPackageName(fileName);
253 oOnboradingRequest.setPackagePath(localDirName);
255 packageData.setCsarId(packageId);
256 packageData.setDownloadCount(-1);
257 PackageData packateDbData = PackageManager.getInstance().addPackage(packageData);
259 LOG.info("Store package data to database succed ! packateDbData = " + ToolUtil.objectToString(packateDbData));
260 LOG.info("upload package file end, fileName:" + fileName);
262 result.setCsarId(packateDbData.getCsarId());
264 addOnBoardingRequest(oOnboradingRequest);
266 LOG.info("OnboradingRequest Data : " + ToolUtil.objectToString(oOnboradingRequest));
268 } catch (NullPointerException e) {
269 LOG.error("Package basicInfo is incorrect ! basicIonfo = " + ToolUtil.objectToString(basicInfo), e);
270 return Response.serverError().build();
273 return Response.ok(ToolUtil.objectToString(result), MediaType.APPLICATION_JSON).build();
277 * Execute OnBarding request
278 * @param oOnboradingRequest
280 private void addOnBoardingRequest(final OnBoradingRequest oOnboradingRequest)
282 ExecutorService es = Executors.newFixedThreadPool(CommonConstant.ONBOARDING_THREAD_COUNT);
283 Callable<Integer> callableInteger = () -> {
284 new OnBoardingHandler().handleOnBoardingReq(oOnboradingRequest);
285 return CommonConstant.SUCESS;
287 es.submit(callableInteger);
291 * delete package by package id.
292 * @param csarId package id
295 public Response delPackage(String csarId) {
296 LOG.info("delete package info.csarId:" + csarId);
297 if (ToolUtil.isEmptyString(csarId)) {
298 LOG.error("delete package fail, csarid is null");
299 return Response.serverError().build();
301 deletePackageDataById(csarId);
302 return Response.ok().build();
306 * Delete Package by CSAR ID
309 private void deletePackageDataById(String csarId) {
310 String packagePath = PackageWrapperUtil.getPackagePath(csarId);
311 if (packagePath == null) {
312 LOG.error("package path is null! ");
316 FileManagerFactory.createFileManager().delete(packagePath);
317 //Delete Results Data
318 FileManagerFactory.createFileManager().delete(File.separator + csarId);
321 //delete package data from database
323 PackageManager.getInstance().deletePackage(csarId);
324 } catch (MarketplaceResourceException e1) {
325 LOG.error("delete package by csarId from db error ! " + e1.getMessage(), e1);
330 * download package by package id.
331 * @param csarId package id
334 public Response downloadCsarPackagesById(String csarId) {
335 PackageData packageData = PackageWrapperUtil.getPackageInfoById(csarId);
337 String packageName = packageData.getName();
338 String path = org.onap.vnfsdk.marketplace.filemanage.http.ToolUtil.getHttpServerAbsolutePath() +File.separatorChar+packageData.getType()+File.separatorChar+
339 packageData.getProvider()+File.separatorChar+ packageData.getCsarId() +File.separator +packageName+File.separatorChar+packageData.getVersion()
340 +File.separator + packageName + ".csar";
342 LOG.info("downloadCsarPackagesById path is : " + path);
344 File csarFile = new File(path);
345 if (!csarFile.exists()) {
346 return Response.status(Status.INTERNAL_SERVER_ERROR).build();
349 LOG.info("downloadCsarPackagesById ABS path is : " + csarFile.getAbsolutePath());
353 InputStream fis = new BufferedInputStream(new FileInputStream(csarFile.getAbsolutePath()));
354 return Response.ok(fis)
355 .header("Content-Disposition", "attachment; filename=\"" + csarFile.getName() + "\"")
360 LOG.error("download vnf package fail.", e1);
361 return RestUtil.getRestException(e1.getMessage());
366 * get package file uri.
367 * @param csarId package id
368 * @param relativePath file relative path
371 public Response getCsarFileUri(String csarId) {
372 return downloadCsarPackagesById(csarId);
376 * Interface to Update Download count for CSAR ID
380 public Response updateDwonloadCount(String csarId) {
381 return handleDownladCountUpdate(csarId) ?
382 Response.ok().build() :
383 Response.status(Status.EXPECTATION_FAILED).build();
387 * Handle downlowa count update
391 private boolean handleDownladCountUpdate(String csarId) {
392 boolean bupdateSucess = false;
395 PackageManager.getInstance().updateDwonloadCount(csarId);
396 bupdateSucess = true;
398 catch (Exception exp)
400 LOG.error("Updating Donwload count failed for Package with ID !!! : " + exp.getMessage(), exp);
402 return bupdateSucess;
406 * Interface to Re upload Package
408 * @param uploadedInputStream
415 public Response reUploadPackage(String csarId,
416 InputStream uploadedInputStream,
417 FormDataContentDisposition fileDetail,
419 HttpHeaders head) throws IOException, MarketplaceResourceException
421 LOG.info("Reupload request Received !!!!");
423 //STEP 1: Validate Input Data
424 //----------------------------
425 boolean bResult = handleDataValidate(csarId,uploadedInputStream,fileDetail);
428 LOG.error("Validation of Input received for Package Upload failed during Reload!!!");
429 return Response.status(Status.EXPECTATION_FAILED).build();
432 //STEP 2: Delete All Package Data based on package id
433 //----------------------------------------------------
434 deletePackageDataById(csarId);
436 //STEP 3: upload package with same package id
437 //-------------------------------------------
438 return handlePackageUpload(csarId,uploadedInputStream, fileDetail, details, head);
442 * Interface to get OnBoarding Result by Operation Type
448 public Response getOnBoardingResult(String csarId, String operTypeId, String operId)
450 LOG.info("getOnBoardingResult request : csarId:" + csarId + " operTypeId:" + operTypeId + " operId:" + operId);
452 PackageData packageData = PackageWrapperUtil.getPackageInfoById(csarId);
453 if (null == packageData) {
454 return Response.status(Response.Status.PRECONDITION_FAILED).build();
457 handleDelayExec(operId);
459 OnBoardingResult oOnBoardingResult = FunctionTestHook.getOnBoardingResult(packageData);
460 if (null == oOnBoardingResult) {
461 return Response.status(Response.Status.PRECONDITION_FAILED).build();
463 filterOnBoardingResultByOperId(oOnBoardingResult, operId);
465 String strResult = ToolUtil.objectToString(oOnBoardingResult);
466 LOG.info("getOnBoardingResult response : " + strResult);
467 return Response.ok(strResult, "application/json").build();
468 } catch (NullPointerException e) {
469 LOG.error("Null param in getOnBoardingResult", e);
470 return Response.status(Response.Status.BAD_REQUEST).build();
475 private void filterOnBoardingResultByOperId(OnBoardingResult oOnBoardingResult, String operId)
477 if (0 == operId.compareToIgnoreCase("all")) {
480 if (0 == operId.compareToIgnoreCase("download"))
482 List<OnBoardingOperResult> operResultListTemp = new ArrayList<>();
483 OnBoardingOperResult operResultListTmp = new OnBoardingOperResult();
484 operResultListTmp.setOperId("download");
485 operResultListTmp.setStatus(0);
486 operResultListTemp.add(operResultListTmp);
487 oOnBoardingResult.setOperResult(operResultListTemp);
490 List<OnBoardingOperResult> operResultListOut = new ArrayList<>();
491 List<OnBoardingOperResult> operResultList = oOnBoardingResult.getOperResult();
492 for (OnBoardingOperResult operResult : operResultList) {
493 if (0 == operResult.getOperId().compareToIgnoreCase(operId)) {
494 operResultListOut.add(operResult);
497 oOnBoardingResult.setOperResult(operResultListOut);
501 * Interface to get OnBoarding Status by Operation ID
506 public Response getOperResultByOperTypeId(String csarId, String operTypeId)
508 LOG.error("getOnBoardingResult request : csarId:"+ csarId + " operTypeId:"+operTypeId);
509 if(null == csarId || null == operTypeId || csarId.isEmpty() || operTypeId.isEmpty())
511 return Response.status(Status.BAD_REQUEST).build();
514 PackageData packageData = PackageWrapperUtil.getPackageInfoById(csarId);
515 if(null == packageData)
517 LOG.error("Failed to find package for PackageID:"+ csarId);
518 return Response.status(Status.PRECONDITION_FAILED).build();
521 //Get result key to fetch Function Test Results
522 //---------------------------------------------
523 String strResult = FunctionTestHook.getFuncTestResults(packageData);
524 if(null == strResult)
526 LOG.error("NULL reponse for getOperResultByOperTypeId response :"+ strResult);
527 return Response.status(Status.INTERNAL_SERVER_ERROR).build();
529 LOG.info("getOperResultByOperTypeId response :"+ strResult);
530 return Response.ok(strResult, MediaType.APPLICATION_JSON).build();
533 private boolean handleDataValidate(String packageId,InputStream uploadedInputStream, FormDataContentDisposition fileDetail)
535 boolean bvalidateOk = false;
536 if ((null != uploadedInputStream) && (fileDetail != null) && !ToolUtil.isEmptyString(packageId))
544 * Interface to get OnBoarding Steps
547 public Response getOnBoardingSteps()
549 LOG.info("Get OnBoarding Steps request Received !!!");
551 String filePath = org.onap.vnfsdk.marketplace.filemanage.http.ToolUtil.getAppDeployPath() + File.separator +"generalconfig/OnBoardingSteps.json";
552 LOG.info("Onboarding Steps Json file Path :" + filePath);
554 OnBoardingSteps oOnBoardingSteps = (OnBoardingSteps)FileUtil.readJsonDatafFromFile(filePath, OnBoardingSteps.class);
555 if (null == oOnBoardingSteps) {
556 return Response.status(Response.Status.INTERNAL_SERVER_ERROR).build();
558 String strResult = ToolUtil.objectToString(oOnBoardingSteps);
559 LOG.info("getOnBoardingSteps response :" + strResult);
560 return Response.ok(strResult, MediaType.APPLICATION_JSON).build();
563 private void handleDelayExec(String operId)
565 if (0 == operId.compareToIgnoreCase(CommonConstant.functionTest.FUNCTEST_EXEC))
571 catch (InterruptedException e)
573 LOG.info("handleDelayExex response : ", e);
574 Thread.currentThread().interrupt();