1 # -*- coding: utf-8 -*-
4 # Copyright 2018 Telefonica S.A.
6 # Licensed under the Apache License, Version 2.0 (the "License"); you may
7 # not use this file except in compliance with the License. You may obtain
8 # a copy of the License at
10 # http://www.apache.org/licenses/LICENSE-2.0
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
15 # License for the specific language governing permissions and limitations
19 from collections
import OrderedDict
20 # from osm_common.dbbase import DbException
22 __author__
= "Alfonso Tierno"
25 class LcmException(Exception):
29 class LcmExceptionNoMgmtIP(LcmException
):
33 class LcmExceptionExit(LcmException
):
38 """utility for compare dot separate versions. Fills with zeros to proper number comparison
39 package version will be something like 4.0.1.post11+gb3f024d.dirty-1. Where 4.0.1 is the git tag, postXX is the
40 number of commits from this tag, and +XXXXXXX is the git commit short id. Total length is 16 with until 999 commits
43 for point
in v
.split("."):
44 filled
.append(point
.zfill(16))
50 Implements a registry of task needed for later cancelation, look for related tasks that must be completed before
51 etc. It stores a four level dict
52 First level is the topic, ns, vim_account, sdn
53 Second level is the _id
54 Third level is the operation id
55 Fourth level is a descriptive name, the value is the task class
59 self
.task_registry
= {
67 def register(self
, topic
, _id
, op_id
, task_name
, task
):
70 :param topic: Can be "ns", "nsi", "vim_account", "sdn"
71 :param _id: _id of the related item
72 :param op_id: id of the operation of the related item
73 :param task_name: Task descriptive name, as create, instantiate, terminate. Must be unique in this op_id
74 :param task: Task class
77 if _id
not in self
.task_registry
[topic
]:
78 self
.task_registry
[topic
][_id
] = OrderedDict()
79 if op_id
not in self
.task_registry
[topic
][_id
]:
80 self
.task_registry
[topic
][_id
][op_id
] = {task_name
: task
}
82 self
.task_registry
[topic
][_id
][op_id
][task_name
] = task
83 # print("registering task", topic, _id, op_id, task_name, task)
85 def remove(self
, topic
, _id
, op_id
, task_name
=None):
87 When task is ended, it should be removed. It ignores missing tasks. It also removes tasks done with this _id
88 :param topic: Can be "ns", "nsi", "vim_account", "sdn"
89 :param _id: _id of the related item
90 :param op_id: id of the operation of the related item
91 :param task_name: Task descriptive name. If none it deletes all tasks with same _id and op_id
94 if not self
.task_registry
[topic
].get(_id
):
97 self
.task_registry
[topic
][_id
].pop(op_id
, None)
98 elif self
.task_registry
[topic
][_id
].get(op_id
):
99 self
.task_registry
[topic
][_id
][op_id
].pop(task_name
, None)
102 for op_id_
in list(self
.task_registry
[topic
][_id
]):
103 for name
, task
in self
.task_registry
[topic
][_id
][op_id_
].items():
107 del self
.task_registry
[topic
][_id
][op_id_
]
108 if not self
.task_registry
[topic
][_id
]:
109 del self
.task_registry
[topic
][_id
]
111 def lookfor_related(self
, topic
, _id
, my_op_id
=None):
114 if _id
not in self
.task_registry
[topic
]:
115 return "", task_name_list
116 for op_id
in reversed(self
.task_registry
[topic
][_id
]):
118 if my_op_id
== op_id
:
119 my_op_id
= None # so that the next task is taken
122 for task_name
, task
in self
.task_registry
[topic
][_id
][op_id
].items():
124 task_list
.append(task
)
125 task_name_list
.append(task_name
)
127 return ", ".join(task_name_list
), task_list
129 def cancel(self
, topic
, _id
, target_op_id
=None, target_task_name
=None):
131 Cancel all active tasks of a concrete ns, nsi, vim_account, sdn identified for _id. If op_id is supplied only
132 this is cancelled, and the same with task_name
134 if not self
.task_registry
[topic
].get(_id
):
136 for op_id
in reversed(self
.task_registry
[topic
][_id
]):
137 if target_op_id
and target_op_id
!= op_id
:
139 for task_name
, task
in self
.task_registry
[topic
][_id
][op_id
].items():
140 if target_task_name
and target_task_name
!= task_name
:
145 # self.logger.debug("{} _id={} order_id={} task={} cancelled".format(topic, _id, op_id, task_name))
150 def __init__(self
, db
, msg
, fs
, logger
):
153 :param db: database connection
160 def update_db_2(self
, item
, _id
, _desc
):
162 Updates database with _desc information. If success _desc is cleared
165 :param _desc: dictionary with the content to update. Keys are dot separated keys for
166 :return: None. Exception is raised on error
170 self
.db
.set_one(item
, {"_id": _id
}, _desc
)
172 # except DbException as e:
173 # self.logger.error("Updating {} _id={} with '{}'. Error: {}".format(item, _id, _desc, e))