Add UT for vfc-nfvo-lcm buildin wf
[vfc/nfvo/lcm.git] / lcm / workflows / build_in.py
1 # Copyright 2017 ZTE Corporation.
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 #         http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14 import json
15 import logging
16 import traceback
17 from threading import Thread
18 import time
19
20 from lcm.pub.utils.syscomm import fun_name
21 from lcm.pub.utils.values import ignore_case_get
22 from lcm.pub.utils import restcall
23 from lcm.pub.exceptions import NSLCMException
24
25 logger = logging.getLogger(__name__)
26
27 RESULT_OK, RESULT_NG = "0", "1"
28 JOB_ERROR = 255
29
30 g_jobs_status = {}
31
32 """
33 format of input_data
34 {
35     "jobId": uuid of job, 
36     "nsInstanceId": id of ns instance,
37     "object_context": json format of nsd,
38     "object_additionalParamForNs": json format of additional parameters for ns,
39     "object_additionalParamForVnf": json format of additional parameters for vnf,
40     "vlCount": int type of VL count,
41     "vnfCount: int type of VNF count,
42     "sfcCount": int type of SFC count, 
43     "sdnControllerId": uuid of SDN controller
44 }
45 """
46 def run_ns_instantiate(input_data):
47     logger.debug("Enter %s, input_data is %s", fun_name(), input_data)
48     ns_instantiate_ok = False
49     job_id = ignore_case_get(input_data, "jobId")
50     ns_inst_id = ignore_case_get(input_data, "nsInstanceId")
51     nsd_json = ignore_case_get(input_data, "object_context")
52     ns_param_json = ignore_case_get(input_data, "object_additionalParamForNs")
53     vnf_param_json = ignore_case_get(input_data, "object_additionalParamForVnf")
54     vl_count = ignore_case_get(input_data, "vlCount")
55     vnf_count = ignore_case_get(input_data, "vnfCount")
56     sfc_count = ignore_case_get(input_data, "sfcCount")
57     sdnc_id = ignore_case_get(input_data, "sdnControllerId")
58     g_jobs_status[job_id] = [1 for i in range(vnf_count)]
59     try:
60         update_job(job_id, 10, "0", "Start to create VL")
61         for i in range(vl_count):
62             create_vl(ns_inst_id, i + 1, nsd_json, ns_param_json)
63
64         update_job(job_id, 30, "0", "Start to create VNF")
65         jobs = [create_vnf(ns_inst_id, i + 1, vnf_param_json) for i in range(vnf_count)] 
66         wait_until_jobs_done(job_id, jobs)
67
68         [confirm_vnf_status(inst_id) for inst_id, _, _ in jobs]
69
70         update_job(job_id, 70, "0", "Start to create SFC")
71         jobs = [create_sfc(ns_inst_id, i + 1, nsd_json, sdnc_id) for i in range(sfc_count)] 
72         wait_until_jobs_done(job_id, jobs)
73
74         [confirm_sfc_status(inst_id) for inst_id, _, _ in jobs]
75
76         update_job(job_id, 90, "0", "Start to post deal")
77         post_deal(ns_inst_id, "true")
78
79         update_job(job_id, 100, "0", "Create NS successfully.")
80         ns_instantiate_ok = True
81     except NSLCMException as e:
82         logger.error("Failded to Create NS: %s", e.message)
83         update_job(job_id, JOB_ERROR, "255", "Failded to Create NS.")
84         post_deal(ns_inst_id, "false")
85     except:
86         logger.error(traceback.format_exc())
87         update_job(job_id, JOB_ERROR, "255", "Failded to Create NS.")
88         post_deal(ns_inst_id, "false")
89     finally:
90         g_jobs_status.pop(job_id)
91     return ns_instantiate_ok
92
93
94 def create_vl(ns_inst_id, vl_index, nsd, ns_param):
95     uri = "api/nslcm/v1/ns/vls"
96     data = json.JSONEncoder().encode({
97         "nsInstanceId": ns_inst_id,
98         "vlIndex": vl_index,
99         "context": nsd,
100         "additionalParamForNs": ns_param
101     })
102
103     ret = restcall.req_by_msb(uri, "POST", data)
104     if ret[0] != 0:
105         logger.error("Failed to call create_vl(%s): %s", vl_index, ret[1])
106         raise NSLCMException("Failed to call create_vl(index is %s)" % vl_index)
107     ret[1] = json.JSONDecoder().decode(ret[1])
108
109     result = str(ret[1]["result"])
110     detail = ret[1]["detail"]
111     vl_id = ret[1]["vlId"]
112     if result != RESULT_OK:
113         logger.error("Failed to create VL(%s): %s", vl_id, detail)
114         raise NSLCMException("Failed to create VL(%s)" % vl_id)
115
116     logger.debug("Create VL(%s) successfully.", vl_id)
117
118 def create_vnf(ns_inst_id, vnf_index, nf_param):
119     uri = "api/nslcm/v1/ns/vnfs"
120     data = json.JSONEncoder().encode({
121         "nsInstanceId": ns_inst_id,
122         "vnfIndex": vnf_index,
123         "additionalParamForVnf": nf_param
124     })
125
126     ret = restcall.req_by_msb(uri, "POST", data)
127     if ret[0] != 0:
128         logger.error("Failed to call create_vnf(%s): %s", vnf_index, ret[1])
129         raise NSLCMException("Failed to call create_vnf(index is %s)" % vnf_index)
130     ret[1] = json.JSONDecoder().decode(ret[1])
131
132     vnf_inst_id = ret[1]["vnfInstId"]
133     job_id = ret[1]["jobId"]
134     logger.debug("Create VNF(%s) started.", vnf_inst_id)
135     return vnf_inst_id, job_id, vnf_index - 1
136
137 def create_sfc(ns_inst_id, fp_index, nsd_json, sdnc_id):
138     uri = "api/nslcm/v1/ns/sfcs"
139     data = json.JSONEncoder().encode({
140         "nsInstanceId": ns_inst_id,
141         "context": nsd_json,
142         "fpindex": fp_index,
143         "sdnControllerId": sdnc_id
144     })
145
146     ret = restcall.req_by_msb(uri, "POST", data)
147     if ret[0] != 0:
148         logger.error("Failed to call create_sfc(%s): %s", fp_index, ret[1])
149         raise NSLCMException("Failed to call create_sfc(index is %s)" % fp_index)
150     ret[1] = json.JSONDecoder().decode(ret[1])
151
152     sfc_inst_id = ret[1]["sfcInstId"]
153     job_id = ret[1]["jobId"]
154     logger.debug("Create SFC(%s) started.", sfc_inst_id)
155     return sfc_inst_id, job_id, fp_index - 1
156
157 def post_deal(ns_inst_id, status):
158     uri = "api/nslcm/v1/ns/{nsInstanceId}/postdeal".format(nsInstanceId=ns_inst_id) 
159     data = json.JSONEncoder().encode({
160         "status": status
161     })
162
163     ret = restcall.req_by_msb(uri, "POST", data)
164     if ret[0] != 0:
165         logger.error("Failed to call post_deal(%s): %s", ns_inst_id, ret[1])
166     logger.debug("Call post_deal(%s, %s) successfully.", ns_inst_id, status)
167
168 def update_job(job_id, progress, errcode, desc):
169     uri = "api/nslcm/v1/jobs/{jobId}".format(jobId=job_id)
170     data = json.JSONEncoder().encode({
171         "progress": progress,
172         "errcode": errcode,
173         "desc": desc
174     })
175     restcall.req_by_msb(uri, "POST", data)  
176
177 class JobWaitThread(Thread):
178     """
179     Job Wait 
180     """
181
182     def __init__(self, inst_id, job_id, ns_job_id, index):
183         Thread.__init__(self)
184         self.inst_id = inst_id
185         self.job_id = job_id
186         self.ns_job_id = ns_job_id
187         self.index = index
188         self.retry_count = 60
189         self.interval_second = 3
190
191     def run(self):
192         count = 0
193         response_id, new_response_id = 0, 0
194         job_end_normal, job_timeout = False, True
195         while count < self.retry_count:
196             count = count + 1
197             time.sleep(self.interval_second)
198             uri = "/api/nslcm/v1/jobs/%s?responseId=%s" % (self.job_id, response_id)
199             ret = restcall.req_by_msb(uri, "GET")
200             if ret[0] != 0:
201                 logger.error("Failed to query job: %s:%s", ret[2], ret[1])
202                 continue
203             job_result = json.JSONDecoder().decode(ret[1])
204             if "responseDescriptor" not in job_result:
205                 logger.error("Job(%s) does not exist.", self.job_id)
206                 continue
207             progress = job_result["responseDescriptor"]["progress"]
208             new_response_id = job_result["responseDescriptor"]["responseId"]
209             job_desc = job_result["responseDescriptor"]["statusDescription"]
210             if new_response_id != response_id:
211                 logger.debug("%s:%s:%s", progress, new_response_id, job_desc)
212                 response_id = new_response_id
213                 count = 0
214             if progress == JOB_ERROR:
215                 job_timeout = False
216                 logger.error("Job(%s) failed: %s", self.job_id, job_desc)
217                 break
218             elif progress == 100:
219                 job_end_normal, job_timeout = True, False
220                 logger.info("Job(%s) ended normally", self.job_id)
221                 break
222         if job_timeout:
223             logger.error("Job(%s) timeout", self.job_id)
224         if self.ns_job_id in g_jobs_status:
225             if job_end_normal:
226                 g_jobs_status[self.ns_job_id][self.index] = 0
227
228 def wait_until_jobs_done(g_job_id, jobs):
229     job_threads = []
230     for inst_id, job_id, index in jobs:
231         job_threads.append(JobWaitThread(inst_id, job_id, g_job_id, index))
232     for t in job_threads:
233         t.start()
234     for t in job_threads:
235         t.join()
236     if g_job_id in g_jobs_status:
237         if sum(g_jobs_status[g_job_id]) > 0:
238             logger.error("g_jobs_status[%s]: %s", g_job_id, g_jobs_status[g_job_id])
239             raise NSLCMException("Some jobs failed!")
240
241 def confirm_vnf_status(vnf_inst_id):
242     uri = "api/nslcm/v1/ns/vnfs/{vnfInstId}".format(vnfInstId=vnf_inst_id)
243     ret = restcall.req_by_msb(uri, "GET")
244     if ret[0] != 0:
245         raise NSLCMException("Failed to call get_vnf(%s)" % vnf_inst_id)
246     ret[1] = json.JSONDecoder().decode(ret[1])
247
248     vnf_status = ret[1]["vnfStatus"]
249     if vnf_status != "active":
250         raise NSLCMException("Status of VNF(%s) is not active" % vnf_inst_id)
251
252 def confirm_sfc_status(sfc_inst_id):
253     uri = "api/nslcm/v1/ns/sfcs/{sfcInstId}".format(sfcInstId=sfc_inst_id)
254     ret = restcall.req_by_msb(uri, "GET")
255     if ret[0] != 0:
256         raise NSLCMException("Failed to call get_sfc(%s)" % sfc_inst_id)
257     ret[1] = json.JSONDecoder().decode(ret[1])
258
259     sfc_status = ret[1]["sfcStatus"]
260     if sfc_status != "active":
261         raise NSLCMException("Status of SFC(%s) is not active" % sfc_inst_id)
262
263
264
265
266
267       
268