5 import sys, os, os.path
9 from optparse import OptionParser
11 # e.g. other_choices = [ ('d','iff') , ('g','uess') ] - lowercase
12 def prompt (question,default=True,other_choices=[],allow_outside=False):
13 if not isinstance (other_choices,list):
14 other_choices = [ other_choices ]
15 chars = [ c for (c,rest) in other_choices ]
19 if default is True: choices.append('[y]')
20 else : choices.append('y')
22 if default is False: choices.append('[n]')
23 else : choices.append('n')
25 for (char,choice) in other_choices:
27 choices.append("["+char+"]"+choice)
29 choices.append("<"+char+">"+choice)
31 answer=raw_input(question + " " + "/".join(choices) + " ? ")
34 answer=answer[0].lower()
36 if 'y' in chars: return 'y'
39 if 'n' in chars: return 'n'
42 for (char,choice) in other_choices:
47 return prompt(question,default,other_choices)
53 editor = os.environ['EDITOR']
61 def print_fold (line):
62 while len(line) >= fold_length:
63 print line[:fold_length],'\\'
64 line=line[fold_length:]
68 def __init__ (self,command,options):
71 self.tmp="/tmp/command-%d"%os.getpid()
74 if self.options.dry_run:
75 print 'dry_run',self.command
77 if self.options.verbose and self.options.mode not in Main.silent_modes:
78 print '+',self.command
80 return os.system(self.command)
82 def run_silent (self):
83 if self.options.dry_run:
84 print 'dry_run',self.command
86 if self.options.verbose:
87 print '+',self.command,' .. ',
89 retcod=os.system(self.command + " &> " + self.tmp)
91 print "FAILED ! -- out+err below (command was %s)"%self.command
92 os.system("cat " + self.tmp)
93 print "FAILED ! -- end of quoted output"
94 elif self.options.verbose:
100 if self.run_silent() !=0:
101 raise Exception,"Command %s failed"%self.command
103 # returns stdout, like bash's $(mycommand)
104 def output_of (self,with_stderr=False):
105 if self.options.dry_run:
106 print 'dry_run',self.command
107 return 'dry_run output'
108 tmp="/tmp/status-%d"%os.getpid()
109 if self.options.debug:
110 print '+',self.command,' .. ',
119 result=file(tmp).read()
121 if self.options.debug:
126 def __init__(self,path,options):
130 def url_exists (self):
131 return os.system("svn list %s &> /dev/null"%self.path) == 0
133 def dir_needs_revert (self):
134 command="svn status %s"%self.path
135 return len(Command(command,self.options).output_of(True)) != 0
136 # turns out it's the same implem.
137 def file_needs_commit (self):
138 command="svn status %s"%self.path
139 return len(Command(command,self.options).output_of(True)) != 0
141 # support for tagged module is minimal, and is for the Build class only
144 svn_magic_line="--This line, and those below, will be ignored--"
146 redirectors=[ # ('module_name_varname','name'),
147 ('module_version_varname','version'),
148 ('module_taglevel_varname','taglevel'), ]
150 # where to store user's config
151 config_storage="CONFIG"
156 configKeys=[ ('svnpath',"Enter your toplevel svnpath",
157 "svn+ssh://%s@svn.planet-lab.org/svn/"%commands.getoutput("id -un")),
158 ("build", "Enter the name of your build module","build"),
159 ('username',"Enter your firstname and lastname for changelogs",""),
160 ("email","Enter your email address for changelogs",""),
164 def prompt_config ():
165 for (key,message,default) in Module.configKeys:
166 Module.config[key]=""
167 while not Module.config[key]:
168 Module.config[key]=raw_input("%s [%s] : "%(message,default)).strip() or default
171 # for parsing module spec name:branch
172 matcher_branch_spec=re.compile("\A(?P<name>[\w\.-]+):(?P<branch>[\w\.-]+)\Z")
173 # special form for tagged module - for Build
174 matcher_tag_spec=re.compile("\A(?P<name>[\w-]+)@(?P<tagname>[\w\.-]+)\Z")
176 matcher_rpm_define=re.compile("%(define|global)\s+(\S+)\s+(\S*)\s*")
178 def __init__ (self,module_spec,options):
180 attempt=Module.matcher_branch_spec.match(module_spec)
182 self.name=attempt.group('name')
183 self.branch=attempt.group('branch')
185 attempt=Module.matcher_tag_spec.match(module_spec)
187 self.name=attempt.group('name')
188 self.tagname=attempt.group('tagname')
190 self.name=module_spec
193 self.module_dir="%s/%s"%(options.workdir,self.name)
195 def friendly_name (self):
196 if hasattr(self,'branch'):
197 return "%s:%s"%(self.name,self.branch)
198 elif hasattr(self,'tagname'):
199 return "%s@%s"%(self.name,self.tagname)
204 if hasattr(self,'branch'):
205 return "%s/branches/%s"%(self.module_dir,self.branch)
206 elif hasattr(self,'tagname'):
207 return "%s/tags/%s"%(self.module_dir,self.tagname)
209 return "%s/trunk"%(self.module_dir)
212 return "%s/tags"%(self.module_dir)
214 def run (self,command):
215 return Command(command,self.options).run()
216 def run_fatal (self,command):
217 return Command(command,self.options).run_fatal()
218 def run_prompt (self,message,command):
219 if not self.options.verbose:
221 choice=prompt(message,True,('s','how'))
225 elif choice is False:
228 print 'About to run:',command
230 question=message+" - want to run " + command
231 if prompt(question,True):
235 def init_homedir (options):
236 topdir=options.workdir
237 if options.verbose and options.mode not in Main.silent_modes:
238 print 'Checking for',topdir
239 storage="%s/%s"%(topdir,Module.config_storage)
240 # sanity check. Either the topdir exists AND we have a config/storage
241 # or topdir does not exist and we create it
242 # to avoid people use their own daily svn repo
243 if os.path.isdir(topdir) and not os.path.isfile(storage):
244 print """The directory %s exists and has no CONFIG file
245 If this is your regular working directory, please provide another one as the
246 module-* commands need a fresh working dir. Make sure that you do not use
247 that for other purposes than tagging"""%topdir
249 if not os.path.isdir (topdir):
250 print "Cannot find",topdir,"let's create it"
251 Module.prompt_config()
252 print "Checking ...",
253 Command("svn co -N %s %s"%(Module.config['svnpath'],topdir),options).run_fatal()
254 Command("svn co -N %s/%s %s/%s"%(Module.config['svnpath'],
255 Module.config['build'],
257 Module.config['build']),options).run_fatal()
262 for (key,message,default) in Module.configKeys:
263 f.write("%s=%s\n"%(key,Module.config[key]))
266 print 'Stored',storage
267 Command("cat %s"%storage,options).run()
271 for line in f.readlines():
272 (key,value)=re.compile("^(.+)=(.+)$").match(line).groups()
273 Module.config[key]=value
275 if options.verbose and options.mode not in Main.silent_modes:
276 print '******** Using config'
277 for (key,message,default) in Module.configKeys:
278 print '\t',key,'=',Module.config[key]
280 def init_module_dir (self):
281 if self.options.verbose:
282 print 'Checking for',self.module_dir
283 if not os.path.isdir (self.module_dir):
284 self.run_fatal("svn update -N %s"%self.module_dir)
285 if not os.path.isdir (self.module_dir):
286 raise Exception, 'Cannot find %s - check module name'%self.module_dir
288 def init_subdir (self,fullpath):
289 if self.options.verbose:
290 print 'Checking for',fullpath
291 if not os.path.isdir (fullpath):
292 self.run_fatal("svn update -N %s"%fullpath)
294 def revert_subdir (self,fullpath):
295 if self.options.fast_checks:
296 if self.options.verbose: print 'Skipping revert of %s'%fullpath
298 if self.options.verbose:
299 print 'Checking whether',fullpath,'needs being reverted'
300 if Svnpath(fullpath,self.options).dir_needs_revert():
301 self.run_fatal("svn revert -R %s"%fullpath)
303 def update_subdir (self,fullpath):
304 if self.options.fast_checks:
305 if self.options.verbose: print 'Skipping update of %s'%fullpath
307 if self.options.verbose:
308 print 'Updating',fullpath
309 self.run_fatal("svn update -N %s"%fullpath)
311 def init_edge_dir (self):
312 # if branch, edge_dir is two steps down
313 if hasattr(self,'branch'):
314 self.init_subdir("%s/branches"%self.module_dir)
315 elif hasattr(self,'tagname'):
316 self.init_subdir("%s/tags"%self.module_dir)
317 self.init_subdir(self.edge_dir())
319 def revert_edge_dir (self):
320 self.revert_subdir(self.edge_dir())
322 def update_edge_dir (self):
323 self.update_subdir(self.edge_dir())
325 def main_specname (self):
326 attempt="%s/%s.spec"%(self.edge_dir(),self.name)
327 if os.path.isfile (attempt):
331 return glob("%s/*.spec"%self.edge_dir())[0]
333 raise Exception, 'Cannot guess specfile for module %s'%self.name
335 def all_specnames (self):
336 return glob("%s/*.spec"%self.edge_dir())
338 def parse_spec (self, specfile, varnames):
339 if self.options.verbose:
340 print 'Parsing',specfile,
346 for line in f.readlines():
347 attempt=Module.matcher_rpm_define.match(line)
349 (define,var,value)=attempt.groups()
353 if self.options.debug:
354 print 'found',len(result),'keys'
355 for (k,v) in result.iteritems():
359 # stores in self.module_name_varname the rpm variable to be used for the module's name
360 # and the list of these names in self.varnames
361 def spec_dict (self):
362 specfile=self.main_specname()
363 redirector_keys = [ varname for (varname,default) in Module.redirectors]
364 redirect_dict = self.parse_spec(specfile,redirector_keys)
365 if self.options.debug:
366 print '1st pass parsing done, redirect_dict=',redirect_dict
368 for (varname,default) in Module.redirectors:
369 if redirect_dict.has_key(varname):
370 setattr(self,varname,redirect_dict[varname])
371 varnames += [redirect_dict[varname]]
373 setattr(self,varname,default)
374 varnames += [ default ]
375 self.varnames = varnames
376 result = self.parse_spec (specfile,self.varnames)
377 if self.options.debug:
378 print '2st pass parsing done, varnames=',varnames,'result=',result
381 def patch_spec_var (self, patch_dict,define_missing=False):
382 for specfile in self.all_specnames():
383 # record the keys that were changed
384 changed = dict ( [ (x,False) for x in patch_dict.keys() ] )
385 newspecfile=specfile+".new"
386 if self.options.verbose:
387 print 'Patching',specfile,'for',patch_dict.keys()
389 new=open(newspecfile,"w")
391 for line in spec.readlines():
392 attempt=Module.matcher_rpm_define.match(line)
394 (define,var,value)=attempt.groups()
395 if var in patch_dict.keys():
396 if self.options.debug:
397 print 'rewriting %s as %s'%(var,patch_dict[var])
398 new.write('%%%s %s %s\n'%(define,var,patch_dict[var]))
403 for (key,was_changed) in changed.iteritems():
405 if self.options.debug:
406 print 'rewriting missing %s as %s'%(key,patch_dict[key])
407 new.write('\n%%define %s %s\n'%(key,patch_dict[key]))
410 os.rename(newspecfile,specfile)
412 def unignored_lines (self, logfile):
414 exclude="Tagging module %s"%self.name
415 white_line_matcher = re.compile("\A\s*\Z")
416 for logline in file(logfile).readlines():
417 if logline.strip() == Module.svn_magic_line:
419 if logline.find(exclude) >= 0:
421 elif white_line_matcher.match(logline):
424 result.append(logline.strip()+'\n')
427 def insert_changelog (self, logfile, oldtag, newtag):
428 for specfile in self.all_specnames():
429 newspecfile=specfile+".new"
430 if self.options.verbose:
431 print 'Inserting changelog from %s into %s'%(logfile,specfile)
433 new=open(newspecfile,"w")
434 for line in spec.readlines():
436 if re.compile('%changelog').match(line):
437 dateformat="* %a %b %d %Y"
438 datepart=time.strftime(dateformat)
439 logpart="%s <%s> - %s"%(Module.config['username'],
440 Module.config['email'],
442 new.write(datepart+" "+logpart+"\n")
443 for logline in self.unignored_lines(logfile):
444 new.write("- " + logline)
448 os.rename(newspecfile,specfile)
450 def show_dict (self, spec_dict):
451 if self.options.verbose:
452 for (k,v) in spec_dict.iteritems():
456 return "%s/%s"%(Module.config['svnpath'],self.name)
459 if hasattr(self,'branch'):
460 return "%s/branches/%s"%(self.mod_url(),self.branch)
461 elif hasattr(self,'tagname'):
462 return "%s/tags/%s"%(self.mod_url(),self.tagname)
464 return "%s/trunk"%(self.mod_url())
466 def tag_name (self, spec_dict):
468 return "%s-%s-%s"%(#spec_dict[self.module_name_varname],
470 spec_dict[self.module_version_varname],
471 spec_dict[self.module_taglevel_varname])
473 raise Exception, 'Something is wrong with module %s, cannot determine %s - exiting'%(self.name,err)
475 def tag_url (self, spec_dict):
476 return "%s/tags/%s"%(self.mod_url(),self.tag_name(spec_dict))
478 def check_svnpath_exists (self, url, message):
479 if self.options.fast_checks:
481 if self.options.verbose:
482 print 'Checking url (%s) %s'%(url,message),
483 ok=Svnpath(url,self.options).url_exists()
485 if self.options.verbose: print 'exists - OK'
487 if self.options.verbose: print 'KO'
488 raise Exception, 'Could not find %s URL %s'%(message,url)
490 def check_svnpath_not_exists (self, url, message):
491 if self.options.fast_checks:
493 if self.options.verbose:
494 print 'Checking url (%s) %s'%(url,message),
495 ok=not Svnpath(url,self.options).url_exists()
497 if self.options.verbose: print 'does not exist - OK'
499 if self.options.verbose: print 'KO'
500 raise Exception, '%s URL %s already exists - exiting'%(message,url)
502 # locate specfile, parse it, check it and show values
504 ##############################
505 def do_version (self):
506 self.init_module_dir()
508 self.revert_edge_dir()
509 self.update_edge_dir()
510 spec_dict = self.spec_dict()
511 for varname in self.varnames:
512 if not spec_dict.has_key(varname):
513 print 'Could not find %%define for %s'%varname
516 print "%-16s %s"%(varname,spec_dict[varname])
517 if self.options.show_urls:
518 print "%-16s %s"%('edge url',self.edge_url())
519 print "%-16s %s"%('latest tag url',self.tag_url(spec_dict))
520 if self.options.verbose:
521 print "%-16s %s"%('main specfile:',self.main_specname())
522 print "%-16s %s"%('specfiles:',self.all_specnames())
524 ##############################
526 # print 'verbose',self.options.verbose
527 # print 'list_tags',self.options.list_tags
528 # print 'list_branches',self.options.list_branches
529 # print 'all_modules',self.options.all_modules
531 (verbose,branches,pattern,exact) = (self.options.verbose,self.options.list_branches,
532 self.options.list_pattern,self.options.list_exact)
536 if hasattr(self,'branch'):
540 if verbose: grep="%s/$"%exact
541 else: grep="^%s$"%exact
544 extra_command=" | grep %s"%grep
545 extra_message=" matching %s"%grep
548 message="==================== tags for %s"%self.friendly_name()
550 if verbose: command+="--verbose "
551 command += "%s/tags"%self.mod_url()
552 command += extra_command
553 message += extra_message
554 if verbose: print message
558 message="==================== branches for %s"%self.friendly_name()
560 if verbose: command+="--verbose "
561 command += "%s/branches"%self.mod_url()
562 command += extra_command
563 message += extra_message
564 if verbose: print message
567 ##############################
568 sync_warning="""*** WARNING
569 The module-sync function has the following limitations
570 * it does not handle changelogs
571 * it does not scan the -tags*.mk files to adopt the new tags"""
574 if self.options.verbose:
575 print Module.sync_warning
576 if not prompt('Want to proceed anyway'):
579 self.init_module_dir()
581 self.revert_edge_dir()
582 self.update_edge_dir()
583 spec_dict = self.spec_dict()
585 edge_url=self.edge_url()
586 tag_name=self.tag_name(spec_dict)
587 tag_url=self.tag_url(spec_dict)
588 # check the tag does not exist yet
589 self.check_svnpath_not_exists(tag_url,"new tag")
591 if self.options.message:
592 svnopt='--message "%s"'%self.options.message
594 svnopt='--editor-cmd=%s'%self.options.editor
595 self.run_prompt("Create initial tag",
596 "svn copy %s %s %s"%(svnopt,edge_url,tag_url))
598 ##############################
599 def do_diff (self,compute_only=False):
600 self.init_module_dir()
602 self.revert_edge_dir()
603 self.update_edge_dir()
604 spec_dict = self.spec_dict()
605 self.show_dict(spec_dict)
607 edge_url=self.edge_url()
608 tag_url=self.tag_url(spec_dict)
609 self.check_svnpath_exists(edge_url,"edge track")
610 self.check_svnpath_exists(tag_url,"latest tag")
611 command="svn diff %s %s"%(tag_url,edge_url)
613 if self.options.verbose:
614 print 'Getting diff with %s'%command
615 diff_output = Command(command,self.options).output_of()
616 # if used as a utility
618 return (spec_dict,edge_url,tag_url,diff_output)
619 # otherwise print the result
620 if self.options.list:
624 if not self.options.only or diff_output:
625 print 'x'*30,'module',self.friendly_name()
626 print 'x'*20,'<',tag_url
627 print 'x'*20,'>',edge_url
630 ##############################
631 # using fine_grain means replacing only those instances that currently refer to this tag
632 # otherwise, <module>-SVNPATH is replaced unconditionnally
633 def patch_tags_file (self, tagsfile, oldname, newname,fine_grain=True):
634 newtagsfile=tagsfile+".new"
636 new=open(newtagsfile,"w")
639 # fine-grain : replace those lines that refer to oldname
641 if self.options.verbose:
642 print 'Replacing %s into %s\n\tin %s .. '%(oldname,newname,tagsfile),
643 matcher=re.compile("^(.*)%s(.*)"%oldname)
644 for line in tags.readlines():
645 if not matcher.match(line):
648 (begin,end)=matcher.match(line).groups()
649 new.write(begin+newname+end+"\n")
651 # brute-force : change uncommented lines that define <module>-SVNPATH
653 if self.options.verbose:
654 print 'Setting %s-SVNPATH for using %s\n\tin %s .. '%(self.name,newname,tagsfile),
655 pattern="\A\s*%s-SVNPATH\s*(=|:=)\s*(?P<url_main>[^\s]+)/%s/[^\s]+"\
656 %(self.name,self.name)
657 matcher_module=re.compile(pattern)
658 for line in tags.readlines():
659 attempt=matcher_module.match(line)
661 svnpath="%s-SVNPATH"%self.name
662 replacement = "%-32s:= %s/%s/tags/%s\n"%(svnpath,attempt.group('url_main'),self.name,newname)
663 new.write(replacement)
669 os.rename(newtagsfile,tagsfile)
670 if self.options.verbose: print "%d changes"%matches
674 self.init_module_dir()
676 self.revert_edge_dir()
677 self.update_edge_dir()
679 spec_dict = self.spec_dict()
680 self.show_dict(spec_dict)
683 edge_url=self.edge_url()
684 old_tag_name = self.tag_name(spec_dict)
685 old_tag_url=self.tag_url(spec_dict)
686 if (self.options.new_version):
687 # new version set on command line
688 spec_dict[self.module_version_varname] = self.options.new_version
689 spec_dict[self.module_taglevel_varname] = 0
692 new_taglevel = str ( int (spec_dict[self.module_taglevel_varname]) + 1)
693 spec_dict[self.module_taglevel_varname] = new_taglevel
696 new_tag_name = self.tag_name(spec_dict)
697 new_tag_url=self.tag_url(spec_dict)
698 self.check_svnpath_exists (edge_url,"edge track")
699 self.check_svnpath_exists (old_tag_url,"previous tag")
700 self.check_svnpath_not_exists (new_tag_url,"new tag")
703 diff_output=Command("svn diff %s %s"%(old_tag_url,edge_url),
704 self.options).output_of()
705 if len(diff_output) == 0:
706 if not prompt ("No pending difference in module %s, want to tag anyway"%self.name,False):
709 # side effect in trunk's specfile
710 self.patch_spec_var(spec_dict)
712 # prepare changelog file
713 # we use the standard subversion magic string (see svn_magic_line)
714 # so we can provide useful information, such as version numbers and diff
716 changelog="/tmp/%s-%d.txt"%(self.name,os.getpid())
717 file(changelog,"w").write("""Tagging module %s - %s
720 Please write a changelog for this new tag in the section above
721 """%(self.name,new_tag_name,Module.svn_magic_line))
723 if not self.options.verbose or prompt('Want to see diffs while writing changelog',True):
724 file(changelog,"a").write('DIFF=========\n' + diff_output)
726 if self.options.debug:
730 self.run("%s %s"%(self.options.editor,changelog))
731 # insert changelog in spec
732 if self.options.changelog:
733 self.insert_changelog (changelog,old_tag_name,new_tag_name)
737 buildname=Module.config['build']
740 if self.options.build_branch:
741 buildname+=":"+self.options.build_branch
742 build = Module(buildname,self.options)
743 build.init_module_dir()
744 build.init_edge_dir()
745 build.revert_edge_dir()
746 build.update_edge_dir()
748 tagsfiles=glob(build.edge_dir()+"/*-tags*.mk")
749 tagsdict=dict( [ (x,'todo') for x in tagsfiles ] )
752 for (tagsfile,status) in tagsdict.iteritems():
753 basename=os.path.basename(tagsfile)
754 print ".................... Dealing with %s"%basename
755 while tagsdict[tagsfile] == 'todo' :
756 choice = prompt ("insert %s in %s "%(new_tag_name,basename),default_answer,
757 [ ('y','es'), ('n', 'ext'), ('f','orce'),
758 ('d','iff'), ('r','evert'), ('h','elp') ] ,
761 self.patch_tags_file(tagsfile,old_tag_name,new_tag_name,fine_grain=True)
763 print 'Done with %s'%os.path.basename(tagsfile)
764 tagsdict[tagsfile]='done'
766 self.patch_tags_file(tagsfile,old_tag_name,new_tag_name,fine_grain=False)
768 self.run("svn diff %s"%tagsfile)
770 self.run("svn revert %s"%tagsfile)
773 print """y: change %(name)s-SVNPATH only if it currently refers to %(old_tag_name)s
774 f: unconditionnally change any line setting %(name)s-SVNPATH to using %(new_tag_name)s
775 d: show current diff for this tag file
776 r: revert that tag file
777 n: move to next file"""%locals()
779 if prompt("Want to review changes on tags files",False):
780 tagsdict = dict ( [ (x, 'todo') for tagsfile in tagsfiles ] )
786 paths += self.edge_dir() + " "
787 paths += build.edge_dir() + " "
788 self.run_prompt("Review module and build","svn diff " + paths)
789 self.run_prompt("Commit module and build","svn commit --file %s %s"%(changelog,paths))
790 self.run_prompt("Create tag","svn copy --file %s %s %s"%(changelog,edge_url,new_tag_url))
792 if self.options.debug:
793 print 'Preserving',changelog
797 ##############################
798 def do_branch (self):
800 # save self.branch if any, as a hint for the new branch
801 # do this before anything else and restore .branch to None,
802 # as this is part of the class's logic
804 if hasattr(self,'branch'):
805 new_trunk_name=self.branch
807 elif self.options.new_version:
808 new_trunk_name = self.options.new_version
810 # compute diff - a way to initialize the whole stuff
811 # do_diff already does edge_dir initialization
812 # and it checks that edge_url and tag_url exist as well
813 (spec_dict,edge_url,tag_url,diff_listing) = self.do_diff(compute_only=True)
815 # the version name in the trunk becomes the new branch name
816 branch_name = spec_dict[self.module_version_varname]
818 # figure new branch name (the one for the trunk) if not provided on the command line
819 if not new_trunk_name:
820 # heuristic is to assume 'version' is a dot-separated name
821 # we isolate the rightmost part and try incrementing it by 1
822 version=spec_dict[self.module_version_varname]
824 m=re.compile("\A(?P<leftpart>.+)\.(?P<rightmost>[^\.]+)\Z")
825 (leftpart,rightmost)=m.match(version).groups()
826 incremented = int(rightmost)+1
827 new_trunk_name="%s.%d"%(leftpart,incremented)
829 raise Exception, 'Cannot figure next branch name from %s - exiting'%version
831 # record starting point tagname
832 latest_tag_name = self.tag_name(spec_dict)
835 print "Using starting point %s (%s)"%(tag_url,latest_tag_name)
836 print "Creating branch %s & moving trunk to %s"%(branch_name,new_trunk_name)
839 # print warning if pending diffs
841 print """*** WARNING : Module %s has pending diffs on its trunk
842 It is safe to proceed, but please note that branch %s
843 will be based on latest tag %s and *not* on the current trunk"""%(self.name,branch_name,latest_tag_name)
845 answer = prompt ('Are you sure you want to proceed with branching',True,('d','iff'))
848 elif answer is False:
849 raise Exception,"User quit"
851 print '<<<< %s'%tag_url
852 print '>>>> %s'%edge_url
855 branch_url = "%s/%s/branches/%s"%(Module.config['svnpath'],self.name,branch_name)
856 self.check_svnpath_not_exists (branch_url,"new branch")
859 spec_dict[self.module_version_varname]=new_trunk_name
860 spec_dict[self.module_taglevel_varname]='0'
861 # remember this in the trunk for easy location of the current branch
862 spec_dict['module_current_branch']=branch_name
863 self.patch_spec_var(spec_dict,True)
865 # create commit log file
866 tmp="/tmp/branching-%d"%os.getpid()
868 f.write("Branch %s for module %s created (as new trunk) from tag %s\n"%(new_trunk_name,self.name,latest_tag_name))
871 # we're done, let's commit the stuff
872 command="svn diff %s"%self.edge_dir()
873 self.run_prompt("Review changes in trunk",command)
874 command="svn copy --file %s %s %s"%(tmp,self.edge_url(),branch_url)
875 self.run_prompt("Create branch",command)
876 command="svn commit --file %s %s"%(tmp,self.edge_dir())
877 self.run_prompt("Commit trunk",command)
878 new_tag_url=self.tag_url(spec_dict)
879 command="svn copy --file %s %s %s"%(tmp,self.edge_url(),new_tag_url)
880 self.run_prompt("Create initial tag in trunk",command)
883 ##############################
886 def __init__(self, package, module, svnpath, spec):
891 self.specpath="%s/%s"%(svnpath,spec)
892 self.basename=os.path.basename(svnpath)
894 # returns a http URL to the trac path where full diff can be viewed (between self and pkg)
895 # typically http://svn.planet-lab.org/changeset?old_path=Monitor%2Ftags%2FMonitor-1.0-7&new_path=Monitor%2Ftags%2FMonitor-1.0-13
896 # xxx quick & dirty: rough url parsing
897 def trac_full_diff (self, pkg):
898 matcher=re.compile("\A(?P<method>.*)://(?P<hostname>[^/]+)/(svn/)?(?P<path>.*)\Z")
899 self_match=matcher.match(self.svnpath)
900 pkg_match=matcher.match(pkg.svnpath)
901 if self_match and pkg_match:
902 (method,hostname,svn,path)=self_match.groups()
903 self_path=path.replace("/","%2F")
904 pkg_path=pkg_match.group('path').replace("/","%2F")
905 return "%s://%s/changeset?old_path=%s&new_path=%s"%(method,hostname,self_path,pkg_path)
910 return "[%s %s] [%s (spec)]"%(self.svnpath,self.basename,self.specpath)
912 class Build (Module):
914 # we cannot get build's svnpath as for other packages as we'd get something in svn+ssh
916 def __init__ (self, buildtag,options):
917 self.buildtag=buildtag
918 # if the buildtag start with a : (to use a branch rather than a tag)
919 if buildtag.find(':') == 0 :
920 module_name="build%(buildtag)s"%locals()
921 self.display=buildtag[1:]
922 self.svnpath="http://svn.planet-lab.org/svn/build/branches/%s"%self.display
924 module_name="build@%(buildtag)s"%locals()
925 self.display=buildtag
926 self.svnpath="http://svn.planet-lab.org/svn/build/tags/%s"%self.buildtag
927 Module.__init__(self,module_name,options)
930 def get_distro_from_distrotag (distrotag):
931 # mhh: remove -tag* from distrotags to get distro
932 n=distrotag.find('-tag')
938 def get_packages (self,distrotag):
940 distro=Build.get_distro_from_distrotag(distrotag)
943 make_options="--no-print-directory -C %s stage1=true PLDISTRO=%s PLDISTROTAGS=%s 2> /dev/null"%(self.edge_dir(),distro,distrotag)
944 command="make %s packages"%make_options
945 make_packages=Command(command,self.options).output_of()
946 pkg_line=re.compile("\Apackage=(?P<package>[^\s]+)\s+ref_module=(?P<module>[^\s]+)\s.*\Z")
947 for line in make_packages.split("\n"):
950 attempt=pkg_line.match(line)
951 if line and not attempt:
953 print "WARNING: line not understood from make packages"
954 print "in dir %s"%self.edge_dir
955 print "with options",make_options
959 (package,module) = (attempt.group('package'),attempt.group('module'))
960 command="make %s +%s-SVNPATH"%(make_options,module)
961 svnpath=Command(command,self.options).output_of().strip()
962 command="make %s +%s-SPEC"%(make_options,package)
963 spec=Command(command,self.options).output_of().strip()
964 result[package]=Package(package,module,svnpath,spec)
967 def get_distrotags (self):
968 return [os.path.basename(p) for p in glob("%s/*tags*mk"%self.edge_dir())]
975 def key(self, frompath,topath):
976 return frompath+'-to-'+topath
978 def fetch (self, frompath, topath):
979 key=self.key(frompath,topath)
980 if not self._cache.has_key(key):
982 return self._cache[key]
984 def store (self, frompath, topath, diff):
985 key=self.key(frompath,topath)
986 self._cache[key]=diff
990 # header in diff output
991 discard_matcher=re.compile("\A(\+\+\+|---).*")
994 def do_changelog (buildtag_new,buildtag_old,options):
998 (build_new,build_old) = (Build (buildtag_new,options), Build (buildtag_old,options))
999 print "= build tag %s to %s = #build-%s"%(build_old.display,build_new.display,build_new.display)
1000 for b in (build_new,build_old):
1004 # find out the tags files that are common, unless option was specified
1005 if options.distrotags:
1006 distrotags=options.distrotags
1008 distrotags_new=build_new.get_distrotags()
1009 distrotags_old=build_old.get_distrotags()
1010 distrotags = list(set(distrotags_new).intersection(set(distrotags_old)))
1012 if options.verbose: print "Found distrotags",distrotags
1013 first_distrotag=True
1014 diffcache = DiffCache()
1015 for distrotag in distrotags:
1016 distro=Build.get_distro_from_distrotag(distrotag)
1020 first_distrotag=False
1023 print '== distro %s (%s to %s) == #distro-%s-%s'%(distrotag,build_old.display,build_new.display,distro,build_new.display)
1024 print ' * from %s/%s'%(build_old.svnpath,distrotag)
1025 print ' * to %s/%s'%(build_new.svnpath,distrotag)
1027 # parse make packages
1028 packages_new=build_new.get_packages(distrotag)
1029 pnames_new=set(packages_new.keys())
1030 if options.verbose: print 'got packages for ',build_new.display
1031 packages_old=build_old.get_packages(distrotag)
1032 pnames_old=set(packages_old.keys())
1033 if options.verbose: print 'got packages for ',build_old.display
1035 # get created, deprecated, and preserved package names
1036 pnames_created = list(pnames_new-pnames_old)
1037 pnames_created.sort()
1038 pnames_deprecated = list(pnames_old-pnames_new)
1039 pnames_deprecated.sort()
1040 pnames = list(pnames_new.intersection(pnames_old))
1043 if options.verbose: print "Found new/deprecated/preserved pnames",pnames_new,pnames_deprecated,pnames
1045 # display created and deprecated
1046 for name in pnames_created:
1047 print '=== %s : new package %s -- appeared in %s === #package-%s-%s-%s'%(
1048 distrotag,name,build_new.display,name,distro,build_new.display)
1049 pobj=packages_new[name]
1050 print ' * %s'%pobj.details()
1051 for name in pnames_deprecated:
1052 print '=== %s : package %s -- deprecated, last occurrence in %s === #package-%s-%s-%s'%(
1053 distrotag,name,build_old.display,name,distro,build_new.display)
1054 pobj=packages_old[name]
1055 if not pobj.svnpath:
1056 print ' * codebase stored in CVS, specfile is %s'%pobj.spec
1058 print ' * %s'%pobj.details()
1060 # display other packages
1062 (pobj_new,pobj_old)=(packages_new[name],packages_old[name])
1063 if options.verbose: print "Dealing with package",name
1064 if pobj_old.specpath == pobj_new.specpath:
1066 specdiff = diffcache.fetch(pobj_old.specpath,pobj_new.specpath)
1067 if specdiff is None:
1068 command="svn diff %s %s"%(pobj_old.specpath,pobj_new.specpath)
1069 specdiff=Command(command,options).output_of()
1070 diffcache.store(pobj_old.specpath,pobj_new.specpath,specdiff)
1072 if options.verbose: print 'got diff from cache'
1075 print '=== %s - %s to %s : package %s === #package-%s-%s-%s'%(
1076 distrotag,build_old.display,build_new.display,name,name,distro,build_new.display)
1077 print ' * from %s to %s'%(pobj_old.details(),pobj_new.details())
1078 trac_diff_url=pobj_old.trac_full_diff(pobj_new)
1080 print ' * [%s View full diff]'%trac_diff_url
1082 for line in specdiff.split('\n'):
1085 if Release.discard_matcher.match(line):
1087 if line[0] in ['@']:
1089 elif line[0] in ['+','-']:
1093 ##############################
1096 module_usage="""Usage: %prog [options] module_desc [ .. module_desc ]
1097 module-tools : a set of tools to manage subversion tags and specfile
1098 requires the specfile to either
1099 * define *version* and *taglevel*
1101 * define redirection variables module_version_varname / module_taglevel_varname
1103 by default, the trunk of modules is taken into account
1104 in this case, just mention the module name as <module_desc>
1106 if you wish to work on a branch rather than on the trunk,
1107 you can use something like e.g. Mom:2.1 as <module_desc>
1109 release_usage="""Usage: %prog [options] tag1 .. tagn
1110 Extract release notes from the changes in specfiles between several build tags, latest first
1112 release-changelog 4.2-rc25 4.2-rc24 4.2-rc23 4.2-rc22
1113 You can refer to a (build) branch by prepending a colon, like in
1114 release-changelog :4.2 4.2-rc25
1116 common_usage="""More help:
1117 see http://svn.planet-lab.org/wiki/ModuleTools"""
1120 'list' : "displays a list of available tags or branches",
1121 'version' : "check latest specfile and print out details",
1122 'diff' : "show difference between module (trunk or branch) and latest tag",
1123 'tag' : """increment taglevel in specfile, insert changelog in specfile,
1124 create new tag and and monitor its adoption in build/*-tags*.mk""",
1125 'branch' : """create a branch for this module, from the latest tag on the trunk,
1126 and change trunk's version number to reflect the new branch name;
1127 you can specify the new branch name by using module:branch""",
1128 'sync' : """create a tag from the module
1129 this is a last resort option, mostly for repairs""",
1130 'changelog' : """extract changelog between build tags
1131 expected arguments are a list of tags""",
1134 silent_modes = ['list']
1135 release_modes = ['changelog']
1138 def optparse_list (option, opt, value, parser):
1140 setattr(parser.values,option.dest,getattr(parser.values,option.dest)+value.split())
1142 setattr(parser.values,option.dest,value.split())
1147 for function in Main.modes.keys():
1148 if sys.argv[0].find(function) >= 0:
1152 print "Unsupported command",sys.argv[0]
1153 print "Supported commands:" + Modes.modes.keys.join(" ")
1156 if mode not in Main.release_modes:
1157 usage = Main.module_usage
1158 usage += Main.common_usage
1159 usage += "\nmodule-%s : %s"%(mode,Main.modes[mode])
1161 usage = Main.release_usage
1162 usage += Main.common_usage
1164 parser=OptionParser(usage=usage,version=subversion_id)
1167 parser.add_option("-b","--branches",action="store_true",dest="list_branches",default=False,
1168 help="list branches")
1169 parser.add_option("-t","--tags",action="store_false",dest="list_branches",
1171 parser.add_option("-m","--match",action="store",dest="list_pattern",default=None,
1172 help="grep pattern for filtering output")
1173 parser.add_option("-x","--exact-match",action="store",dest="list_exact",default=None,
1174 help="exact grep pattern for filtering output")
1175 if mode == "tag" or mode == 'branch':
1176 parser.add_option("-s","--set-version",action="store",dest="new_version",default=None,
1177 help="set new version and reset taglevel to 0")
1179 parser.add_option("-c","--no-changelog", action="store_false", dest="changelog", default=True,
1180 help="do not update changelog section in specfile when tagging")
1181 parser.add_option("-b","--build-branch", action="store", dest="build_branch", default=None,
1182 help="specify a build branch; used for locating the *tags*.mk files where adoption is to take place")
1183 if mode == "tag" or mode == "sync" :
1184 parser.add_option("-e","--editor", action="store", dest="editor", default=default_editor(),
1185 help="specify editor")
1187 parser.add_option("-m","--message", action="store", dest="message", default=None,
1188 help="specify log message")
1190 parser.add_option("-o","--only", action="store_true", dest="only", default=False,
1191 help="report diff only for modules that exhibit differences")
1193 parser.add_option("-l","--list", action="store_true", dest="list", default=False,
1194 help="just list modules that exhibit differences")
1196 if mode == 'version':
1197 parser.add_option("-u","--url", action="store_true", dest="show_urls", default=False,
1198 help="display URLs")
1200 default_modules_list=os.path.dirname(sys.argv[0])+"/modules.list"
1201 if mode not in Main.release_modes:
1202 parser.add_option("-a","--all",action="store_true",dest="all_modules",default=False,
1203 help="run on all modules as found in %s"%default_modules_list)
1204 parser.add_option("-f","--file",action="store",dest="modules_list",default=None,
1205 help="run on all modules found in specified file")
1207 parser.add_option("-n","--dry-run",action="store_true",dest="dry_run",default=False,
1208 help="dry run - shell commands are only displayed")
1209 parser.add_option("-t","--distrotags",action="callback",callback=Main.optparse_list, dest="distrotags",
1210 default=[], nargs=1,type="string",
1211 help="""specify distro-tags files, e.g. onelab-tags-4.2.mk
1212 -- can be set multiple times, or use quotes""")
1214 parser.add_option("-w","--workdir", action="store", dest="workdir",
1215 default="%s/%s"%(os.getenv("HOME"),"modules"),
1216 help="""name for dedicated working dir - defaults to ~/modules
1217 ** THIS MUST NOT ** be your usual working directory""")
1218 parser.add_option("-F","--fast-checks",action="store_true",dest="fast_checks",default=False,
1219 help="skip safety checks, such as svn updates -- use with care")
1221 # default verbosity depending on function - temp
1222 verbose_modes= ['tag','sync']
1224 if mode not in verbose_modes:
1225 parser.add_option("-v","--verbose", action="store_true", dest="verbose", default=False,
1226 help="run in verbose mode")
1228 parser.add_option("-q","--quiet", action="store_false", dest="verbose", default=True,
1229 help="run in quiet (non-verbose) mode")
1230 # parser.add_option("-d","--debug", action="store_true", dest="debug", default=False,
1231 # help="debug mode - mostly more verbose")
1232 (options, args) = parser.parse_args()
1234 if not hasattr(options,'dry_run'):
1235 options.dry_run=False
1238 ########## release-*
1239 if mode in Main.release_modes :
1240 ########## changelog
1244 Module.init_homedir(options)
1245 for n in range(len(args)-1):
1246 [t_new,t_old]=args[n:n+2]
1247 Release.do_changelog (t_new,t_old,options)
1251 if options.all_modules:
1252 options.modules_list=default_modules_list
1253 if options.modules_list:
1254 args=Command("grep -v '#' %s"%options.modules_list,options).output_of().split()
1258 Module.init_homedir(options)
1259 for modname in args:
1260 module=Module(modname,options)
1261 if len(args)>1 and mode not in Main.silent_modes:
1262 print '========================================',module.friendly_name()
1263 # call the method called do_<mode>
1264 method=Module.__dict__["do_%s"%mode]
1268 print 'Skipping failed %s: '%modname,e
1270 ####################
1271 if __name__ == "__main__" :
1274 except KeyboardInterrupt: