cosmetic
[build.git] / module-tools.py
index 6a2b77c..0834f58 100755 (executable)
@@ -1,6 +1,6 @@
 #!/usr/bin/python -u
 
-import sys, os
+import sys, os, os.path
 import re
 import time
 import tempfile
@@ -16,12 +16,11 @@ RENAMED_SVN_MODULES = {
     "PLCAPI": "plcapi",
     "BootManager": "bootmanager",
     "BootCD": "bootcd",
-    "VserverReference": "vserver-reference",
-    "BootstrapFS": "bootstrapfs",
     "MyPLC": "myplc",
     "CoDemux": "codemux",
     "NodeManager": "nodemanager",
-    "NodeUpdate": "nodeupdate"
+    "NodeUpdate": "nodeupdate",
+    "Monitor": "monitor",
     }
 
 def svn_to_git_name(module):
@@ -161,6 +160,11 @@ class SvnRepository:
     def name(self):
         return os.path.basename(self.path)
 
+    def pathname(self):
+        # for svn modules pathname is just the name of the module as
+        # all modules are at the root
+        return self.name()
+
     def url(self):
         out = Command("svn info %s" % self.path, self.options).output_of()
         for line in out.split('\n'):
@@ -172,7 +176,7 @@ class SvnRepository:
         for line in out.split('\n'):
             if line.startswith("Repository Root:"):
                 root = line.split()[2].strip()
-                return "%s/%s" % (root, self.name())
+                return "%s/%s" % (root, self.pathname())
 
     @classmethod
     def checkout(cls, remote, local, options, recursive=False):
@@ -410,7 +414,7 @@ class Repository:
 # support for tagged module is minimal, and is for the Build class only
 class Module:
 
-    svn_magic_line="--This line, and those below, will be ignored--"
+    edit_magic_line="--This line, and those below, will be ignored--"
     setting_tag_format = "Setting tag %s"
     
     redirectors=[ # ('module_name_varname','name'),
@@ -443,10 +447,10 @@ class Module:
             while not cls.config[key]:
                 cls.prompt_config_option(key, message, default)
 
-    # for parsing module spec name:branch
-    matcher_branch_spec=re.compile("\A(?P<name>[\w\.-]+):(?P<branch>[\w\.-]+)\Z")
-    # special form for tagged module - for Build
-    matcher_tag_spec=re.compile("\A(?P<name>[\w\.-]+)@(?P<tagname>[\w\.-]+)\Z")
+    # for parsing module spec name:branch                                                                                                                                                                     
+    matcher_branch_spec=re.compile("\A(?P<name>[\w\.\-\/]+):(?P<branch>[\w\.\-]+)\Z")                                                                                                                         
+    # special form for tagged module - for Build                                                                                                                                                              
+    matcher_tag_spec=re.compile("\A(?P<name>[\w\.\-\/]+)@(?P<tagname>[\w\.\-]+)\Z")
     # parsing specfiles
     matcher_rpm_define=re.compile("%(define|global)\s+(\S+)\s+(\S*)\s*")
 
@@ -472,7 +476,8 @@ class Module:
 
     def __init__ (self,module_spec,options):
         # parse module spec
-        self.name, branch_or_tagname, module_type = self.parse_module_spec(module_spec)
+        self.pathname, branch_or_tagname, module_type = self.parse_module_spec(module_spec)
+        self.name = os.path.basename(self.pathname)
 
         if module_type == "branch":
             self.branch=branch_or_tagname
@@ -483,7 +488,7 @@ class Module:
         self.name = svn_to_git_name(self.name)
 
         self.options=options
-        self.module_dir="%s/%s"%(options.workdir,self.name)
+        self.module_dir="%s/%s"%(options.workdir,self.pathname)
         self.repository = None
         self.build = None
 
@@ -508,11 +513,11 @@ class Module:
 
     def friendly_name (self):
         if hasattr(self,'branch'):
-            return "%s:%s"%(self.name,self.branch)
+            return "%s:%s"%(self.pathname,self.branch)
         elif hasattr(self,'tagname'):
-            return "%s@%s"%(self.name,self.tagname)
+            return "%s@%s"%(self.pathname,self.tagname)
         else:
-            return self.name
+            return self.pathname
 
     @classmethod
     def git_remote_dir (cls, name):
@@ -577,6 +582,10 @@ that for other purposes than tagging""" % options.workdir
                 Module.config[key]=value                
             f.close()
 
+            # owerride config variables using options.
+            if options.build_module:
+                Module.config['build'] = options.build_module
+
         if not os.path.isdir (options.workdir):
             print "Cannot find",options.workdir,"let's create it"
             Command("mkdir -p %s" % options.workdir, options).run_silent()
@@ -620,8 +629,8 @@ that for other purposes than tagging""" % options.workdir
             print 'Checking for',self.module_dir
 
         if not os.path.isdir (self.module_dir):
-            if Repository.has_moved_to_git(self.name, Module.config):
-                self.repository = GitRepository.checkout(self.git_remote_dir(self.name),
+            if Repository.has_moved_to_git(self.pathname, Module.config):
+                self.repository = GitRepository.checkout(self.git_remote_dir(self.pathname),
                                                          self.module_dir,
                                                          self.options)
             else:
@@ -633,7 +642,7 @@ that for other purposes than tagging""" % options.workdir
         self.repository = Repository(self.module_dir, self.options)
         if self.repository.type == "svn":
             # check if module has moved to git    
-            if Repository.has_moved_to_git(self.name, Module.config):
+            if Repository.has_moved_to_git(self.pathname, Module.config):
                 Command("rm -rf %s" % self.module_dir, self.options).run_silent()
                 self.init_module_dir()
             # check if we have the required branch/tag
@@ -688,7 +697,7 @@ that for other purposes than tagging""" % options.workdir
 
         if level2:
             return level2[0]
-        raise Exception, 'Cannot guess specfile for module %s -- patterns were %s or %s'%(self.name,pattern1,pattern2)
+        raise Exception, 'Cannot guess specfile for module %s -- patterns were %s or %s'%(self.pathname,pattern1,pattern2)
 
     def all_specnames (self):
         level1=glob("%s/*.spec" % self.module_dir)
@@ -775,7 +784,7 @@ that for other purposes than tagging""" % options.workdir
         result=[]
         white_line_matcher = re.compile("\A\s*\Z")
         for logline in file(logfile).readlines():
-            if logline.strip() == Module.svn_magic_line:
+            if logline.strip() == Module.edit_magic_line:
                 break
             elif white_line_matcher.match(logline):
                 continue
@@ -784,7 +793,7 @@ that for other purposes than tagging""" % options.workdir
         return result
 
     # creates a copy of the input with only the unignored lines
-    def stripped_magic_line_filename (self, filein, fileout ,new_tag_name):
+    def strip_magic_line_filename (self, filein, fileout ,new_tag_name):
        f=file(fileout,'w')
        f.write(self.setting_tag_format%new_tag_name + '\n')
        for line in self.unignored_lines(filein):
@@ -857,7 +866,7 @@ that for other purposes than tagging""" % options.workdir
         # brute-force : change uncommented lines that define <module>-SVNPATH
         else:
             if self.options.verbose:
-                print 'Searching for -SVNPATH or -GITPATH lines referring to /%s/\n\tin %s .. '%(self.name,tagsfile),
+                print 'Searching for -SVNPATH or -GITPATH lines referring to /%s/\n\tin %s .. '%(self.pathname,tagsfile),
             pattern="\A\s*%s-(SVNPATH|GITPATH)\s*(=|:=)\s*(?P<url_main>[^\s]+)/%s[^\s]+"\
                                           %(self.name,self.name)
             matcher_module=re.compile(pattern)
@@ -866,7 +875,7 @@ that for other purposes than tagging""" % options.workdir
                 if attempt:
                     if line.find("-GITPATH") >= 0:
                         modulepath = "%s-GITPATH"%self.name
-                        replacement = "%-32s:= %s/%s.git@%s\n"%(modulepath,attempt.group('url_main'),self.name,newname)
+                        replacement = "%-32s:= %s/%s.git@%s\n"%(modulepath,attempt.group('url_main'),self.pathname,newname)
                     else:
                         modulepath = "%s-SVNPATH"%self.name
                         replacement = "%-32s:= %s/%s/tags/%s\n"%(modulepath,attempt.group('url_main'),self.name,newname)
@@ -943,39 +952,39 @@ that for other purposes than tagging""" % options.workdir
         # checking for diffs
         diff_output = self.repository.diff_with_tag(old_tag_name)
         if len(diff_output) == 0:
-            if not prompt ("No pending difference in module %s, want to tag anyway"%self.name,False):
+            if not prompt ("No pending difference in module %s, want to tag anyway"%self.pathname,False):
                 return
 
-        # side effect in trunk's specfile
+        # side effect in head's specfile
         self.patch_spec_var(spec_dict)
 
         # prepare changelog file 
-        # we use the standard subversion magic string (see svn_magic_line)
+        # we use the standard subversion magic string (see edit_magic_line)
         # so we can provide useful information, such as version numbers and diff
         # in the same file
-        changelog="/tmp/%s-%d.edit"%(self.name,os.getpid())
-        changelog_svn="/tmp/%s-%d.svn"%(self.name,os.getpid())
+        changelog_plain="/tmp/%s-%d.edit"%(self.name,os.getpid())
+        changelog_strip="/tmp/%s-%d.strip"%(self.name,os.getpid())
         setting_tag_line=Module.setting_tag_format%new_tag_name
-        file(changelog,"w").write("""
+        file(changelog_plain,"w").write("""
 %s
 %s
-Please write a changelog for this new tag in the section above
-"""%(Module.svn_magic_line,setting_tag_line))
+Please write a changelog for this new tag in the section below
+"""%(Module.edit_magic_line,setting_tag_line))
 
         if not self.options.verbose or prompt('Want to see diffs while writing changelog',True):
-            file(changelog,"a").write('DIFF=========\n' + diff_output)
+            file(changelog_plain,"a").write('DIFF=========\n' + diff_output)
         
         if self.options.debug:
             prompt('Proceed ?')
 
         # edit it        
-        self.run("%s %s"%(self.options.editor,changelog))
+        self.run("%s %s"%(self.options.editor,changelog_plain))
         # strip magic line in second file - looks like svn has changed its magic line with 1.6
         # so we do the job ourselves
-        self.stripped_magic_line_filename(changelog,changelog_svn,new_tag_name)
+        self.strip_magic_line_filename(changelog_plain,changelog_strip,new_tag_name)
         # insert changelog in spec
         if self.options.changelog:
-            self.insert_changelog (changelog,old_tag_name,new_tag_name)
+            self.insert_changelog (changelog_plain,old_tag_name,new_tag_name)
 
         ## update build
         build_path = os.path.join(self.options.workdir,
@@ -986,7 +995,7 @@ Please write a changelog for this new tag in the section above
         if not build.is_clean():
             build.revert()
 
-        tagsfiles=glob(build.path+"/*-tags*.mk")
+        tagsfiles=glob(build.path+"/*-tags.mk")
         tagsdict=dict( [ (x,'todo') for x in tagsfiles ] )
         default_answer = 'y'
         tagsfiles.sort()
@@ -1040,14 +1049,14 @@ n: move to next file"""%locals()
             build.commit(log)
 
         self.run_prompt("Review module and build", diff_all_changes)
-        self.run_prompt("Commit module and build", commit_all_changes, changelog_svn)
-        self.run_prompt("Create tag", self.repository.tag, new_tag_name, changelog_svn)
+        self.run_prompt("Commit module and build", commit_all_changes, changelog_strip)
+        self.run_prompt("Create tag", self.repository.tag, new_tag_name, changelog_strip)
 
         if self.options.debug:
-            print 'Preserving',changelog,'and stripped',changelog_svn
+            print 'Preserving',changelog_plain,'and stripped',changelog_strip
         else:
-            os.unlink(changelog)
-            os.unlink(changelog_svn)
+            os.unlink(changelog_plain)
+            os.unlink(changelog_strip)
 
 
 ##############################
@@ -1093,7 +1102,7 @@ n: move to next file"""%locals()
 
         if self.options.list:
             if diff_output:
-                print self.name
+                print self.pathname
         else:
             thename=self.friendly_name()
             do_print=False
@@ -1237,6 +1246,9 @@ def modules_diff(first, second):
     diff = {}
 
     for module in first:
+        if module not in second: 
+            print "=== module %s missing in right-hand side ==="%module
+            continue
         if first[module]['tag_or_branch'] != second[module]['tag_or_branch']:
             diff[module] = (first[module]['tag_or_branch'], second[module]['tag_or_branch'])
 
@@ -1250,27 +1262,38 @@ def modules_diff(first, second):
 
 def release_changelog(options, buildtag_old, buildtag_new):
 
-    tagfile = options.distrotags[0]
-    if not tagfile:
-        print "ERROR: provide a tagfile name (eg. onelab, onelab-k27, planetlab)"
+    # the command line expects new old, so we treat the tagfiles in the same order
+    nb_tags=len(options.distrotags)
+    if nb_tags==1:
+        tagfile_new=tagfile_old=options.distrotags[0]
+    elif nb_tags==2:
+        [tagfile_new,tagfile_old]=options.distrotags
+    else:
+        print "ERROR: provide one or two tagfile name (eg. onelab-k32-tags.mk)"
+        print "two tagfiles can be mentioned when a tagfile has been renamed"
         return
-    tagfile = "%s-tags.mk" % tagfile
-    
+
+    if options.dry_run:
+        print "------------------------------ Computing Changelog from"
+        print "buildtag_old",buildtag_old,"tagfile_old",tagfile_old
+        print "buildtag_new",buildtag_new,"tagfile_new",tagfile_new
+        return
+
     print '----'
     print '----'
     print '----'
     print '= build tag %s to %s =' % (buildtag_old, buildtag_new)
-    print '== distro %s (%s to %s) ==' % (tagfile, buildtag_old, buildtag_new)
+    print '== distro %s (%s to %s) ==' % (tagfile_new, buildtag_old, buildtag_new)
 
     build = Build("build@%s" % buildtag_old, options)
     build.init_module_dir()
-    first = build.get_modules(tagfile)
+    first = build.get_modules(tagfile_old)
 
     print ' * from', buildtag_old, build.repository.gitweb()
 
     build = Build("build@%s" % buildtag_new, options)
     build.init_module_dir()
-    second = build.get_modules(tagfile)
+    second = build.get_modules(tagfile_new)
 
     print ' * to', buildtag_new, build.repository.gitweb()
 
@@ -1285,7 +1308,7 @@ def release_changelog(options, buildtag_old, buildtag_new):
 
 
     for module in diff:
-        print '=== %s - %s to %s : package %s ===' % (tagfile, buildtag_old, buildtag_new, module)
+        print '=== %s - %s to %s : package %s ===' % (tagfile_new, buildtag_old, buildtag_new, module)
 
         first, second = diff[module]
         m = get_module(module, first)
@@ -1311,17 +1334,30 @@ def release_changelog(options, buildtag_old, buildtag_new):
             print ' * to', second, m.repository.gitweb()
 
         print '{{{'
-        os.system("diff -u %s %s" % (tmpfile, specfile))
+        os.system("diff -u %s %s | sed -e 's,%s,[[previous version]],'" % (tmpfile, specfile,tmpfile))
         print '}}}'
 
         os.unlink(tmpfile)
 
     for module in new_modules:
-        print '=== %s : new package in build %s ===' % (tagfile, module)
+        print '=== %s : new package in build %s ===' % (tagfile_new, module)
 
     for module in removed_modules:
-        print '=== %s : removed package from build %s ===' % (tagfile, module)
-
+        print '=== %s : removed package from build %s ===' % (tagfile_new, module)
+
+
+def adopt_tag (options, args):
+    modules=[]
+    for module in options.modules:
+        modules += module.split()
+    for module in modules: 
+        modobj=Module(module,options)
+        for tags_file in args:
+            if options.verbose:
+                print 'adopting tag %s for %s in %s'%(options.tag,module,tags_file)
+            modobj.patch_tags_file(tags_file,'_unused_',options.tag,fine_grain=False)
+    if options.verbose:
+        Command("git diff %s"%" ".join(args),options).run()
 
 ##############################
 class Main:
@@ -1333,11 +1369,11 @@ module-tools : a set of tools to manage subversion tags and specfile
   * define *version* and *taglevel*
   OR alternatively 
   * define redirection variables module_version_varname / module_taglevel_varname
-Trunk:
-  by default, the trunk of modules is taken into account
+Master:
+  by default, the 'master' branch of modules is the target
   in this case, just mention the module name as <module_desc>
 Branches:
-  if you wish to work on a branch rather than on the trunk
+  if you wish to work on another branch
   you can use something like e.g. Mom:2.1 as <module_desc>
 """
     release_usage="""Usage: %prog [options] tag1 .. tagn
@@ -1348,6 +1384,15 @@ Branches:
       release-changelog :4.2 4.2-rc25
   You can refer to the build trunk by just mentioning 'trunk', e.g.
       release-changelog -t coblitz-tags.mk coblitz-2.01-rc6 trunk
+  You can use 2 different tagfile names if that was renamed meanwhile
+      release-changelog -t onelab-tags.mk 5.0-rc29 -t onelab-k32-tags.mk 5.0-rc28
+"""
+    adopt_usage="""Usage: %prog [options] tag-file[s]
+  With this command you can adopt a specifi tag or branch in your tag files
+    This should be run in your daily build workdir; no call of git nor svn is done
+  Examples:
+    adopt-tag -m "plewww plcapi" -m Monitor onelab*tags.mk
+    adopt-tag -m sfa -t sfa-1.0-33 *tags.mk
 """
     common_usage="""More help:
   see http://svn.planet-lab.org/wiki/ModuleTools"""
@@ -1357,7 +1402,7 @@ Branches:
         'version' : "check latest specfile and print out details",
         'diff' : "show difference between module (trunk or branch) and latest tag",
         'tag'  : """increment taglevel in specfile, insert changelog in specfile,
-                create new tag and and monitor its adoption in build/*-tags*.mk""",
+                create new tag and and monitor its adoption in build/*-tags.mk""",
         'branch' : """create a branch for this module, from the latest tag on the trunk, 
                   and change trunk's version number to reflect the new branch name;
                   you can specify the new branch name by using module:branch""",
@@ -1365,10 +1410,13 @@ Branches:
                 this is a last resort option, mostly for repairs""",
         'changelog' : """extract changelog between build tags
                 expected arguments are a list of tags""",
+        'adopt' : """locally adopt a specific tag""",
         }
 
     silent_modes = ['list']
-    release_modes = ['changelog']
+    # 'changelog' is for release-changelog
+    # 'adopt' is for 'adopt-tag'
+    regular_modes = set(modes.keys()).difference(set(['changelog','adopt']))
 
     @staticmethod
     def optparse_list (option, opt, value, parser):
@@ -1380,7 +1428,8 @@ Branches:
     def run(self):
 
         mode=None
-        for function in Main.modes.keys():
+        # hack - need to check for adopt first as 'adopt-tag' contains tag..
+        for function in [ 'adopt' ] + Main.modes.keys():
             if sys.argv[0].find(function) >= 0:
                 mode = function
                 break
@@ -1389,16 +1438,39 @@ Branches:
             print "Supported commands:" + " ".join(Main.modes.keys())
             sys.exit(1)
 
-        if mode not in Main.release_modes:
+        usage='undefined usage, mode=%s'%mode
+        if mode in Main.regular_modes:
             usage = Main.module_usage
             usage += Main.common_usage
             usage += "\nmodule-%s : %s"%(mode,Main.modes[mode])
-        else:
+        elif mode=='changelog':
             usage = Main.release_usage
             usage += Main.common_usage
+        elif mode=='adopt':
+            usage = Main.adopt_usage
+            usage += Main.common_usage
 
         parser=OptionParser(usage=usage)
         
+        # the 'adopt' mode is really special and doesn't share any option
+        if mode=='adopt':
+            parser.add_option("-m","--module",action="append",dest="modules",default=[],
+                              help="modules, can be used several times or with quotes")
+            parser.add_option("-t","--tag",action="store", dest="tag", default='master',
+                              help="specify the tag to adopt, default is 'master'")
+            parser.add_option("-v","--verbose", action="store_true", dest="verbose", default=False, 
+                              help="run in verbose mode")
+            (options, args) = parser.parse_args()
+            options.workdir='unused'
+            options.dry_run=False
+            options.mode='adopt'
+            if len(args)==0 or len(options.modules)==0:
+                parser.print_help()
+                sys.exit(1)
+            adopt_tag (options,args)
+            return 
+
+        # the other commands (module-* and release-changelog) share the same skeleton
         if mode == "tag" or mode == 'branch':
             parser.add_option("-s","--set-version",action="store",dest="new_version",default=None,
                               help="set new version and reset taglevel to 0")
@@ -1406,7 +1478,7 @@ Branches:
             parser.add_option("-c","--no-changelog", action="store_false", dest="changelog", default=True,
                               help="do not update changelog section in specfile when tagging")
             parser.add_option("-b","--build-branch", action="store", dest="build_branch", default=None,
-                              help="specify a build branch; used for locating the *tags*.mk files where adoption is to take place")
+                              help="specify a build branch; used for locating the *tags.mk files where adoption is to take place")
         if mode == "tag" or mode == "sync" :
             parser.add_option("-e","--editor", action="store", dest="editor", default=default_editor(),
                               help="specify editor")
@@ -1437,6 +1509,8 @@ Branches:
 ** THIS MUST NOT ** be your usual working directory""")
         parser.add_option("-F","--fast-checks",action="store_true",dest="fast_checks",default=False,
                           help="skip safety checks, such as svn updates -- use with care")
+        parser.add_option("-B","--build-module",action="store",dest="build_module",default=None,
+                          help="specify a build module to owerride the one in the CONFIG")
 
         # default verbosity depending on function - temp
         verbose_modes= ['tag', 'sync', 'branch']
@@ -1455,6 +1529,8 @@ Branches:
             options.www=False
         options.debug=False
 
+        
+
         ########## module-*
         if len(args) == 0:
             if options.all_modules:
@@ -1467,7 +1543,7 @@ Branches:
         Module.init_homedir(options)
         
 
-        if mode not in Main.release_modes:
+        if mode in Main.regular_modes:
             modules=[ Module(modname,options) for modname in args ]
             # hack: create a dummy Module to store errors/warnings
             error_module = Module('__errors__',options)
@@ -1504,7 +1580,11 @@ Branches:
                     module.html_dump_body()
                 Module.html_dump_footer()
         else:
-            release_changelog(options, *args)
+            # if we provide, say a b c d, we want to build (a,b) (b,c) and (c,d)
+            # remember that the changelog in the twiki comes latest first, so
+            # we typically have here latest latest-1 latest-2
+            for (tag_new,tag_old) in zip ( args[:-1], args [1:]):
+                release_changelog(options, tag_old, tag_new)
             
     
 ####################