aboutsummaryrefslogtreecommitdiffstats
path: root/vnfmarket-be/vnf-sdk-marketplace/src/main/java/org/onap/vnfsdk/marketplace/onboarding/hooks/validatelifecycle/LifecycleTestHook.java
blob: 7fe8d12dc5e401790e14c5eb8dc75e25ff305f1a (plain)
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
/**
 * Copyright 2017 Huawei Technologies Co., Ltd.
 *
 * 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.
 */
package org.onap.vnfsdk.marketplace.onboarding.hooks.validatelifecycle;

import java.io.File;
import java.util.ArrayList;
import java.util.List;

import org.onap.vnfsdk.marketplace.common.CommonConstant;
import org.onap.vnfsdk.marketplace.common.FileUtil;
import org.onap.vnfsdk.marketplace.common.ToolUtil;
import org.onap.vnfsdk.marketplace.entity.EnumOperationStatus;
import org.onap.vnfsdk.marketplace.entity.EnumResult;
import org.onap.vnfsdk.marketplace.onboarding.entity.OnBoardingOperResult;
import org.onap.vnfsdk.marketplace.onboarding.entity.OnBoardingResult;
import org.onap.vnfsdk.marketplace.onboarding.entity.OnBoradingRequest;
import org.onap.vnfsdk.marketplace.onboarding.entity.ResultKey;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/* It executes the life cycle (create, delete) test for the VNF on the specified VM and collects the result 
 * and return result to the caller and then uploads package to the catalogue 
 *  
 * OnBoardingHandler --> LifecycleTestHook---> LifecycleTestExecutor */

public class LifecycleTestHook {
	private static final Logger logger = LoggerFactory.getLogger(LifecycleTestHook.class);

	/**
	 * Start Executing Life cycle test
	 * 
	 * @param onBoradingReq
	 * @return
	 */
	public int exec(OnBoradingRequest onBoradingReq) {
		logger.info("OnboardingRequest Lifecycle Request received for Package:{} Path:{}" , onBoradingReq.getCsarId()
				, onBoradingReq.getPackagePath());

		// STEP 1: Validate Input and Build result
	    // ---------------------------------------------------------
		buildResultPath(onBoradingReq);

		OnBoardingResult olifecycleTestResult = new OnBoardingResult();
		buildlifecycleTestResponse(onBoradingReq, olifecycleTestResult);
		updateResult(olifecycleTestResult);

		if (null == onBoradingReq.getCsarIdCatalouge() || onBoradingReq.getCsarIdCatalouge().isEmpty()) {
			olifecycleTestResult.setOperFinished(true);
			olifecycleTestResult.setOperStatus(EnumResult.FAIL.getIndex());
			buildFuncTestResponse(olifecycleTestResult, CommonConstant.LifeCycleTest.LIFECYCLE_TEST_EXEC,
					EnumOperationStatus.FAILED.getIndex());
			updateResult(olifecycleTestResult);
			return EnumResult.FAIL.getIndex();
		}

		LifeCycleTestReq oLifeCycleTestReq = new LifeCycleTestReq();
		populateLifeCycleReq(onBoradingReq, oLifeCycleTestReq);

		// STEP 2: Execute Life Cycle Test and Get Result Back !!!!
		// ---------------------------------------------------------
		String lifecycleTestResultKey = LifecycleTestExceutor.execlifecycleTest(onBoradingReq, oLifeCycleTestReq);
		if (null == lifecycleTestResultKey) {
			olifecycleTestResult.setOperFinished(true);
			olifecycleTestResult.setOperStatus(EnumResult.FAIL.getIndex());
			buildFuncTestResponse(olifecycleTestResult, CommonConstant.LifeCycleTest.LIFECYCLE_TEST_EXEC,
					EnumOperationStatus.FAILED.getIndex());
			updateResult(olifecycleTestResult);
			return EnumResult.FAIL.getIndex();
		}

		olifecycleTestResult.setOperFinished(true);
		olifecycleTestResult.setOperStatus(EnumResult.SUCCESS.getIndex());
		buildFuncTestResponse(olifecycleTestResult, CommonConstant.LifeCycleTest.LIFECYCLE_TEST_EXEC,
				EnumOperationStatus.SUCCESS.getIndex());
		updateResult(olifecycleTestResult);

		// STEP 3: Store Lifecycle test key to get Life cycle Test Results
		// -------------------------------------------------
		storelifecycleResultKey(onBoradingReq, lifecycleTestResultKey);

		return (olifecycleTestResult.getOperStatus() == EnumResult.SUCCESS.getIndex()) ? EnumResult.SUCCESS.getIndex()
				: EnumResult.FAIL.getIndex();
	}

	private void populateLifeCycleReq(OnBoradingRequest onBoradingReq, LifeCycleTestReq oLifeCycleTestReq) {
		
		// Input error handling is done by lifecycle module, not need validate here
		oLifeCycleTestReq.setCsarId(onBoradingReq.getCsarId());
		oLifeCycleTestReq.setLabVimId(oLifeCycleTestReq.getLabVimId());

		// Currently this is not populated, only lavVimId is sufficient
		List<String> vimIds = new ArrayList<>();
		oLifeCycleTestReq.setVimIds(vimIds);
	}

	/**
	 * Build result path where result is stored as a file
	 * @param onBoradingReq
	 */
	private void buildResultPath(OnBoradingRequest onBoradingReq) {
		String filePath = getResultStorePath() + File.separator + onBoradingReq.getCsarId();
		if (!FileUtil.checkFileExists(filePath)) {
			FileUtil.createDirectory(filePath);
		}
	}

	/**
	 * Store Function test Execution Results
	 * 
	 * @param oFuncTestResult
	 */
	private void updateResult(OnBoardingResult oFuncTestResult) {
		// STore Results to DB(Currently we will make JSON and Store JSON to
		// Package Path)
		// -------------------------------------------------------------------------------
		String jsonoFuncTestResult = ToolUtil.objectToString(oFuncTestResult);
		logger.info("Lifecycle test Status for Package Id:{} Result:{}" , oFuncTestResult.getCsarId()
				, jsonoFuncTestResult);
		String filePath = getResultStorePath() + File.separator + oFuncTestResult.getCsarId() + File.separator
				+ "lifecycleTest.json";
		FileUtil.writeJsonDatatoFile(filePath, oFuncTestResult);
	}

	/**
	 * Build Function Test Response
	 * 
	 * @param onBoradingReq
	 * @param oFuncTestResult
	 */
	private void buildlifecycleTestResponse(OnBoradingRequest onBoradingReq, OnBoardingResult oTestResult) {
		oTestResult.setOperFinished(false);
		oTestResult.setCsarId(onBoradingReq.getCsarId());
		oTestResult.setOperTypeId(CommonConstant.LifeCycleTest.LIFECYCLE_TEST_OPERTYPE_ID);

		OnBoardingOperResult lifecycleTestExec = new OnBoardingOperResult();
		lifecycleTestExec.setOperId(CommonConstant.LifeCycleTest.LIFECYCLE_TEST_EXEC);
		lifecycleTestExec.setStatus(EnumOperationStatus.NOTSTARTED.getIndex());

		List<OnBoardingOperResult> operResult = new ArrayList<>();
		operResult.add(lifecycleTestExec);
		oTestResult.setOperResult(operResult);
	}


	/**
	 * Store Lifecycle Test Result key
	 * 
	 * @param onBoradingReq
	 * @param resultKey
	 */
	private void storelifecycleResultKey(OnBoradingRequest onBoradingReq, String resultKey) {
		// Currently we will make JSON and Store JSON to Package Path)
		// -------------------------------------------------------------------------------
		String filePath = getResultStorePath() + File.separator + onBoradingReq.getCsarId() + File.separator
				+ "lifecycleTestResultKey.json";

		logger.debug("Function test Results Key for Package Id:{} Key:{} Path{}" , onBoradingReq.getCsarId(), resultKey
				, filePath);

		ResultKey oResultKey = new ResultKey();
		oResultKey.setCsarId(onBoradingReq.getCsarId());
		oResultKey.setOperTypeId(CommonConstant.LifeCycleTest.LIFECYCLE_TEST_OPERTYPE_ID);
		oResultKey.setKey(resultKey);

		FileUtil.writeJsonDatatoFile(filePath, oResultKey);
	}

	private static String getResultStorePath() {
		// Using full path due to compilation issue
		return org.onap.vnfsdk.marketplace.filemanage.http.ToolUtil.getHttpServerAbsolutePath();
	}

	private void buildFuncTestResponse(OnBoardingResult oFuncTestResult, String opreKey, int operStatusVal) {
		List<OnBoardingOperResult> operStatusList = oFuncTestResult.getOperResult();
		for (OnBoardingOperResult operObj : operStatusList) {
			if (operObj.getOperId().equalsIgnoreCase(opreKey)) {
				operObj.setStatus(operStatusVal);
				break;
			}
		}
	}
}