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
|
# Software License Agreement (BSD License)
#
# Copyright (c) 2013, Willow Garage, Inc.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above
# copyright notice, this list of conditions and the following
# disclaimer in the documentation and/or other materials provided
# with the distribution.
# * Neither the name of Willow Garage, Inc. nor the names of its
# contributors may be used to endorse or promote products derived
# from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
from __future__ import print_function
import os
import re
from ..utils.common import change_directory
from ..utils.common import user
def bump_version(version, bump='patch'):
"""
Increases version number.
:param version: str, must be in version format "int.int.int"
:param bump: str, one of 'patch, minor, major'
:returns: version with the given part increased, and all inferior
parts reset to 0
"""
# split the version number
match = re.match(r'^(\d+)\.(\d+)\.(\d+)$', version)
if match is None:
raise ValueError(
'Invalid version string, must be int.int.int: "%s"' % version
)
new_version = match.groups()
new_version = [int(x) for x in new_version]
# find the desired index
idx = dict(major=0, minor=1, patch=2)[bump]
# increment the desired part
new_version[idx] += 1
# reset all parts behind the bumped part
new_version = new_version[:idx + 1] + [0 for x in new_version[idx + 1:]]
return '%d.%d.%d' % tuple(new_version)
def _replace_version(package_str, new_version):
"""
replaces the version tag in contents if there is only one instance
:param package_str: str contents of package.xml
:param new_version: str version number
:returns: str new package.xml
:raises RuntimeError:
"""
# try to replace contens
new_package_str, number_of_subs = re.subn(
r'<version([^<>]*)>[^<>]*</version>',
r'<version\g<1>>%s</version>' % new_version, package_str
)
if number_of_subs != 1:
raise RuntimeError(
'Illegal number of version tags: %s' % (number_of_subs)
)
return new_package_str
def _check_for_version_comment(package_str, new_version):
"""
checks if a comment is present behind the version tag and return it
:param package_str: str contents of package.xml
:param version: str version number
:returns: str comment if available, else None
"""
version_tag = '>%s</version>' % new_version
pattern = '%s[ \t]*%s *(.+) *%s' % (
re.escape(version_tag), re.escape('<!--'), re.escape('-->')
)
comment = re.search(pattern, package_str)
if comment:
comment = comment.group(1)
return comment
def update_versions(paths, new_version):
"""
bulk replace of version: searches for package.xml files directly in
given folders and replaces version tag within.
:param paths: list of string, folder names
:param new_version: version string "int.int.int"
:raises RuntimeError: if any one package.xml cannot be updated
"""
files = {}
for path in paths:
package_path = os.path.join(path, 'package.xml')
with open(package_path, 'r') as f:
package_str = f.read()
try:
new_package_str = _replace_version(package_str, new_version)
comment = _check_for_version_comment(new_package_str, new_version)
if comment:
print('''\
NOTE: The package manifest "%s" contains a comment besides the version tag:
%s\
''' % (path, comment))
except RuntimeError as rue:
raise RuntimeError(
'Could not bump version number in file '
'%s: %s' % (package_path, str(rue))
)
files[package_path] = new_package_str
# if all replacements successful, write back modified package.xml
for package_path, new_package_str in files.items():
with open(package_path, 'w') as f:
f.write(new_package_str)
def change_upstream_version(upstream_dir, version):
update_versions([upstream_dir], version)
with change_directory(upstream_dir):
user('git commit -am "Version {0}" --allow-empty'.format(version))
user('git tag ' + version)
|
