release.py

   1 # Copyright (C) 2009, Thomas Leonard
   2 # See the README file for details, or visit http://0install.net.
   3
   4 import os, subprocess, shutil
   5 from zeroinstall import SafeException
   6 from zeroinstall.injector import model
   7 from zeroinstall.support import ro_rmtree
   8 from logging import info, warn
   9
  10 import support, compile
  11 from scm import get_scm
  12
  13 XMLNS_RELEASE = 'http://zero-install.sourceforge.net/2007/namespaces/0release'
  14
  15 valid_phases = ['commit-release', 'generate-archive']
  16
  17 TMP_BRANCH_NAME = '0release-tmp'
  18
  19 test_command = os.environ['0TEST']
  20
  21 def run_unit_tests(local_feed):
  22         print "Running self-tests..."
  23         exitstatus = subprocess.call([test_command, '--', local_feed])
  24         if exitstatus == 2:
  25                 print "SKIPPED unit tests for %s (no 'self-test' attribute set)" % local_feed
  26                 return
  27         if exitstatus:
  28                 raise SafeException("Self-test failed with exit status %d" % exitstatus)
  29
  30 def get_archive_url(options, status, archive):
  31         archive_dir_public_url = options.archive_dir_public_url.replace('$RELEASE_VERSION', status.release_version)
  32         if not archive_dir_public_url.endswith('/'):
  33                 archive_dir_public_url += '/'
  34         return archive_dir_public_url + archive
  35
  36 def upload_archives(options, status, uploads):
  37         # For each binary or source archive in uploads, ensure it is available
  38         # from options.archive_dir_public_url
  39
  40         # We try to do all the uploads together first, and then verify them all
  41         # afterwards. This is because we may have to wait for them to be moved
  42         # from an incoming queue before we can test them.
  43
  44         def url(archive):
  45                 return get_archive_url(options, status, archive)
  46
  47         # Check that url exists and has the given size
  48         def is_uploaded(url, size):
  49                 if url.startswith('http://TESTING/releases'):
  50                         return True
  51
  52                 print "Testing URL %s..." % url
  53                 try:
  54                         actual_size = int(support.get_size(url))
  55                 except Exception, ex:
  56                         print "Can't get size of '%s': %s" % (url, ex)
  57                         return False
  58                 else:
  59                         if actual_size == size:
  60                                 return True
  61                         print "WARNING: %s exists, but size is %d, not %d!" % (url, actual_size, size)
  62                         return False
  63
  64         # status.verified_uploads is an array of status flags:
  65         description = {
  66                 'N': 'Upload required',
  67                 'A': 'Upload has been attempted, but we need to check whether it worked',
  68                 'V': 'Upload has been checked (exists and has correct size)',
  69         }
  70
  71         if status.verified_uploads is None:
  72                 # First time around; no point checking for existing uploads
  73                 status.verified_uploads = 'N' * len(uploads)
  74                 status.save()
  75
  76         while True:
  77                 print "\nUpload status:"
  78                 for i, stat in enumerate(status.verified_uploads):
  79                         print "- %s : %s" % (uploads[i], description[stat])
  80                 print
  81
  82                 # Break if finished
  83                 if status.verified_uploads == 'V' * len(uploads):
  84                         break
  85
  86                 # Find all New archives
  87                 to_upload = []
  88                 for i, stat in enumerate(status.verified_uploads):
  89                         assert stat in 'NAV'
  90                         if stat == 'N':
  91                                 to_upload.append(uploads[i])
  92                                 print "Upload %s/%s as %s" % (status.release_version, uploads[i], url(uploads[i]))
  93
  94                 cmd = options.archive_upload_command.strip()
  95
  96                 if to_upload:
  97                         # Mark all New items as Attempted
  98                         status.verified_uploads = status.verified_uploads.replace('N', 'A')
  99                         status.save()
 100
 101                         # Upload them...
 102                         if cmd:
 103                                 support.show_and_run(cmd, to_upload)
 104                         else:
 105                                 if len(to_upload) == 1:
 106                                         print "No upload command is set => please upload the archive manually now"
 107                                         raw_input('Press Return once the archive is uploaded.')
 108                                 else:
 109                                         print "No upload command is set => please upload the archives manually now"
 110                                         raw_input('Press Return once the %d archives are uploaded.' % len(to_upload))
 111
 112                 # Verify all Attempted uploads
 113                 new_stat = ''
 114                 for i, stat in enumerate(status.verified_uploads):
 115                         assert stat in 'AV', status.verified_uploads
 116                         if stat == 'A' :
 117                                 if not is_uploaded(url(uploads[i]), os.path.getsize(uploads[i])):
 118                                         print "** Archive '%s' still not uploaded! Try again..." % uploads[i]
 119                                         stat = 'N'
 120                                 else:
 121                                         stat = 'V'
 122                         new_stat += stat
 123
 124                 status.verified_uploads = new_stat
 125                 status.save()
 126
 127                 if 'N' in new_stat and cmd:
 128                         raw_input('Press Return to try again.')
 129
 130 def do_release(local_feed, options):
 131         assert options.master_feed_file
 132         options.master_feed_file = os.path.abspath(options.master_feed_file)
 133
 134         if not options.archive_dir_public_url:
 135                 raise SafeException("Downloads directory not set. Edit the 'make-release' script and try again.")
 136
 137         if not local_feed.feed_for:
 138                 raise SafeException("Feed %s missing a <feed-for> element" % local_feed.local_path)
 139
 140         status = support.Status()
 141         local_impl = support.get_singleton_impl(local_feed)
 142
 143         local_impl_dir = local_impl.id
 144         assert local_impl_dir.startswith('/')
 145         local_impl_dir = os.path.realpath(local_impl_dir)
 146         assert os.path.isdir(local_impl_dir)
 147         assert local_feed.local_path.startswith(local_impl_dir + '/')
 148
 149         # From the impl directory to the feed
 150         # NOT relative to the archive root (in general)
 151         local_iface_rel_path = local_feed.local_path[len(local_impl_dir) + 1:]
 152         assert not local_iface_rel_path.startswith('/')
 153         assert os.path.isfile(os.path.join(local_impl_dir, local_iface_rel_path))
 154
 155         phase_actions = {}
 156         for phase in valid_phases:
 157                 phase_actions[phase] = []       # List of <release:action> elements
 158
 159         add_toplevel_dir = None
 160         release_management = local_feed.get_metadata(XMLNS_RELEASE, 'management')
 161         if len(release_management) == 1:
 162                 info("Found <release:management> element.")
 163                 release_management = release_management[0]
 164                 for x in release_management.childNodes:
 165                         if x.uri == XMLNS_RELEASE and x.name == 'action':
 166                                 phase = x.getAttribute('phase')
 167                                 if phase not in valid_phases:
 168                                         raise SafeException("Invalid action phase '%s' in local feed %s. Valid actions are:\n%s" % (phase, local_feed.local_path, '\n'.join(valid_phases)))
 169                                 phase_actions[phase].append(x.content)
 170                         elif x.uri == XMLNS_RELEASE and x.name == 'add-toplevel-directory':
 171                                 add_toplevel_dir = local_feed.get_name()
 172                         else:
 173                                 warn("Unknown <release:management> element: %s", x)
 174         elif len(release_management) > 1:
 175                 raise SafeException("Multiple <release:management> sections in %s!" % local_feed)
 176         else:
 177                 info("No <release:management> element found in local feed.")
 178
 179         scm = get_scm(local_feed, options)
 180
 181         # Path relative to the archive / SCM root
 182         local_iface_rel_root_path = local_feed.local_path[len(scm.root_dir) + 1:]
 183
 184         def run_hooks(phase, cwd, env):
 185                 info("Running hooks for phase '%s'" % phase)
 186                 full_env = os.environ.copy()
 187                 full_env.update(env)
 188                 for x in phase_actions[phase]:
 189                         print "[%s]: %s" % (phase, x)
 190                         support.check_call(x, shell = True, cwd = cwd, env = full_env)
 191
 192         def set_to_release():
 193                 print "Snapshot version is " + local_impl.get_version()
 194                 release_version = options.release_version
 195                 if release_version is None:
 196                         suggested = support.suggest_release_version(local_impl.get_version())
 197                         release_version = raw_input("Version number for new release [%s]: " % suggested)
 198                         if not release_version:
 199                                 release_version = suggested
 200
 201                 scm.ensure_no_tag(release_version)
 202
 203                 status.head_before_release = scm.get_head_revision()
 204                 status.save()
 205
 206                 working_copy = local_impl.id
 207                 run_hooks('commit-release', cwd = working_copy, env = {'RELEASE_VERSION': release_version})
 208
 209                 print "Releasing version", release_version
 210                 support.publish(local_feed.local_path, set_released = 'today', set_version = release_version)
 211
 212                 support.backup_if_exists(release_version)
 213                 os.mkdir(release_version)
 214                 os.chdir(release_version)
 215
 216                 status.old_snapshot_version = local_impl.get_version()
 217                 status.release_version = release_version
 218                 status.head_at_release = scm.commit('Release %s' % release_version, branch = TMP_BRANCH_NAME, parent = 'HEAD')
 219                 status.save()
 220
 221         def set_to_snapshot(snapshot_version):
 222                 assert snapshot_version.endswith('-post')
 223                 support.publish(local_feed.local_path, set_released = '', set_version = snapshot_version)
 224                 scm.commit('Start development series %s' % snapshot_version, branch = TMP_BRANCH_NAME, parent = TMP_BRANCH_NAME)
 225                 status.new_snapshot_version = scm.get_head_revision()
 226                 status.save()
 227
 228         def ensure_ready_to_release():
 229                 if not options.master_feed_file:
 230                         raise SafeException("Master feed file not set! Check your configuration")
 231
 232                 scm.ensure_committed()
 233                 scm.ensure_versioned(os.path.abspath(local_feed.local_path))
 234                 info("No uncommitted changes. Good.")
 235                 # Not needed for GIT. For SCMs where tagging is expensive (e.g. svn) this might be useful.
 236                 #run_unit_tests(local_impl)
 237
 238                 scm.grep('\(^\\|[^=]\)\<\\(TODO\\|XXX\\|FIXME\\)\>')
 239
 240         def create_feed(target_feed, local_iface_path, archive_file, archive_name, main):
 241                 shutil.copyfile(local_iface_path, target_feed)
 242
 243                 support.publish(target_feed,
 244                         set_main = main,
 245                         archive_url = get_archive_url(options, status, os.path.basename(archive_file)),
 246                         archive_file = archive_file,
 247                         archive_extract = archive_name)
 248
 249         def get_previous_release(this_version):
 250                 """Return the highest numbered verison in the master feed before this_version.
 251                 @return: version, or None if there wasn't one"""
 252                 parsed_release_version = model.parse_version(this_version)
 253
 254                 if os.path.exists(options.master_feed_file):
 255                         master = support.load_feed(options.master_feed_file)
 256                         versions = [impl.version for impl in master.implementations.values() if impl.version < parsed_release_version]
 257                         if versions:
 258                                 return model.format_version(max(versions))
 259                 return None
 260
 261         def export_changelog(previous_release):
 262                 changelog = file('changelog-%s' % status.release_version, 'w')
 263                 try:
 264                         try:
 265                                 scm.export_changelog(previous_release, status.head_before_release, changelog)
 266                         except SafeException, ex:
 267                                 print "WARNING: Failed to generate changelog: " + str(ex)
 268                         else:
 269                                 print "Wrote changelog from %s to here as %s" % (previous_release or 'start', changelog.name)
 270                 finally:
 271                         changelog.close()
 272
 273         def fail_candidate():
 274                 cwd = os.getcwd()
 275                 assert cwd.endswith(status.release_version)
 276                 support.backup_if_exists(cwd)
 277                 scm.delete_branch(TMP_BRANCH_NAME)
 278                 os.unlink(support.release_status_file)
 279                 print "Restored to state before starting release. Make your fixes and try again..."
 280
 281         def accept_and_publish(archive_file, src_feed_name):
 282                 assert options.master_feed_file
 283
 284                 if not options.archive_dir_public_url:
 285                         raise SafeException("Archive directory public URL is not set! Edit configuration and try again.")
 286
 287                 if status.tagged:
 288                         print "Already tagged in SCM. Not re-tagging."
 289                 else:
 290                         scm.ensure_committed()
 291                         head = scm.get_head_revision()
 292                         if head != status.head_before_release:
 293                                 raise SafeException("Changes committed since we started!\n" +
 294                                                     "HEAD was " + status.head_before_release + "\n"
 295                                                     "HEAD now " + head)
 296
 297                         scm.tag(status.release_version, status.head_at_release)
 298                         scm.reset_hard(TMP_BRANCH_NAME)
 299                         scm.delete_branch(TMP_BRANCH_NAME)
 300
 301                         status.tagged = 'true'
 302                         status.save()
 303
 304                 if status.updated_master_feed:
 305                         print "Already added to master feed. Not changing."
 306                 else:
 307                         publish_opts = {}
 308                         if os.path.exists(options.master_feed_file):
 309                                 # Check we haven't already released this version
 310                                 master = support.load_feed(os.path.realpath(options.master_feed_file))
 311                                 existing_releases = [impl for impl in master.implementations.values() if impl.get_version() == status.release_version]
 312                                 if len(existing_releases):
 313                                         raise SafeException("Master feed %s already contains an implementation with version number %s!" % (options.master_feed_file, status.release_version))
 314
 315                                 previous_release = get_previous_release(status.release_version)
 316                                 previous_testing_releases = [impl for impl in master.implementations.values() if impl.get_version() == previous_release
 317                                                                                                              and impl.upstream_stability == model.stability_levels["testing"]]
 318                                 if previous_testing_releases:
 319                                         print "The previous release, version %s, is still marked as 'testing'. Set to stable?" % previous_release
 320                                         if support.get_choice(['Yes', 'No']) == 'Yes':
 321                                                 publish_opts['select_version'] = previous_release
 322                                                 publish_opts['set_stability'] = "stable"
 323
 324                         # Merge the source and binary feeds together first, so
 325                         # that we update the master feed atomically and only
 326                         # have to sign it once.
 327                         shutil.copyfile(src_feed_name, 'merged.xml')
 328                         for b in compiler.get_binary_feeds():
 329                                 support.publish('merged.xml', local = b)
 330
 331                         support.publish(options.master_feed_file, local = 'merged.xml', xmlsign = True, key = options.key, **publish_opts)
 332                         os.unlink('merged.xml')
 333
 334                         status.updated_master_feed = 'true'
 335                         status.save()
 336
 337                 # Copy files...
 338                 uploads = [os.path.basename(archive_file)]
 339                 for b in compiler.get_binary_feeds():
 340                         binary_feed = support.load_feed(b)
 341                         impl, = binary_feed.implementations.values()
 342                         uploads.append(os.path.basename(impl.download_sources[0].url))
 343
 344                 upload_archives(options, status, uploads)
 345
 346                 assert len(local_feed.feed_for) == 1
 347                 feed_base = os.path.dirname(list(local_feed.feed_for)[0])
 348                 feed_files = [options.master_feed_file]
 349                 print "Upload %s into %s" % (', '.join(feed_files), feed_base)
 350                 cmd = options.master_feed_upload_command.strip()
 351                 if cmd:
 352                         support.show_and_run(cmd, feed_files)
 353                 else:
 354                         print "NOTE: No feed upload command set => you'll have to upload them yourself!"
 355
 356                 print "Push changes to public SCM repository..."
 357                 public_repos = options.public_scm_repository
 358                 if public_repos:
 359                         scm.push_head_and_release(status.release_version)
 360                 else:
 361                         print "NOTE: No public repository set => you'll have to push the tag and trunk yourself."
 362
 363                 os.unlink(support.release_status_file)
 364
 365         if status.head_before_release:
 366                 head = scm.get_head_revision()
 367                 if status.release_version:
 368                         print "RESUMING release of %s %s" % (local_feed.get_name(), status.release_version)
 369                         if options.release_version and options.release_version != status.release_version:
 370                                 raise SafeException("Can't start release of version %s; we are currently releasing %s.\nDelete the release-status file to abort the previous release." % (options.release_version, status.release_version))
 371                 elif head == status.head_before_release:
 372                         print "Restarting release of %s (HEAD revision has not changed)" % local_feed.get_name()
 373                 else:
 374                         raise SafeException("Something went wrong with the last run:\n" +
 375                                             "HEAD revision for last run was " + status.head_before_release + "\n" +
 376                                             "HEAD revision now is " + head + "\n" +
 377                                             "You should revert your working copy to the previous head and try again.\n" +
 378                                             "If you're sure you want to release from the current head, delete '" + support.release_status_file + "'")
 379         else:
 380                 print "Releasing", local_feed.get_name()
 381
 382         ensure_ready_to_release()
 383
 384         if status.release_version:
 385                 if not os.path.isdir(status.release_version):
 386                         raise SafeException("Can't resume; directory %s missing. Try deleting '%s'." % (status.release_version, support.release_status_file))
 387                 os.chdir(status.release_version)
 388                 need_set_snapshot = False
 389                 if status.tagged:
 390                         print "Already tagged. Resuming the publishing process..."
 391                 elif status.new_snapshot_version:
 392                         head = scm.get_head_revision()
 393                         if head != status.head_before_release:
 394                                 raise SafeException("There are more commits since we started!\n"
 395                                                     "HEAD was " + status.head_before_release + "\n"
 396                                                     "HEAD now " + head + "\n"
 397                                                     "To include them, delete '" + support.release_status_file + "' and try again.\n"
 398                                                     "To leave them out, put them on a new branch and reset HEAD to the release version.")
 399                 else:
 400                         raise SafeException("Something went wrong previously when setting the new snapshot version.\n" +
 401                                             "Suggest you reset to the original HEAD of\n%s and delete '%s'." % (status.head_before_release, support.release_status_file))
 402         else:
 403                 set_to_release()        # Changes directory
 404                 assert status.release_version
 405                 need_set_snapshot = True
 406
 407         # May be needed by the upload command
 408         os.environ['RELEASE_VERSION'] = status.release_version
 409
 410         archive_name = support.make_archive_name(local_feed.get_name(), status.release_version)
 411         archive_file = archive_name + '.tar.bz2'
 412
 413         export_prefix = archive_name
 414         if add_toplevel_dir is not None:
 415                 export_prefix += '/' + add_toplevel_dir
 416
 417         if status.created_archive and os.path.isfile(archive_file):
 418                 print "Archive already created"
 419         else:
 420                 support.backup_if_exists(archive_file)
 421                 scm.export(export_prefix, archive_file, status.head_at_release)
 422
 423                 has_submodules = scm.has_submodules()
 424
 425                 if phase_actions['generate-archive'] or has_submodules:
 426                         try:
 427                                 support.unpack_tarball(archive_file)
 428                                 if has_submodules:
 429                                         scm.export_submodules(archive_name)
 430                                 run_hooks('generate-archive', cwd = archive_name, env = {'RELEASE_VERSION': status.release_version})
 431                                 info("Regenerating archive (may have been modified by generate-archive hooks...")
 432                                 support.check_call(['tar', 'cjf', archive_file, archive_name])
 433                         except SafeException:
 434                                 scm.reset_hard(scm.get_current_branch())
 435                                 fail_candidate()
 436                                 raise
 437
 438                 status.created_archive = 'true'
 439                 status.save()
 440
 441         if need_set_snapshot:
 442                 set_to_snapshot(status.release_version + '-post')
 443                 # Revert back to the original revision, so that any fixes the user makes
 444                 # will get applied before the tag
 445                 scm.reset_hard(scm.get_current_branch())
 446
 447         #backup_if_exists(archive_name)
 448         support.unpack_tarball(archive_file)
 449
 450         extracted_feed_path = os.path.abspath(os.path.join(export_prefix, local_iface_rel_root_path))
 451         assert os.path.isfile(extracted_feed_path), "Local feed not in archive! Is it under version control?"
 452         extracted_feed = support.load_feed(extracted_feed_path)
 453         extracted_impl = support.get_singleton_impl(extracted_feed)
 454
 455         if extracted_impl.main:
 456                 # Find main executable, relative to the archive root
 457                 abs_main = os.path.join(os.path.dirname(extracted_feed_path), extracted_impl.id, extracted_impl.main)
 458                 main = support.relative_path(archive_name + '/', abs_main)
 459                 if main != extracted_impl.main:
 460                         print "(adjusting main: '%s' for the feed inside the archive, '%s' externally)" % (extracted_impl.main, main)
 461                         # XXX: this is going to fail if the feed uses the new <command> syntax
 462                 if not os.path.exists(abs_main):
 463                         raise SafeException("Main executable '%s' not found after unpacking archive!" % abs_main)
 464                 if main == extracted_impl.main:
 465                         main = None     # Don't change the main attribute
 466         else:
 467                 main = None
 468
 469         try:
 470                 if status.src_tests_passed:
 471                         print "Unit-tests already passed - not running again"
 472                 else:
 473                         # Make directories read-only (checks tests don't write)
 474                         support.make_readonly_recursive(archive_name)
 475
 476                         run_unit_tests(extracted_feed_path)
 477                         status.src_tests_passed = True
 478                         status.save()
 479         except SafeException:
 480                 print "(leaving extracted directory for examination)"
 481                 fail_candidate()
 482                 raise
 483         # Unpack it again in case the unit-tests changed anything
 484         ro_rmtree(archive_name)
 485         support.unpack_tarball(archive_file)
 486
 487         # Generate feed for source
 488         src_feed_name = '%s.xml' % archive_name
 489         create_feed(src_feed_name, extracted_feed_path, archive_file, archive_name, main)
 490         print "Wrote source feed as %s" % src_feed_name
 491
 492         # If it's a source package, compile the binaries now...
 493         compiler = compile.Compiler(options, os.path.abspath(src_feed_name))
 494         compiler.build_binaries()
 495
 496         previous_release = get_previous_release(status.release_version)
 497         export_changelog(previous_release)
 498
 499         if status.tagged:
 500                 raw_input('Already tagged. Press Return to resume publishing process...')
 501                 choice = 'Publish'
 502         else:
 503                 print "\nCandidate release archive:", archive_file
 504                 print "(extracted to %s for inspection)" % os.path.abspath(archive_name)
 505
 506                 print "\nPlease check candidate and select an action:"
 507                 print "P) Publish candidate (accept)"
 508                 print "F) Fail candidate (delete release-status file)"
 509                 if previous_release:
 510                         print "D) Diff against release archive for %s" % previous_release
 511                         maybe_diff = ['Diff']
 512                 else:
 513                         maybe_diff = []
 514                 print "(you can also hit CTRL-C and resume this script when done)"
 515
 516                 while True:
 517                         choice = support.get_choice(['Publish', 'Fail'] + maybe_diff)
 518                         if choice == 'Diff':
 519                                 previous_archive_name = support.make_archive_name(local_feed.get_name(), previous_release)
 520                                 previous_archive_file = '../%s/%s.tar.bz2' % (previous_release, previous_archive_name)
 521
 522                                 # For archives created by older versions of 0release
 523                                 if not os.path.isfile(previous_archive_file):
 524                                         old_previous_archive_file = '../%s.tar.bz2' % previous_archive_name
 525                                         if os.path.isfile(old_previous_archive_file):
 526                                                 previous_archive_file = old_previous_archive_file
 527
 528                                 if os.path.isfile(previous_archive_file):
 529                                         support.unpack_tarball(previous_archive_file)
 530                                         try:
 531                                                 support.show_diff(previous_archive_name, archive_name)
 532                                         finally:
 533                                                 shutil.rmtree(previous_archive_name)
 534                                 else:
 535                                         # TODO: download it?
 536                                         print "Sorry, archive file %s not found! Can't show diff." % previous_archive_file
 537                         else:
 538                                 break
 539
 540         info("Deleting extracted archive %s", archive_name)
 541         shutil.rmtree(archive_name)
 542
 543         if choice == 'Publish':
 544                 accept_and_publish(archive_file, src_feed_name)
 545         else:
 546                 assert choice == 'Fail'
 547                 fail_candidate()