-
Notifications
You must be signed in to change notification settings - Fork 237
/
UpdateDependencies.py
369 lines (334 loc) · 15.4 KB
/
UpdateDependencies.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
import functools
from distutils.version import LooseVersion
from cumulusci.core.utils import process_bool_arg
from cumulusci.core.config import ScratchOrgConfig
from cumulusci.core.exceptions import TaskOptionsError
from cumulusci.salesforce_api.metadata import ApiDeploy
from cumulusci.salesforce_api.metadata import ApiRetrieveInstalledPackages
from cumulusci.salesforce_api.package_zip import InstallPackageZipBuilder
from cumulusci.salesforce_api.package_zip import UninstallPackageZipBuilder
from cumulusci.salesforce_api.package_zip import ZipfilePackageZipBuilder
from cumulusci.tasks.salesforce import BaseSalesforceMetadataApiTask
from cumulusci.utils import download_extract_zip
from cumulusci.utils import download_extract_github
from cumulusci.utils import inject_namespace
from cumulusci.utils import strip_namespace
from cumulusci.utils import process_text_in_zipfile
from cumulusci.utils import tokenize_namespace
class UpdateDependencies(BaseSalesforceMetadataApiTask):
api_class = ApiDeploy
name = "UpdateDependencies"
task_options = {
"dependencies": {
"description": "List of dependencies to update. Defaults to project__dependencies. "
"Each dependency is a dict with either 'github' set to a github repository URL "
"or 'namespace' set to a Salesforce package namespace. "
"Github dependencies may include 'tag' to install a particular git ref. "
"Package dependencies may include 'version' to install a particular version."
},
"namespaced_org": {
"description": "If True, the changes namespace token injection on any dependencies so tokens %%%NAMESPACED_ORG%%% and ___NAMESPACED_ORG___ will get replaced with the namespace. The default is false causing those tokens to get stripped and replaced with an empty string. Set this if deploying to a namespaced scratch org or packaging org."
},
"purge_on_delete": {
"description": "Sets the purgeOnDelete option for the deployment. Defaults to True"
},
"include_beta": {
"description": "Install the most recent release, even if beta. Defaults to False."
},
"allow_newer": {
"description": "If the org already has a newer release, use it. Defaults to True."
},
"allow_uninstalls": {
"description": "Allow uninstalling a beta release or newer final release "
"in order to install the requested version. Defaults to False. "
"Warning: Enabling this may destroy data."
},
}
def _init_options(self, kwargs):
super(UpdateDependencies, self)._init_options(kwargs)
self.options["purge_on_delete"] = process_bool_arg(
self.options.get("purge_on_delete", True)
)
self.options["namespaced_org"] = process_bool_arg(
self.options.get("namespaced_org", False)
)
self.options["include_beta"] = process_bool_arg(
self.options.get("include_beta", False)
)
self.options["dependencies"] = (
self.options.get("dependencies")
or self.project_config.project__dependencies
)
self.options["allow_newer"] = process_bool_arg(
self.options.get("allow_newer", True)
)
self.options["allow_uninstalls"] = process_bool_arg(
self.options.get("allow_uninstalls", False)
)
def _run_task(self):
if not self.options["dependencies"]:
self.logger.info("Project has no dependencies, doing nothing")
return
if self.options["include_beta"] and not isinstance(
self.org_config, ScratchOrgConfig
):
raise TaskOptionsError(
"Target org must be a scratch org when `include_beta` is true."
)
self.logger.info("Preparing static dependencies map")
dependencies = self.project_config.get_static_dependencies(
self.options["dependencies"], include_beta=self.options["include_beta"]
)
self.installed = None
self.uninstall_queue = []
self.install_queue = []
self.logger.info("Dependencies:")
for line in self.project_config.pretty_dependencies(dependencies):
self.logger.info(line)
self._process_dependencies(dependencies)
# Reverse the uninstall queue
self.uninstall_queue.reverse()
self._uninstall_dependencies()
self._install_dependencies()
def _process_dependencies(self, dependencies):
for dependency in dependencies:
# Process child dependencies
dependency_uninstalled = False
subdependencies = dependency.get("dependencies")
if subdependencies:
count_uninstall = len(self.uninstall_queue)
self._process_dependencies(subdependencies)
if count_uninstall != len(self.uninstall_queue):
dependency_uninstalled = True
# Process namespace dependencies (managed packages)
if "namespace" in dependency:
self._process_namespace_dependency(dependency, dependency_uninstalled)
else:
# zip_url or repo dependency
self.install_queue.append(dependency)
if self.uninstall_queue and not self.options["allow_uninstalls"]:
raise TaskOptionsError(
"Updating dependencies would require uninstalling these packages "
"but uninstalls are not enabled: {}".format(
", ".join(dep["namespace"] for dep in self.uninstall_queue)
)
)
def _process_namespace_dependency(self, dependency, dependency_uninstalled=None):
dependency_version = str(dependency["version"])
if self.installed is None:
self.installed = self._get_installed()
if dependency["namespace"] in self.installed:
# Some version is installed, check what to do
installed_version = self.installed[dependency["namespace"]]
required_version = LooseVersion(dependency_version)
installed_version = LooseVersion(installed_version)
if installed_version > required_version and self.options["allow_newer"]:
# Avoid downgrading if allow_newer = True
required_version = installed_version
if required_version == installed_version and not dependency_uninstalled:
self.logger.info(
" {}: version {} already installed".format(
dependency["namespace"], dependency_version
)
)
return
if "Beta" in installed_version.vstring:
# Always uninstall Beta versions if required is different
self.uninstall_queue.append(dependency)
self.logger.info(
" {}: Uninstall {} to upgrade to {}".format(
dependency["namespace"],
installed_version,
dependency["version"],
)
)
elif dependency_uninstalled:
# If a dependency of this one needs to be uninstalled, always uninstall the package
self.uninstall_queue.append(dependency)
self.logger.info(
" {}: Uninstall and Reinstall to allow downgrade of dependency".format(
dependency["namespace"]
)
)
elif required_version < installed_version:
# Uninstall to downgrade
self.uninstall_queue.append(dependency)
self.logger.info(
" {}: Downgrade from {} to {} (requires uninstall/install)".format(
dependency["namespace"],
installed_version,
dependency["version"],
)
)
else:
self.logger.info(
" {}: Upgrade from {} to {}".format(
dependency["namespace"],
installed_version,
dependency["version"],
)
)
self.install_queue.append(dependency)
else:
# Just a regular install
self.logger.info(
" {}: Install version {}".format(
dependency["namespace"], dependency["version"]
)
)
self.install_queue.append(dependency)
def _get_installed(self):
self.logger.info("Retrieving list of packages from target org")
api = ApiRetrieveInstalledPackages(self)
return api()
def _uninstall_dependencies(self):
for dependency in self.uninstall_queue:
self._uninstall_dependency(dependency)
def _install_dependencies(self):
for dependency in self.install_queue:
self._install_dependency(dependency)
# hooks for tests
_download_extract_github = staticmethod(download_extract_github)
_download_extract_zip = staticmethod(download_extract_zip)
def _install_dependency(self, dependency):
if "zip_url" or "repo_name" in dependency:
package_zip = None
if "zip_url" in dependency:
self.logger.info(
"Deploying unmanaged metadata from /{} of {}".format(
dependency["subfolder"], dependency["zip_url"]
)
)
package_zip = self._download_extract_zip(
dependency["zip_url"], subfolder=dependency.get("subfolder")
)
elif "repo_name" in dependency:
self.logger.info(
"Deploying unmanaged metadata from /{} of {}/{}".format(
dependency["subfolder"],
dependency["repo_owner"],
dependency["repo_name"],
)
)
gh_for_repo = self.project_config.get_github_api(
dependency["repo_owner"], dependency["repo_name"]
)
package_zip = self._download_extract_github(
gh_for_repo,
dependency["repo_owner"],
dependency["repo_name"],
dependency["subfolder"],
ref=dependency.get("ref"),
)
if package_zip:
if dependency.get("namespace_tokenize"):
self.logger.info(
"Replacing namespace prefix {}__ in files and filenames with namespace token strings".format(
"{}__".format(dependency["namespace_tokenize"])
)
)
package_zip = process_text_in_zipfile(
package_zip,
functools.partial(
tokenize_namespace,
namespace=dependency["namespace_tokenize"],
logger=self.logger,
),
)
if dependency.get("namespace_inject"):
self.logger.info(
"Replacing namespace tokens with {}".format(
"{}__".format(dependency["namespace_inject"])
)
)
package_zip = process_text_in_zipfile(
package_zip,
functools.partial(
inject_namespace,
namespace=dependency["namespace_inject"],
managed=not dependency.get("unmanaged"),
namespaced_org=self.options["namespaced_org"],
logger=self.logger,
),
)
if dependency.get("namespace_strip"):
self.logger.info(
"Removing namespace prefix {}__ from all files and filenames".format(
"{}__".format(dependency["namespace_strip"])
)
)
package_zip = process_text_in_zipfile(
package_zip,
functools.partial(
strip_namespace,
namespace=dependency["namespace_strip"],
logger=self.logger,
),
)
package_zip = ZipfilePackageZipBuilder(package_zip)()
elif "namespace" in dependency:
self.logger.info(
"Installing {} version {}".format(
dependency["namespace"], dependency["version"]
)
)
package_zip = InstallPackageZipBuilder(
dependency["namespace"], dependency["version"]
)()
api = self.api_class(
self, package_zip, purge_on_delete=self.options["purge_on_delete"]
)
return api()
def _uninstall_dependency(self, dependency):
self.logger.info("Uninstalling {}".format(dependency["namespace"]))
package_zip = UninstallPackageZipBuilder(
dependency["namespace"], self.project_config.project__package__api_version
)
api = self.api_class(
self, package_zip(), purge_on_delete=self.options["purge_on_delete"]
)
return api()
def freeze(self, step):
ui_options = self.task_config.config.get("ui_options", {})
dependencies = self.project_config.get_static_dependencies(
self.options["dependencies"], include_beta=self.options["include_beta"]
)
steps = []
for i, dependency in enumerate(self._flatten(dependencies), start=1):
name = dependency.pop("name", None)
if "namespace" in dependency:
kind = "managed"
name = name or "Install {} {}".format(
dependency["namespace"], dependency["version"]
)
else:
kind = "metadata"
name = name or "Deploy {}".format(dependency["subfolder"])
task_config = {
"options": self.options.copy(),
"checks": self.task_config.checks or [],
}
task_config["options"]["dependencies"] = [dependency]
ui_step = {"name": name, "kind": kind, "is_required": True}
ui_step.update(ui_options.get(i, {}))
ui_step.update(
{
"path": "{}.{}".format(step.path, i),
"step_num": "{}.{}".format(step.step_num, i),
"task_class": self.task_config.class_path,
"task_config": task_config,
"source": step.project_config.source.frozenspec,
}
)
steps.append(ui_step)
return steps
def _flatten(self, dependencies):
result = []
for dependency in dependencies:
subdeps = dependency.pop("dependencies", [])
for subdep in self._flatten(subdeps):
if subdep not in result:
result.append(subdep)
if dependency not in result:
result.append(dependency)
return result