/
patches.py
311 lines (233 loc) · 9.51 KB
/
patches.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
# /*******************************************************************************
# * Copyright (c) 07.04.2011 Aaron Digulla.
# * All rights reserved. This program and the accompanying materials
# * are made available under the terms of the Eclipse Public License v1.0
# * which accompanies this distribution, and is available at
# * http://www.eclipse.org/legal/epl-v10.html
# *
# * Contributors:
# * Aaron Digulla - initial API and implementation and/or initial documentation
# *******************************************************************************/
'''
Helper code to create m4e patches
Created on Apr 7, 2011
@author: Aaron Digulla <digulla@hepe.com>
'''
import os.path
import logging
import re
from lxml import etree, objectify
from pom import removeElement
log = logging.getLogger("m4e.patches")
class PatchInfo(object):
'''Information about a patch, for example the involved dependencies'''
pass
class RemoveNonOptional(PatchInfo):
'''Remove <optional>false</optional> from all POMs'''
def run(self, pom):
for dependency in pom.dependencies():
if dependency.optional:
continue
dependency.optional = None
def __repr__(self):
return 'RemoveNonOptional()'
class PatchSet(object):
'''A set of patches'''
def __init__(self, fileName):
self.fileName = fileName
self.patches = []
def __repr__(self):
return 'PatchSet(%s)' % self.fileName
def run(self, pom):
for patch in self.patches:
patch.run(pom)
class PatchDependency(object):
'''Data container for dependency data (groupId, artifactId, version, scope, ...)'''
def __init__(self, groupId=None, artifactId=None, version=None, optional=None, scope=None):
self.groupId = groupId
self.artifactId = artifactId
self.version = version
self.optional = optional
self.scope = scope
def __repr__(self):
s = ''
if self.optional:
s += ':optional=%s' % self.optional
if self.scope:
s += ':scope=%s' % self.scope
return '%s:%s:%s%s' % (self.groupId, self.artifactId, self.version, s)
def key(self):
return '%s:%s:%s' % (self.groupId, self.artifactId, self.version)
def __eq__(self, other):
return ((self.groupId, self.artifactId, self.version) ==
(other.groupId, other.artifactId, other.version))
def dependencyFromString(s):
'''Create a PatchDependency from a string'''
parts = s.split(':')
if len(parts) < 3:
raise ValueError('Expected at least three colon-separated values: [%s]' % s)
options = {}
for part in parts[3:]:
tmp = part.split('=', 2)
if len(tmp) != 2:
raise ValueError('Expected at least two equals-separated values in [%s] of [%s]' % (part, s))
options[tmp[0]] = tmp[1]
optional = options.pop('optional', None)
scope = options.pop('scope', None)
if len(options):
raise ValueError('Unexpected options %s in [%s]' % (options, s))
if optional is not None:
optional = 'true' == optional
return PatchDependency(groupId=parts[0], artifactId=parts[1], version=parts[2], optional=optional, scope=scope)
class ReplaceDependency(PatchInfo):
'''Replace a dependency with another'''
def __init__(self, pattern, replacement):
self.pattern = dependencyFromString(pattern)
self.replacement = dependencyFromString(replacement)
def __repr__(self):
return 'ReplaceDependency(%s -> %s)' % (self.pattern, self.replacement)
class DeleteDependency(PatchInfo):
'''Delete a dependency'''
def __init__(self, pattern):
self.pattern = dependencyFromString(pattern)
def __repr__(self):
return 'DeleteDependency(%s -> %s)' % (self.pattern)
class ProfileTool(object):
'''Tool to move replaced dependencies to a profile'''
def __init__(self, pom, defaultProfileName, profileName):
self.pom = pom
self.defaultProfileName = defaultProfileName
self.profileName = profileName
self.defaultProfile = None
self.profile = None
def replaceDependency(self, dependency, replacement):
'''Remove the dependency from the original place and more it
to self.defaultProfile. Add the replacement to self.profile.'''
dependency.remove()
if self.defaultProfile is None:
self.defaultProfile = self.pom.profile(self.defaultProfileName)
self.defaultProfile.activeByDefault( True )
self.profile = self.pom.profile(self.profileName)
self.defaultProfile.addDependency(dependency)
d = self.createXmlDependency(replacement)
self.profile.addDependency(d)
def createXmlDependency(self, template):
'''Create an XML tree from a PatchDependency'''
d = objectify.Element('dependency')
for field in ('groupId', 'artifactId', 'version', 'optional', 'scope'):
value = getattr(template, field)
if value is None:
continue
if type(value) == type(True):
if not value:
continue
value = 'true' if value else 'false'
etree.SubElement(d, field)._setText(value)
return d
class DependencyPatcher(object):
'''Apply dependency patches to a POM'''
def __init__(self, defaultProfileName, profileName, replacements, deletes):
self.defaultProfileName = defaultProfileName
self.profileName = profileName
self.replacements = replacements
self.deletes = deletes
self.depMap = {}
for r in self.replacements:
key = r.pattern.key()
self.depMap[key] = r
self.delSet = set()
for d in self.deletes:
key = d.pattern.key()
self.delSet.add(key)
def run(self, pom):
tool = ProfileTool(pom, self.defaultProfileName, self.profileName)
for dependency in pom.dependencies():
key = dependency.key()
if key in self.delSet:
dependency.remove()
continue
r = self.depMap.get(key, None)
if r is None:
continue
log.debug('Found %s in %s' % (key, pom.pomFile))
tool.replaceDependency(dependency, r.replacement)
if tool.profile:
removeElement(tool.profile.xml().activation)
def __repr__(self):
return 'DependencyPatcher(%d)' % len(self.replacements)
class StripQualifiers(object):
'''Strip Eclipse qualifiers from versions'''
def __init__(self):
self.versionRangePattern = re.compile('^([\[\]()])([^,]*),([^,]*)([\[\]()])$')
def run(self, pom):
for d in pom.dependencies():
d.version = self.stripQualifier(d.version)
def stripQualifier(self, version):
m = self.versionRangePattern.match(version)
if m is None:
return self.stripQualifier2(version)
prefix = m.group(1)
v1 = m.group(2)
v2 = m.group(3)
postfix = m.group(4)
v1 = self.stripQualifier2(v1)
v2 = self.stripQualifier2(v2)
return '%s%s,%s%s' % (prefix, v1, v2, postfix)
def stripQualifier2(self, version):
if not version:
return version
parts = version.split('.')
return '.'.join(parts[0:3])
def __repr__(self):
return 'StripQualifiers()'
class PatchLoader(object):
'''Load patches from a file'''
def __init__(self, path):
self.path = path
self.patches = []
self.profile = None
self.defaultProfile = None
def addRemoveNonOptional(self):
self.patches.append(RemoveNonOptional())
def run(self):
self.process(self.path)
def process(self, root):
'''Search a folder for patches'''
for name in os.listdir(root):
path = os.path.join(root, name)
if os.path.isdir(path):
self.process(path)
elif path.endswith('.patches'):
self.addPatch(path)
def addPatch(self, fileName):
'''Add all patches in a file to the list of patches'''
patch = PatchSet(fileName)
self.patches.append(patch)
self.patches.append(StripQualifiers())
replacements = []
deletes = []
def replace(*args):
replacements.append(ReplaceDependency(*args))
def delete(*args):
deletes.append(DeleteDependency(*args))
def profile(name):
self.profile = name
def defaultProfile(name):
self.defaultProfile = name
globals = dict(
replace=replace,
delete=delete,
profile=profile,
defaultProfile=defaultProfile,
)
locals = {}
execfile(fileName, globals, locals)
if replacements or deletes:
patch.patches.append(DependencyPatcher(self.defaultProfile, self.profile, replacements, deletes))
class PatchTool(object):
'''Tool to apply a set of patches to a single POM'''
def __init__(self, patches):
self.patches = patches
def apply(self, pom):
for patch in self.patches:
patch.run(pom)