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
|
#!/usr/bin/env python3
# encoding: utf-8
"""
release.py
Created by Thomas Mangin on 2011-01-24.
Copyright (c) 2009-2017 Exa Networks. All rights reserved.
"""
import os
import sys
import fileinput
import glob
import shutil
import zipapp
import argparse
CHANGELOG = 'CHANGELOG.rst'
class Path:
root = os.path.join(os.getcwd(), os.path.dirname(sys.argv[0]))
changelog = os.path.join(root, CHANGELOG)
lib_exa = os.path.join(root, 'lib/exabgp')
version = os.path.join(root, 'lib/exabgp/version.py')
debian = os.path.join(root, 'debian/changelog')
egg = os.path.join(root, 'lib/exabgp.egg-info')
build_exabgp = os.path.join(root, 'build/lib/exabgp')
build_root = os.path.join(root, 'build')
@classmethod
def remove_egg(cls, *args):
from shutil import rmtree
print('removing left-over egg')
if os.path.exists(cls.egg):
rmtree(cls.egg)
if os.path.exists(cls.build_exabgp):
rmtree(cls.build_root)
return 0
class Version:
JSON = '4.0.1'
TEXT = '4.0.1'
template = """\
import os
commit = "%s"
release = "%s"
json = "%s"
text = "%s"
version = os.environ.get('EXABGP_VERSION',release)
# Do not change the first line as it is parsed by scripts
if __name__ == '__main__':
import sys
sys.stdout.write(version)
"""
@staticmethod
def current():
sys.path.append(Path.lib_exa)
from version import version as release
# transitional fix
if "-" in release:
release = release.split("-")[0]
return release
@staticmethod
def changelog():
with open(Path.changelog) as f:
f.readline()
for line in f:
if line.lower().startswith('version '):
return line.split()[1].rstrip().rstrip(':').strip()
return ''
@staticmethod
def set(tag, commit):
with open(Path.version, 'w') as f:
f.write(Version.template % (commit, tag, Version.JSON, Version.TEXT))
return Version.current() == tag
@staticmethod
def latest(tags):
valid = [[int(_) for _ in tag.split('.')] for tag in tags if Version.valid(tag)]
return '.'.join(str(_) for _ in sorted(valid)[-1])
@staticmethod
def valid(tag):
parts = tag.split('.')
return len(parts) == 3 and parts[0].isdigit() and parts[1].isdigit() and parts[2].isdigit()
@staticmethod
def candidates(tag):
latest = [int(_) for _ in tag.split('.')]
return [
'.'.join([str(_) for _ in (latest[0], latest[1], latest[2] + 1)]),
'.'.join([str(_) for _ in (latest[0], latest[1] + 1, 0)]),
'.'.join([str(_) for _ in (latest[0] + 1, 0, 0)]),
]
class Debian:
template = """\
exabgp (%s-0) unstable; urgency=low
* Latest ExaBGP release.
-- Vincent Bernat <bernat@debian.org> %s
"""
@staticmethod
def set(version):
from email.utils import formatdate
with open(Path.debian, 'w') as w:
w.write(Debian.template % (version, formatdate()))
print('updated debian/changelog')
class Command:
dryrun = 'dry-run' if os.environ.get('DRY', os.environ.get('DRYRUN', os.environ.get('DRY_RUN', False))) else ''
@staticmethod
def run(cmd):
print('>', cmd)
return Git.dryrun or os.system(cmd)
class Git(Command):
@staticmethod
def commit(comment):
return Git.run('git commit -a -m "%s"' % comment)
@staticmethod
def push(tag=False, repo=''):
command = 'git push'
if tag:
command += ' --tags'
if repo:
command += ' %s' % repo
return Git.run(command)
@staticmethod
def head_commit():
return os.popen('git rev-parse --short HEAD').read().strip()
@staticmethod
def tags():
return os.popen('git tag').read().split('-')[0].strip().split('\n')
@staticmethod
def tag(release):
return Git.run('git tag -s -a %s -m "release %s"' % (release, release))
@staticmethod
def pending():
# XXX: terrible please rewrite
commit = None
for line in os.popen('git status').read().split('\n'):
if 'modified:' in line:
if 'lib/exabgp/version.py' in line or 'debian/changelog' in line or 'README' in line:
if commit is not False:
commit = True
else:
return False
elif 'renamed:' in line:
return False
return commit
#
# Check that that there is no version inconsistancy before any pypi action
#
def release_github(args):
print()
print('updating Github')
current = Version.current()
print('current version is %s (from version.py)' % current)
release = Version.changelog()
print('release version is %s (from %s)' % (release, CHANGELOG))
if not Version.valid(release):
print('invalid new version in %s' % CHANGELOG)
return 1
tags = Git.tags()
if release in tags:
print(f'version {release} was already released/used')
return 1
candidates = Version.candidates(Version.latest(tags))
if release not in candidates:
print('valid versions are:', ', '.join(candidates))
print('this release is not one of the candidates')
print('updating lib/exabgp/version.py')
Version.set(release, Git.head_commit())
print('updating debian/changelog')
Debian.set(release)
print('updating ', end='')
for readme in ('README.md', 'README.rst'):
print(readme + ' ', end='')
with fileinput.FileInput(readme, inplace=True) as replacer:
for line in replacer:
print(line.replace(current, release), end='')
print()
print('checking if we need to commit a version.py change')
status = Git.pending()
if status is None:
print('all is already set for release')
elif status is False:
print('more than one file is modified and need updating, aborting')
return 1
else:
if Git.commit('updating version to %s' % release):
print('could not commit version change (%s)' % release)
return 1
print('version was updated')
print('tagging the new version')
if Git.tag(release):
print('could not tag version (%s)' % release)
return 1
print('pushing the new tag')
if Git.push(tag=True, repo='origin'):
print('could not push release tag to origin')
return 1
if Git.push(tag=False, repo='origin'):
print('could not push release version to origin')
return 1
if Git.push(tag=True, repo='upstream'):
print('could not push release tag to upstream')
return 1
if Git.push(tag=False, repo='upstream'):
print('could not push release version to upstream')
return 1
return 0
def release_pypi(args):
test = args.test
print()
print('updating PyPI')
Path.remove_egg()
if Command.run('python3 setup.py sdist bdist_wheel'):
print('could not generate egg')
return 1
# keyring used to save credential
# https://pypi.org/project/twine/
release = Version.latest(Git.tags())
server = ''
if test:
server = '--repository-url https://test.pypi.org/legacy/'
if Command.run('twine upload %s dist/exabgp-%s.tar.gz' % (server, release)):
print('could not upload with twine')
return 1
print('all done.')
return 0
def remove_cache():
for name in glob.glob('./lib/*/__pycache__'):
shutil.rmtree(name)
for name in glob.glob('./lib/*/*/__pycache__'):
shutil.rmtree(name)
for name in glob.glob('./lib/*/*.pyc'):
os.remove(name)
for name in glob.glob('./lib/*/*/*.pyc'):
os.remove(name)
def generate_binary(args):
target = args.target
debug = args.debug
if sys.version_info.minor < 5:
sys.exit('zipapp is only available with python 3.5+')
FOLDER = os.path.dirname(os.path.realpath(__file__))
IMPORT = os.path.abspath(os.path.join(FOLDER, 'lib'))
if not os.path.exists(IMPORT):
sys.exit(f'could not import "{IMPORT}"')
sys.path = [IMPORT]
params = {
'source': 'lib',
'target': target,
'interpreter': '/usr/bin/env python3',
'main': 'exabgp.application.main:main',
}
if debug:
params['interpreter'] = '/usr/bin/env VYOSEXTRA_DEBUG=1 python3'
if sys.version_info.minor >= 7:
params['compressed'] = not debug
here = os.path.dirname(os.path.realpath(__file__))
data = os.path.abspath(os.path.join(here, 'data'))
zipapp.create_archive(**params)
def show_version(args):
if args.version == 'current':
print(Version.current())
if args.version == 'release':
print(Version.changelog())
def main():
# To late for it .. but here as a reminder that it can be done
os.environ['PYTHONDONTWRITEBYTECODE'] = ""
if os.environ.get("SCRUTINIZER", "") == "true":
sys.exit(0)
if len(sys.argv) > 1 and sys.argv[1] == 'debian':
release = Version.changelog()
Debian.set(release)
sys.exit(0)
parser = argparse.ArgumentParser(description='exabgp release tool')
root = parser.add_subparsers()
binary = root.add_parser('binary',help='release an exabgp binary')
binary.add_argument('target', help='name of the binary to create', default='./vyos')
binary.add_argument('-d', '--debug', help='run python with pdb', action='store_true')
binary.set_defaults(func=generate_binary)
pypi = root.add_parser('pypi', help='create egg/wheel')
pypi.add_argument('-t', '--test', help='only test', action='store_true')
pypi.set_defaults(func=release_pypi)
github = root.add_parser('github', help='tag a new version on github, and update pypi')
github.set_defaults(func=release_github)
cleanup = root.add_parser('cleanup', help='delete left-over file from release')
cleanup.set_defaults(func=Path.remove_egg)
show = root.add_parser('show', help='show exabgp version')
show.add_argument('version', help='which version', choices=['current', 'release'])
show.set_defaults(func=show_version)
args = parser.parse_args()
if 'func' not in dir(args):
sys.exit(1)
args.func(args)
sys.exit(0)
if __name__ == '__main__':
main()
|