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 if self.options.verbose:
88 print 'Checking url',self.path
89 return os.system("svn list %s &> /dev/null"%self.path) == 0
91 def dir_needs_revert (self):
92 command="svn status %s"%self.path
93 return len(Command(command,self.options).output_of(True)) != 0
94 # turns out it's the same implem.
95 def file_needs_commit (self):
96 command="svn status %s"%self.path
97 return len(Command(command,self.options).output_of(True)) != 0
101 svn_magic_line="--This line, and those below, will be ignored--"
103 redirectors=[ # ('module_name_varname','name'),
104 ('module_version_varname','version'),
105 ('module_taglevel_varname','taglevel'), ]
107 # where to store user's config
108 config_storage="CONFIG"
113 configKeys=[ ('svnpath',"Enter your toplevel svnpath",
114 "svn+ssh://%s@svn.planet-lab.org/svn/"%commands.getoutput("id -un")),
115 ("build", "Enter the name of your build module","build"),
116 ('username',"Enter your firstname and lastname for changelogs",""),
117 ("email","Enter your email address for changelogs",""),
121 def prompt_config ():
122 for (key,message,default) in Module.configKeys:
123 Module.config[key]=""
124 while not Module.config[key]:
125 Module.config[key]=raw_input("%s [%s] : "%(message,default)).strip() or default
127 def __init__ (self,name,options):
130 self.moddir="%s/%s"%(options.workdir,name)
131 self.trunkdir="%s/trunk"%(self.moddir)
132 self.varmatcher=re.compile("%define\s+(\S+)\s+(\S*)\s*")
135 def run (self,command):
136 return Command(command,self.options).run()
137 def run_fatal (self,command):
138 return Command(command,self.options).run_fatal()
139 def run_prompt (self,message,command):
140 if not self.options.verbose:
143 question="Want to run " + command
144 if prompt(question,True):
148 def init_homedir (options):
149 topdir=options.workdir
151 print 'Checking for',topdir
152 storage="%s/%s"%(topdir,Module.config_storage)
153 # sanity check. Either the topdir exists AND we have a config/storage
154 # or topdir does not exist and we create it
155 # to avoid people use their own daily svn repo
156 if os.path.isdir(topdir) and not os.path.isfile(storage):
157 print """The directory %s exists and has no CONFIG file
158 If this is your regular working directory, please provide another one as the
159 module-* commands need a fresh working dir. Make sure that you do not use
160 that for other purposes than tagging"""%topdir
162 if not os.path.isdir (topdir):
163 print "Cannot find",topdir,"let's create it"
164 Module.prompt_config()
165 print "Checking ...",
166 Command("svn co -N %s %s"%(Module.config['svnpath'],topdir),options).run_fatal()
167 Command("svn co -N %s/%s %s/%s"%(Module.config['svnpath'],
168 Module.config['build'],
170 Module.config['build']),options).run_fatal()
175 for (key,message,default) in Module.configKeys:
176 f.write("%s=%s\n"%(key,Module.config[key]))
179 print 'Stored',storage
180 Command("cat %s"%storage,options).run()
184 for line in f.readlines():
185 (key,value)=re.compile("^(.+)=(.+)$").match(line).groups()
186 Module.config[key]=value
189 print '******** Using config'
190 for (key,message,default) in Module.configKeys:
191 print '\t',key,'=',Module.config[key]
193 def init_moddir (self):
194 if self.options.verbose:
195 print 'Checking for',self.moddir
196 if not os.path.isdir (self.moddir):
197 self.run_fatal("svn up -N %s"%self.moddir)
198 if not os.path.isdir (self.moddir):
199 print 'Cannot find %s - check module name'%self.moddir
202 def init_trunkdir (self):
203 if self.options.verbose:
204 print 'Checking for',self.trunkdir
205 if not os.path.isdir (self.trunkdir):
206 self.run_fatal("svn up -N %s"%self.trunkdir)
208 def revert_trunkdir (self):
209 if self.options.verbose:
210 print 'Checking whether',self.trunkdir,'needs being reverted'
211 if Svnpath(self.trunkdir,self.options).dir_needs_revert():
212 self.run_fatal("svn revert -R %s"%self.trunkdir)
214 def update_trunkdir (self):
215 if self.options.fast_checks:
217 if self.options.verbose:
218 print 'Updating',self.trunkdir
219 self.run_fatal("svn update -N %s"%self.trunkdir)
221 def main_specname (self):
222 attempt="%s/%s.spec"%(self.trunkdir,self.name)
223 if os.path.isfile (attempt):
227 return glob("%s/*.spec"%self.trunkdir)[0]
229 print 'Cannot guess specfile for module %s'%self.name
232 def all_specnames (self):
233 return glob("%s/*.spec"%self.trunkdir)
235 def parse_spec (self, specfile, varnames):
236 if self.options.debug:
237 print 'parse_spec',specfile,
240 for line in f.readlines():
241 if self.varmatcher.match(line):
242 (var,value)=self.varmatcher.match(line).groups()
246 if self.options.verbose:
247 print 'found',len(result),'keys'
248 if self.options.debug:
249 for (k,v) in result.iteritems():
253 # stores in self.module_name_varname the rpm variable to be used for the module's name
254 # and the list of these names in self.varnames
255 def spec_dict (self):
256 specfile=self.main_specname()
257 redirector_keys = [ varname for (varname,default) in Module.redirectors]
258 redirect_dict = self.parse_spec(specfile,redirector_keys)
259 if self.options.debug:
260 print '1st pass parsing done, redirect_dict=',redirect_dict
262 for (varname,default) in Module.redirectors:
263 if redirect_dict.has_key(varname):
264 setattr(self,varname,redirect_dict[varname])
265 varnames += [redirect_dict[varname]]
267 setattr(self,varname,default)
268 varnames += [ default ]
269 self.varnames = varnames
270 result = self.parse_spec (specfile,self.varnames)
271 if self.options.debug:
272 print '2st pass parsing done, varnames=',varnames,'result=',result
275 def patch_spec_var (self, patch_dict):
276 for specfile in self.all_specnames():
277 newspecfile=specfile+".new"
278 if self.options.verbose:
279 print 'Patching',specfile,'for',patch_dict.keys()
281 new=open(newspecfile,"w")
283 for line in spec.readlines():
284 if self.varmatcher.match(line):
285 (var,value)=self.varmatcher.match(line).groups()
286 if var in patch_dict.keys():
287 new.write('%%define %s %s\n'%(var,patch_dict[var]))
292 os.rename(newspecfile,specfile)
294 def unignored_lines (self, logfile):
296 exclude="Tagging module %s"%self.name
297 for logline in file(logfile).readlines():
298 if logline.strip() == Module.svn_magic_line:
300 if logline.find(exclude) < 0:
301 result += [ logline ]
304 def insert_changelog (self, logfile, oldtag, newtag):
305 for specfile in self.all_specnames():
306 newspecfile=specfile+".new"
307 if self.options.verbose:
308 print 'Inserting changelog from %s into %s'%(logfile,specfile)
310 new=open(newspecfile,"w")
311 for line in spec.readlines():
313 if re.compile('%changelog').match(line):
314 dateformat="* %a %b %d %Y"
315 datepart=time.strftime(dateformat)
316 logpart="%s <%s> - %s %s"%(Module.config['username'],
317 Module.config['email'],
319 new.write(datepart+" "+logpart+"\n")
320 for logline in self.unignored_lines(logfile):
321 new.write("- " + logline)
325 os.rename(newspecfile,specfile)
327 def show_dict (self, spec_dict):
328 if self.options.verbose:
329 for (k,v) in spec_dict.iteritems():
332 def trunk_url (self):
333 return "%s/%s/trunk"%(Module.config['svnpath'],self.name)
334 def tag_name (self, spec_dict):
335 return "%s-%s-%s"%(#spec_dict[self.module_name_varname],
337 spec_dict[self.module_version_varname],
338 spec_dict[self.module_taglevel_varname])
339 def tag_url (self, spec_dict):
340 return "%s/%s/tags/%s"%(Module.config['svnpath'],self.name,self.tag_name(spec_dict))
342 # locate specfile, parse it, check it and show values
343 def do_version (self):
346 self.revert_trunkdir()
347 self.update_trunkdir()
348 print '==============================',self.name
349 spec_dict = self.spec_dict()
350 print 'trunk url',self.trunk_url()
351 print 'latest tag url',self.tag_url(spec_dict)
352 print 'main specfile:',self.main_specname()
353 print 'specfiles:',self.all_specnames()
354 for varname in self.varnames:
355 if not spec_dict.has_key(varname):
356 print 'Could not find %%define for %s'%varname
359 print varname+":",spec_dict[varname]
361 init_warning="""WARNING
362 The module-init function has the following limitations
363 * it does not handle changelogs
364 * it does not scan the -tags*.mk files to adopt the new tags"""
366 if self.options.verbose:
367 print Module.init_warning
368 if not prompt('Want to proceed anyway'):
373 self.revert_trunkdir()
374 self.update_trunkdir()
375 spec_dict = self.spec_dict()
377 trunk_url=self.trunk_url()
378 tag_name=self.tag_name(spec_dict)
379 tag_url=self.tag_url(spec_dict)
380 # check the tag does not exist yet
381 if not self.options.fast_checks and Svnpath(tag_url,self.options).url_exists():
382 print 'Module %s already has a tag %s'%(self.name,tag_name)
385 if self.options.message:
386 svnopt='--message "%s"'%self.options.message
388 svnopt='--editor-cmd=%s'%self.options.editor
389 self.run_prompt("Create initial tag",
390 "svn copy %s %s %s"%(svnopt,trunk_url,tag_url))
395 self.revert_trunkdir()
396 self.update_trunkdir()
397 spec_dict = self.spec_dict()
398 self.show_dict(spec_dict)
400 trunk_url=self.trunk_url()
401 tag_url=self.tag_url(spec_dict)
402 diff_output = Command("svn diff %s %s"%(tag_url,trunk_url),self.options).output_of()
403 if self.options.list:
407 if not self.options.only or diff_output:
408 print 'x'*40,'module',self.name
409 print 'x'*20,'<',tag_url
410 print 'x'*20,'>',trunk_url
413 def patch_tags_file (self, tagsfile, oldname, newname):
414 newtagsfile=tagsfile+".new"
415 if self.options.verbose:
416 print 'Replacing %s into %s in %s'%(oldname,newname,tagsfile)
418 new=open(newtagsfile,"w")
419 matcher=re.compile("^(.*)%s(.*)"%oldname)
420 for line in tags.readlines():
421 if not matcher.match(line):
424 (begin,end)=matcher.match(line).groups()
425 new.write(begin+newname+end+"\n")
428 os.rename(newtagsfile,tagsfile)
433 self.revert_trunkdir()
434 self.update_trunkdir()
436 spec_dict = self.spec_dict()
437 self.show_dict(spec_dict)
440 trunk_url=self.trunk_url()
441 old_tag_name = self.tag_name(spec_dict)
442 old_tag_url=self.tag_url(spec_dict)
443 if (self.options.new_version):
444 # new version set on command line
445 spec_dict[self.module_version_varname] = self.options.new_version
446 spec_dict[self.module_taglevel_varname] = 0
449 new_taglevel = str ( int (spec_dict[self.module_taglevel_varname]) + 1)
450 spec_dict[self.module_taglevel_varname] = new_taglevel
453 new_tag_name = self.tag_name(spec_dict)
454 new_tag_url=self.tag_url(spec_dict)
455 for url in [ trunk_url, old_tag_url ] :
456 if not self.options.fast_checks and not Svnpath(url,self.options).url_exists():
457 print 'Could not find svn URL %s'%url
459 if not self.options.fast_checks and Svnpath(new_tag_url,self.options).url_exists():
460 print 'New tag\'s svn URL %s already exists ! '%url
464 diff_output=Command("svn diff %s %s"%(old_tag_url,trunk_url),
465 self.options).output_of()
466 if len(diff_output) == 0:
467 if not prompt ("No difference in trunk for module %s, want to tag anyway"%self.name,False):
470 # side effect in trunk's specfile
471 self.patch_spec_var(spec_dict)
473 # prepare changelog file
474 # we use the standard subversion magic string (see svn_magic_line)
475 # so we can provide useful information, such as version numbers and diff
477 changelog="/tmp/%s-%d.txt"%(self.name,os.getpid())
478 file(changelog,"w").write("""Tagging module %s - %s
481 Please write a changelog for this new tag in the section above
482 """%(self.name,new_tag_name,Module.svn_magic_line))
484 if not self.options.verbose or prompt('Want to see diffs while writing changelog',True):
485 file(changelog,"a").write('DIFF=========\n' + diff_output)
487 if self.options.debug:
491 self.run("%s %s"%(self.options.editor,changelog))
492 # insert changelog in spec
493 if self.options.changelog:
494 self.insert_changelog (changelog,old_tag_name,new_tag_name)
498 buildname=Module.config['build']
501 build = Module(buildname,self.options)
503 build.init_trunkdir()
504 build.revert_trunkdir()
505 build.update_trunkdir()
507 for tagsfile in glob(build.trunkdir+"/*-tags*.mk"):
508 if prompt("Want to adopt new tag in %s"%tagsfile):
509 self.patch_tags_file(tagsfile,old_tag_name,new_tag_name)
512 paths += self.trunkdir + " "
513 paths += build.trunkdir + " "
514 self.run_prompt("Check","svn diff " + paths)
515 self.run_prompt("Commit","svn commit --file %s %s"%(changelog,paths))
516 self.run_prompt("Create tag","svn copy --file %s %s %s"%(changelog,trunk_url,new_tag_url))
518 if self.options.debug:
519 print 'Preserving',changelog
523 usage="""Usage: %prog options module1 [ .. modulen ]
525 manage subversion tags and specfile
526 requires the specfile to define version and taglevel
528 redirection variables module_version_varname / module_taglevel_varname
531 'diff' : "show difference between trunk and latest tag",
532 'tag' : """increment taglevel in specfile, insert changelog in specfile,
533 create new tag and and adopt it in build/*-tags*.mk""",
534 'init' : "create initial tag",
535 'version' : "only check specfile and print out details"}
539 if sys.argv[0].find("diff") >= 0:
541 elif sys.argv[0].find("tag") >= 0:
543 elif sys.argv[0].find("init") >= 0:
545 elif sys.argv[0].find("version") >= 0:
548 print "Unsupported command",sys.argv[0]
552 usage += "module-%s.py : %s"%(mode,functions[mode])
553 all_modules=os.path.dirname(sys.argv[0])+"/modules.list"
555 parser=OptionParser(usage=usage,version=subversion_id)
556 parser.add_option("-a","--all",action="store_true",dest="all_modules",default=False,
557 help="run on all modules as found in %s"%all_modules)
558 parser.add_option("-f","--fast-checks",action="store_true",dest="fast_checks",default=False,
559 help="skip safety checks, such as svn updates -- use with care")
561 parser.add_option("-s","--set-version",action="store",dest="new_version",default=None,
562 help="set new version and reset taglevel to 0")
564 parser.add_option("-c","--no-changelog", action="store_false", dest="changelog", default=True,
565 help="do not update changelog section in specfile when tagging")
566 if mode == "tag" or mode == "init" :
567 parser.add_option("-e","--editor", action="store", dest="editor", default="emacs",
568 help="specify editor")
570 parser.add_option("-m","--message", action="store", dest="message", default=None,
571 help="specify log message")
573 parser.add_option("-o","--only", action="store_true", dest="only", default=False,
574 help="report diff only for modules that exhibit differences")
576 parser.add_option("-l","--list", action="store_true", dest="list", default=False,
577 help="just list modules that exhibit differences")
578 parser.add_option("-w","--workdir", action="store", dest="workdir",
579 default="%s/%s"%(os.getenv("HOME"),"modules"),
580 help="""name for dedicated working dir - defaults to ~/modules
581 ** THIS MUST NOT ** be your usual working directory""")
582 parser.add_option("-v","--verbose", action="store_true", dest="verbose", default=False,
583 help="run in verbose mode")
584 parser.add_option("-d","--debug", action="store_true", dest="debug", default=False,
585 help="debug mode - mostly more verbose")
586 (options, args) = parser.parse_args()
587 if options.debug: options.verbose=True
590 if options.all_modules:
591 args=Command("grep -v '#' %s"%all_modules,options).output_of().split()
595 Module.init_homedir(options)
597 module=Module(modname,options)
598 if sys.argv[0].find("diff") >= 0:
600 elif sys.argv[0].find("tag") >= 0:
602 elif sys.argv[0].find("init") >= 0:
604 elif sys.argv[0].find("version") >= 0:
607 print "Unsupported command",sys.argv[0]
611 # basically, we exit if anything goes wrong
612 if __name__ == "__main__" :