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
|
# Copyright 2012 Hewlett-Packard Development Company, L.P.
# Copyright 2013 OpenStack Foundation
# Copyright 2016 Red Hat, Inc.
#
# 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.
import logging
import threading
import time
from collections import defaultdict
from uuid import uuid4
from apscheduler.schedulers.background import BackgroundScheduler
from apscheduler.triggers.cron import CronTrigger
from opentelemetry import trace
from zuul.driver import Driver, TriggerInterface
from zuul.driver.timer import timertrigger
from zuul.driver.timer import timermodel
from zuul.driver.timer.timermodel import TimerTriggerEvent
from zuul.lib.logutil import get_annotated_logger
from zuul.zk.election import SessionAwareElection
class TimerDriver(Driver, TriggerInterface):
name = 'timer'
election_root = "/zuul/scheduler/timer-election"
log = logging.getLogger("zuul.TimerDriver")
tracer = trace.get_tracer("zuul")
def __init__(self):
self.apsched = BackgroundScheduler()
self.apsched.start()
self.tenant_jobs = {}
self.election = None
self.election_thread = None
self.election_won = False
# Mapping of locks: canonical project name -> lock
# The lock are used to avoid concurrent update errors when a
# lot of periodic pipelines are triggering simultanously.
self.project_update_locks = defaultdict(threading.Lock)
self.stop_event = threading.Event()
self.stopped = False
def registerScheduler(self, scheduler):
self.sched = scheduler
self.election = SessionAwareElection(
self.sched.zk_client.client, self.election_root)
self.election_thread = threading.Thread(name="TimerElection",
target=self._runElection,
daemon=True)
self.election_thread.start()
def _runElection(self):
while not self.stopped:
try:
self.log.info("Running timer election")
self.election.run(self._electionInner)
except Exception:
self.log.exception("Error in timer election:")
def _electionInner(self):
try:
self.election_won = True
self.log.info("Won timer election")
self.stop_event.wait()
finally:
self.election_won = False
self.stop_event.clear()
def reconfigure(self, tenant):
self._removeJobs(tenant)
if self.stopped:
return
if not self.apsched:
# Handle possible reuse of the driver without connection objects.
self.apsched = BackgroundScheduler()
self.apsched.start()
self._addJobs(tenant)
def _removeJobs(self, tenant):
jobs = self.tenant_jobs.get(tenant.name, [])
for job in jobs:
job.remove()
def _addJobs(self, tenant):
jobs = []
self.tenant_jobs[tenant.name] = jobs
for pipeline in tenant.layout.pipelines.values():
for ef in pipeline.manager.event_filters:
if not isinstance(ef.trigger, timertrigger.TimerTrigger):
continue
for timespec in ef.timespecs:
parts = timespec.split()
if len(parts) < 5 or len(parts) > 7:
self.log.error(
"Unable to parse time value '%s' "
"defined in pipeline %s" % (
timespec,
pipeline.name))
continue
minute, hour, dom, month, dow = parts[:5]
# default values
second = None
jitter = None
if len(parts) > 5:
second = parts[5]
if len(parts) > 6:
jitter = parts[6]
try:
jitter = int(jitter) if jitter is not None else None
trigger = CronTrigger(day=dom, day_of_week=dow,
hour=hour, minute=minute,
second=second, jitter=jitter)
except ValueError:
self.log.exception(
"Unable to create CronTrigger "
"for value '%s' defined in "
"pipeline %s",
timespec,
pipeline.name)
continue
self._addJobsInner(tenant, pipeline, trigger, timespec,
jobs)
def _addJobsInner(self, tenant, pipeline, trigger, timespec, jobs):
# jobs is a list that we mutate
for project_name, pcs in tenant.layout.project_configs.items():
# timer operates on branch heads and doesn't need
# speculative layouts to decide if it should be
# enqueued or not. So it can be decided on cached
# data if it needs to run or not.
pcst = tenant.layout.getAllProjectConfigs(project_name)
if not [True for pc in pcst if pipeline.name in pc.pipelines]:
continue
(trusted, project) = tenant.getProject(project_name)
try:
for branch in project.source.getProjectBranches(
project, tenant):
# The 'misfire_grace_time' argument is set to None to
# disable checking if the job missed its run time window.
# This ensures we don't miss a trigger when the job is
# delayed due to e.g. high scheduler load. Those short
# delays are not a problem for our trigger use-case.
job = self.apsched.add_job(
self._onTrigger, trigger=trigger,
args=(tenant, pipeline.name, project_name,
branch, timespec,),
misfire_grace_time=None)
jobs.append(job)
except Exception:
self.log.exception("Unable to create APScheduler job for "
"%s %s %s",
tenant, pipeline, project)
def _onTrigger(self, tenant, pipeline_name, project_name, branch,
timespec):
if not self.election_won:
return
if not self.election.is_still_valid():
self.stop_event.set()
return
try:
attributes = {
"timespec": timespec,
}
with self.tracer.start_as_current_span(
"TimerEvent", attributes=attributes):
self._dispatchEvent(tenant, pipeline_name, project_name,
branch, timespec)
except Exception:
self.stop_event.set()
self.log.exception("Error when dispatching timer event")
def _dispatchEvent(self, tenant, pipeline_name, project_name,
branch, timespec):
self.log.debug('Got trigger for tenant %s and pipeline %s '
'project %s branch %s with timespec %s',
tenant.name, pipeline_name, project_name,
branch, timespec)
try:
(trusted, project) = tenant.getProject(project_name)
event = TimerTriggerEvent()
event.type = 'timer'
event.timespec = timespec
event.forced_pipeline = pipeline_name
event.project_hostname = project.canonical_hostname
event.project_name = project.name
event.ref = 'refs/heads/%s' % branch
event.branch = branch
event.zuul_event_id = str(uuid4().hex)
event.timestamp = time.time()
# Refresh the branch in order to update the item in the
# change cache.
change_key = project.source.getChangeKey(event)
with self.project_update_locks[project.canonical_name]:
project.source.getChange(change_key, refresh=True,
event=event)
log = get_annotated_logger(self.log, event)
log.debug("Adding event")
self.sched.addTriggerEvent(self.name, event)
except Exception:
self.log.exception("Error dispatching timer event for "
"tenant %s project %s branch %s",
tenant, project_name, branch)
def stop(self):
self.stopped = True
self.stop_event.set()
if self.apsched:
self.apsched.shutdown()
self.apsched = None
if self.election:
self.election.cancel()
if self.election_thread:
self.election_thread.join()
def getTrigger(self, connection_name, config=None):
return timertrigger.TimerTrigger(self, config)
def getTriggerSchema(self):
return timertrigger.getSchema()
def getTriggerEventClass(self):
return timermodel.TimerTriggerEvent
|
