Initial drop of bin/update-release-info.py.

This program automates the process of inserting the release configuration
information that is currently done by hand.  The configuration data now
all lives in a file, 'ReleaseConfig'.  Change the configuration file, run
the program, and, hey presto, the files are updated.

More work needs to be done; the documentation doesn't quite match with the
program and the regression tests only cover the release flows, but it's
important to get this stuff out before the next release is published so
people can start using it.

1 files changed, 306 insertions, 0 deletions

diff --git a/bin/update-release-info.py b/bin/update-release-info.py
new file mode 100644
index 00000000..c65963a0
--- /dev/null
+++ b/bin/update-release-info.py
@@ -0,0 +1,306 @@
+#!/usr/bin/env python
+"""
+Update files for release.  FIXME: make the doc string actually document.
+"""
+#
+# __COPYRIGHT__
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
+
+import os
+import sys
+import time
+import re
+
+DEBUG = os.environ.get('DEBUG', 0)
+
+# Evaluate parameter
+
+if len(sys.argv) < 2:
+    mode = 'develop'
+else:
+    mode = sys.argv[1]
+    if mode not in ['develop', 'release', 'post']:
+        print("""ERROR: `%s' as a parameter is invalid; it must be one of
+\tdevelop, release, or post.  The default is develop.""" % mode)
+        sys.exit(1)
+
+# Get configuration information
+
+config = dict()
+exec open('ReleaseConfig').read() in globals(), config
+
+try:
+    version_tuple = config['version_tuple']
+    unsupported_version = config['unsupported_python_version']
+    deprecated_version = config['deprecated_python_version']
+except KeyError:
+    print('''ERROR: Config file must contain at least version_tuple,
+\tunsupported_python_version, and deprecated_python_version.''')
+    sys.exit(1)
+if DEBUG: print 'version tuple', version_tuple
+if DEBUG: print 'unsupported Python version', unsupported_version
+if DEBUG: print 'deprecated Python version', deprecated_version
+
+if mode == 'develop' and version_tuple[3] != 'alpha':
+    version_tuple ==  version_tuple[:3] + ('alpha', 0)
+if version_tuple[3] != 'final':
+    if mode == 'develop':
+        version_tuple = version_tuple[:4] + ('yyyymmdd',)
+    else:
+        yyyy,mm,dd,_,_,_ = release_date
+        version_tuple = version_tuple[:4] + ((yyyy*100 + mm)*100 + dd,)
+version_string = '.'.join(map(str, version_tuple))
+version_type = version_tuple[3]
+if DEBUG: print 'version string', version_string
+
+if version_type not in ['alpha', 'beta', 'candidate', 'final']:
+    print("""ERROR: `%s' is not a valid release type in version tuple;
+\tit must be one of alpha, beta, candidate, or final""" % version_type)
+    sys.exit(1)
+
+try:
+    release_date = config['release_date']
+except KeyError:
+    release_date = time.localtime()[:6]
+else:
+    if len(release_date) == 3:
+        release_date = release_date + time.localtime()[3:6]
+    if len(release_date) != 6:
+        print '''ERROR: Invalid release date''', release_date
+        sys.exit(1)
+if DEBUG: print 'release date', release_date
+
+try:
+    month_year = config['month_year']
+except KeyError:
+    if version_type == 'alpha':
+        month_year = 'MONTH YEAR'
+    else:
+        month_year =  time.strftime('%B %Y', release_date + (0,0,0))
+if DEBUG: print 'month year', month_year
+
+try:
+    copyright_years = config['copyright_years']
+except KeyError:
+    copyright_years = ', '.join(map(str, list(range(2001, release_date[0] + 1))))
+if DEBUG: print 'copyright years', copyright_years
+
+class UpdateFile(object):
+    """
+    XXX
+    """
+
+    def __init__(self, file, orig = None):
+        '''
+        '''
+        if orig is None: orig = file
+        try:
+            self.content = open(orig, 'rU').read()
+        except IOError:
+            # Couldn't open file; don't try to write anything in __del__
+            self.file = None
+            raise
+        else:
+            self.file = file
+            if file == orig:
+                # so we can see if it changed
+                self.orig = self.content
+            else:
+                # pretend file changed
+                self.orig = ''
+
+    def sub(self, pattern, replacement, count = 1):
+        '''
+        XXX
+        '''
+        self.content = re.sub(pattern, replacement, self.content, count)
+
+    def replace_assign(self, name, replacement, count = 1):
+        '''
+        XXX
+        '''
+        self.sub('\n' + name + ' = .*', '\n' + name + ' = ' + replacement)
+
+    # Determine the pattern to match a version
+
+    _rel_types = '(alpha|beta|candidate|final)'
+    match_pat = '\d+\.\d+\.\d+\.' + _rel_types + '\.(\d+|yyyymmdd)'
+    match_rel = re.compile(match_pat)
+
+    def replace_version(self, replacement = version_string, count = 1):
+        '''
+        XXX
+        '''
+        self.content = self.match_rel.sub(replacement, self.content, count)
+
+    # Determine the release date and the pattern to match a date
+    # Mon, 05 Jun 2010 21:17:15 -0700
+    # NEW DATE WILL BE INSERTED HERE
+
+    if mode == 'develop':
+        new_date = 'NEW DATE WILL BE INSERTED HERE'
+    else:
+        min = (time.daylight and time.altzone or time.timezone)//60
+        hr = min//60
+        min = -(min%60 + hr*100)
+        new_date =  (time.strftime('%a, %d %b %Y %X', release_date + (0,0,0))
+                         + ' %+.4d' % min)
+
+    _days = '(Sun|Mon|Tue|Wed|Thu|Fri|Sat)'
+    _months = '(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oce|Nov|Dec)'
+    match_date = _days+', \d\d '+_months+' \d\d\d\d \d\d:\d\d:\d\d [+-]\d\d\d\d'
+    match_date = re.compile(match_date)
+
+    def replace_date(self, replacement = new_date, count = 1):
+        '''
+        XXX
+        '''
+        self.content = self.match_date.sub(replacement, self.content, count)
+
+    def __del__(self):
+        '''
+        XXX
+        '''
+        if self.file is not None and self.content != self.orig:
+            print 'Updating ' + self.file + '...'
+            open(self.file, 'w').write(self.content)
+
+if mode == 'post':
+    # Set up for the next release series.
+
+    if version_tuple[2]:
+        # micro release, increment micro value
+        minor = version_tuple[1]
+        micro = version_tuple[2] + 1
+    else:
+        # minor release, increment minor value
+        minor = version_tuple[1] + 1
+        micro = 0
+    new_tuple = (version_tuple[0], minor, micro, 'alpha', 0)
+    new_version = '.'.join(map(str, new_tuple[:4])) + '.yyyymmdd'
+
+    # Update ReleaseConfig
+
+    t = UpdateFile('ReleaseConfig')
+    if DEBUG: t.file = '/tmp/ReleaseConfig'
+    t.replace_assign('version_tuple', str(new_tuple))
+
+    # Update src/CHANGES.txt
+
+    t = UpdateFile(os.path.join('src', 'CHANGES.txt'))
+    if DEBUG: t.file = '/tmp/CHANGES.txt'
+    t.sub('(\nRELEASE .*)', r"""\nRELEASE  VERSION/DATE TO BE FILLED IN LATER\n
+  From John Doe:\n
+    - Whatever John Doe did.\n
+\1""")
+
+    # Update src/RELEASE.txt
+
+    t = UpdateFile(os.path.join('src', 'RELEASE.txt'),
+                   os.path.join('template', 'RELEASE.txt'))
+    if DEBUG: t.file = '/tmp/RELEASE.txt'
+    t.replace_version(new_version)
+
+    # Update src/Announce.txt
+
+    t = UpdateFile(os.path.join('src', 'Announce.txt'))
+    if DEBUG: t.file = '/tmp/Announce.txt'
+    t.sub('\nRELEASE .*', '\nRELEASE VERSION/DATE TO BE FILLED IN LATER')
+    announce_pattern = """(
+  Please note the following important changes scheduled for the next
+  release:
+)"""
+    announce_replace = (r"""\1
+    --  FEATURE THAT WILL CHANGE\n
+  Please note the following important changes since release """
+            + '.'.join(map(str, version_tuple[:3])) + ':\n')
+    t.sub(announce_pattern, announce_replace)
+
+    # Write out the last update and exit
+
+    t = None
+    sys.exit()
+
+# Update src/CHANGES.txt
+
+t = UpdateFile(os.path.join('src', 'CHANGES.txt'))
+if DEBUG: t.file = '/tmp/CHANGES.txt'
+t.sub('\nRELEASE .*', '\nRELEASE ' + version_string + ' - ' + t.new_date)
+
+# Update src/RELEASE.txt
+
+t = UpdateFile(os.path.join('src', 'RELEASE.txt'))
+if DEBUG: t.file = '/tmp/RELEASE.txt'
+t.replace_version()
+
+# Update src/Announce.txt
+
+t = UpdateFile(os.path.join('src', 'Announce.txt'))
+if DEBUG: t.file = '/tmp/Announce.txt'
+t.sub('\nRELEASE .*', '\nRELEASE ' + version_string + ' - ' + t.new_date)
+
+# Update SConstruct
+
+t = UpdateFile('SConstruct')
+if DEBUG: t.file = '/tmp/SConstruct'
+t.replace_assign('month_year', repr(month_year))
+t.replace_assign('copyright_years', repr(copyright_years))
+t.replace_assign('default_version', repr(version_string))
+
+# Update README
+
+t = UpdateFile('README')
+if DEBUG: t.file = '/tmp/README'
+t.sub('-' + t.match_pat + '\.', '-' + version_string + '.', count = 0)
+# the loop below can be removed after all 1.x.y releases are dead
+for suf in ['tar', 'win32', 'zip']:
+    t.sub('-(\d+\.\d+\.\d+)\.%s' % suf,
+          '-%s.%s' % (version_string, suf),
+          count = 0)
+
+# Update QMTest/TestSCons.py
+
+t = UpdateFile(os.path.join('QMTest', 'TestSCons.py'))
+if DEBUG: t.file = '/tmp/TestSCons.py'
+t.replace_assign('copyright_years', repr(copyright_years))
+t.replace_assign('default_version', repr(version_string))
+#??? t.replace_assign('SConsVersion', repr(version_string))
+t.replace_assign('python_version_unsupported', str(unsupported_version))
+t.replace_assign('python_version_deprecated', str(deprecated_version))
+
+# Update Script/Main.py
+
+t = UpdateFile(os.path.join('src', 'engine', 'SCons', 'Script', 'Main.py'))
+if DEBUG: t.file = '/tmp/Main.py'
+t.replace_assign('unsupported_python_version', str(unsupported_version))
+t.replace_assign('deprecated_python_version', str(deprecated_version))
+
+# Write out the last update
+
+t = None
+
+# Local Variables:
+# tab-width:4
+# indent-tabs-mode:nil
+# End:
+# vim: set expandtab tabstop=4 shiftwidth=4: