-
Notifications
You must be signed in to change notification settings - Fork 237
/
tasks.py
436 lines (374 loc) · 15.3 KB
/
tasks.py
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
from datetime import datetime
from datetime import timedelta
import time
from cumulusci.core.exceptions import CumulusCIException
from cumulusci.core.exceptions import PushApiObjectNotFound
from cumulusci.core.tasks import BaseTask
from cumulusci.tasks.push.push_api import SalesforcePushApi
from cumulusci.tasks.salesforce import BaseSalesforceApiTask
class BaseSalesforcePushTask(BaseSalesforceApiTask):
completed_statuses = ["Succeeded", "Failed", "Canceled"]
api_version = "38.0"
def _init_task(self):
super(BaseSalesforcePushTask, self)._init_task()
self.push = SalesforcePushApi(self.sf, self.logger)
def _parse_version(self, version):
# Parse the version number string
major = None
minor = None
patch = None
build = None
state = "Released"
version_parts = version.split(".")
if len(version_parts) >= 1:
major = version_parts[0]
if len(version_parts) == 2:
minor = version_parts[1]
if minor.find("Beta") != -1:
state = "Beta"
minor, build = minor.replace(" (Beta ", ",").replace(")", "").split(",")
if len(version_parts) > 2:
minor = version_parts[1]
patch = version_parts[2]
if patch.find("Beta") != -1:
state = "Beta"
patch, build = minor.replace(" (Beta ", ",").replace(")", "").split(",")
return {
"major": major,
"minor": minor,
"patch": patch,
"build": build,
"state": state,
}
def _get_version(self, package, version):
version_info = self._parse_version(version)
version_where = (
"ReleaseState = '{}'".format(version_info["state"])
+ " AND MajorVersion = {}".format(version_info["major"])
+ " AND MinorVersion = {}".format(version_info["minor"])
)
if version_info.get("patch"):
version_where += " AND PatchVersion = {}".format(version_info["patch"])
if version_info["state"] == "Beta" and version_info.get("build"):
version_where += " AND BuildNumber = {}".format(version_info["build"])
version = package.get_package_version_objs(version_where, limit=1)
if not version:
raise PushApiObjectNotFound(
"PackageVersion not found."
+ " Namespace = {}, Version Info = {}".format(
package.namespace, version_info
)
)
return version[0]
def _get_package(self, namespace):
package = self.push.get_package_objs(
"NamespacePrefix = '{}'".format(namespace), limit=1
)
if not package:
raise PushApiObjectNotFound(
"The package with namespace {} was not found".format(namespace)
)
return package[0]
def _load_orgs_file(self, path):
orgs = []
with open(path, "r") as f:
for line in f:
if line.isspace():
continue
orgs.append(line.split()[0])
return orgs
def _report_push_status(self, request_id):
default_where = {"PackagePushRequest": "Id = '{}'".format(request_id)}
# Create a new PushAPI instance with different settings than self.push
self.push_report = SalesforcePushApi(
self.sf,
self.logger,
lazy=["subscribers", "jobs"],
default_where=default_where,
)
# Get the push request
push_request = self.push_report.get_push_request_objs(
"Id = '{}'".format(request_id), limit=1
)
if not push_request:
raise PushApiObjectNotFound(
"Push Request {} was not found".format(push_request)
)
push_request = push_request[0]
# Check if the request is complete
interval = 10
if push_request.status not in self.completed_statuses:
self.logger.info(
"Push request is not yet complete."
+ " Polling for status every {} seconds until completion".format(
interval
)
)
# Loop waiting for request completion
i = 0
while push_request.status not in self.completed_statuses:
if i == 10:
self.logger.info("This is taking a while! Polling every 60 seconds")
interval = 60
time.sleep(interval)
# Clear the method level cache on get_push_requests and
# get_push_request_objs
self.push_report.get_push_requests.cache.clear()
self.push_report.get_push_request_objs.cache.clear()
# Get the push_request again
push_request = self.push_report.get_push_request_objs(
"Id = '{}'".format(request_id), limit=1
)[0]
self.logger.info(push_request.status)
i += 1
failed_jobs = []
success_jobs = []
canceled_jobs = []
jobs = push_request.get_push_job_objs()
for job in jobs:
if job.status == "Failed":
failed_jobs.append(job)
elif job.status == "Succeeded":
success_jobs.append(job)
elif job.status == "Canceled":
canceled_jobs.append(job)
self.logger.info(
"Push complete: {} succeeded, {} failed, {} canceled".format(
len(success_jobs), len(failed_jobs), len(canceled_jobs)
)
)
failed_by_error = {}
for job in failed_jobs:
errors = job.get_push_error_objs()
for error in errors:
error_key = (
error.error_type,
error.title,
error.message,
error.details,
)
if error_key not in failed_by_error:
failed_by_error[error_key] = []
failed_by_error[error_key].append(error)
if failed_jobs:
self.logger.info("-----------------------------------")
self.logger.info("Failures by error type")
self.logger.info("-----------------------------------")
for key, errors in failed_by_error.items():
self.logger.info(" ")
self.logger.info("{} failed with...".format(len(errors)))
self.logger.info(" Error Type = {}".format(key[0]))
self.logger.info(" Title = {}".format(key[1]))
self.logger.info(" Message = {}".format(key[2]))
self.logger.info(" Details = {}".format(key[3]))
class SchedulePushOrgList(BaseSalesforcePushTask):
task_options = {
"orgs": {
"description": "The path to a file containing one OrgID per line.",
"required": True,
},
"version": {
"description": "The managed package version to push",
"required": True,
},
"namespace": {
"description": (
"The managed package namespace to push."
+ " Defaults to project__package__namespace."
)
},
"start_time": {
"description": (
"Set the start time (UTC) to queue a future push."
+ " Ex: 2016-10-19T10:00"
)
},
"batch_size": {
"description": (
"Break pull requests into batches of this many orgs."
+ " Defaults to 200."
)
},
}
def _init_task(self):
super(SchedulePushOrgList, self)._init_task()
self.push = SalesforcePushApi(self.sf, self.logger, self.options["batch_size"])
def _init_options(self, kwargs):
super(SchedulePushOrgList, self)._init_options(kwargs)
# Set the namespace option to the value from cumulusci.yml if not
# already set
if "namespace" not in self.options:
self.options["namespace"] = self.project_config.project__package__namespace
if "batch_size" not in self.options:
self.options["batch_size"] = 200
def _get_orgs(self):
return self._load_orgs_file(self.options.get("orgs"))
def _run_task(self):
orgs = self._get_orgs()
package = self._get_package(self.options.get("namespace"))
version = self._get_version(package, self.options.get("version"))
start_time = self.options.get("start_time")
if start_time:
if start_time.lower() == "now":
start_time = datetime.utcnow() + timedelta(seconds=5)
else:
start_time = datetime.strptime(start_time, "%Y-%m-%dT%H:%M")
if start_time < datetime.utcnow():
raise CumulusCIException("Start time cannot be in the past")
else:
# delay a bit to allow for review
delay_minutes = 5
self.logger.warning(
"Scheduling push for %d minutes from now", delay_minutes
)
start_time = datetime.utcnow() + timedelta(minutes=delay_minutes)
self.request_id, num_scheduled_orgs = self.push.create_push_request(
version, orgs, start_time
)
self.return_values["request_id"] = self.request_id
if num_scheduled_orgs > 1000:
sleep_time_s = 30
self.logger.info(
"Delaying {} seconds to allow all jobs to initialize".format(
sleep_time_s
)
)
time.sleep(sleep_time_s)
elif num_scheduled_orgs == 0:
self.logger.warning("Canceling push request with 0 orgs")
self.push.cancel_push_request
return
self.logger.info("Setting status to Pending to queue execution.")
self.logger.info("The push upgrade will start at UTC {}".format(start_time))
# Run the job
self.logger.info(self.push.run_push_request(self.request_id))
self.logger.info(
"Push Request {} is queued for execution.".format(self.request_id)
)
# Report the status if start time is less than 1 minute from now
if start_time - datetime.utcnow() < timedelta(minutes=1):
self._report_push_status(self.request_id)
else:
self.logger.info("Exiting early since request is in the future")
class SchedulePushOrgQuery(SchedulePushOrgList):
task_options = {
"version": {
"description": "The managed package version to push",
"required": True,
},
"subscriber_where": {
"description": (
"A SOQL style WHERE clause for filtering PackageSubscriber"
+ " objects. Ex: OrgType = 'Sandbox'"
)
},
"min_version": {
"description": (
"If set, no subscriber with a version lower than min_version"
+ " will be selected for push"
)
},
"namespace": {
"description": (
"The managed package namespace to push."
+ " Defaults to project__package__namespace."
)
},
"start_time": {
"description": (
"Set the start time (UTC) to queue a future push."
+ " Ex: 2016-10-19T10:00"
)
},
}
def _get_orgs(self):
subscriber_where = self.options.get("subscriber_where")
default_where = {
"PackageSubscriber": ("OrgStatus = 'Active' AND InstalledStatus = 'i'")
}
if subscriber_where:
default_where["PackageSubscriber"] += " AND ({})".format(subscriber_where)
push_api = SalesforcePushApi(
self.sf, self.logger, default_where=default_where.copy()
)
package = self._get_package(self.options.get("namespace"))
version = self._get_version(package, self.options.get("version"))
min_version = self.options.get("min_version")
if min_version:
min_version = self._get_version(package, self.options.get("min_version"))
orgs = []
if min_version:
# If working with a range of versions, use an inclusive search
versions = version.get_older_released_version_objs(
greater_than_version=min_version
)
included_versions = []
for include_version in versions:
included_versions.append(str(include_version.sf_id))
if not included_versions:
raise ValueError(
"No versions found between version id {} and {}".format(
version.version_number, min_version.version_number
)
)
# Query orgs for each version in the range individually to avoid
# query timeout errors with querying multiple versions
for included_version in included_versions:
# Clear the get_subscribers method cache before each call
push_api.get_subscribers.cache.clear()
push_api.default_where[
"PackageSubscriber"
] = "{} AND MetadataPackageVersionId = '{}'".format(
default_where["PackageSubscriber"], included_version
)
for subscriber in push_api.get_subscribers():
orgs.append(subscriber["OrgKey"])
else:
# If working with a specific version rather than a range, use an
# exclusive search.
# Add exclusion of all orgs running on newer releases
newer_versions = version.get_newer_released_version_objs()
excluded_versions = [str(version.sf_id)]
for newer in newer_versions:
excluded_versions.append(str(newer.sf_id))
if len(excluded_versions) == 1:
push_api.default_where[
"PackageSubscriber"
] += " AND MetadataPackageVersionId != '{}'".format(
excluded_versions[0]
)
else:
push_api.default_where[
"PackageSubscriber"
] += " AND MetadataPackageVersionId NOT IN {}".format(
"('" + "','".join(excluded_versions) + "')"
)
for subscriber in push_api.get_subscribers():
orgs.append(subscriber["OrgKey"])
return orgs
class GetSubscriberList(BaseSalesforceApiTask):
""" Get subscribed org info and write to local CSV file """
task_options = {
"filename": {
"description": "File where org IDs will be written",
"required": True,
}
}
def _run_task(self):
raise NotImplementedError
class FilterSubscriberList(BaseTask):
"""
Filter subscriber org list by org type, version.
Write file with org IDs only
"""
task_options = {
"file_in": {"description": "CSV file with full org info", "required": True},
"file_out": {
"description": "File where org IDs will be written",
"required": True,
},
"org_type": {"description": "Filter by org type"},
"version": {"description": "Filter by installed package version"},
}
def _run_task(self):
raise NotImplementedError