tune list of modules to monitor
[build.git] / module-tools.py
index 4a01c97..3317bbe 100755 (executable)
@@ -142,6 +142,7 @@ class Svnpath:
 class Module:
 
     svn_magic_line="--This line, and those below, will be ignored--"
+    setting_tag_format = "Setting tag %s"
     
     redirectors=[ # ('module_name_varname','name'),
                   ('module_version_varname','version'),
@@ -306,7 +307,7 @@ span.error {text-weight:bold; color: red; }
                 print '<hr /><h1>',self.html_anchor(self.friendly_name(),title),'</h1>'
         if hasattr(self,'body'):
             print self.body
-        print '<p class="top">',self.html_href('#','Back to top'),'</p>'
+            print '<p class="top">',self.html_href('#','Back to top'),'</p>'
 
     ####################
     @staticmethod
@@ -329,7 +330,7 @@ that for other purposes than tagging"""%topdir
             Module.prompt_config()
             print "Checking ...",
             Command("svn co -N %s %s"%(Module.config['svnpath'],topdir),options).run_fatal()
-            Command("svn co -N %s/%s %s/%s"%(Module.config['svnpath'],
+            Command("svn co %s/%s %s/%s"%(Module.config['svnpath'],
                                              Module.config['build'],
                                              topdir,
                                              Module.config['build']),options).run_fatal()
@@ -363,11 +364,13 @@ that for other purposes than tagging"""%topdir
         if not os.path.isdir (self.module_dir):
             raise Exception, 'Cannot find %s - check module name'%self.module_dir
 
-    def init_subdir (self,fullpath):
+    def init_subdir (self,fullpath, deep=False):
         if self.options.verbose:
             print 'Checking for',fullpath
+        opt=""
+        if not deep: opt="-N"
         if not os.path.isdir (fullpath):
-            self.run_fatal("svn update -N %s"%fullpath)
+            self.run_fatal("svn update %s %s"%(opt,fullpath))
 
     def revert_subdir (self,fullpath):
         if self.options.fast_checks:
@@ -384,15 +387,15 @@ that for other purposes than tagging"""%topdir
             return
         if self.options.verbose:
             print 'Updating',fullpath
-        self.run_fatal("svn update -N %s"%fullpath)
+        self.run_fatal("svn update %s"%fullpath)
 
     def init_edge_dir (self):
         # if branch, edge_dir is two steps down
         if hasattr(self,'branch'):
-            self.init_subdir("%s/branches"%self.module_dir)
+            self.init_subdir("%s/branches"%self.module_dir,deep=False)
         elif hasattr(self,'tagname'):
-            self.init_subdir("%s/tags"%self.module_dir)
-        self.init_subdir(self.edge_dir())
+            self.init_subdir("%s/tags"%self.module_dir,deep=False)
+        self.init_subdir(self.edge_dir(),deep=True)
 
     def revert_edge_dir (self):
         self.revert_subdir(self.edge_dir())
@@ -404,15 +407,21 @@ that for other purposes than tagging"""%topdir
         attempt="%s/%s.spec"%(self.edge_dir(),self.name)
         if os.path.isfile (attempt):
             return attempt
-        else:
-            pattern="%s/*.spec"%self.edge_dir()
-            try:
-                return glob(pattern)[0]
-            except:
-                raise Exception, 'Cannot guess specfile for module %s -- pattern was %s'%(self.name,pattern)
+        pattern1="%s/*.spec"%self.edge_dir()
+        level1=glob(pattern1)
+        if level1:
+            return level1[0]
+        pattern2="%s/*/*.spec"%self.edge_dir()
+        level2=glob(pattern2)
+        if level2:
+            return level2[0]
+        raise Exception, 'Cannot guess specfile for module %s -- patterns were %s or %s'%(self.name,pattern1,pattern2)
 
     def all_specnames (self):
-        return glob("%s/*.spec"%self.edge_dir())
+        level1=glob("%s/*.spec"%self.edge_dir())
+        if level1: return level1
+        level2=glob("%s/*/*.spec"%self.edge_dir())
+        return level2
 
     def parse_spec (self, specfile, varnames):
         if self.options.verbose:
@@ -488,21 +497,27 @@ that for other purposes than tagging"""%topdir
             new.close()
             os.rename(newspecfile,specfile)
 
+    # returns all lines until the magic line
     def unignored_lines (self, logfile):
         result=[]
-        exclude="Setting tag %s"%self.name
         white_line_matcher = re.compile("\A\s*\Z")
         for logline in file(logfile).readlines():
             if logline.strip() == Module.svn_magic_line:
                 break
-            if logline.find(exclude) >= 0:
-                continue
             elif white_line_matcher.match(logline):
                 continue
             else:
                 result.append(logline.strip()+'\n')
         return result
 
+    # creates a copy of the input with only the unignored lines
+    def stripped_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):
+           f.write(line)
+       f.close()
+
     def insert_changelog (self, logfile, oldtag, newtag):
         for specfile in self.all_specnames():
             newspecfile=specfile+".new"
@@ -808,12 +823,14 @@ The module-sync function has the following limitations
         # we use the standard subversion magic string (see svn_magic_line)
         # so we can provide useful information, such as version numbers and diff
         # in the same file
-        changelog="/tmp/%s-%d.txt"%(self.name,os.getpid())
-        file(changelog,"w").write("""Setting tag %s
-
+        changelog="/tmp/%s-%d.edit"%(self.name,os.getpid())
+        changelog_svn="/tmp/%s-%d.svn"%(self.name,os.getpid())
+        setting_tag_line=Module.setting_tag_format%new_tag_name
+        file(changelog,"w").write("""
+%s
 %s
 Please write a changelog for this new tag in the section above
-"""%(new_tag_name,Module.svn_magic_line))
+"""%(Module.svn_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)
@@ -823,6 +840,9 @@ Please write a changelog for this new tag in the section above
 
         # edit it        
         self.run("%s %s"%(self.options.editor,changelog))
+        # 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)
         # insert changelog in spec
         if self.options.changelog:
             self.insert_changelog (changelog,old_tag_name,new_tag_name)
@@ -843,14 +863,16 @@ Please write a changelog for this new tag in the section above
         tagsfiles=glob(build.edge_dir()+"/*-tags*.mk")
         tagsdict=dict( [ (x,'todo') for x in tagsfiles ] )
         default_answer = 'y'
+        tagsfiles.sort()
         while True:
-            for (tagsfile,status) in tagsdict.iteritems():
+            for tagsfile in tagsfiles:
+                status=tagsdict[tagsfile]
                 basename=os.path.basename(tagsfile)
                 print ".................... Dealing with %s"%basename
                 while tagsdict[tagsfile] == 'todo' :
                     choice = prompt ("insert %s in %s    "%(new_tag_name,basename),default_answer,
                                      [ ('y','es'), ('n', 'ext'), ('f','orce'), 
-                                       ('d','iff'), ('r','evert'), ('h','elp') ] ,
+                                       ('d','iff'), ('r','evert'), ('c', 'at'), ('h','elp') ] ,
                                      allow_outside=True)
                     if choice == 'y':
                         self.patch_tags_file(tagsfile,old_tag_name,new_tag_name,fine_grain=True)
@@ -863,16 +885,19 @@ Please write a changelog for this new tag in the section above
                         self.run("svn diff %s"%tagsfile)
                     elif choice == 'r':
                         self.run("svn revert %s"%tagsfile)
+                    elif choice == 'c':
+                        self.run("cat %s"%tagsfile)
                     else:
                         name=self.name
                         print """y: change %(name)s-SVNPATH only if it currently refers to %(old_tag_name)s
-f: unconditionnally change any line setting %(name)s-SVNPATH to using %(new_tag_name)s
+f: unconditionnally change any line that assigns %(name)s-SVNPATH to using %(new_tag_name)s
 d: show current diff for this tag file
 r: revert that tag file
+c: cat the current tag file
 n: move to next file"""%locals()
 
             if prompt("Want to review changes on tags files",False):
-                tagsdict = dict ( [ (x, 'todo') for tagsfile in tagsfiles ] )
+                tagsdict = dict ( [ (x, 'todo') for x in tagsfiles ] )
                 default_answer='d'
             else:
                 break
@@ -881,13 +906,14 @@ n: move to next file"""%locals()
         paths += self.edge_dir() + " "
         paths += build.edge_dir() + " "
         self.run_prompt("Review module and build","svn diff " + paths)
-        self.run_prompt("Commit module and build","svn commit --file %s %s"%(changelog,paths))
-        self.run_prompt("Create tag","svn copy --file %s %s %s"%(changelog,edge_url,new_tag_url))
+        self.run_prompt("Commit module and build","svn commit --file %s %s"%(changelog_svn,paths))
+        self.run_prompt("Create tag","svn copy --file %s %s %s"%(changelog_svn,edge_url,new_tag_url))
 
         if self.options.debug:
-            print 'Preserving',changelog
+            print 'Preserving',changelog,'and stripped',changelog_svn
         else:
             os.unlink(changelog)
+            os.unlink(changelog_svn)
             
 ##############################
     def do_branch (self):
@@ -963,28 +989,41 @@ will be based on latest tag %s and *not* on the current trunk"""%(self.name,bran
         f.write("Branch %s for module %s created (as new trunk) from tag %s\n"%(new_trunk_name,self.name,latest_tag_name))
         f.close()
 
-        # we're done, let's commit the stuff
+        # review the renumbering changes in trunk
         command="svn diff %s"%self.edge_dir()
-        self.run_prompt("Review changes in trunk",command)
-        command="svn copy --file %s %s %s"%(tmp,self.edge_url(),branch_url)
+        self.run_prompt("Review (renumbering) changes in trunk",command)
+        # create branch
+        command="svn copy --file %s %s %s"%(tmp,tag_url,branch_url)
         self.run_prompt("Create branch",command)
+        # commit trunk
         command="svn commit --file %s %s"%(tmp,self.edge_dir())
         self.run_prompt("Commit trunk",command)
+        # create initial tag for the new trunk
         new_tag_url=self.tag_url(spec_dict)
-        command="svn copy --file %s %s %s"%(tmp,self.edge_url(),new_tag_url)
+        command="svn copy --file %s %s %s"%(tmp,tag_url,new_tag_url)
         self.run_prompt("Create initial tag in trunk",command)
         os.unlink(tmp)
+        # print message about SVNBRANCH
+        print """You might now wish to review your tags files
+Please make sure you mention as appropriate 
+%s-SVNBRANCH := %s""" %(self.name,branch_name)
 
 ##############################
 class Package:
 
-    def __init__(self, package, module, svnpath, spec):
+    def __init__(self, package, module, svnpath, spec,options):
         self.package=package
         self.module=module
-        self.svnpath=svnpath
+        self.svnrev = None
+        self.svnpath=svnpath    
+        if svnpath.rfind('@') > 0:
+            self.svnpath, self.svnrev = svnpath.split('@')
         self.spec=spec
-        self.specpath="%s/%s"%(svnpath,spec)
+        self.specpath="%s/%s"%(self.svnpath,self.spec)
+        if self.svnrev:
+            self.specpath += "@%s" % self.svnrev
         self.basename=os.path.basename(svnpath)
+        self.options=options
 
     # returns a http URL to the trac path where full diff can be viewed (between self and pkg)
     # typically http://svn.planet-lab.org/changeset?old_path=Monitor%2Ftags%2FMonitor-1.0-7&new_path=Monitor%2Ftags%2FMonitor-1.0-13
@@ -1000,6 +1039,12 @@ class Package:
             return "%s://%s/changeset?old_path=%s&new_path=%s"%(method,hostname,self_path,pkg_path)
         else:
             return None
+    
+    def inline_full_diff (self, pkg):
+        print '{{{'
+        command='svn diff %s %s'%(self.svnpath,pkg.svnpath)
+        Command(command,self.options).run()
+        print '}}}'
 
     def details (self):
         return "[%s %s] [%s (spec)]"%(self.svnpath,self.basename,self.specpath)
@@ -1008,10 +1053,14 @@ class Build (Module):
     
     # we cannot get build's svnpath as for other packages as we'd get something in svn+ssh
     # xxx quick & dirty
-    def __init__ (self, buildtag,options):
+    def __init__ (self, buildtag, options):
         self.buildtag=buildtag
+        if buildtag == "trunk":
+            module_name="build"
+            self.display="trunk"
+            self.svnpath="http://svn.planet-lab.org/svn/build/trunk"
         # if the buildtag start with a : (to use a branch rather than a tag)
-        if buildtag.find(':') == 0 : 
+        elif buildtag.find(':') == 0 : 
             module_name="build%(buildtag)s"%locals()
             self.display=buildtag[1:]
             self.svnpath="http://svn.planet-lab.org/svn/build/branches/%s"%self.display
@@ -1038,6 +1087,9 @@ class Build (Module):
         make_options="--no-print-directory -C %s stage1=true PLDISTRO=%s PLDISTROTAGS=%s 2> /dev/null"%(self.edge_dir(),distro,distrotag)
         command="make %s packages"%make_options
         make_packages=Command(command,self.options).output_of()
+        if self.options.verbose:
+            print 'obtaining packages information with command:'
+            print command
         pkg_line=re.compile("\Apackage=(?P<package>[^\s]+)\s+ref_module=(?P<module>[^\s]+)\s.*\Z")
         for line in make_packages.split("\n"):
             if not line:
@@ -1056,7 +1108,7 @@ class Build (Module):
                 svnpath=Command(command,self.options).output_of().strip()
                 command="make %s +%s-SPEC"%(make_options,package)
                 spec=Command(command,self.options).output_of().strip()
-                result[package]=Package(package,module,svnpath,spec)
+                result[module]=Package(package,module,svnpath,spec,self.options)
         return result
 
     def get_distrotags (self):
@@ -1122,20 +1174,32 @@ class Release:
             # parse make packages
             packages_new=build_new.get_packages(distrotag)
             pnames_new=set(packages_new.keys())
-            if options.verbose: print 'got packages for ',build_new.display
             packages_old=build_old.get_packages(distrotag)
             pnames_old=set(packages_old.keys())
-            if options.verbose: print 'got packages for ',build_old.display
 
-            # get created, deprecated, and preserved package names
+            # get names of created, deprecated, and preserved modules
             pnames_created = list(pnames_new-pnames_old)
-            pnames_created.sort()
             pnames_deprecated = list(pnames_old-pnames_new)
-            pnames_deprecated.sort()
             pnames = list(pnames_new.intersection(pnames_old))
+
+            pnames_created.sort()
+            pnames_deprecated.sort()
             pnames.sort()
 
-            if options.verbose: print "Found new/deprecated/preserved pnames",pnames_new,pnames_deprecated,pnames
+            if options.verbose: 
+                print '--------------------'
+                print 'got packages for ',build_new.display
+                print pnames_new
+                print '--------------------'
+                print 'got packages for ',build_old.display
+                print pnames_old
+                print '--------------------'
+                print "Found new modules",pnames_created
+                print '--------------------'
+                print "Found deprecated modules",pnames_deprecated
+                print '--------------------'
+                print "Found preserved modules",pnames
+                print '--------------------'
 
             # display created and deprecated 
             for name in pnames_created:
@@ -1170,25 +1234,32 @@ class Release:
                 print '=== %s - %s to %s : package %s === #package-%s-%s-%s'%(
                     distrotag,build_old.display,build_new.display,name,name,distro,build_new.display)
                 print ' * from %s to %s'%(pobj_old.details(),pobj_new.details())
-                trac_diff_url=pobj_old.trac_full_diff(pobj_new)
-                if trac_diff_url:
-                    print ' * [%s View full diff]'%trac_diff_url
-                print '{{{'
-                for line in specdiff.split('\n'):
-                    if not line:
-                        continue
-                    if Release.discard_matcher.match(line):
-                        continue
-                    if line[0] in ['@']:
-                        print '----------'
-                    elif line[0] in ['+','-']:
-                        print_fold(line)
-                print '}}}'
+                if options.inline_diff:
+                    pobj_old.inline_full_diff(pobj_new)
+                else:
+                    trac_diff_url=pobj_old.trac_full_diff(pobj_new)
+                    if trac_diff_url:
+                        print ' * [%s View full diff]'%trac_diff_url
+                    else:
+                        print ' * No full diff available'
+                    print '{{{'
+                    for line in specdiff.split('\n'):
+                        if not line:
+                            continue
+                        if Release.discard_matcher.match(line):
+                            continue
+                        if line[0] in ['@']:
+                            print '----------'
+                        elif line[0] in ['+','-']:
+                            print_fold(line)
+                    print '}}}'
 
 ##############################
 class Main:
 
     module_usage="""Usage: %prog [options] module_desc [ .. module_desc ]
+Revision: $Revision$
+
 module-tools : a set of tools to manage subversion tags and specfile
   requires the specfile to either
   * define *version* and *taglevel*
@@ -1207,6 +1278,8 @@ Branches:
       release-changelog 4.2-rc25 4.2-rc24 4.2-rc23 4.2-rc22
   You can refer to a (build) branch by prepending a colon, like in
       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
 """
     common_usage="""More help:
   see http://svn.planet-lab.org/wiki/ModuleTools"""
@@ -1245,7 +1318,7 @@ Branches:
                 break
         if not mode:
             print "Unsupported command",sys.argv[0]
-            print "Supported commands:" + Modes.modes.keys.join(" ")
+            print "Supported commands:" + " ".join(Main.modes.keys())
             sys.exit(1)
 
         if mode not in Main.release_modes:
@@ -1301,6 +1374,8 @@ Branches:
         else:
             parser.add_option("-n","--dry-run",action="store_true",dest="dry_run",default=False,
                               help="dry run - shell commands are only displayed")
+            parser.add_option("-i","--inline-diff",action="store_true",dest="inline_diff",default=False,
+                              help="calls svn diff on whole module, not just only the spec file")
             parser.add_option("-t","--distrotags",action="callback",callback=Main.optparse_list, dest="distrotags",
                               default=[], nargs=1,type="string",
                               help="""specify distro-tags files, e.g. onelab-tags-4.2.mk
@@ -1314,7 +1389,7 @@ Branches:
                           help="skip safety checks, such as svn updates -- use with care")
 
         # default verbosity depending on function - temp
-        verbose_modes= ['tag','sync']
+        verbose_modes= ['tag', 'sync', 'branch']
         
         if mode not in verbose_modes:
             parser.add_option("-v","--verbose", action="store_true", dest="verbose", default=False,