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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
# ================================================================================
# Copyright (c) 2017-2018 AT&T Intellectual Property. All rights reserved.
# ================================================================================
# 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.
# ============LICENSE_END=========================================================
#
# ECOMP is a trademark and service mark of AT&T Intellectual Property.
"""policy-updater thread"""
import copy
import json
import logging
from Queue import Queue
from threading import Lock, Thread
from .config import Config
from .deploy_handler import DeployHandler
from .onap.audit import Audit
from .policy_consts import (AUTO_CATCH_UP, CATCH_UP, LATEST_POLICIES,
REMOVED_POLICIES)
from .policy_rest import PolicyRest
from .policy_utils import Utils
from .step_timer import StepTimer
class PolicyUpdater(Thread):
"""queue and handle the policy-updates in a separate thread"""
_logger = logging.getLogger("policy_handler.policy_updater")
def __init__(self):
"""init static config of PolicyUpdater."""
Thread.__init__(self, name="policy_updater")
self.daemon = True
self._catch_up_timer = None
self._aud_shutdown = None
self._aud_catch_up = None
catch_up_config = Config.config.get("catch_up", {})
self._catch_up_interval = catch_up_config.get("interval") or 15*60
self._catch_up_max_skips = catch_up_config.get("max_skips") or 3
self._catch_up_skips = 0
self._catch_up_prev_message = None
self._lock = Lock()
self._queue = Queue()
def enqueue(self, audit=None, policies_updated=None, policies_removed=None):
"""enqueue the policy-updates"""
policies_updated = policies_updated or []
policies_removed = policies_removed or []
PolicyUpdater._logger.info(
"enqueue request_id %s policies_updated %s policies_removed %s",
((audit and audit.request_id) or "none"),
json.dumps(policies_updated), json.dumps(policies_removed))
self._queue.put((audit, policies_updated, policies_removed))
def run(self):
"""wait and run the policy-update in thread"""
while True:
PolicyUpdater._logger.info("waiting for policy-updates...")
queued_audit, policies_updated, policies_removed = self._queue.get()
PolicyUpdater._logger.info(
"got request_id %s policies_updated %s policies_removed %s",
((queued_audit and queued_audit.request_id) or "none"),
json.dumps(policies_updated), json.dumps(policies_removed))
if not self._keep_running():
self._queue.task_done()
break
if self._on_catch_up():
self._reset_queue()
continue
elif not queued_audit:
self._queue.task_done()
continue
updated_policies, removed_policies = PolicyRest.get_latest_updated_policies(
(queued_audit, policies_updated, policies_removed))
message = {LATEST_POLICIES: updated_policies, REMOVED_POLICIES: removed_policies}
deployment_handler_changed = DeployHandler.policy_update(queued_audit, message)
self._queue.task_done()
queued_audit.audit_done()
if deployment_handler_changed:
self._catch_up_prev_message = None
self._pause_catch_up_timer()
self.catch_up()
elif not queued_audit.is_success():
self._catch_up_prev_message = None
PolicyUpdater._logger.info("exit policy-updater")
def _keep_running(self):
"""thread-safe check whether to continue running"""
with self._lock:
keep_running = not self._aud_shutdown
if self._aud_shutdown:
self._aud_shutdown.audit_done()
return keep_running
def catch_up(self, audit=None):
"""need to bring the latest policies to DCAE-Controller"""
with self._lock:
self._aud_catch_up = audit or Audit(req_message=AUTO_CATCH_UP)
PolicyUpdater._logger.info("catch_up %s request_id %s",
self._aud_catch_up.req_message, self._aud_catch_up.request_id)
self.enqueue()
def _run_catch_up_timer(self):
"""create and start the catch_up timer"""
if not self._catch_up_interval:
return
if self._catch_up_timer:
self._catch_up_timer.next()
self._logger.info("next step catch_up_timer in %s", self._catch_up_interval)
return
self._catch_up_timer = StepTimer(
"catch_up_timer",
self._catch_up_interval,
PolicyUpdater.catch_up,
PolicyUpdater._logger,
self
)
self._catch_up_timer.start()
self._logger.info("started catch_up_timer in %s", self._catch_up_interval)
def _pause_catch_up_timer(self):
"""pause catch_up_timer"""
if self._catch_up_timer:
self._logger.info("pause catch_up_timer")
self._catch_up_timer.pause()
def _stop_catch_up_timer(self):
"""stop and destroy the catch_up_timer"""
if self._catch_up_timer:
self._logger.info("stopping catch_up_timer")
self._catch_up_timer.stop()
self._catch_up_timer.join()
self._catch_up_timer = None
self._logger.info("stopped catch_up_timer")
def _need_to_send_catch_up(self, aud_catch_up, catch_up_message):
"""try not to send the duplicate messages on auto catchup unless hitting the max count"""
if aud_catch_up.req_message != AUTO_CATCH_UP \
or self._catch_up_skips >= self._catch_up_max_skips \
or not Utils.are_the_same(catch_up_message, self._catch_up_prev_message):
self._catch_up_skips = 0
self._catch_up_prev_message = copy.deepcopy(catch_up_message)
log_line = "going to send the catch_up {0}: {1}".format(
aud_catch_up.req_message,
json.dumps(self._catch_up_prev_message)
)
self._logger.info(log_line)
aud_catch_up.info(log_line)
return True
self._catch_up_skips += 1
self._catch_up_prev_message = copy.deepcopy(catch_up_message)
log_line = "skip {0}/{1} sending the same catch_up {2}: {3}".format(
self._catch_up_skips, self._catch_up_max_skips,
aud_catch_up.req_message, json.dumps(self._catch_up_prev_message)
)
self._logger.info(log_line)
aud_catch_up.info(log_line)
return False
def _reset_queue(self):
"""clear up the queue"""
with self._lock:
self._aud_catch_up = None
self._queue.task_done()
self._queue = Queue()
def _on_catch_up(self):
"""bring all the latest policies to DCAE-Controller"""
with self._lock:
aud_catch_up = self._aud_catch_up
if self._aud_catch_up:
self._aud_catch_up = None
if not aud_catch_up:
return False
log_line = "catch_up {0} request_id {1}".format(
aud_catch_up.req_message, aud_catch_up.request_id
)
PolicyUpdater._logger.info(log_line)
self._pause_catch_up_timer()
catch_up_message = PolicyRest.get_latest_policies(aud_catch_up)
catch_up_message[CATCH_UP] = True
catch_up_result = ""
if not aud_catch_up.is_success():
catch_up_result = "- not sending catch-up to deployment-handler due to errors"
PolicyUpdater._logger.warn(catch_up_result)
elif self._need_to_send_catch_up(aud_catch_up, catch_up_message):
DeployHandler.policy_update(aud_catch_up, catch_up_message)
if aud_catch_up.is_success():
catch_up_result = "- sent catch-up to deployment-handler"
else:
catch_up_result = "- failed to send catch-up to deployment-handler"
PolicyUpdater._logger.warn(catch_up_result)
else:
catch_up_result = "- skipped sending the same policies"
success, _, _ = aud_catch_up.audit_done(result=catch_up_result)
PolicyUpdater._logger.info(log_line + " " + catch_up_result)
PolicyUpdater._logger.info("policy_handler health: %s", json.dumps(Audit.health()))
if not success:
self._catch_up_prev_message = None
self._run_catch_up_timer()
return success
def shutdown(self, audit):
"""Shutdown the policy-updater"""
PolicyUpdater._logger.info("shutdown policy-updater")
with self._lock:
self._aud_shutdown = audit
self.enqueue()
self._stop_catch_up_timer()
if self.is_alive():
self.join()
|
