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.
17 package org.onap.vnfsdk.marketplace.wrapper;
19 import java.io.BufferedInputStream;
21 import java.io.FileInputStream;
22 import java.io.IOException;
23 import java.io.InputStream;
24 import java.util.ArrayList;
25 import java.util.List;
26 import java.util.concurrent.Callable;
27 import java.util.concurrent.ExecutorService;
28 import java.util.concurrent.Executors;
30 import javax.ws.rs.core.HttpHeaders;
31 import javax.ws.rs.core.MediaType;
32 import javax.ws.rs.core.Response;
33 import javax.ws.rs.core.Response.Status;
35 import org.apache.commons.io.IOUtils;
36 import org.apache.commons.lang3.StringUtils;
37 import org.eclipse.jetty.http.HttpStatus;
38 import org.glassfish.jersey.media.multipart.FormDataContentDisposition;
39 import org.onap.validation.csar.CsarValidator;
40 import org.onap.vnfsdk.marketplace.common.CommonConstant;
41 import org.onap.vnfsdk.marketplace.common.CommonErrorResponse;
42 import org.onap.vnfsdk.marketplace.common.FileUtil;
43 import org.onap.vnfsdk.marketplace.common.RestUtil;
44 import org.onap.vnfsdk.marketplace.common.ToolUtil;
45 import org.onap.vnfsdk.marketplace.db.entity.PackageData;
46 import org.onap.vnfsdk.marketplace.db.exception.ErrorCodeException;
47 import org.onap.vnfsdk.marketplace.db.exception.MarketplaceResourceException;
48 import org.onap.vnfsdk.marketplace.db.resource.PackageManager;
49 import org.onap.vnfsdk.marketplace.db.util.MarketplaceDbUtil;
50 import org.onap.vnfsdk.marketplace.entity.request.PackageBasicInfo;
51 import org.onap.vnfsdk.marketplace.entity.response.PackageMeta;
52 import org.onap.vnfsdk.marketplace.entity.response.UploadPackageResponse;
53 import org.onap.vnfsdk.marketplace.filemanage.FileManagerFactory;
54 import org.onap.vnfsdk.marketplace.onboarding.entity.OnBoardingOperResult;
55 import org.onap.vnfsdk.marketplace.onboarding.entity.OnBoardingResult;
56 import org.onap.vnfsdk.marketplace.onboarding.entity.OnBoardingSteps;
57 import org.onap.vnfsdk.marketplace.onboarding.entity.OnBoradingRequest;
58 import org.onap.vnfsdk.marketplace.onboarding.hooks.functiontest.FunctionTestExceutor;
59 import org.onap.vnfsdk.marketplace.onboarding.hooks.functiontest.FunctionTestHook;
60 import org.onap.vnfsdk.marketplace.onboarding.hooks.validatelifecycle.ValidateLifecycleTestResponse;
61 import org.onap.vnfsdk.marketplace.onboarding.onboardmanager.OnBoardingHandler;
62 import org.slf4j.Logger;
63 import org.slf4j.LoggerFactory;
65 public class PackageWrapper {
67 private static PackageWrapper packageWrapper;
69 private static final Logger LOG = LoggerFactory.getLogger(PackageWrapper.class);
72 * get PackageWrapper instance.
74 * @return package wrapper instance
76 public static PackageWrapper getInstance() {
77 if(packageWrapper == null) {
78 packageWrapper = new PackageWrapper();
80 return packageWrapper;
83 public Response updateValidateStatus(InputStream inputStream) throws IOException {
84 String reqParam = IOUtils.toString(inputStream);
85 LOG.info("updateValidateStatus request param:" + reqParam);
86 if(StringUtils.isBlank(reqParam)) {
87 LOG.error("The updateValidateStatus request params can't be null");
88 return Response.status(Status.EXPECTATION_FAILED).build();
91 ValidateLifecycleTestResponse lyfValidateResp = null; // TBD - Use Gson - jackson has
93 // JsonUtil.fromJson(reqParam, ValidateLifecycleTestResponse.class);
94 if(!checkOperationSucess(lyfValidateResp)) {
95 return Response.status(Status.EXPECTATION_FAILED).build();
98 String funcTestResponse = FunctionTestExceutor.executeFunctionTest(reqParam);
99 if(null == funcTestResponse) {
100 return Response.status(Status.EXPECTATION_FAILED).build();
103 if(!funcTestResponse.contains(CommonConstant.SUCCESS_STR)) {
104 return Response.status(Status.EXPECTATION_FAILED).build();
107 return Response.ok().build();
110 private boolean checkOperationSucess(ValidateLifecycleTestResponse lyfValidateResp) {
111 boolean bOperStatus = false;
112 if(null == lyfValidateResp) {
113 LOG.error("ValidateLifecycleTestResponse is NUll !!!");
116 if(lyfValidateResp.getLifecycle_status().equalsIgnoreCase(CommonConstant.SUCCESS_STR)
117 && lyfValidateResp.getValidate_status().equalsIgnoreCase(CommonConstant.SUCCESS_STR)) {
118 LOG.error("Lifecycle/Validation Response failed :" + lyfValidateResp.getLifecycle_status() + File.separator
119 + lyfValidateResp.getValidate_status());
126 * query package list by condition.
128 * @param name package name
129 * @param provider package provider
130 * @param version package version
131 * @param deletionPending package deletionPending
132 * @param type package type
135 public Response queryPackageListByCond(String name, String provider, String version, String deletionPending,
137 List<PackageData> dbresult = new ArrayList<>();
138 List<PackageMeta> result = new ArrayList<>();
139 LOG.info("query package info.name:" + name + " provider:" + provider + " version" + version + " deletionPending"
140 + deletionPending + " type:" + type);
142 dbresult = PackageManager.getInstance().queryPackage(name, provider, version, deletionPending, type);
143 result = PackageWrapperUtil.packageDataList2PackageMetaList(dbresult);
144 return Response.ok(ToolUtil.objectToString(result)).build();
145 } catch(MarketplaceResourceException e1) {
146 LOG.error("query package by csarId from db error ! ", e1);
147 return RestUtil.getRestException(e1.getMessage());
152 * query package by id.
154 * @param csarId package id
157 public Response queryPackageById(String csarId) {
158 PackageData dbResult = PackageWrapperUtil.getPackageInfoById(csarId);
159 PackageMeta result = PackageWrapperUtil.packageData2PackageMeta(dbResult);
160 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, FormDataContentDisposition fileDetail,
173 String details, HttpHeaders head) {
174 LOG.info("Upload/Reupload request Received !!!!");
176 String packageId = MarketplaceDbUtil.generateId();
177 return handlePackageUpload(packageId, uploadedInputStream, fileDetail, details, head);
178 } catch(IOException e) {
179 LOG.error("can't get package id", e);
181 return Response.status(Status.INTERNAL_SERVER_ERROR).build();
184 private UploadPackageResponse manageUpload(String packageId, String fileName, String fileLocation, String details,
185 String contentRange) throws IOException, ErrorCodeException {
186 String localDirName = ToolUtil.getTempDir(CommonConstant.CATALOG_CSAR_DIR_NAME, fileName);
187 PackageBasicInfo basicInfo = PackageWrapperUtil.getPacageBasicInfo(fileLocation);
188 UploadPackageResponse result = new UploadPackageResponse();
189 Boolean isEnd = PackageWrapperUtil.isUploadEnd(contentRange);
191 PackageMeta packageMeta =
192 PackageWrapperUtil.getPackageMeta(packageId, fileName, fileLocation, basicInfo, details);
194 String path = basicInfo.getType().toString() + File.separator + basicInfo.getProvider() + File.separator
195 + packageMeta.getCsarId() + File.separator + fileName.replace(".csar", "") + File.separator
196 + basicInfo.getVersion();
198 String dowloadUri = File.separator + path + File.separator;
199 packageMeta.setDownloadUri(dowloadUri);
201 LOG.info("dest path is : " + path);
202 LOG.info("packageMeta = " + ToolUtil.objectToString(packageMeta));
204 PackageData packageData = PackageWrapperUtil.getPackageData(packageMeta);
206 List<PackageData> lstPkgData =
207 PackageManager.getInstance().queryPackage(packageMeta.getName(), "", "", "", "");
208 if(!lstPkgData.isEmpty()) {
209 LOG.error("Package name is not unique");
210 throw new ErrorCodeException(HttpStatus.INTERNAL_SERVER_ERROR_500, "Package name already exists");
213 String destPath = File.separator + path + File.separator + File.separator;
214 boolean uploadResult = FileManagerFactory.createFileManager().upload(localDirName, destPath);
216 OnBoradingRequest oOnboradingRequest = new OnBoradingRequest();
217 oOnboradingRequest.setCsarId(packageId);
218 oOnboradingRequest.setPackageName(fileName);
219 oOnboradingRequest.setPackagePath(localDirName);
221 packageData.setCsarId(packageId);
222 packageData.setDownloadCount(-1);
223 PackageData packateDbData = PackageManager.getInstance().addPackage(packageData);
225 LOG.info("Store package data to database succed ! packateDbData = "
226 + ToolUtil.objectToString(packateDbData));
227 LOG.info("upload package file end, fileName:" + fileName);
229 result.setCsarId(packateDbData.getCsarId());
231 addOnBoardingRequest(oOnboradingRequest);
233 LOG.info("OnboradingRequest Data : " + ToolUtil.objectToString(oOnboradingRequest));
235 } catch(NullPointerException e) {
236 LOG.error("Package basicInfo is incorrect ! basicIonfo = " + ToolUtil.objectToString(basicInfo), e);
244 * Interface for Uploading package
247 * @param uploadedInputStream
252 * @throws IOException
253 * @throws MarketplaceResourceException
255 private Response handlePackageUpload(String packageId, InputStream uploadedInputStream,
256 FormDataContentDisposition fileDetail, String details, HttpHeaders head) throws IOException {
257 boolean bResult = handleDataValidate(packageId, uploadedInputStream, fileDetail);
259 LOG.error("Validation of Input received for Package Upload failed !!!");
260 return Response.status(Status.EXPECTATION_FAILED)
261 .entity(new CommonErrorResponse("Input package is empty or exception happened during validation"))
265 String fileName = "temp_" + packageId + ".csar";
266 if(null != fileDetail) {
267 LOG.info("the fileDetail = " + ToolUtil.objectToString(fileDetail));
269 fileName = ToolUtil.processFileName(fileDetail.getFileName());
272 String localDirName = ToolUtil.getTempDir(CommonConstant.CATALOG_CSAR_DIR_NAME, fileName);
274 String contentRange = null;
276 contentRange = head.getHeaderString(CommonConstant.HTTP_HEADER_CONTENT_RANGE);
278 LOG.info("store package chunk file, fileName:" + fileName + ",contentRange:" + contentRange);
279 if(ToolUtil.isEmptyString(contentRange)) {
280 int fileSize = uploadedInputStream.available();
281 contentRange = "0-" + fileSize + "/" + fileSize;
284 String fileLocation = ToolUtil.storeChunkFileInLocal(localDirName, fileName, uploadedInputStream);
285 LOG.info("the fileLocation when upload package is :" + fileLocation);
287 uploadedInputStream.close();
290 CsarValidator cv = new CsarValidator(packageId, fileLocation);
292 String validationResp = cv.validateCsar();
293 if("SUCCESS" != validationResp) {
294 LOG.error("Could not validate failed");
295 return Response.status(Status.EXPECTATION_FAILED).entity(new CommonErrorResponse(validationResp))
298 } catch(Exception e) {
299 LOG.error("CSAR validation panicked", e);
300 return Response.status(Status.EXPECTATION_FAILED).entity(
301 new CommonErrorResponse("Exception occurred while validating csar package:" + e.getMessage()))
305 UploadPackageResponse result = null;
307 result = manageUpload(packageId, fileName, fileLocation, details, contentRange);
308 } catch(ErrorCodeException e) {
309 return Response.status(Status.EXPECTATION_FAILED)
310 .entity(new CommonErrorResponse("Package Name already exists")).build();
313 return Response.ok(ToolUtil.objectToString(result), MediaType.APPLICATION_JSON).build();
315 return Response.serverError().build();
320 * Execute OnBarding request
322 * @param oOnboradingRequest
324 private void addOnBoardingRequest(final OnBoradingRequest oOnboradingRequest) {
325 ExecutorService es = Executors.newFixedThreadPool(CommonConstant.ONBOARDING_THREAD_COUNT);
326 Callable<Integer> callableInteger = () -> {
327 new OnBoardingHandler().handleOnBoardingReq(oOnboradingRequest);
328 return CommonConstant.SUCESS;
330 es.submit(callableInteger);
334 * delete package by package id.
336 * @param csarId package id
339 public Response delPackage(String csarId) {
340 LOG.info("delete package info.csarId:" + csarId);
341 if(ToolUtil.isEmptyString(csarId)) {
342 LOG.error("delete package fail, csarid is null");
343 return Response.serverError().build();
345 deletePackageDataById(csarId);
346 return Response.ok().build();
350 * Delete Package by CSAR ID
354 private void deletePackageDataById(String csarId) {
355 String packagePath = PackageWrapperUtil.getPackagePath(csarId);
356 if(packagePath == null) {
357 LOG.error("package path is null! ");
361 FileManagerFactory.createFileManager().delete(packagePath);
362 // Delete Results Data
363 FileManagerFactory.createFileManager().delete(File.separator + csarId);
365 // delete package data from database
367 PackageManager.getInstance().deletePackage(csarId);
368 } catch(MarketplaceResourceException e1) {
369 LOG.error("delete package by csarId from db error ! " + e1.getMessage(), e1);
374 * download package by package id.
376 * @param csarId package id
379 public Response downloadCsarPackagesById(String csarId) {
380 PackageData packageData = PackageWrapperUtil.getPackageInfoById(csarId);
382 String packageName = packageData.getName();
383 String path = org.onap.vnfsdk.marketplace.filemanage.http.ToolUtil.getHttpServerAbsolutePath()
384 + File.separatorChar + packageData.getType() + File.separatorChar + packageData.getProvider()
385 + File.separatorChar + packageData.getCsarId() + File.separator + packageName + File.separatorChar
386 + packageData.getVersion() + File.separator + packageName + ".csar";
388 LOG.info("downloadCsarPackagesById path is : " + path);
390 File csarFile = new File(path);
391 if(!csarFile.exists()) {
392 return Response.status(Status.INTERNAL_SERVER_ERROR).build();
395 LOG.info("downloadCsarPackagesById ABS path is : " + csarFile.getAbsolutePath());
398 InputStream fis = new BufferedInputStream(new FileInputStream(csarFile.getAbsolutePath()));
399 return Response.ok(fis).header("Content-Disposition", "attachment; filename=\"" + csarFile.getName() + "\"")
401 } catch(Exception e1) {
402 LOG.error("download vnf package fail.", e1);
403 return RestUtil.getRestException(e1.getMessage());
408 * get package file uri.
410 * @param csarId package id
411 * @param relativePath file relative path
414 public Response getCsarFileUri(String csarId) {
415 return downloadCsarPackagesById(csarId);
419 * Interface to Update Download count for CSAR ID
424 public Response updateDwonloadCount(String csarId) {
425 return handleDownladCountUpdate(csarId) ? Response.ok().build()
426 : Response.status(Status.EXPECTATION_FAILED).build();
430 * Handle downlowa count update
435 private boolean handleDownladCountUpdate(String csarId) {
436 boolean bupdateSucess = false;
438 PackageManager.getInstance().updateDownloadCount(csarId);
439 bupdateSucess = true;
440 } catch(Exception exp) {
441 LOG.error("Updating Donwload count failed for Package with ID !!! : " + exp.getMessage(), exp);
443 return bupdateSucess;
447 * Interface to Re upload Package
450 * @param uploadedInputStream
457 public Response reUploadPackage(String csarId, InputStream uploadedInputStream,
458 FormDataContentDisposition fileDetail, String details, HttpHeaders head)
459 throws MarketplaceResourceException {
460 LOG.info("Reupload request Received !!!!");
462 // STEP 1: Validate Input Data
463 // ----------------------------
464 boolean bResult = handleDataValidate(csarId, uploadedInputStream, fileDetail);
466 LOG.error("Validation of Input received for Package Upload failed during Reload!!!");
467 return Response.status(Status.EXPECTATION_FAILED).build();
471 // STEP 2: Delete All Package Data based on package id
472 // ----------------------------------------------------
473 deletePackageDataById(csarId);
475 // STEP 3: upload package with same package id
476 // -------------------------------------------
477 return handlePackageUpload(csarId, uploadedInputStream, fileDetail, details, head);
478 } catch(IOException e) {
479 LOG.error("delete package failed", e);
481 return Response.status(Status.INTERNAL_SERVER_ERROR).build();
485 * Interface to get OnBoarding Result by Operation Type
492 public Response getOnBoardingResult(String csarId, String operTypeId, String operId) {
493 LOG.info("getOnBoardingResult request : csarId:" + csarId + " operTypeId:" + operTypeId + " operId:" + operId);
495 PackageData packageData = PackageWrapperUtil.getPackageInfoById(csarId);
496 if(null == packageData) {
497 return Response.status(Response.Status.PRECONDITION_FAILED).build();
500 handleDelayExec(operId);
502 OnBoardingResult oOnBoardingResult = FunctionTestHook.getOnBoardingResult(packageData);
503 if(null == oOnBoardingResult) {
504 return Response.status(Response.Status.PRECONDITION_FAILED).build();
506 filterOnBoardingResultByOperId(oOnBoardingResult, operId);
508 String strResult = ToolUtil.objectToString(oOnBoardingResult);
509 LOG.info("getOnBoardingResult response : " + strResult);
510 return Response.ok(strResult, "application/json").build();
511 } catch(NullPointerException e) {
512 LOG.error("Null param in getOnBoardingResult", e);
513 return Response.status(Response.Status.BAD_REQUEST).build();
517 private void filterOnBoardingResultByOperId(OnBoardingResult oOnBoardingResult, String operId) {
518 if(0 == operId.compareToIgnoreCase("all")) {
521 if(0 == operId.compareToIgnoreCase("download")) {
522 List<OnBoardingOperResult> operResultListTemp = new ArrayList<>();
523 OnBoardingOperResult operResultListTmp = new OnBoardingOperResult();
524 operResultListTmp.setOperId("download");
525 operResultListTmp.setStatus(0);
526 operResultListTemp.add(operResultListTmp);
527 oOnBoardingResult.setOperResult(operResultListTemp);
530 List<OnBoardingOperResult> operResultListOut = new ArrayList<>();
531 List<OnBoardingOperResult> operResultList = oOnBoardingResult.getOperResult();
532 for(OnBoardingOperResult operResult : operResultList) {
533 if(0 == operResult.getOperId().compareToIgnoreCase(operId)) {
534 operResultListOut.add(operResult);
537 oOnBoardingResult.setOperResult(operResultListOut);
541 * Interface to get OnBoarding Status by Operation ID
547 public Response getOperResultByOperTypeId(String csarId, String operTypeId) {
548 LOG.error("getOnBoardingResult request : csarId:" + csarId + " operTypeId:" + operTypeId);
549 if(null == csarId || null == operTypeId || csarId.isEmpty() || operTypeId.isEmpty()) {
550 return Response.status(Status.BAD_REQUEST).build();
553 PackageData packageData = PackageWrapperUtil.getPackageInfoById(csarId);
554 if(null == packageData) {
555 LOG.error("Failed to find package for PackageID:" + csarId);
556 return Response.status(Status.PRECONDITION_FAILED).build();
559 // Get result key to fetch Function Test Results
560 // ---------------------------------------------
561 String strResult = FunctionTestHook.getFuncTestResults(packageData);
562 if(null == strResult) {
563 LOG.error("NULL reponse for getOperResultByOperTypeId response :" + strResult);
564 return Response.status(Status.INTERNAL_SERVER_ERROR).build();
566 LOG.info("getOperResultByOperTypeId response :" + strResult);
567 return Response.ok(strResult, MediaType.APPLICATION_JSON).build();
570 private boolean handleDataValidate(String packageId, InputStream uploadedInputStream,
571 FormDataContentDisposition fileDetail) {
572 boolean bvalidateOk = false;
573 if((null != uploadedInputStream) && (fileDetail != null) && !ToolUtil.isEmptyString(packageId)) {
580 * Interface to get OnBoarding Steps
584 public Response getOnBoardingSteps() {
585 LOG.info("Get OnBoarding Steps request Received !!!");
587 String filePath = org.onap.vnfsdk.marketplace.filemanage.http.ToolUtil.getAppDeployPath() + File.separator
588 + "generalconfig/OnBoardingSteps.json";
589 LOG.info("Onboarding Steps Json file Path :" + filePath);
591 OnBoardingSteps oOnBoardingSteps =
592 (OnBoardingSteps)FileUtil.readJsonDatafFromFile(filePath, OnBoardingSteps.class);
593 if(null == oOnBoardingSteps) {
594 return Response.status(Response.Status.INTERNAL_SERVER_ERROR).build();
596 String strResult = ToolUtil.objectToString(oOnBoardingSteps);
597 LOG.info("getOnBoardingSteps response :" + strResult);
598 return Response.ok(strResult, MediaType.APPLICATION_JSON).build();
601 private void handleDelayExec(String operId) {
602 if(0 == operId.compareToIgnoreCase(CommonConstant.functionTest.FUNCTEST_EXEC)) {
605 } catch(InterruptedException e) {
606 LOG.info("handleDelayExex response : ", e);
607 Thread.currentThread().interrupt();