5 import sys, os, os.path
9 from optparse import OptionParser
11 def prompt (question,default=True):
13 question += " [y]/n ? "
15 question += " y/[n] ? "
17 answer=raw_input(question)
20 elif answer[0] in [ 'y','Y']:
22 elif answer[0] in [ 'n','N']:
25 return prompt(question,default)
26 except KeyboardInterrupt:
33 def __init__ (self,command,options):
36 self.tmp="/tmp/command-%d"%os.getpid()
39 if self.options.verbose:
40 print '+',self.command
42 return os.system(self.command)
44 def run_silent (self):
45 if self.options.verbose:
46 print '+',self.command,' .. ',
48 retcod=os.system(self.command + " &> " + self.tmp)
50 print "FAILED ! -- output quoted below "
51 os.system("cat " + self.tmp)
52 print "FAILED ! -- end of quoted output"
53 elif self.options.verbose:
59 if self.run_silent() !=0:
60 raise Exception,"Command %s failed"%self.command
62 # returns stdout, like bash's $(mycommand)
63 def output_of (self,with_stderr=False):
64 tmp="/tmp/status-%d"%os.getpid()
65 if self.options.debug:
66 print '+',self.command,' .. ',
75 result=file(tmp).read()
77 if self.options.debug:
82 def __init__(self,path,options):
86 def url_exists (self):
87 return os.system("svn list %s &> /dev/null"%self.path) == 0
89 def dir_needs_revert (self):
90 command="svn status %s"%self.path
91 return len(Command(command,self.options).output_of(True)) != 0
92 # turns out it's the same implem.
93 def file_needs_commit (self):
94 command="svn status %s"%self.path
95 return len(Command(command,self.options).output_of(True)) != 0
99 svn_magic_line="--This line, and those below, will be ignored--"
101 redirectors=[ # ('module_name_varname','name'),
102 ('module_version_varname','version'),
103 ('module_taglevel_varname','taglevel'), ]
105 # where to store user's config
106 config_storage="CONFIG"
111 configKeys=[ ('svnpath',"Enter your toplevel svnpath",
112 "svn+ssh://%s@svn.planet-lab.org/svn/"%commands.getoutput("id -un")),
113 ("build", "Enter the name of your build module","build"),
114 ('username',"Enter your firstname and lastname for changelogs",""),
115 ("email","Enter your email address for changelogs",""),
119 def prompt_config ():
120 for (key,message,default) in Module.configKeys:
121 Module.config[key]=""
122 while not Module.config[key]:
123 Module.config[key]=raw_input("%s [%s] : "%(message,default)).strip() or default
126 # for parsing module spec name:branch
127 matcher_branch_spec=mbq=re.compile("\A(?P<name>\w+):(?P<branch>[\w\.]+)\Z")
128 matcher_rpm_define=re.compile("%define\s+(\S+)\s+(\S*)\s*")
130 def __init__ (self,module_spec,options):
132 attempt=Module.matcher_branch_spec.match(module_spec)
134 self.name=attempt.group('name')
135 self.branch=attempt.group('branch')
137 self.name=module_spec
141 self.moddir="%s/%s"%(options.workdir,self.name)
145 return "%s/trunk"%(self.moddir)
147 return "%s/branches/%s"%(self.moddir,self.branch)
150 return "%s/tags"%(self.moddir)
152 def run (self,command):
153 return Command(command,self.options).run()
154 def run_fatal (self,command):
155 return Command(command,self.options).run_fatal()
156 def run_prompt (self,message,command):
157 if not self.options.verbose:
160 question="Want to run " + command
161 if prompt(question,True):
165 def init_homedir (options):
166 topdir=options.workdir
168 print 'Checking for',topdir
169 storage="%s/%s"%(topdir,Module.config_storage)
170 # sanity check. Either the topdir exists AND we have a config/storage
171 # or topdir does not exist and we create it
172 # to avoid people use their own daily svn repo
173 if os.path.isdir(topdir) and not os.path.isfile(storage):
174 print """The directory %s exists and has no CONFIG file
175 If this is your regular working directory, please provide another one as the
176 module-* commands need a fresh working dir. Make sure that you do not use
177 that for other purposes than tagging"""%topdir
179 if not os.path.isdir (topdir):
180 print "Cannot find",topdir,"let's create it"
181 Module.prompt_config()
182 print "Checking ...",
183 Command("svn co -N %s %s"%(Module.config['svnpath'],topdir),options).run_fatal()
184 Command("svn co -N %s/%s %s/%s"%(Module.config['svnpath'],
185 Module.config['build'],
187 Module.config['build']),options).run_fatal()
192 for (key,message,default) in Module.configKeys:
193 f.write("%s=%s\n"%(key,Module.config[key]))
196 print 'Stored',storage
197 Command("cat %s"%storage,options).run()
201 for line in f.readlines():
202 (key,value)=re.compile("^(.+)=(.+)$").match(line).groups()
203 Module.config[key]=value
206 print '******** Using config'
207 for (key,message,default) in Module.configKeys:
208 print '\t',key,'=',Module.config[key]
210 def init_moddir (self):
211 if self.options.verbose:
212 print 'Checking for',self.moddir
213 if not os.path.isdir (self.moddir):
214 self.run_fatal("svn up -N %s"%self.moddir)
215 if not os.path.isdir (self.moddir):
216 print 'Cannot find %s - check module name'%self.moddir
219 def init_subdir (self,fullpath):
220 if self.options.verbose:
221 print 'Checking for',fullpath
222 if not os.path.isdir (fullpath):
223 self.run_fatal("svn up -N %s"%fullpath)
225 def revert_subdir (self,fullpath):
226 if self.options.fast_checks:
227 if self.options.verbose: print 'Skipping revert of %s'%fullpath
229 if self.options.verbose:
230 print 'Checking whether',fullpath,'needs being reverted'
231 if Svnpath(fullpath,self.options).dir_needs_revert():
232 self.run_fatal("svn revert -R %s"%fullpath)
234 def update_subdir (self,fullpath):
235 if self.options.fast_checks:
236 if self.options.verbose: print 'Skipping update of %s'%fullpath
238 if self.options.verbose:
239 print 'Updating',fullpath
240 self.run_fatal("svn update -N %s"%fullpath)
242 def init_edge_dir (self):
243 # if branch, edge_dir is two steps down
245 self.init_subdir("%s/branches"%self.moddir)
246 self.init_subdir(self.edge_dir())
248 def revert_edge_dir (self):
249 self.revert_subdir(self.edge_dir())
251 def update_edge_dir (self):
252 self.update_subdir(self.edge_dir())
254 def main_specname (self):
255 attempt="%s/%s.spec"%(self.edge_dir(),self.name)
256 if os.path.isfile (attempt):
260 return glob("%s/*.spec"%self.edge_dir())[0]
262 print 'Cannot guess specfile for module %s'%self.name
265 def all_specnames (self):
266 return glob("%s/*.spec"%self.edge_dir())
268 def parse_spec (self, specfile, varnames):
269 if self.options.debug:
270 print 'parse_spec',specfile,
273 for line in f.readlines():
274 attempt=Module.matcher_rpm_define.match(line)
276 (var,value)=attempt.groups()
280 if self.options.verbose:
281 print 'found',len(result),'keys'
282 if self.options.debug:
283 for (k,v) in result.iteritems():
287 # stores in self.module_name_varname the rpm variable to be used for the module's name
288 # and the list of these names in self.varnames
289 def spec_dict (self):
290 specfile=self.main_specname()
291 redirector_keys = [ varname for (varname,default) in Module.redirectors]
292 redirect_dict = self.parse_spec(specfile,redirector_keys)
293 if self.options.debug:
294 print '1st pass parsing done, redirect_dict=',redirect_dict
296 for (varname,default) in Module.redirectors:
297 if redirect_dict.has_key(varname):
298 setattr(self,varname,redirect_dict[varname])
299 varnames += [redirect_dict[varname]]
301 setattr(self,varname,default)
302 varnames += [ default ]
303 self.varnames = varnames
304 result = self.parse_spec (specfile,self.varnames)
305 if self.options.debug:
306 print '2st pass parsing done, varnames=',varnames,'result=',result
309 def patch_spec_var (self, patch_dict):
310 for specfile in self.all_specnames():
311 newspecfile=specfile+".new"
312 if self.options.verbose:
313 print 'Patching',specfile,'for',patch_dict.keys()
315 new=open(newspecfile,"w")
317 for line in spec.readlines():
318 attempt=Module.matcher_rpm_define.match(line)
320 (var,value)=attempt.groups()
321 if var in patch_dict.keys():
322 new.write('%%define %s %s\n'%(var,patch_dict[var]))
327 os.rename(newspecfile,specfile)
329 def unignored_lines (self, logfile):
331 exclude="Tagging module %s"%self.name
332 for logline in file(logfile).readlines():
333 if logline.strip() == Module.svn_magic_line:
335 if logline.find(exclude) < 0:
336 result += [ logline ]
339 def insert_changelog (self, logfile, oldtag, newtag):
340 for specfile in self.all_specnames():
341 newspecfile=specfile+".new"
342 if self.options.verbose:
343 print 'Inserting changelog from %s into %s'%(logfile,specfile)
345 new=open(newspecfile,"w")
346 for line in spec.readlines():
348 if re.compile('%changelog').match(line):
349 dateformat="* %a %b %d %Y"
350 datepart=time.strftime(dateformat)
351 logpart="%s <%s> - %s %s"%(Module.config['username'],
352 Module.config['email'],
354 new.write(datepart+" "+logpart+"\n")
355 for logline in self.unignored_lines(logfile):
356 new.write("- " + logline)
360 os.rename(newspecfile,specfile)
362 def show_dict (self, spec_dict):
363 if self.options.verbose:
364 for (k,v) in spec_dict.iteritems():
368 return "%s/%s"%(Module.config['svnpath'],self.name)
372 return "%s/trunk"%(self.mod_url())
374 return "%s/branches/%s"%(self.mod_url(),self.branch)
376 def tag_name (self, spec_dict):
378 return "%s-%s-%s"%(#spec_dict[self.module_name_varname],
380 spec_dict[self.module_version_varname],
381 spec_dict[self.module_taglevel_varname])
383 print 'Something is wrong with module %s, cannot determine %s - exiting'%(self.name,err)
386 def tag_url (self, spec_dict):
387 return "%s/tags/%s"%(self.mod_url(),self.tag_name(spec_dict))
389 def check_svnpath_exists (self, url, message):
390 if self.options.fast_checks:
392 if self.options.verbose:
393 print 'Checking url (%s) %s'%(url,message),
394 ok=Svnpath(url,self.options).url_exists()
396 if self.options.verbose: print 'exists - OK'
398 if self.options.verbose: print 'KO'
399 print 'Could not find %s URL %s'%(message,url)
401 def check_svnpath_not_exists (self, url, message):
402 if self.options.fast_checks:
404 if self.options.verbose:
405 print 'Checking url (%s) %s'%(url,message),
406 ok=not Svnpath(url,self.options).url_exists()
408 if self.options.verbose: print 'does not exist - OK'
410 if self.options.verbose: print 'KO'
411 print '%s URL %s already exists - exiting'%(message,url)
414 # locate specfile, parse it, check it and show values
415 ##############################
416 def do_version (self):
419 self.revert_edge_dir()
420 self.update_edge_dir()
421 spec_dict = self.spec_dict()
422 for varname in self.varnames:
423 if not spec_dict.has_key(varname):
424 print 'Could not find %%define for %s'%varname
427 print varname+":",spec_dict[varname]
428 print 'edge url',self.edge_url()
429 print 'latest tag url',self.tag_url(spec_dict)
430 if self.options.verbose:
431 print 'main specfile:',self.main_specname()
432 print 'specfiles:',self.all_specnames()
434 init_warning="""WARNING
435 The module-init function has the following limitations
436 * it does not handle changelogs
437 * it does not scan the -tags*.mk files to adopt the new tags"""
438 ##############################
440 if self.options.verbose:
441 print Module.init_warning
442 if not prompt('Want to proceed anyway'):
447 self.revert_edge_dir()
448 self.update_edge_dir()
449 spec_dict = self.spec_dict()
451 edge_url=self.edge_url()
452 tag_name=self.tag_name(spec_dict)
453 tag_url=self.tag_url(spec_dict)
454 # check the tag does not exist yet
455 self.check_svnpath_not_exists(tag_url,"new tag")
457 if self.options.message:
458 svnopt='--message "%s"'%self.options.message
460 svnopt='--editor-cmd=%s'%self.options.editor
461 self.run_prompt("Create initial tag",
462 "svn copy %s %s %s"%(svnopt,edge_url,tag_url))
464 ##############################
468 self.revert_edge_dir()
469 self.update_edge_dir()
470 spec_dict = self.spec_dict()
471 self.show_dict(spec_dict)
473 edge_url=self.edge_url()
474 tag_url=self.tag_url(spec_dict)
475 self.check_svnpath_exists(edge_url,"edge track")
476 self.check_svnpath_exists(tag_url,"latest tag")
477 diff_output = Command("svn diff %s %s"%(tag_url,edge_url),self.options).output_of()
478 if self.options.list:
482 if not self.options.only or diff_output:
483 print 'x'*40,'module',self.name
484 print 'x'*20,'<',tag_url
485 print 'x'*20,'>',edge_url
488 ##############################
489 def patch_tags_file (self, tagsfile, oldname, newname):
490 newtagsfile=tagsfile+".new"
491 if self.options.verbose:
492 print 'Replacing %s into %s in %s'%(oldname,newname,tagsfile)
494 new=open(newtagsfile,"w")
495 matcher=re.compile("^(.*)%s(.*)"%oldname)
496 for line in tags.readlines():
497 if not matcher.match(line):
500 (begin,end)=matcher.match(line).groups()
501 new.write(begin+newname+end+"\n")
504 os.rename(newtagsfile,tagsfile)
509 self.revert_edge_dir()
510 self.update_edge_dir()
512 spec_dict = self.spec_dict()
513 self.show_dict(spec_dict)
516 edge_url=self.edge_url()
517 old_tag_name = self.tag_name(spec_dict)
518 old_tag_url=self.tag_url(spec_dict)
519 if (self.options.new_version):
520 # new version set on command line
521 spec_dict[self.module_version_varname] = self.options.new_version
522 spec_dict[self.module_taglevel_varname] = 0
525 new_taglevel = str ( int (spec_dict[self.module_taglevel_varname]) + 1)
526 spec_dict[self.module_taglevel_varname] = new_taglevel
529 new_tag_name = self.tag_name(spec_dict)
530 new_tag_url=self.tag_url(spec_dict)
531 self.check_svnpath_exists (edge_url,"edge track")
532 self.check_svnpath_exists (old_tag_url,"previous tag")
533 self.check_svnpath_not_exists (new_tag_url,"new tag")
536 diff_output=Command("svn diff %s %s"%(old_tag_url,edge_url),
537 self.options).output_of()
538 if len(diff_output) == 0:
539 if not prompt ("No difference in trunk for module %s, want to tag anyway"%self.name,False):
542 # side effect in trunk's specfile
543 self.patch_spec_var(spec_dict)
545 # prepare changelog file
546 # we use the standard subversion magic string (see svn_magic_line)
547 # so we can provide useful information, such as version numbers and diff
549 changelog="/tmp/%s-%d.txt"%(self.name,os.getpid())
550 file(changelog,"w").write("""Tagging module %s - %s
553 Please write a changelog for this new tag in the section above
554 """%(self.name,new_tag_name,Module.svn_magic_line))
556 if not self.options.verbose or prompt('Want to see diffs while writing changelog',True):
557 file(changelog,"a").write('DIFF=========\n' + diff_output)
559 if self.options.debug:
563 self.run("%s %s"%(self.options.editor,changelog))
564 # insert changelog in spec
565 if self.options.changelog:
566 self.insert_changelog (changelog,old_tag_name,new_tag_name)
570 buildname=Module.config['build']
573 build = Module(buildname,self.options)
575 build.init_edge_dir()
576 build.revert_edge_dir()
577 build.update_edge_dir()
579 for tagsfile in glob(build.edge_dir()+"/*-tags*.mk"):
580 if prompt("Want to adopt new tag in %s"%tagsfile):
581 self.patch_tags_file(tagsfile,old_tag_name,new_tag_name)
584 paths += self.edge_dir() + " "
585 paths += build.edge_dir() + " "
586 self.run_prompt("Check","svn diff " + paths)
587 self.run_prompt("Commit","svn commit --file %s %s"%(changelog,paths))
588 self.run_prompt("Create tag","svn copy --file %s %s %s"%(changelog,edge_url,new_tag_url))
590 if self.options.debug:
591 print 'Preserving',changelog
595 ##############################
596 def do_branch (self):
598 print 'module-branch is experimental - exiting'
602 print 'Cannot create a branch from another branch - exiting'
608 answer = raw_input ("enter tag name [trunk]").strip()
609 if answer == "" or answer == "trunk":
613 ref="/tags/%s-%s"%(self.name,answer)
616 ref_url = "%s/%s"%(self.mod_url(),ref)
617 self.check_svnpath_exists (ref_url,"branch creation point")
618 print "Using starting point %s"%ref_url
620 spec=self.main_specname()
622 self.init_subdir(self.tags_dir())
623 workdir="%s/%s"%(self.moddir,ref)
625 workdir=self.edge_dir()
627 self.init_subdir(workdir)
628 self.revert_subdir(workdir)
629 self.update_subdir(workdir)
631 print 'got spec',spec
632 if not os.path.isfile(spec):
633 print 'cannot find spec'
635 # read version & taglevel from the origin specfile
637 origin=self.spec_dict()
638 self.show_dict(origin)
640 default_branch=self.options.new_version
641 if not default_branch:
643 match=re.compile("\A(?P<main>.*[\.-_])(?P<subid>[0-9]+)\Z").match(origin['version'])
644 new_subid=int(match.group('subid'))+1
645 default_branch="%s%d"%(match.group('main'),new_subid)
647 # default_branch="not found"
648 new_branch_name=raw_input("Enter branch name [%s] "%default_branch) or default_branch
650 new_branch_url="%s/branches/%s"%(self.mod_url(),new_branch_name)
651 self.check_svnpath_not_exists(new_branch_url,"new branch")
652 print new_branch_name
655 ##############################
656 usage="""Usage: %prog options module_desc [ .. module_desc ]
658 manage subversion tags and specfile
659 requires the specfile to define *version* and *taglevel*
661 redirection variables module_version_varname / module_taglevel_varname
663 by default, the trunk of modules is taken into account
664 in this case, just mention the module name as <module_desc>
666 if you wish to work on a branch rather than on the trunk,
667 you can use the following syntax for <module_desc>
669 works on Mom/branches/2.1
674 # the branch_id is deduced from the current *version* in the trunk's specfile
675 # e.g. if Mom/trunk/Mom.spec specifies %define version 2.3, then this script
676 # would use Mom/branches/2.2
677 # if if stated %define version 3.0, then the script fails
681 'diff' : "show difference between trunk and latest tag",
682 'tag' : """increment taglevel in specfile, insert changelog in specfile,
683 create new tag and and adopt it in build/*-tags*.mk""",
684 'init' : "create initial tag",
685 'version' : "only check specfile and print out details",
686 'branch' : """create a branch for this module.
687 either from trunk, or from a tag""",
693 for function in functions.keys():
694 if sys.argv[0].find(function) >= 0:
698 print "Unsupported command",sys.argv[0]
702 usage += "module-%s.py : %s"%(mode,functions[mode])
703 all_modules=os.path.dirname(sys.argv[0])+"/modules.list"
705 parser=OptionParser(usage=usage,version=subversion_id)
706 parser.add_option("-a","--all",action="store_true",dest="all_modules",default=False,
707 help="run on all modules as found in %s"%all_modules)
708 parser.add_option("-f","--fast-checks",action="store_true",dest="fast_checks",default=False,
709 help="skip safety checks, such as svn updates -- use with care")
710 if mode == "tag" or mode == 'branch':
711 parser.add_option("-s","--set-version",action="store",dest="new_version",default=None,
712 help="set new version and reset taglevel to 0")
714 parser.add_option("-c","--no-changelog", action="store_false", dest="changelog", default=True,
715 help="do not update changelog section in specfile when tagging")
716 if mode == "tag" or mode == "init" :
717 parser.add_option("-e","--editor", action="store", dest="editor", default="emacs",
718 help="specify editor")
720 parser.add_option("-m","--message", action="store", dest="message", default=None,
721 help="specify log message")
723 parser.add_option("-o","--only", action="store_true", dest="only", default=False,
724 help="report diff only for modules that exhibit differences")
726 parser.add_option("-l","--list", action="store_true", dest="list", default=False,
727 help="just list modules that exhibit differences")
728 parser.add_option("-w","--workdir", action="store", dest="workdir",
729 default="%s/%s"%(os.getenv("HOME"),"modules"),
730 help="""name for dedicated working dir - defaults to ~/modules
731 ** THIS MUST NOT ** be your usual working directory""")
732 parser.add_option("-v","--verbose", action="store_true", dest="verbose", default=True,
733 help="run in verbose mode")
734 parser.add_option("-q","--quiet", action="store_false", dest="verbose",
735 help="run in quiet (non-verbose) mode")
736 parser.add_option("-d","--debug", action="store_true", dest="debug", default=False,
737 help="debug mode - mostly more verbose")
738 (options, args) = parser.parse_args()
741 if options.all_modules:
742 args=Command("grep -v '#' %s"%all_modules,options).output_of().split()
746 Module.init_homedir(options)
748 module=Module(modname,options)
749 print '==============================',module.name
750 # call the method called do_<mode>
751 method=Module.__dict__["do_%s"%mode]
754 # basically, we exit if anything goes wrong
755 if __name__ == "__main__" :