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--"
145 setting_tag_format = "Setting tag %s"
147 redirectors=[ # ('module_name_varname','name'),
148 ('module_version_varname','version'),
149 ('module_taglevel_varname','taglevel'), ]
151 # where to store user's config
152 config_storage="CONFIG"
157 configKeys=[ ('svnpath',"Enter your toplevel svnpath",
158 "svn+ssh://%s@svn.planet-lab.org/svn/"%commands.getoutput("id -un")),
159 ("build", "Enter the name of your build module","build"),
160 ('username',"Enter your firstname and lastname for changelogs",""),
161 ("email","Enter your email address for changelogs",""),
165 def prompt_config ():
166 for (key,message,default) in Module.configKeys:
167 Module.config[key]=""
168 while not Module.config[key]:
169 Module.config[key]=raw_input("%s [%s] : "%(message,default)).strip() or default
172 # for parsing module spec name:branch
173 matcher_branch_spec=re.compile("\A(?P<name>[\w\.-]+):(?P<branch>[\w\.-]+)\Z")
174 # special form for tagged module - for Build
175 matcher_tag_spec=re.compile("\A(?P<name>[\w-]+)@(?P<tagname>[\w\.-]+)\Z")
177 matcher_rpm_define=re.compile("%(define|global)\s+(\S+)\s+(\S*)\s*")
179 def __init__ (self,module_spec,options):
181 attempt=Module.matcher_branch_spec.match(module_spec)
183 self.name=attempt.group('name')
184 self.branch=attempt.group('branch')
186 attempt=Module.matcher_tag_spec.match(module_spec)
188 self.name=attempt.group('name')
189 self.tagname=attempt.group('tagname')
191 self.name=module_spec
194 self.module_dir="%s/%s"%(options.workdir,self.name)
196 def friendly_name (self):
197 if hasattr(self,'branch'):
198 return "%s:%s"%(self.name,self.branch)
199 elif hasattr(self,'tagname'):
200 return "%s@%s"%(self.name,self.tagname)
205 if hasattr(self,'branch'):
206 return "%s/branches/%s"%(self.module_dir,self.branch)
207 elif hasattr(self,'tagname'):
208 return "%s/tags/%s"%(self.module_dir,self.tagname)
210 return "%s/trunk"%(self.module_dir)
213 return "%s/tags"%(self.module_dir)
215 def run (self,command):
216 return Command(command,self.options).run()
217 def run_fatal (self,command):
218 return Command(command,self.options).run_fatal()
219 def run_prompt (self,message,command):
220 if not self.options.verbose:
222 choice=prompt(message,True,('s','how'))
226 elif choice is False:
229 print 'About to run:',command
231 question=message+" - want to run " + command
232 if prompt(question,True):
236 # store and restitute html fragments
238 def html_href (url,text): return '<a href="%s">%s</a>'%(url,text)
240 def html_anchor (url,text): return '<a name="%s">%s</a>'%(url,text)
241 # there must be some smarter means to do that - dirty for now
243 def html_quote (text):
244 return text.replace('&','&').replace('<','<').replace('>','>')
246 # only the fake error module has multiple titles
247 def html_store_title (self, title):
248 if not hasattr(self,'titles'): self.titles=[]
249 self.titles.append(title)
250 def html_store_raw (self, html):
251 if not hasattr(self,'body'): self.body=''
253 def html_store_pre (self, text):
254 if not hasattr(self,'body'): self.body=''
255 self.body += '<pre>' + self.html_quote(text) + '</pre>'
257 def html_print (self, txt):
258 if not self.options.www:
261 if not hasattr(self,'in_list') or not self.in_list:
262 self.html_store_raw('<ul>')
264 self.html_store_raw('<li>'+txt+'</li>')
265 def html_print_end (self):
267 self.html_store_raw ('</ul>')
270 def html_dump_header(title):
271 nowdate=time.strftime("%Y-%m-%d")
272 nowtime=time.strftime("%H:%M")
274 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
275 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
278 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
279 <style type="text/css">
280 body { font-family:georgia, serif; }
281 h1 {font-size: large; }
282 p.title {font-size: x-large; }
283 span.error {text-weight:bold; color: red; }
287 <p class='title'> %s - status on %s at %s</p>
289 """%(title,title,nowdate,nowtime)
292 def html_dump_middle():
296 def html_dump_footer():
297 print "</body></html"
299 def html_dump_toc(self):
300 if hasattr(self,'titles'):
301 for title in self.titles:
302 print '<li>',self.html_href ('#'+self.friendly_name(),title),'</li>'
304 def html_dump_body(self):
305 if hasattr(self,'titles'):
306 for title in self.titles:
307 print '<hr /><h1>',self.html_anchor(self.friendly_name(),title),'</h1>'
308 if hasattr(self,'body'):
310 print '<p class="top">',self.html_href('#','Back to top'),'</p>'
314 def init_homedir (options):
315 topdir=options.workdir
316 if options.verbose and options.mode not in Main.silent_modes:
317 print 'Checking for',topdir
318 storage="%s/%s"%(topdir,Module.config_storage)
319 # sanity check. Either the topdir exists AND we have a config/storage
320 # or topdir does not exist and we create it
321 # to avoid people use their own daily svn repo
322 if os.path.isdir(topdir) and not os.path.isfile(storage):
323 print """The directory %s exists and has no CONFIG file
324 If this is your regular working directory, please provide another one as the
325 module-* commands need a fresh working dir. Make sure that you do not use
326 that for other purposes than tagging"""%topdir
328 if not os.path.isdir (topdir):
329 print "Cannot find",topdir,"let's create it"
330 Module.prompt_config()
331 print "Checking ...",
332 Command("svn co -N %s %s"%(Module.config['svnpath'],topdir),options).run_fatal()
333 Command("svn co -N %s/%s %s/%s"%(Module.config['svnpath'],
334 Module.config['build'],
336 Module.config['build']),options).run_fatal()
341 for (key,message,default) in Module.configKeys:
342 f.write("%s=%s\n"%(key,Module.config[key]))
345 print 'Stored',storage
346 Command("cat %s"%storage,options).run()
350 for line in f.readlines():
351 (key,value)=re.compile("^(.+)=(.+)$").match(line).groups()
352 Module.config[key]=value
354 if options.verbose and options.mode not in Main.silent_modes:
355 print '******** Using config'
356 for (key,message,default) in Module.configKeys:
357 print '\t',key,'=',Module.config[key]
359 def init_module_dir (self):
360 if self.options.verbose:
361 print 'Checking for',self.module_dir
362 if not os.path.isdir (self.module_dir):
363 self.run_fatal("svn update -N %s"%self.module_dir)
364 if not os.path.isdir (self.module_dir):
365 raise Exception, 'Cannot find %s - check module name'%self.module_dir
367 def init_subdir (self,fullpath):
368 if self.options.verbose:
369 print 'Checking for',fullpath
370 if not os.path.isdir (fullpath):
371 self.run_fatal("svn update -N %s"%fullpath)
373 def revert_subdir (self,fullpath):
374 if self.options.fast_checks:
375 if self.options.verbose: print 'Skipping revert of %s'%fullpath
377 if self.options.verbose:
378 print 'Checking whether',fullpath,'needs being reverted'
379 if Svnpath(fullpath,self.options).dir_needs_revert():
380 self.run_fatal("svn revert -R %s"%fullpath)
382 def update_subdir (self,fullpath):
383 if self.options.fast_checks:
384 if self.options.verbose: print 'Skipping update of %s'%fullpath
386 if self.options.verbose:
387 print 'Updating',fullpath
388 self.run_fatal("svn update -N %s"%fullpath)
390 def init_edge_dir (self):
391 # if branch, edge_dir is two steps down
392 if hasattr(self,'branch'):
393 self.init_subdir("%s/branches"%self.module_dir)
394 elif hasattr(self,'tagname'):
395 self.init_subdir("%s/tags"%self.module_dir)
396 self.init_subdir(self.edge_dir())
398 def revert_edge_dir (self):
399 self.revert_subdir(self.edge_dir())
401 def update_edge_dir (self):
402 self.update_subdir(self.edge_dir())
404 def main_specname (self):
405 attempt="%s/%s.spec"%(self.edge_dir(),self.name)
406 if os.path.isfile (attempt):
409 pattern="%s/*.spec"%self.edge_dir()
411 return glob(pattern)[0]
413 raise Exception, 'Cannot guess specfile for module %s -- pattern was %s'%(self.name,pattern)
415 def all_specnames (self):
416 return glob("%s/*.spec"%self.edge_dir())
418 def parse_spec (self, specfile, varnames):
419 if self.options.verbose:
420 print 'Parsing',specfile,
426 for line in f.readlines():
427 attempt=Module.matcher_rpm_define.match(line)
429 (define,var,value)=attempt.groups()
433 if self.options.debug:
434 print 'found',len(result),'keys'
435 for (k,v) in result.iteritems():
439 # stores in self.module_name_varname the rpm variable to be used for the module's name
440 # and the list of these names in self.varnames
441 def spec_dict (self):
442 specfile=self.main_specname()
443 redirector_keys = [ varname for (varname,default) in Module.redirectors]
444 redirect_dict = self.parse_spec(specfile,redirector_keys)
445 if self.options.debug:
446 print '1st pass parsing done, redirect_dict=',redirect_dict
448 for (varname,default) in Module.redirectors:
449 if redirect_dict.has_key(varname):
450 setattr(self,varname,redirect_dict[varname])
451 varnames += [redirect_dict[varname]]
453 setattr(self,varname,default)
454 varnames += [ default ]
455 self.varnames = varnames
456 result = self.parse_spec (specfile,self.varnames)
457 if self.options.debug:
458 print '2st pass parsing done, varnames=',varnames,'result=',result
461 def patch_spec_var (self, patch_dict,define_missing=False):
462 for specfile in self.all_specnames():
463 # record the keys that were changed
464 changed = dict ( [ (x,False) for x in patch_dict.keys() ] )
465 newspecfile=specfile+".new"
466 if self.options.verbose:
467 print 'Patching',specfile,'for',patch_dict.keys()
469 new=open(newspecfile,"w")
471 for line in spec.readlines():
472 attempt=Module.matcher_rpm_define.match(line)
474 (define,var,value)=attempt.groups()
475 if var in patch_dict.keys():
476 if self.options.debug:
477 print 'rewriting %s as %s'%(var,patch_dict[var])
478 new.write('%%%s %s %s\n'%(define,var,patch_dict[var]))
483 for (key,was_changed) in changed.iteritems():
485 if self.options.debug:
486 print 'rewriting missing %s as %s'%(key,patch_dict[key])
487 new.write('\n%%define %s %s\n'%(key,patch_dict[key]))
490 os.rename(newspecfile,specfile)
492 # returns all lines until the magic line
493 def unignored_lines (self, logfile):
495 white_line_matcher = re.compile("\A\s*\Z")
496 for logline in file(logfile).readlines():
497 if logline.strip() == Module.svn_magic_line:
499 elif white_line_matcher.match(logline):
502 result.append(logline.strip()+'\n')
505 # creates a copy of the input with only the unignored lines
506 def stripped_magic_line_filename (self, filein, fileout ,new_tag_name):
508 f.write(self.setting_tag_format%new_tag_name + '\n')
509 for line in self.unignored_lines(filein):
513 def insert_changelog (self, logfile, oldtag, newtag):
514 for specfile in self.all_specnames():
515 newspecfile=specfile+".new"
516 if self.options.verbose:
517 print 'Inserting changelog from %s into %s'%(logfile,specfile)
519 new=open(newspecfile,"w")
520 for line in spec.readlines():
522 if re.compile('%changelog').match(line):
523 dateformat="* %a %b %d %Y"
524 datepart=time.strftime(dateformat)
525 logpart="%s <%s> - %s"%(Module.config['username'],
526 Module.config['email'],
528 new.write(datepart+" "+logpart+"\n")
529 for logline in self.unignored_lines(logfile):
530 new.write("- " + logline)
534 os.rename(newspecfile,specfile)
536 def show_dict (self, spec_dict):
537 if self.options.verbose:
538 for (k,v) in spec_dict.iteritems():
542 return "%s/%s"%(Module.config['svnpath'],self.name)
545 if hasattr(self,'branch'):
546 return "%s/branches/%s"%(self.mod_url(),self.branch)
547 elif hasattr(self,'tagname'):
548 return "%s/tags/%s"%(self.mod_url(),self.tagname)
550 return "%s/trunk"%(self.mod_url())
552 def last_tag (self, spec_dict):
553 return "%s-%s"%(spec_dict[self.module_version_varname],spec_dict[self.module_taglevel_varname])
555 def tag_name (self, spec_dict):
557 return "%s-%s"%(self.name,
558 self.last_tag(spec_dict))
560 raise Exception, 'Something is wrong with module %s, cannot determine %s - exiting'%(self.name,err)
562 def tag_url (self, spec_dict):
563 return "%s/tags/%s"%(self.mod_url(),self.tag_name(spec_dict))
565 def check_svnpath_exists (self, url, message):
566 if self.options.fast_checks:
568 if self.options.verbose:
569 print 'Checking url (%s) %s'%(url,message),
570 ok=Svnpath(url,self.options).url_exists()
572 if self.options.verbose: print 'exists - OK'
574 if self.options.verbose: print 'KO'
575 raise Exception, 'Could not find %s URL %s'%(message,url)
577 def check_svnpath_not_exists (self, url, message):
578 if self.options.fast_checks:
580 if self.options.verbose:
581 print 'Checking url (%s) %s'%(url,message),
582 ok=not Svnpath(url,self.options).url_exists()
584 if self.options.verbose: print 'does not exist - OK'
586 if self.options.verbose: print 'KO'
587 raise Exception, '%s URL %s already exists - exiting'%(message,url)
589 # locate specfile, parse it, check it and show values
591 ##############################
592 def do_version (self):
593 self.init_module_dir()
595 self.revert_edge_dir()
596 self.update_edge_dir()
597 spec_dict = self.spec_dict()
599 self.html_store_title('Version for module %s (%s)' % (self.friendly_name(),self.last_tag(spec_dict)))
600 for varname in self.varnames:
601 if not spec_dict.has_key(varname):
602 self.html_print ('Could not find %%define for %s'%varname)
605 self.html_print ("%-16s %s"%(varname,spec_dict[varname]))
606 if self.options.show_urls:
607 self.html_print ("%-16s %s"%('edge url',self.edge_url()))
608 self.html_print ("%-16s %s"%('latest tag url',self.tag_url(spec_dict)))
609 if self.options.verbose:
610 self.html_print ("%-16s %s"%('main specfile:',self.main_specname()))
611 self.html_print ("%-16s %s"%('specfiles:',self.all_specnames()))
612 self.html_print_end()
614 ##############################
616 # print 'verbose',self.options.verbose
617 # print 'list_tags',self.options.list_tags
618 # print 'list_branches',self.options.list_branches
619 # print 'all_modules',self.options.all_modules
621 (verbose,branches,pattern,exact) = (self.options.verbose,self.options.list_branches,
622 self.options.list_pattern,self.options.list_exact)
626 if hasattr(self,'branch'):
630 if verbose: grep="%s/$"%exact
631 else: grep="^%s$"%exact
634 extra_command=" | grep %s"%grep
635 extra_message=" matching %s"%grep
638 message="==================== tags for %s"%self.friendly_name()
640 if verbose: command+="--verbose "
641 command += "%s/tags"%self.mod_url()
642 command += extra_command
643 message += extra_message
644 if verbose: print message
648 message="==================== branches for %s"%self.friendly_name()
650 if verbose: command+="--verbose "
651 command += "%s/branches"%self.mod_url()
652 command += extra_command
653 message += extra_message
654 if verbose: print message
657 ##############################
658 sync_warning="""*** WARNING
659 The module-sync function has the following limitations
660 * it does not handle changelogs
661 * it does not scan the -tags*.mk files to adopt the new tags"""
664 if self.options.verbose:
665 print Module.sync_warning
666 if not prompt('Want to proceed anyway'):
669 self.init_module_dir()
671 self.revert_edge_dir()
672 self.update_edge_dir()
673 spec_dict = self.spec_dict()
675 edge_url=self.edge_url()
676 tag_name=self.tag_name(spec_dict)
677 tag_url=self.tag_url(spec_dict)
678 # check the tag does not exist yet
679 self.check_svnpath_not_exists(tag_url,"new tag")
681 if self.options.message:
682 svnopt='--message "%s"'%self.options.message
684 svnopt='--editor-cmd=%s'%self.options.editor
685 self.run_prompt("Create initial tag",
686 "svn copy %s %s %s"%(svnopt,edge_url,tag_url))
688 ##############################
689 def do_diff (self,compute_only=False):
690 self.init_module_dir()
692 self.revert_edge_dir()
693 self.update_edge_dir()
694 spec_dict = self.spec_dict()
695 self.show_dict(spec_dict)
697 edge_url=self.edge_url()
698 tag_url=self.tag_url(spec_dict)
699 self.check_svnpath_exists(edge_url,"edge track")
700 self.check_svnpath_exists(tag_url,"latest tag")
701 command="svn diff %s %s"%(tag_url,edge_url)
703 if self.options.verbose:
704 print 'Getting diff with %s'%command
705 diff_output = Command(command,self.options).output_of()
706 # if used as a utility
708 return (spec_dict,edge_url,tag_url,diff_output)
709 # otherwise print the result
710 if self.options.list:
714 thename=self.friendly_name()
716 if self.options.www and diff_output:
717 self.html_store_title("Diffs in module %s (%s) : %d chars"%(\
718 thename,self.last_tag(spec_dict),len(diff_output)))
719 link=self.html_href(tag_url,tag_url)
720 self.html_store_raw ('<p> < (left) %s </p>'%link)
721 link=self.html_href(edge_url,edge_url)
722 self.html_store_raw ('<p> > (right) %s </p>'%link)
723 self.html_store_pre (diff_output)
724 elif not self.options.www:
725 print 'x'*30,'module',thename
726 print 'x'*20,'<',tag_url
727 print 'x'*20,'>',edge_url
730 ##############################
731 # using fine_grain means replacing only those instances that currently refer to this tag
732 # otherwise, <module>-SVNPATH is replaced unconditionnally
733 def patch_tags_file (self, tagsfile, oldname, newname,fine_grain=True):
734 newtagsfile=tagsfile+".new"
736 new=open(newtagsfile,"w")
739 # fine-grain : replace those lines that refer to oldname
741 if self.options.verbose:
742 print 'Replacing %s into %s\n\tin %s .. '%(oldname,newname,tagsfile),
743 matcher=re.compile("^(.*)%s(.*)"%oldname)
744 for line in tags.readlines():
745 if not matcher.match(line):
748 (begin,end)=matcher.match(line).groups()
749 new.write(begin+newname+end+"\n")
751 # brute-force : change uncommented lines that define <module>-SVNPATH
753 if self.options.verbose:
754 print 'Searching for -SVNPATH lines referring to /%s/\n\tin %s .. '%(self.name,tagsfile),
755 pattern="\A\s*(?P<make_name>[^\s]+)-SVNPATH\s*(=|:=)\s*(?P<url_main>[^\s]+)/%s/[^\s]+"\
757 matcher_module=re.compile(pattern)
758 for line in tags.readlines():
759 attempt=matcher_module.match(line)
761 svnpath="%s-SVNPATH"%(attempt.group('make_name'))
762 if self.options.verbose:
764 replacement = "%-32s:= %s/%s/tags/%s\n"%(svnpath,attempt.group('url_main'),self.name,newname)
765 new.write(replacement)
771 os.rename(newtagsfile,tagsfile)
772 if self.options.verbose: print "%d changes"%matches
776 self.init_module_dir()
778 self.revert_edge_dir()
779 self.update_edge_dir()
781 spec_dict = self.spec_dict()
782 self.show_dict(spec_dict)
785 edge_url=self.edge_url()
786 old_tag_name = self.tag_name(spec_dict)
787 old_tag_url=self.tag_url(spec_dict)
788 if (self.options.new_version):
789 # new version set on command line
790 spec_dict[self.module_version_varname] = self.options.new_version
791 spec_dict[self.module_taglevel_varname] = 0
794 new_taglevel = str ( int (spec_dict[self.module_taglevel_varname]) + 1)
795 spec_dict[self.module_taglevel_varname] = new_taglevel
798 new_tag_name = self.tag_name(spec_dict)
799 new_tag_url=self.tag_url(spec_dict)
800 self.check_svnpath_exists (edge_url,"edge track")
801 self.check_svnpath_exists (old_tag_url,"previous tag")
802 self.check_svnpath_not_exists (new_tag_url,"new tag")
805 diff_output=Command("svn diff %s %s"%(old_tag_url,edge_url),
806 self.options).output_of()
807 if len(diff_output) == 0:
808 if not prompt ("No pending difference in module %s, want to tag anyway"%self.name,False):
811 # side effect in trunk's specfile
812 self.patch_spec_var(spec_dict)
814 # prepare changelog file
815 # we use the standard subversion magic string (see svn_magic_line)
816 # so we can provide useful information, such as version numbers and diff
818 changelog="/tmp/%s-%d.edit"%(self.name,os.getpid())
819 changelog_svn="/tmp/%s-%d.svn"%(self.name,os.getpid())
820 setting_tag_line=Module.setting_tag_format%new_tag_name
821 file(changelog,"w").write("""
824 Please write a changelog for this new tag in the section above
825 """%(Module.svn_magic_line,setting_tag_line))
827 if not self.options.verbose or prompt('Want to see diffs while writing changelog',True):
828 file(changelog,"a").write('DIFF=========\n' + diff_output)
830 if self.options.debug:
834 self.run("%s %s"%(self.options.editor,changelog))
835 # strip magic line in second file - looks like svn has changed its magic line with 1.6
836 # so we do the job ourselves
837 self.stripped_magic_line_filename(changelog,changelog_svn,new_tag_name)
838 # insert changelog in spec
839 if self.options.changelog:
840 self.insert_changelog (changelog,old_tag_name,new_tag_name)
844 buildname=Module.config['build']
847 if self.options.build_branch:
848 buildname+=":"+self.options.build_branch
849 build = Module(buildname,self.options)
850 build.init_module_dir()
851 build.init_edge_dir()
852 build.revert_edge_dir()
853 build.update_edge_dir()
855 tagsfiles=glob(build.edge_dir()+"/*-tags*.mk")
856 tagsdict=dict( [ (x,'todo') for x in tagsfiles ] )
859 for (tagsfile,status) in tagsdict.iteritems():
860 basename=os.path.basename(tagsfile)
861 print ".................... Dealing with %s"%basename
862 while tagsdict[tagsfile] == 'todo' :
863 choice = prompt ("insert %s in %s "%(new_tag_name,basename),default_answer,
864 [ ('y','es'), ('n', 'ext'), ('f','orce'),
865 ('d','iff'), ('r','evert'), ('c', 'at'), ('h','elp') ] ,
868 self.patch_tags_file(tagsfile,old_tag_name,new_tag_name,fine_grain=True)
870 print 'Done with %s'%os.path.basename(tagsfile)
871 tagsdict[tagsfile]='done'
873 self.patch_tags_file(tagsfile,old_tag_name,new_tag_name,fine_grain=False)
875 self.run("svn diff %s"%tagsfile)
877 self.run("svn revert %s"%tagsfile)
879 self.run("cat %s"%tagsfile)
882 print """y: change %(name)s-SVNPATH only if it currently refers to %(old_tag_name)s
883 f: unconditionnally change any line that assigns %(name)s-SVNPATH to using %(new_tag_name)s
884 d: show current diff for this tag file
885 r: revert that tag file
886 c: cat the current tag file
887 n: move to next file"""%locals()
889 if prompt("Want to review changes on tags files",False):
890 tagsdict = dict ( [ (x, 'todo') for tagsfile in tagsfiles ] )
896 paths += self.edge_dir() + " "
897 paths += build.edge_dir() + " "
898 self.run_prompt("Review module and build","svn diff " + paths)
899 self.run_prompt("Commit module and build","svn commit --file %s %s"%(changelog_svn,paths))
900 self.run_prompt("Create tag","svn copy --file %s %s %s"%(changelog_svn,edge_url,new_tag_url))
902 if self.options.debug:
903 print 'Preserving',changelog,'and stripped',changelog_svn
906 os.unlink(changelog_svn)
908 ##############################
909 def do_branch (self):
911 # save self.branch if any, as a hint for the new branch
912 # do this before anything else and restore .branch to None,
913 # as this is part of the class's logic
915 if hasattr(self,'branch'):
916 new_trunk_name=self.branch
918 elif self.options.new_version:
919 new_trunk_name = self.options.new_version
921 # compute diff - a way to initialize the whole stuff
922 # do_diff already does edge_dir initialization
923 # and it checks that edge_url and tag_url exist as well
924 (spec_dict,edge_url,tag_url,diff_listing) = self.do_diff(compute_only=True)
926 # the version name in the trunk becomes the new branch name
927 branch_name = spec_dict[self.module_version_varname]
929 # figure new branch name (the one for the trunk) if not provided on the command line
930 if not new_trunk_name:
931 # heuristic is to assume 'version' is a dot-separated name
932 # we isolate the rightmost part and try incrementing it by 1
933 version=spec_dict[self.module_version_varname]
935 m=re.compile("\A(?P<leftpart>.+)\.(?P<rightmost>[^\.]+)\Z")
936 (leftpart,rightmost)=m.match(version).groups()
937 incremented = int(rightmost)+1
938 new_trunk_name="%s.%d"%(leftpart,incremented)
940 raise Exception, 'Cannot figure next branch name from %s - exiting'%version
942 # record starting point tagname
943 latest_tag_name = self.tag_name(spec_dict)
946 print "Using starting point %s (%s)"%(tag_url,latest_tag_name)
947 print "Creating branch %s & moving trunk to %s"%(branch_name,new_trunk_name)
950 # print warning if pending diffs
952 print """*** WARNING : Module %s has pending diffs on its trunk
953 It is safe to proceed, but please note that branch %s
954 will be based on latest tag %s and *not* on the current trunk"""%(self.name,branch_name,latest_tag_name)
956 answer = prompt ('Are you sure you want to proceed with branching',True,('d','iff'))
959 elif answer is False:
960 raise Exception,"User quit"
962 print '<<<< %s'%tag_url
963 print '>>>> %s'%edge_url
966 branch_url = "%s/%s/branches/%s"%(Module.config['svnpath'],self.name,branch_name)
967 self.check_svnpath_not_exists (branch_url,"new branch")
970 spec_dict[self.module_version_varname]=new_trunk_name
971 spec_dict[self.module_taglevel_varname]='0'
972 # remember this in the trunk for easy location of the current branch
973 spec_dict['module_current_branch']=branch_name
974 self.patch_spec_var(spec_dict,True)
976 # create commit log file
977 tmp="/tmp/branching-%d"%os.getpid()
979 f.write("Branch %s for module %s created (as new trunk) from tag %s\n"%(new_trunk_name,self.name,latest_tag_name))
982 # we're done, let's commit the stuff
983 command="svn diff %s"%self.edge_dir()
984 self.run_prompt("Review changes in trunk",command)
985 command="svn copy --file %s %s %s"%(tmp,self.edge_url(),branch_url)
986 self.run_prompt("Create branch",command)
987 command="svn commit --file %s %s"%(tmp,self.edge_dir())
988 self.run_prompt("Commit trunk",command)
989 new_tag_url=self.tag_url(spec_dict)
990 command="svn copy --file %s %s %s"%(tmp,self.edge_url(),new_tag_url)
991 self.run_prompt("Create initial tag in trunk",command)
994 ##############################
997 def __init__(self, package, module, svnpath, spec):
1000 self.svnpath=svnpath
1002 self.specpath="%s/%s"%(svnpath,spec)
1003 self.basename=os.path.basename(svnpath)
1005 # returns a http URL to the trac path where full diff can be viewed (between self and pkg)
1006 # typically http://svn.planet-lab.org/changeset?old_path=Monitor%2Ftags%2FMonitor-1.0-7&new_path=Monitor%2Ftags%2FMonitor-1.0-13
1007 # xxx quick & dirty: rough url parsing
1008 def trac_full_diff (self, pkg):
1009 matcher=re.compile("\A(?P<method>.*)://(?P<hostname>[^/]+)/(svn/)?(?P<path>.*)\Z")
1010 self_match=matcher.match(self.svnpath)
1011 pkg_match=matcher.match(pkg.svnpath)
1012 if self_match and pkg_match:
1013 (method,hostname,svn,path)=self_match.groups()
1014 self_path=path.replace("/","%2F")
1015 pkg_path=pkg_match.group('path').replace("/","%2F")
1016 return "%s://%s/changeset?old_path=%s&new_path=%s"%(method,hostname,self_path,pkg_path)
1021 return "[%s %s] [%s (spec)]"%(self.svnpath,self.basename,self.specpath)
1023 class Build (Module):
1025 # we cannot get build's svnpath as for other packages as we'd get something in svn+ssh
1027 def __init__ (self, buildtag,options):
1028 self.buildtag=buildtag
1029 # if the buildtag start with a : (to use a branch rather than a tag)
1030 if buildtag.find(':') == 0 :
1031 module_name="build%(buildtag)s"%locals()
1032 self.display=buildtag[1:]
1033 self.svnpath="http://svn.planet-lab.org/svn/build/branches/%s"%self.display
1035 module_name="build@%(buildtag)s"%locals()
1036 self.display=buildtag
1037 self.svnpath="http://svn.planet-lab.org/svn/build/tags/%s"%self.buildtag
1038 Module.__init__(self,module_name,options)
1041 def get_distro_from_distrotag (distrotag):
1042 # mhh: remove -tag* from distrotags to get distro
1043 n=distrotag.find('-tag')
1045 return distrotag[:n]
1049 def get_packages (self,distrotag):
1051 distro=Build.get_distro_from_distrotag(distrotag)
1054 make_options="--no-print-directory -C %s stage1=true PLDISTRO=%s PLDISTROTAGS=%s 2> /dev/null"%(self.edge_dir(),distro,distrotag)
1055 command="make %s packages"%make_options
1056 make_packages=Command(command,self.options).output_of()
1057 pkg_line=re.compile("\Apackage=(?P<package>[^\s]+)\s+ref_module=(?P<module>[^\s]+)\s.*\Z")
1058 for line in make_packages.split("\n"):
1061 attempt=pkg_line.match(line)
1062 if line and not attempt:
1064 print "WARNING: line not understood from make packages"
1065 print "in dir %s"%self.edge_dir
1066 print "with options",make_options
1070 (package,module) = (attempt.group('package'),attempt.group('module'))
1071 command="make %s +%s-SVNPATH"%(make_options,module)
1072 svnpath=Command(command,self.options).output_of().strip()
1073 command="make %s +%s-SPEC"%(make_options,package)
1074 spec=Command(command,self.options).output_of().strip()
1075 result[package]=Package(package,module,svnpath,spec)
1078 def get_distrotags (self):
1079 return [os.path.basename(p) for p in glob("%s/*tags*mk"%self.edge_dir())]
1083 def __init__ (self):
1086 def key(self, frompath,topath):
1087 return frompath+'-to-'+topath
1089 def fetch (self, frompath, topath):
1090 key=self.key(frompath,topath)
1091 if not self._cache.has_key(key):
1093 return self._cache[key]
1095 def store (self, frompath, topath, diff):
1096 key=self.key(frompath,topath)
1097 self._cache[key]=diff
1101 # header in diff output
1102 discard_matcher=re.compile("\A(\+\+\+|---).*")
1105 def do_changelog (buildtag_new,buildtag_old,options):
1109 (build_new,build_old) = (Build (buildtag_new,options), Build (buildtag_old,options))
1110 print "= build tag %s to %s = #build-%s"%(build_old.display,build_new.display,build_new.display)
1111 for b in (build_new,build_old):
1115 # find out the tags files that are common, unless option was specified
1116 if options.distrotags:
1117 distrotags=options.distrotags
1119 distrotags_new=build_new.get_distrotags()
1120 distrotags_old=build_old.get_distrotags()
1121 distrotags = list(set(distrotags_new).intersection(set(distrotags_old)))
1123 if options.verbose: print "Found distrotags",distrotags
1124 first_distrotag=True
1125 diffcache = DiffCache()
1126 for distrotag in distrotags:
1127 distro=Build.get_distro_from_distrotag(distrotag)
1131 first_distrotag=False
1134 print '== distro %s (%s to %s) == #distro-%s-%s'%(distrotag,build_old.display,build_new.display,distro,build_new.display)
1135 print ' * from %s/%s'%(build_old.svnpath,distrotag)
1136 print ' * to %s/%s'%(build_new.svnpath,distrotag)
1138 # parse make packages
1139 packages_new=build_new.get_packages(distrotag)
1140 pnames_new=set(packages_new.keys())
1141 if options.verbose: print 'got packages for ',build_new.display
1142 packages_old=build_old.get_packages(distrotag)
1143 pnames_old=set(packages_old.keys())
1144 if options.verbose: print 'got packages for ',build_old.display
1146 # get created, deprecated, and preserved package names
1147 pnames_created = list(pnames_new-pnames_old)
1148 pnames_created.sort()
1149 pnames_deprecated = list(pnames_old-pnames_new)
1150 pnames_deprecated.sort()
1151 pnames = list(pnames_new.intersection(pnames_old))
1154 if options.verbose: print "Found new/deprecated/preserved pnames",pnames_new,pnames_deprecated,pnames
1156 # display created and deprecated
1157 for name in pnames_created:
1158 print '=== %s : new package %s -- appeared in %s === #package-%s-%s-%s'%(
1159 distrotag,name,build_new.display,name,distro,build_new.display)
1160 pobj=packages_new[name]
1161 print ' * %s'%pobj.details()
1162 for name in pnames_deprecated:
1163 print '=== %s : package %s -- deprecated, last occurrence in %s === #package-%s-%s-%s'%(
1164 distrotag,name,build_old.display,name,distro,build_new.display)
1165 pobj=packages_old[name]
1166 if not pobj.svnpath:
1167 print ' * codebase stored in CVS, specfile is %s'%pobj.spec
1169 print ' * %s'%pobj.details()
1171 # display other packages
1173 (pobj_new,pobj_old)=(packages_new[name],packages_old[name])
1174 if options.verbose: print "Dealing with package",name
1175 if pobj_old.specpath == pobj_new.specpath:
1177 specdiff = diffcache.fetch(pobj_old.specpath,pobj_new.specpath)
1178 if specdiff is None:
1179 command="svn diff %s %s"%(pobj_old.specpath,pobj_new.specpath)
1180 specdiff=Command(command,options).output_of()
1181 diffcache.store(pobj_old.specpath,pobj_new.specpath,specdiff)
1183 if options.verbose: print 'got diff from cache'
1186 print '=== %s - %s to %s : package %s === #package-%s-%s-%s'%(
1187 distrotag,build_old.display,build_new.display,name,name,distro,build_new.display)
1188 print ' * from %s to %s'%(pobj_old.details(),pobj_new.details())
1189 trac_diff_url=pobj_old.trac_full_diff(pobj_new)
1191 print ' * [%s View full diff]'%trac_diff_url
1193 for line in specdiff.split('\n'):
1196 if Release.discard_matcher.match(line):
1198 if line[0] in ['@']:
1200 elif line[0] in ['+','-']:
1204 ##############################
1207 module_usage="""Usage: %prog [options] module_desc [ .. module_desc ]
1208 module-tools : a set of tools to manage subversion tags and specfile
1209 requires the specfile to either
1210 * define *version* and *taglevel*
1212 * define redirection variables module_version_varname / module_taglevel_varname
1214 by default, the trunk of modules is taken into account
1215 in this case, just mention the module name as <module_desc>
1217 if you wish to work on a branch rather than on the trunk,
1218 you can use something like e.g. Mom:2.1 as <module_desc>
1220 release_usage="""Usage: %prog [options] tag1 .. tagn
1221 Extract release notes from the changes in specfiles between several build tags, latest first
1223 release-changelog 4.2-rc25 4.2-rc24 4.2-rc23 4.2-rc22
1224 You can refer to a (build) branch by prepending a colon, like in
1225 release-changelog :4.2 4.2-rc25
1227 common_usage="""More help:
1228 see http://svn.planet-lab.org/wiki/ModuleTools"""
1231 'list' : "displays a list of available tags or branches",
1232 'version' : "check latest specfile and print out details",
1233 'diff' : "show difference between module (trunk or branch) and latest tag",
1234 'tag' : """increment taglevel in specfile, insert changelog in specfile,
1235 create new tag and and monitor its adoption in build/*-tags*.mk""",
1236 'branch' : """create a branch for this module, from the latest tag on the trunk,
1237 and change trunk's version number to reflect the new branch name;
1238 you can specify the new branch name by using module:branch""",
1239 'sync' : """create a tag from the module
1240 this is a last resort option, mostly for repairs""",
1241 'changelog' : """extract changelog between build tags
1242 expected arguments are a list of tags""",
1245 silent_modes = ['list']
1246 release_modes = ['changelog']
1249 def optparse_list (option, opt, value, parser):
1251 setattr(parser.values,option.dest,getattr(parser.values,option.dest)+value.split())
1253 setattr(parser.values,option.dest,value.split())
1258 for function in Main.modes.keys():
1259 if sys.argv[0].find(function) >= 0:
1263 print "Unsupported command",sys.argv[0]
1264 print "Supported commands:" + Modes.modes.keys.join(" ")
1267 if mode not in Main.release_modes:
1268 usage = Main.module_usage
1269 usage += Main.common_usage
1270 usage += "\nmodule-%s : %s"%(mode,Main.modes[mode])
1272 usage = Main.release_usage
1273 usage += Main.common_usage
1275 parser=OptionParser(usage=usage,version=subversion_id)
1278 parser.add_option("-b","--branches",action="store_true",dest="list_branches",default=False,
1279 help="list branches")
1280 parser.add_option("-t","--tags",action="store_false",dest="list_branches",
1282 parser.add_option("-m","--match",action="store",dest="list_pattern",default=None,
1283 help="grep pattern for filtering output")
1284 parser.add_option("-x","--exact-match",action="store",dest="list_exact",default=None,
1285 help="exact grep pattern for filtering output")
1286 if mode == "tag" or mode == 'branch':
1287 parser.add_option("-s","--set-version",action="store",dest="new_version",default=None,
1288 help="set new version and reset taglevel to 0")
1290 parser.add_option("-c","--no-changelog", action="store_false", dest="changelog", default=True,
1291 help="do not update changelog section in specfile when tagging")
1292 parser.add_option("-b","--build-branch", action="store", dest="build_branch", default=None,
1293 help="specify a build branch; used for locating the *tags*.mk files where adoption is to take place")
1294 if mode == "tag" or mode == "sync" :
1295 parser.add_option("-e","--editor", action="store", dest="editor", default=default_editor(),
1296 help="specify editor")
1298 parser.add_option("-m","--message", action="store", dest="message", default=None,
1299 help="specify log message")
1300 if mode in ["diff","version"] :
1301 parser.add_option("-W","--www", action="store", dest="www", default=False,
1302 help="export diff in html format, e.g. -W trunk")
1304 parser.add_option("-l","--list", action="store_true", dest="list", default=False,
1305 help="just list modules that exhibit differences")
1307 if mode == 'version':
1308 parser.add_option("-u","--url", action="store_true", dest="show_urls", default=False,
1309 help="display URLs")
1311 default_modules_list=os.path.dirname(sys.argv[0])+"/modules.list"
1312 if mode not in Main.release_modes:
1313 parser.add_option("-a","--all",action="store_true",dest="all_modules",default=False,
1314 help="run on all modules as found in %s"%default_modules_list)
1315 parser.add_option("-f","--file",action="store",dest="modules_list",default=None,
1316 help="run on all modules found in specified file")
1318 parser.add_option("-n","--dry-run",action="store_true",dest="dry_run",default=False,
1319 help="dry run - shell commands are only displayed")
1320 parser.add_option("-t","--distrotags",action="callback",callback=Main.optparse_list, dest="distrotags",
1321 default=[], nargs=1,type="string",
1322 help="""specify distro-tags files, e.g. onelab-tags-4.2.mk
1323 -- can be set multiple times, or use quotes""")
1325 parser.add_option("-w","--workdir", action="store", dest="workdir",
1326 default="%s/%s"%(os.getenv("HOME"),"modules"),
1327 help="""name for dedicated working dir - defaults to ~/modules
1328 ** THIS MUST NOT ** be your usual working directory""")
1329 parser.add_option("-F","--fast-checks",action="store_true",dest="fast_checks",default=False,
1330 help="skip safety checks, such as svn updates -- use with care")
1332 # default verbosity depending on function - temp
1333 verbose_modes= ['tag','sync']
1335 if mode not in verbose_modes:
1336 parser.add_option("-v","--verbose", action="store_true", dest="verbose", default=False,
1337 help="run in verbose mode")
1339 parser.add_option("-q","--quiet", action="store_false", dest="verbose", default=True,
1340 help="run in quiet (non-verbose) mode")
1341 # parser.add_option("-d","--debug", action="store_true", dest="debug", default=False,
1342 # help="debug mode - mostly more verbose")
1343 (options, args) = parser.parse_args()
1345 if not hasattr(options,'dry_run'):
1346 options.dry_run=False
1347 if not hasattr(options,'www'):
1351 ########## release-*
1352 if mode in Main.release_modes :
1353 ########## changelog
1357 Module.init_homedir(options)
1358 for n in range(len(args)-1):
1359 [t_new,t_old]=args[n:n+2]
1360 Release.do_changelog (t_new,t_old,options)
1364 if options.all_modules:
1365 options.modules_list=default_modules_list
1366 if options.modules_list:
1367 args=Command("grep -v '#' %s"%options.modules_list,options).output_of().split()
1371 Module.init_homedir(options)
1373 # 2 passes for www output
1374 modules=[ Module(modname,options) for modname in args ]
1375 # hack: create a dummy Module to store errors/warnings
1376 error_module = Module('__errors__',options)
1378 # pass 1 : do it, except if options.www
1379 for module in modules:
1380 if len(args)>1 and mode not in Main.silent_modes and not options.www:
1381 print '========================================',module.friendly_name()
1382 # call the method called do_<mode>
1383 method=Module.__dict__["do_%s"%mode]
1388 title='<span class="error"> Skipping module %s - failure: %s </span>'%\
1389 (module.friendly_name(), str(e))
1390 error_module.html_store_title(title)
1392 print 'Skipping module %s: '%modname,e
1394 # in which case we do the actual printing in the second pass
1397 modetitle="Changes to tag in %s"%options.www
1398 elif mode == "version":
1399 modetitle="Latest tags in %s"%options.www
1400 modules.append(error_module)
1401 error_module.html_dump_header(modetitle)
1402 for module in modules:
1403 module.html_dump_toc()
1404 Module.html_dump_middle()
1405 for module in modules:
1406 module.html_dump_body()
1407 Module.html_dump_footer()
1409 ####################
1410 if __name__ == "__main__" :
1413 except KeyboardInterrupt: