7 from optparse import OptionParser
9 # HARDCODED NAME CHANGES
11 # Moving to git we decided to rename some of the repositories. Here is
12 # a map of name changes applied in git repositories.
13 RENAMED_SVN_MODULES = {
16 "BootManager": "bootmanager",
18 "VserverReference": "vserver-reference",
19 "BootstrapFS": "bootstrapfs",
22 "NodeManager": "nodemanager",
23 "NodeUpdate": "nodeupdate"
26 def svn_to_git_name(module):
27 if RENAMED_SVN_MODULES.has_key(module):
28 return RENAMED_SVN_MODULES[module]
31 def git_to_svn_name(module):
32 for key in RENAMED_SVN_MODULES:
33 if module == RENAMED_SVN_MODULES[key]:
38 # e.g. other_choices = [ ('d','iff') , ('g','uess') ] - lowercase
39 def prompt (question,default=True,other_choices=[],allow_outside=False):
40 if not isinstance (other_choices,list):
41 other_choices = [ other_choices ]
42 chars = [ c for (c,rest) in other_choices ]
46 if default is True: choices.append('[y]')
47 else : choices.append('y')
49 if default is False: choices.append('[n]')
50 else : choices.append('n')
52 for (char,choice) in other_choices:
54 choices.append("["+char+"]"+choice)
56 choices.append("<"+char+">"+choice)
58 answer=raw_input(question + " " + "/".join(choices) + " ? ")
61 answer=answer[0].lower()
63 if 'y' in chars: return 'y'
66 if 'n' in chars: return 'n'
69 for (char,choice) in other_choices:
74 return prompt(question,default,other_choices)
80 editor = os.environ['EDITOR']
88 def print_fold (line):
89 while len(line) >= fold_length:
90 print line[:fold_length],'\\'
91 line=line[fold_length:]
95 def __init__ (self,command,options):
98 self.tmp="/tmp/command-%d"%os.getpid()
101 if self.options.dry_run:
102 print 'dry_run',self.command
104 if self.options.verbose and self.options.mode not in Main.silent_modes:
105 print '+',self.command
107 return os.system(self.command)
109 def run_silent (self):
110 if self.options.dry_run:
111 print 'dry_run',self.command
113 if self.options.verbose:
114 print '+',self.command,' .. ',
116 retcod=os.system(self.command + " &> " + self.tmp)
118 print "FAILED ! -- out+err below (command was %s)"%self.command
119 os.system("cat " + self.tmp)
120 print "FAILED ! -- end of quoted output"
121 elif self.options.verbose:
127 if self.run_silent() !=0:
128 raise Exception,"Command %s failed"%self.command
130 # returns stdout, like bash's $(mycommand)
131 def output_of (self,with_stderr=False):
132 if self.options.dry_run:
133 print 'dry_run',self.command
134 return 'dry_run output'
135 tmp="/tmp/status-%d"%os.getpid()
136 if self.options.debug:
137 print '+',self.command,' .. ',
146 result=file(tmp).read()
148 if self.options.debug:
156 def __init__(self, path, options):
158 self.options = options
161 return os.path.basename(self.path)
164 out = Command("svn info %s" % self.path, self.options).output_of()
165 for line in out.split('\n'):
166 if line.startswith("URL:"):
167 return line.split()[1].strip()
170 out = Command("svn info %s" % self.path, self.options).output_of()
171 for line in out.split('\n'):
172 if line.startswith("Repository Root:"):
173 root = line.split()[2].strip()
174 return "%s/%s" % (root, self.name())
177 def checkout(cls, remote, local, options, recursive=False):
179 svncommand = "svn co %s %s" % (remote, local)
181 svncommand = "svn co -N %s %s" % (remote, local)
182 Command("rm -rf %s" % local, options).run_silent()
183 Command(svncommand, options).run_fatal()
185 return SvnRepository(local, options)
188 def remote_exists(cls, remote):
189 return os.system("svn list %s &> /dev/null" % remote) == 0
191 def tag_exists(self, tagname):
192 url = "%s/tags/%s" % (self.repo_root(), tagname)
193 return SvnRepository.remote_exists(url)
195 def update(self, subdir="", recursive=True, branch=None):
196 path = os.path.join(self.path, subdir)
198 svncommand = "svn up %s" % path
200 svncommand = "svn up -N %s" % path
201 Command(svncommand, self.options).run_fatal()
203 def commit(self, logfile):
204 # add all new files to the repository
205 Command("svn status %s | grep '^\?' | sed -e 's/? *//' | sed -e 's/ /\\ /g' | xargs svn add" %
206 self.path, self.options).output_of()
207 Command("svn commit -F %s %s" % (logfile, self.path), self.options).run_fatal()
209 def to_branch(self, branch):
210 remote = "%s/branches/%s" % (self.repo_root(), branch)
211 SvnRepository.checkout(remote, self.path, self.options, recursive=True)
213 def to_tag(self, tag):
214 remote = "%s/tags/%s" % (self.repo_root(), branch)
215 SvnRepository.checkout(remote, self.path, self.options, recursive=True)
217 def tag(self, tagname, logfile):
218 tag_url = "%s/tags/%s" % (self.repo_root(), tagname)
219 self_url = self.url()
220 Command("svn copy -F %s %s %s" % (logfile, self_url, tag_url), self.options).run_fatal()
222 def diff(self, f=""):
224 f = os.path.join(self.path, f)
227 return Command("svn diff %s" % f, self.options).output_of(True)
229 def diff_with_tag(self, tagname):
230 tag_url = "%s/tags/%s" % (self.repo_root(), tagname)
231 return Command("svn diff %s %s" % (tag_url, self.url()),
232 self.options).output_of(True)
234 def revert(self, f=""):
236 Command("svn revert %s" % os.path.join(self.path, f), self.options).run_fatal()
239 Command("svn revert %s -R" % self.path, self.options).run_fatal()
240 Command("svn status %s | grep '^\?' | sed -e 's/? *//' | sed -e 's/ /\\ /g' | xargs rm -rf " %
241 self.path, self.options).run_silent()
244 command="svn status %s" % self.path
245 return len(Command(command,self.options).output_of(True)) == 0
248 return os.path.exists(os.path.join(self.path, ".svn"))
254 def __init__(self, path, options):
256 self.options = options
259 return os.path.basename(self.path)
265 c = Command("git remote show origin", self.options)
266 out = self.__run_in_repo(c.output_of)
267 for line in out.split('\n'):
268 if line.strip().startswith("Fetch URL:"):
269 repo = line.split()[2]
272 def checkout(cls, remote, local, options, depth=1):
273 Command("rm -rf %s" % local, options).run_silent()
274 Command("git clone --depth %d %s %s" % (depth, remote, local), options).run_fatal()
275 return GitRepository(local, options)
278 def remote_exists(cls, remote):
279 return os.system("git --no-pager ls-remote %s &> /dev/null" % remote) == 0
281 def tag_exists(self, tagname):
282 command = 'git tag -l | grep "^%s$"' % tagname
283 c = Command(command, self.options)
284 out = self.__run_in_repo(c.output_of, with_stderr=True)
287 def __run_in_repo(self, fun, *args, **kwargs):
290 ret = fun(*args, **kwargs)
294 def __run_command_in_repo(self, command, ignore_errors=False):
295 c = Command(command, self.options)
297 return self.__run_in_repo(c.output_of)
299 return self.__run_in_repo(c.run_fatal)
301 def update(self, subdir=None, recursive=None, branch="master"):
302 if branch == "master":
303 self.__run_command_in_repo("git checkout %s" % branch)
305 self.__run_command_in_repo("git checkout origin/%s" % branch)
306 self.__run_command_in_repo("git fetch origin --tags")
307 self.__run_command_in_repo("git fetch origin")
308 self.__run_command_in_repo("git merge --ff origin/%s" % branch)
310 def to_branch(self, branch, remote=True):
312 command = "git branch --track %s origin/%s" % (branch, branch)
313 c = Command(command, self.options)
314 self.__run_in_repo(c.output_of, with_stderr=True)
315 return self.__run_command_in_repo("git checkout %s" % branch)
317 def to_tag(self, tag):
318 return self.__run_command_in_repo("git checkout %s" % tag)
320 def tag(self, tagname, logfile):
321 self.__run_command_in_repo("git tag %s -F %s" % (tagname, logfile))
324 def diff(self, f=""):
325 c = Command("git diff %s" % f, self.options)
326 return self.__run_in_repo(c.output_of, with_stderr=True)
328 def diff_with_tag(self, tagname):
329 c = Command("git diff %s" % tagname, self.options)
330 return self.__run_in_repo(c.output_of, with_stderr=True)
332 def commit(self, logfile, branch="master"):
333 self.__run_command_in_repo("git add .", ignore_errors=True)
334 self.__run_command_in_repo("git add -u", ignore_errors=True)
335 self.__run_command_in_repo("git commit -F %s" % logfile, ignore_errors=True)
336 if branch == "master":
337 self.__run_command_in_repo("git push")
339 self.__run_command_in_repo("git push %s:%s" % (branch, branch))
340 self.__run_command_in_repo("git push --tags")
342 def revert(self, f=""):
344 self.__run_command_in_repo("git checkout %s" % f)
347 self.__run_command_in_repo("git --no-pager reset --hard")
348 self.__run_command_in_repo("git --no-pager clean -f")
353 s="nothing to commit (working directory clean)"
354 return Command(command, self.options).output_of(True).find(s) >= 0
355 return self.__run_in_repo(check_commit)
358 return os.path.exists(os.path.join(self.path, ".git"))
362 """ Generic repository """
363 supported_repo_types = [SvnRepository, GitRepository]
365 def __init__(self, path, options):
367 self.options = options
368 for repo in self.supported_repo_types:
369 self.repo = repo(self.path, self.options)
370 if self.repo.is_valid():
374 def has_moved_to_git(cls, module, config):
375 module = svn_to_git_name(module)
376 # check if the module is already in Git
377 # return SvnRepository.remote_exists("%s/%s/aaaa-has-moved-to-git" % (config['svnpath'], module))
378 return GitRepository.remote_exists(Module.git_remote_dir(module))
382 def remote_exists(cls, remote):
383 for repo in Repository.supported_repo_types:
384 if repo.remote_exists(remote):
388 def __getattr__(self, attr):
389 return getattr(self.repo, attr)
393 # support for tagged module is minimal, and is for the Build class only
396 svn_magic_line="--This line, and those below, will be ignored--"
397 setting_tag_format = "Setting tag %s"
399 redirectors=[ # ('module_name_varname','name'),
400 ('module_version_varname','version'),
401 ('module_taglevel_varname','taglevel'), ]
403 # where to store user's config
404 config_storage="CONFIG"
409 configKeys=[ ('svnpath',"Enter your toplevel svnpath",
410 "svn+ssh://%s@svn.planet-lab.org/svn/"%commands.getoutput("id -un")),
411 ('gitserver', "Enter your git server's hostname", "git.onelab.eu"),
412 ('gituser', "Enter your user name (login name) on git server", commands.getoutput("id -un")),
413 ("build", "Enter the name of your build module","build"),
414 ('username',"Enter your firstname and lastname for changelogs",""),
415 ("email","Enter your email address for changelogs",""),
419 def prompt_config_option(cls, key, message, default):
420 cls.config[key]=raw_input("%s [%s] : "%(message,default)).strip() or default
423 def prompt_config (cls):
424 for (key,message,default) in cls.configKeys:
426 while not cls.config[key]:
427 cls.prompt_config_option(key, message, default)
430 # for parsing module spec name:branch
431 matcher_branch_spec=re.compile("\A(?P<name>[\w\.-]+):(?P<branch>[\w\.-]+)\Z")
432 # special form for tagged module - for Build
433 matcher_tag_spec=re.compile("\A(?P<name>[\w-]+)@(?P<tagname>[\w\.-]+)\Z")
435 matcher_rpm_define=re.compile("%(define|global)\s+(\S+)\s+(\S*)\s*")
437 def __init__ (self,module_spec,options):
439 attempt=Module.matcher_branch_spec.match(module_spec)
441 self.name=attempt.group('name')
442 self.branch=attempt.group('branch')
444 attempt=Module.matcher_tag_spec.match(module_spec)
446 self.name=attempt.group('name')
447 self.tagname=attempt.group('tagname')
449 self.name=module_spec
451 # when available prefer to use git module name internally
452 self.name = svn_to_git_name(self.name)
455 self.module_dir="%s/%s"%(options.workdir,self.name)
456 self.repository = None
459 def run (self,command):
460 return Command(command,self.options).run()
461 def run_fatal (self,command):
462 return Command(command,self.options).run_fatal()
463 def run_prompt (self,message,fun, *args):
464 fun_msg = "%s(%s)" % (fun.func_name, ",".join(args))
465 if not self.options.verbose:
467 choice=prompt(message,True,('s','how'))
471 elif choice is False:
472 print 'About to run function:', fun_msg
474 question=message+" - want to run function: " + fun_msg
475 if prompt(question,True):
478 def friendly_name (self):
479 if hasattr(self,'branch'):
480 return "%s:%s"%(self.name,self.branch)
481 elif hasattr(self,'tagname'):
482 return "%s@%s"%(self.name,self.tagname)
487 def git_remote_dir (cls, name):
488 return "%s@%s:/git/%s.git" % (cls.config['gituser'], cls.config['gitserver'], name)
491 def svn_remote_dir (cls, name):
492 name = git_to_svn_name(name)
493 svn = cls.config['svnpath']
494 if svn.endswith('/'):
495 return "%s%s" % (svn, name)
496 return "%s/%s" % (svn, name)
498 def svn_selected_remote(self):
499 svn_name = git_to_svn_name(self.name)
500 remote = self.svn_remote_dir(svn_name)
501 if hasattr(self,'branch'):
502 remote = "%s/branches/%s" % (remote, self.branch)
503 elif hasattr(self,'tagname'):
504 remote = "%s/tags/%s" % (remote, self.tagname)
506 remote = "%s/trunk" % remote
511 def init_homedir (cls, options):
512 if options.verbose and options.mode not in Main.silent_modes:
513 print 'Checking for', options.workdir
514 storage="%s/%s"%(options.workdir, cls.config_storage)
515 # sanity check. Either the topdir exists AND we have a config/storage
516 # or topdir does not exist and we create it
517 # to avoid people use their own daily svn repo
518 if os.path.isdir(options.workdir) and not os.path.isfile(storage):
519 print """The directory %s exists and has no CONFIG file
520 If this is your regular working directory, please provide another one as the
521 module-* commands need a fresh working dir. Make sure that you do not use
522 that for other purposes than tagging""" % options.workdir
525 def checkout_build():
526 print "Checking out build module..."
527 remote = cls.git_remote_dir(cls.config['build'])
528 local = os.path.join(options.workdir, cls.config['build'])
529 GitRepository.checkout(remote, local, options, depth=1)
534 for (key,message,default) in Module.configKeys:
535 f.write("%s=%s\n"%(key,Module.config[key]))
538 print 'Stored',storage
539 Command("cat %s"%storage,options).run()
544 for line in f.readlines():
545 (key,value)=re.compile("^(.+)=(.+)$").match(line).groups()
546 Module.config[key]=value
549 if not os.path.isdir (options.workdir):
550 print "Cannot find",options.workdir,"let's create it"
551 Command("mkdir -p %s" % options.workdir, options).run_silent()
557 # check missing config options
559 for (key,message,default) in cls.configKeys:
560 if not Module.config.has_key(key):
561 print "Configuration changed for module-tools"
562 cls.prompt_config_option(key, message, default)
566 Command("rm -rf %s" % options.workdir, options).run_silent()
567 Command("mkdir -p %s" % options.workdir, options).run_silent()
571 build_dir = os.path.join(options.workdir, cls.config['build'])
572 if not os.path.isdir(build_dir):
575 build = Repository(build_dir, options)
576 if not build.is_clean():
577 print "build module needs a revert"
582 if options.verbose and options.mode not in Main.silent_modes:
583 print '******** Using config'
584 for (key,message,default) in Module.configKeys:
585 print '\t',key,'=',Module.config[key]
587 def init_module_dir (self):
588 if self.options.verbose:
589 print 'Checking for',self.module_dir
591 if not os.path.isdir (self.module_dir):
592 if Repository.has_moved_to_git(self.name, Module.config):
593 self.repository = GitRepository.checkout(self.git_remote_dir(self.name),
597 remote = self.svn_selected_remote()
598 self.repository = SvnRepository.checkout(remote,
600 self.options, recursive=False)
602 self.repository = Repository(self.module_dir, self.options)
603 if self.repository.type == "svn":
604 # check if module has moved to git
605 if Repository.has_moved_to_git(self.name, Module.config):
606 Command("rm -rf %s" % self.module_dir, self.options).run_silent()
607 self.init_module_dir()
608 # check if we have the required branch/tag
609 if self.repository.url() != self.svn_selected_remote():
610 Command("rm -rf %s" % self.module_dir, self.options).run_silent()
611 self.init_module_dir()
613 elif self.repository.type == "git":
614 if hasattr(self,'branch'):
615 self.repository.to_branch(self.branch)
616 elif hasattr(self,'tagname'):
617 self.repository.to_tag(self.tagname)
620 raise Exception, 'Cannot find %s - check module name'%self.module_dir
623 def revert_module_dir (self):
624 if self.options.fast_checks:
625 if self.options.verbose: print 'Skipping revert of %s' % self.module_dir
627 if self.options.verbose:
628 print 'Checking whether', self.module_dir, 'needs being reverted'
630 if not self.repository.is_clean():
631 self.repository.revert()
633 def update_module_dir (self):
634 if self.options.fast_checks:
635 if self.options.verbose: print 'Skipping update of %s' % self.module_dir
637 if self.options.verbose:
638 print 'Updating', self.module_dir
640 if hasattr(self,'branch'):
641 self.repository.update(branch=self.branch)
642 elif hasattr(self,'tagname'):
643 self.repository.update(branch=self.tagname)
645 self.repository.update()
647 def main_specname (self):
648 attempt="%s/%s.spec"%(self.module_dir,self.name)
649 if os.path.isfile (attempt):
651 pattern1="%s/*.spec"%self.module_dir
652 level1=glob(pattern1)
655 pattern2="%s/*/*.spec"%self.module_dir
656 level2=glob(pattern2)
660 raise Exception, 'Cannot guess specfile for module %s -- patterns were %s or %s'%(self.name,pattern1,pattern2)
662 def all_specnames (self):
663 level1=glob("%s/*.spec" % self.module_dir)
664 if level1: return level1
665 level2=glob("%s/*/*.spec" % self.module_dir)
668 def parse_spec (self, specfile, varnames):
669 if self.options.verbose:
670 print 'Parsing',specfile,
676 for line in f.readlines():
677 attempt=Module.matcher_rpm_define.match(line)
679 (define,var,value)=attempt.groups()
683 if self.options.debug:
684 print 'found',len(result),'keys'
685 for (k,v) in result.iteritems():
689 # stores in self.module_name_varname the rpm variable to be used for the module's name
690 # and the list of these names in self.varnames
691 def spec_dict (self):
692 specfile=self.main_specname()
693 redirector_keys = [ varname for (varname,default) in Module.redirectors]
694 redirect_dict = self.parse_spec(specfile,redirector_keys)
695 if self.options.debug:
696 print '1st pass parsing done, redirect_dict=',redirect_dict
698 for (varname,default) in Module.redirectors:
699 if redirect_dict.has_key(varname):
700 setattr(self,varname,redirect_dict[varname])
701 varnames += [redirect_dict[varname]]
703 setattr(self,varname,default)
704 varnames += [ default ]
705 self.varnames = varnames
706 result = self.parse_spec (specfile,self.varnames)
707 if self.options.debug:
708 print '2st pass parsing done, varnames=',varnames,'result=',result
711 def patch_spec_var (self, patch_dict,define_missing=False):
712 for specfile in self.all_specnames():
713 # record the keys that were changed
714 changed = dict ( [ (x,False) for x in patch_dict.keys() ] )
715 newspecfile=specfile+".new"
716 if self.options.verbose:
717 print 'Patching',specfile,'for',patch_dict.keys()
719 new=open(newspecfile,"w")
721 for line in spec.readlines():
722 attempt=Module.matcher_rpm_define.match(line)
724 (define,var,value)=attempt.groups()
725 if var in patch_dict.keys():
726 if self.options.debug:
727 print 'rewriting %s as %s'%(var,patch_dict[var])
728 new.write('%%%s %s %s\n'%(define,var,patch_dict[var]))
733 for (key,was_changed) in changed.iteritems():
735 if self.options.debug:
736 print 'rewriting missing %s as %s'%(key,patch_dict[key])
737 new.write('\n%%define %s %s\n'%(key,patch_dict[key]))
740 os.rename(newspecfile,specfile)
742 # returns all lines until the magic line
743 def unignored_lines (self, logfile):
745 white_line_matcher = re.compile("\A\s*\Z")
746 for logline in file(logfile).readlines():
747 if logline.strip() == Module.svn_magic_line:
749 elif white_line_matcher.match(logline):
752 result.append(logline.strip()+'\n')
755 # creates a copy of the input with only the unignored lines
756 def stripped_magic_line_filename (self, filein, fileout ,new_tag_name):
758 f.write(self.setting_tag_format%new_tag_name + '\n')
759 for line in self.unignored_lines(filein):
763 def insert_changelog (self, logfile, oldtag, newtag):
764 for specfile in self.all_specnames():
765 newspecfile=specfile+".new"
766 if self.options.verbose:
767 print 'Inserting changelog from %s into %s'%(logfile,specfile)
769 new=open(newspecfile,"w")
770 for line in spec.readlines():
772 if re.compile('%changelog').match(line):
773 dateformat="* %a %b %d %Y"
774 datepart=time.strftime(dateformat)
775 logpart="%s <%s> - %s"%(Module.config['username'],
776 Module.config['email'],
778 new.write(datepart+" "+logpart+"\n")
779 for logline in self.unignored_lines(logfile):
780 new.write("- " + logline)
784 os.rename(newspecfile,specfile)
786 def show_dict (self, spec_dict):
787 if self.options.verbose:
788 for (k,v) in spec_dict.iteritems():
791 def last_tag (self, spec_dict):
793 return "%s-%s" % (spec_dict[self.module_version_varname],
794 spec_dict[self.module_taglevel_varname])
796 raise Exception,'Something is wrong with module %s, cannot determine %s - exiting'%(self.name,err)
798 def tag_name (self, spec_dict, old_svn_name=False):
799 base_tag_name = self.name
801 base_tag_name = git_to_svn_name(self.name)
802 return "%s-%s" % (base_tag_name, self.last_tag(spec_dict))
805 ##############################
806 # using fine_grain means replacing only those instances that currently refer to this tag
807 # otherwise, <module>-{SVNPATH,GITPATH} is replaced unconditionnally
808 def patch_tags_file (self, tagsfile, oldname, newname,fine_grain=True):
809 newtagsfile=tagsfile+".new"
811 new=open(newtagsfile,"w")
814 # fine-grain : replace those lines that refer to oldname
816 if self.options.verbose:
817 print 'Replacing %s into %s\n\tin %s .. '%(oldname,newname,tagsfile),
818 matcher=re.compile("^(.*)%s(.*)"%oldname)
819 for line in tags.readlines():
820 if not matcher.match(line):
823 (begin,end)=matcher.match(line).groups()
824 new.write(begin+newname+end+"\n")
826 # brute-force : change uncommented lines that define <module>-SVNPATH
828 if self.options.verbose:
829 print 'Searching for -SVNPATH or -GITPATH lines referring to /%s/\n\tin %s .. '%(self.name,tagsfile),
830 pattern="\A\s*(?P<make_name>[^\s]+)-(SVNPATH|GITPATH)\s*(=|:=)\s*(?P<url_main>[^\s]+)/%s[^\s]+"\
832 matcher_module=re.compile(pattern)
833 for line in tags.readlines():
834 attempt=matcher_module.match(line)
836 if line.find("-GITPATH") >= 0:
837 modulepath = "%s-GITPATH"%(attempt.group('make_name'))
838 replacement = "%-32s:= %s/%s.git@%s\n"%(modulepath,attempt.group('url_main'),self.name,newname)
840 modulepath = "%s-SVNPATH"%(attempt.group('make_name'))
841 replacement = "%-32s:= %s/%s/tags/%s\n"%(modulepath,attempt.group('url_main'),self.name,newname)
842 if self.options.verbose:
843 print ' ' + modulepath,
844 new.write(replacement)
850 os.rename(newtagsfile,tagsfile)
851 if self.options.verbose: print "%d changes"%matches
854 def check_tag(self, tagname, need_it=False, old_svn_tag_name=None):
855 if self.options.verbose:
856 print "Checking %s repository tag: %s - " % (self.repository.type, tagname),
858 found_tagname = tagname
859 found = self.repository.tag_exists(tagname)
860 if not found and old_svn_tag_name:
861 if self.options.verbose:
863 print "Checking %s repository tag: %s - " % (self.repository.type, old_svn_tag_name),
864 found = self.repository.tag_exists(old_svn_tag_name)
866 found_tagname = old_svn_tag_name
868 if (found and need_it) or (not found and not need_it):
869 if self.options.verbose:
871 if found: print "- found"
872 else: print "- not found"
874 if self.options.verbose:
877 raise Exception, "tag (%s) is already there" % tagname
879 raise Exception, "can not find required tag (%s)" % tagname
884 ##############################
886 self.init_module_dir()
887 self.revert_module_dir()
888 self.update_module_dir()
890 spec_dict = self.spec_dict()
891 self.show_dict(spec_dict)
894 old_tag_name = self.tag_name(spec_dict)
895 old_svn_tag_name = self.tag_name(spec_dict, old_svn_name=True)
897 if (self.options.new_version):
898 # new version set on command line
899 spec_dict[self.module_version_varname] = self.options.new_version
900 spec_dict[self.module_taglevel_varname] = 0
903 new_taglevel = str ( int (spec_dict[self.module_taglevel_varname]) + 1)
904 spec_dict[self.module_taglevel_varname] = new_taglevel
906 new_tag_name = self.tag_name(spec_dict)
909 old_tag_name = self.check_tag(old_tag_name, need_it=True, old_svn_tag_name=old_svn_tag_name)
910 new_tag_name = self.check_tag(new_tag_name, need_it=False)
913 diff_output = self.repository.diff_with_tag(old_tag_name)
914 if len(diff_output) == 0:
915 if not prompt ("No pending difference in module %s, want to tag anyway"%self.name,False):
918 # side effect in trunk's specfile
919 self.patch_spec_var(spec_dict)
921 # prepare changelog file
922 # we use the standard subversion magic string (see svn_magic_line)
923 # so we can provide useful information, such as version numbers and diff
925 changelog="/tmp/%s-%d.edit"%(self.name,os.getpid())
926 changelog_svn="/tmp/%s-%d.svn"%(self.name,os.getpid())
927 setting_tag_line=Module.setting_tag_format%new_tag_name
928 file(changelog,"w").write("""
931 Please write a changelog for this new tag in the section above
932 """%(Module.svn_magic_line,setting_tag_line))
934 if not self.options.verbose or prompt('Want to see diffs while writing changelog',True):
935 file(changelog,"a").write('DIFF=========\n' + diff_output)
937 if self.options.debug:
941 self.run("%s %s"%(self.options.editor,changelog))
942 # strip magic line in second file - looks like svn has changed its magic line with 1.6
943 # so we do the job ourselves
944 self.stripped_magic_line_filename(changelog,changelog_svn,new_tag_name)
945 # insert changelog in spec
946 if self.options.changelog:
947 self.insert_changelog (changelog,old_tag_name,new_tag_name)
950 build_path = os.path.join(self.options.workdir,
951 Module.config['build'])
952 build = Repository(build_path, self.options)
953 if self.options.build_branch:
954 build.to_branch(self.options.build_branch)
955 if not build.is_clean():
958 tagsfiles=glob(build.path+"/*-tags*.mk")
959 tagsdict=dict( [ (x,'todo') for x in tagsfiles ] )
963 for tagsfile in tagsfiles:
964 status=tagsdict[tagsfile]
965 basename=os.path.basename(tagsfile)
966 print ".................... Dealing with %s"%basename
967 while tagsdict[tagsfile] == 'todo' :
968 choice = prompt ("insert %s in %s "%(new_tag_name,basename),default_answer,
969 [ ('y','es'), ('n', 'ext'), ('f','orce'),
970 ('d','iff'), ('r','evert'), ('c', 'at'), ('h','elp') ] ,
973 self.patch_tags_file(tagsfile,old_tag_name,new_tag_name,fine_grain=True)
975 print 'Done with %s'%os.path.basename(tagsfile)
976 tagsdict[tagsfile]='done'
978 self.patch_tags_file(tagsfile,old_tag_name,new_tag_name,fine_grain=False)
980 print build.diff(f=tagsfile)
982 build.revert(f=tagsfile)
984 self.run("cat %s"%tagsfile)
987 print """y: change %(name)s-{SVNPATH,GITPATH} only if it currently refers to %(old_tag_name)s
988 f: unconditionnally change any line that assigns %(name)s-SVNPATH to using %(new_tag_name)s
989 d: show current diff for this tag file
990 r: revert that tag file
991 c: cat the current tag file
992 n: move to next file"""%locals()
994 if prompt("Want to review changes on tags files",False):
995 tagsdict = dict ( [ (x, 'todo') for x in tagsfiles ] )
1000 def diff_all_changes():
1002 print self.repository.diff()
1004 def commit_all_changes(log):
1005 if hasattr(self,'branch'):
1006 self.repository.commit(log, branch=self.branch)
1008 self.repository.commit(log)
1011 self.run_prompt("Review module and build", diff_all_changes)
1012 self.run_prompt("Commit module and build", commit_all_changes, changelog_svn)
1013 self.run_prompt("Create tag", self.repository.tag, new_tag_name, changelog_svn)
1015 if self.options.debug:
1016 print 'Preserving',changelog,'and stripped',changelog_svn
1018 os.unlink(changelog)
1019 os.unlink(changelog_svn)
1022 ##############################
1023 def do_version (self):
1024 self.init_module_dir()
1025 self.revert_module_dir()
1026 self.update_module_dir()
1027 spec_dict = self.spec_dict()
1028 if self.options.www:
1029 self.html_store_title('Version for module %s (%s)' % (self.friendly_name(),
1030 self.last_tag(spec_dict)))
1031 for varname in self.varnames:
1032 if not spec_dict.has_key(varname):
1033 self.html_print ('Could not find %%define for %s'%varname)
1036 self.html_print ("%-16s %s"%(varname,spec_dict[varname]))
1037 if self.options.verbose:
1038 self.html_print ("%-16s %s"%('main specfile:',self.main_specname()))
1039 self.html_print ("%-16s %s"%('specfiles:',self.all_specnames()))
1040 self.html_print_end()
1043 ##############################
1045 self.init_module_dir()
1046 self.revert_module_dir()
1047 self.update_module_dir()
1048 spec_dict = self.spec_dict()
1049 self.show_dict(spec_dict)
1052 tag_name = self.tag_name(spec_dict)
1053 old_svn_tag_name = self.tag_name(spec_dict, old_svn_name=True)
1056 tag_name = self.check_tag(tag_name, need_it=True, old_svn_tag_name=old_svn_tag_name)
1058 if self.options.verbose:
1059 print 'Getting diff'
1060 diff_output = self.repository.diff_with_tag(tag_name)
1062 if self.options.list:
1066 thename=self.friendly_name()
1068 if self.options.www and diff_output:
1069 self.html_store_title("Diffs in module %s (%s) : %d chars"%(\
1070 thename,self.last_tag(spec_dict),len(diff_output)))
1072 self.html_store_raw ('<p> < (left) %s </p>' % tag_name)
1073 self.html_store_raw ('<p> > (right) %s </p>' % thename)
1074 self.html_store_pre (diff_output)
1075 elif not self.options.www:
1076 print 'x'*30,'module',thename
1077 print 'x'*20,'<',tag_name
1078 print 'x'*20,'>',thename
1081 ##############################
1082 # store and restitute html fragments
1084 def html_href (url,text): return '<a href="%s">%s</a>'%(url,text)
1087 def html_anchor (url,text): return '<a name="%s">%s</a>'%(url,text)
1090 def html_quote (text):
1091 return text.replace('&','&').replace('<','<').replace('>','>')
1093 # only the fake error module has multiple titles
1094 def html_store_title (self, title):
1095 if not hasattr(self,'titles'): self.titles=[]
1096 self.titles.append(title)
1098 def html_store_raw (self, html):
1099 if not hasattr(self,'body'): self.body=''
1102 def html_store_pre (self, text):
1103 if not hasattr(self,'body'): self.body=''
1104 self.body += '<pre>' + self.html_quote(text) + '</pre>'
1106 def html_print (self, txt):
1107 if not self.options.www:
1110 if not hasattr(self,'in_list') or not self.in_list:
1111 self.html_store_raw('<ul>')
1113 self.html_store_raw('<li>'+txt+'</li>')
1115 def html_print_end (self):
1116 if self.options.www:
1117 self.html_store_raw ('</ul>')
1120 def html_dump_header(title):
1121 nowdate=time.strftime("%Y-%m-%d")
1122 nowtime=time.strftime("%H:%M (%Z)")
1123 print """<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1124 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
1127 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1128 <style type="text/css">
1129 body { font-family:georgia, serif; }
1130 h1 {font-size: large; }
1131 p.title {font-size: x-large; }
1132 span.error {text-weight:bold; color: red; }
1136 <p class='title'> %s - status on %s at %s</p>
1138 """%(title,title,nowdate,nowtime)
1141 def html_dump_middle():
1145 def html_dump_footer():
1146 print "</body></html"
1148 def html_dump_toc(self):
1149 if hasattr(self,'titles'):
1150 for title in self.titles:
1151 print '<li>',self.html_href ('#'+self.friendly_name(),title),'</li>'
1153 def html_dump_body(self):
1154 if hasattr(self,'titles'):
1155 for title in self.titles:
1156 print '<hr /><h1>',self.html_anchor(self.friendly_name(),title),'</h1>'
1157 if hasattr(self,'body'):
1159 print '<p class="top">',self.html_href('#','Back to top'),'</p>'
1162 ##############################
1165 module_usage="""Usage: %prog [options] module_desc [ .. module_desc ]
1167 module-tools : a set of tools to manage subversion tags and specfile
1168 requires the specfile to either
1169 * define *version* and *taglevel*
1171 * define redirection variables module_version_varname / module_taglevel_varname
1173 by default, the trunk of modules is taken into account
1174 in this case, just mention the module name as <module_desc>
1176 if you wish to work on a branch rather than on the trunk,
1177 you can use something like e.g. Mom:2.1 as <module_desc>
1179 release_usage="""Usage: %prog [options] tag1 .. tagn
1180 Extract release notes from the changes in specfiles between several build tags, latest first
1182 release-changelog 4.2-rc25 4.2-rc24 4.2-rc23 4.2-rc22
1183 You can refer to a (build) branch by prepending a colon, like in
1184 release-changelog :4.2 4.2-rc25
1185 You can refer to the build trunk by just mentioning 'trunk', e.g.
1186 release-changelog -t coblitz-tags.mk coblitz-2.01-rc6 trunk
1188 common_usage="""More help:
1189 see http://svn.planet-lab.org/wiki/ModuleTools"""
1192 'list' : "displays a list of available tags or branches",
1193 'version' : "check latest specfile and print out details",
1194 'diff' : "show difference between module (trunk or branch) and latest tag",
1195 'tag' : """increment taglevel in specfile, insert changelog in specfile,
1196 create new tag and and monitor its adoption in build/*-tags*.mk""",
1197 'branch' : """create a branch for this module, from the latest tag on the trunk,
1198 and change trunk's version number to reflect the new branch name;
1199 you can specify the new branch name by using module:branch""",
1200 'sync' : """create a tag from the module
1201 this is a last resort option, mostly for repairs""",
1202 'changelog' : """extract changelog between build tags
1203 expected arguments are a list of tags""",
1206 silent_modes = ['list']
1207 release_modes = ['changelog']
1210 def optparse_list (option, opt, value, parser):
1212 setattr(parser.values,option.dest,getattr(parser.values,option.dest)+value.split())
1214 setattr(parser.values,option.dest,value.split())
1219 for function in Main.modes.keys():
1220 if sys.argv[0].find(function) >= 0:
1224 print "Unsupported command",sys.argv[0]
1225 print "Supported commands:" + " ".join(Main.modes.keys())
1228 if mode not in Main.release_modes:
1229 usage = Main.module_usage
1230 usage += Main.common_usage
1231 usage += "\nmodule-%s : %s"%(mode,Main.modes[mode])
1233 usage = Main.release_usage
1234 usage += Main.common_usage
1236 parser=OptionParser(usage=usage)
1238 if mode == "tag" or mode == 'branch':
1239 parser.add_option("-s","--set-version",action="store",dest="new_version",default=None,
1240 help="set new version and reset taglevel to 0")
1242 parser.add_option("-c","--no-changelog", action="store_false", dest="changelog", default=True,
1243 help="do not update changelog section in specfile when tagging")
1244 parser.add_option("-b","--build-branch", action="store", dest="build_branch", default=None,
1245 help="specify a build branch; used for locating the *tags*.mk files where adoption is to take place")
1246 if mode == "tag" or mode == "sync" :
1247 parser.add_option("-e","--editor", action="store", dest="editor", default=default_editor(),
1248 help="specify editor")
1250 if mode in ["diff","version"] :
1251 parser.add_option("-W","--www", action="store", dest="www", default=False,
1252 help="export diff in html format, e.g. -W trunk")
1255 parser.add_option("-l","--list", action="store_true", dest="list", default=False,
1256 help="just list modules that exhibit differences")
1258 default_modules_list=os.path.dirname(sys.argv[0])+"/modules.list"
1259 parser.add_option("-a","--all",action="store_true",dest="all_modules",default=False,
1260 help="run on all modules as found in %s"%default_modules_list)
1261 parser.add_option("-f","--file",action="store",dest="modules_list",default=None,
1262 help="run on all modules found in specified file")
1263 parser.add_option("-n","--dry-run",action="store_true",dest="dry_run",default=False,
1264 help="dry run - shell commands are only displayed")
1265 parser.add_option("-t","--distrotags",action="callback",callback=Main.optparse_list, dest="distrotags",
1266 default=[], nargs=1,type="string",
1267 help="""specify distro-tags files, e.g. onelab-tags-4.2.mk
1268 -- can be set multiple times, or use quotes""")
1270 parser.add_option("-w","--workdir", action="store", dest="workdir",
1271 default="%s/%s"%(os.getenv("HOME"),"modules"),
1272 help="""name for dedicated working dir - defaults to ~/modules
1273 ** THIS MUST NOT ** be your usual working directory""")
1274 parser.add_option("-F","--fast-checks",action="store_true",dest="fast_checks",default=False,
1275 help="skip safety checks, such as svn updates -- use with care")
1277 # default verbosity depending on function - temp
1278 verbose_modes= ['tag', 'sync', 'branch']
1280 if mode not in verbose_modes:
1281 parser.add_option("-v","--verbose", action="store_true", dest="verbose", default=False,
1282 help="run in verbose mode")
1284 parser.add_option("-q","--quiet", action="store_false", dest="verbose", default=True,
1285 help="run in quiet (non-verbose) mode")
1286 (options, args) = parser.parse_args()
1288 if not hasattr(options,'dry_run'):
1289 options.dry_run=False
1290 if not hasattr(options,'www'):
1296 if options.all_modules:
1297 options.modules_list=default_modules_list
1298 if options.modules_list:
1299 args=Command("grep -v '#' %s"%options.modules_list,options).output_of().split()
1303 Module.init_homedir(options)
1306 modules=[ Module(modname,options) for modname in args ]
1307 # hack: create a dummy Module to store errors/warnings
1308 error_module = Module('__errors__',options)
1310 for module in modules:
1311 if len(args)>1 and mode not in Main.silent_modes:
1313 print '========================================',module.friendly_name()
1314 # call the method called do_<mode>
1315 method=Module.__dict__["do_%s"%mode]
1320 title='<span class="error"> Skipping module %s - failure: %s </span>'%\
1321 (module.friendly_name(), str(e))
1322 error_module.html_store_title(title)
1325 traceback.print_exc()
1326 print 'Skipping module %s: '%modname,e
1330 modetitle="Changes to tag in %s"%options.www
1331 elif mode == "version":
1332 modetitle="Latest tags in %s"%options.www
1333 modules.append(error_module)
1334 error_module.html_dump_header(modetitle)
1335 for module in modules:
1336 module.html_dump_toc()
1337 Module.html_dump_middle()
1338 for module in modules:
1339 module.html_dump_body()
1340 Module.html_dump_footer()
1342 ####################
1343 if __name__ == "__main__" :
1346 except KeyboardInterrupt: