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 = {
18 def svn_to_git_name(module):
19 if RENAMED_SVN_MODULES.has_key(module):
20 return RENAMED_SVN_MODULES[module]
23 def git_to_svn_name(module):
24 for key in RENAMED_SVN_MODULES:
25 if module == RENAMED_SVN_MODULES[key]:
30 # e.g. other_choices = [ ('d','iff') , ('g','uess') ] - lowercase
31 def prompt (question,default=True,other_choices=[],allow_outside=False):
32 if not isinstance (other_choices,list):
33 other_choices = [ other_choices ]
34 chars = [ c for (c,rest) in other_choices ]
38 if default is True: choices.append('[y]')
39 else : choices.append('y')
41 if default is False: choices.append('[n]')
42 else : choices.append('n')
44 for (char,choice) in other_choices:
46 choices.append("["+char+"]"+choice)
48 choices.append("<"+char+">"+choice)
50 answer=raw_input(question + " " + "/".join(choices) + " ? ")
53 answer=answer[0].lower()
55 if 'y' in chars: return 'y'
58 if 'n' in chars: return 'n'
61 for (char,choice) in other_choices:
66 return prompt(question,default,other_choices)
72 editor = os.environ['EDITOR']
80 def print_fold (line):
81 while len(line) >= fold_length:
82 print line[:fold_length],'\\'
83 line=line[fold_length:]
87 def __init__ (self,command,options):
90 self.tmp="/tmp/command-%d"%os.getpid()
93 if self.options.dry_run:
94 print 'dry_run',self.command
96 if self.options.verbose and self.options.mode not in Main.silent_modes:
97 print '+',self.command
99 return os.system(self.command)
101 def run_silent (self):
102 if self.options.dry_run:
103 print 'dry_run',self.command
105 if self.options.verbose:
106 print '+',self.command,' .. ',
108 retcod=os.system(self.command + " &> " + self.tmp)
110 print "FAILED ! -- out+err below (command was %s)"%self.command
111 os.system("cat " + self.tmp)
112 print "FAILED ! -- end of quoted output"
113 elif self.options.verbose:
119 if self.run_silent() !=0:
120 raise Exception,"Command %s failed"%self.command
122 # returns stdout, like bash's $(mycommand)
123 def output_of (self,with_stderr=False):
124 if self.options.dry_run:
125 print 'dry_run',self.command
126 return 'dry_run output'
127 tmp="/tmp/status-%d"%os.getpid()
128 if self.options.debug:
129 print '+',self.command,' .. ',
138 result=file(tmp).read()
140 if self.options.debug:
148 def __init__(self, path, options):
150 self.options = options
153 return os.path.basename(self.path)
156 out = Command("svn info %s" % self.path, self.options).output_of()
157 for line in out.split('\n'):
158 if line.startswith("URL:"):
159 return line.split()[1].strip()
162 out = Command("svn info %s" % self.path, self.options).output_of()
163 for line in out.split('\n'):
164 if line.startswith("Repository Root:"):
165 root = line.split()[2].strip()
166 return "%s/%s" % (root, self.name())
169 def checkout(cls, remote, local, options, recursive=False):
171 svncommand = "svn co %s %s" % (remote, local)
173 svncommand = "svn co -N %s %s" % (remote, local)
174 Command("rm -rf %s" % local, options).run_silent()
175 Command(svncommand, options).run_fatal()
177 return SvnRepository(local, options)
180 def remote_exists(cls, remote):
181 return os.system("svn list %s &> /dev/null" % remote) == 0
183 def tag_exists(self, tagname):
184 url = "%s/tags/%s" % (self.repo_root(), tagname)
185 return SvnRepository.remote_exists(url)
187 def update(self, subdir="", recursive=True, branch=None):
188 path = os.path.join(self.path, subdir)
190 svncommand = "svn up %s" % path
192 svncommand = "svn up -N %s" % path
193 Command(svncommand, self.options).run_fatal()
195 def commit(self, logfile):
196 # add all new files to the repository
197 Command("svn status %s | grep '^\?' | sed -e 's/? *//' | sed -e 's/ /\\ /g' | xargs svn add" %
198 self.path, self.options).output_of()
199 Command("svn commit -F %s %s" % (logfile, self.path), self.options).run_fatal()
201 def to_branch(self, branch):
202 remote = "%s/branches/%s" % (self.repo_root(), branch)
203 SvnRepository.checkout(remote, self.path, self.options, recursive=True)
205 def to_tag(self, tag):
206 remote = "%s/tags/%s" % (self.repo_root(), branch)
207 SvnRepository.checkout(remote, self.path, self.options, recursive=True)
209 def tag(self, tagname, logfile):
210 tag_url = "%s/tags/%s" % (self.repo_root(), tagname)
211 self_url = self.url()
212 Command("svn copy -F %s %s %s" % (logfile, self_url, tag_url), self.options).run_fatal()
214 def diff(self, f=""):
216 f = os.path.join(self.path, f)
219 return Command("svn diff %s" % f, self.options).output_of(True)
221 def diff_with_tag(self, tagname):
222 tag_url = "%s/tags/%s" % (self.repo_root(), tagname)
223 return Command("svn diff %s %s" % (tag_url, self.url()),
224 self.options).output_of(True)
226 def revert(self, f=""):
228 Command("svn revert %s" % os.path.join(self.path, f), self.options).run_fatal()
231 Command("svn revert %s -R" % self.path, self.options).run_fatal()
232 Command("svn status %s | grep '^\?' | sed -e 's/? *//' | sed -e 's/ /\\ /g' | xargs rm -rf " %
233 self.path, self.options).run_silent()
236 command="svn status %s" % self.path
237 return len(Command(command,self.options).output_of(True)) == 0
240 return os.path.exists(os.path.join(self.path, ".svn"))
246 def __init__(self, path, options):
248 self.options = options
251 return os.path.basename(self.path)
257 c = Command("git remote show origin", self.options)
258 out = self.__run_in_repo(c.output_of)
259 for line in out.split('\n'):
260 if line.strip().startswith("Fetch URL:"):
261 repo = line.split()[2]
264 def checkout(cls, remote, local, options, depth=1):
265 Command("rm -rf %s" % local, options).run_silent()
266 Command("git clone --depth %d %s %s" % (depth, remote, local), options).run_fatal()
267 return GitRepository(local, options)
270 def remote_exists(cls, remote):
271 return os.system("git --no-pager ls-remote %s &> /dev/null" % remote) == 0
273 def tag_exists(self, tagname):
274 command = 'git tag -l | grep "^%s$"' % tagname
275 c = Command(command, self.options)
276 out = self.__run_in_repo(c.output_of, with_stderr=True)
279 def __run_in_repo(self, fun, *args, **kwargs):
282 ret = fun(*args, **kwargs)
286 def __run_command_in_repo(self, command, ignore_errors=False):
287 c = Command(command, self.options)
289 return self.__run_in_repo(c.output_of)
291 return self.__run_in_repo(c.run_fatal)
293 def update(self, subdir=None, recursive=None, branch="master"):
294 if branch == "master":
295 self.__run_command_in_repo("git checkout %s" % branch)
297 self.__run_command_in_repo("git checkout origin/%s" % branch)
298 self.__run_command_in_repo("git fetch origin --tags")
299 self.__run_command_in_repo("git fetch origin")
300 self.__run_command_in_repo("git merge --ff origin/%s" % branch)
302 def to_branch(self, branch, remote=True):
304 branch = "origin/%s" % branch
305 return self.__run_command_in_repo("git checkout %s" % branch)
307 def to_tag(self, tag):
308 return self.__run_command_in_repo("git checkout %s" % tag)
310 def tag(self, tagname, logfile):
311 self.__run_command_in_repo("git tag %s -F %s" % (tagname, logfile))
314 def diff(self, f=""):
315 c = Command("git diff %s" % f, self.options)
316 return self.__run_in_repo(c.output_of, with_stderr=True)
318 def diff_with_tag(self, tagname):
319 c = Command("git diff %s" % tagname, self.options)
320 return self.__run_in_repo(c.output_of, with_stderr=True)
322 def commit(self, logfile):
323 self.__run_command_in_repo("git add .", ignore_errors=True)
324 self.__run_command_in_repo("git add -u", ignore_errors=True)
325 self.__run_command_in_repo("git commit -F %s" % logfile, ignore_errors=True)
326 self.__run_command_in_repo("git push")
327 self.__run_command_in_repo("git push --tags")
329 def revert(self, f=""):
331 self.__run_command_in_repo("git checkout %s" % f)
334 self.__run_command_in_repo("git --no-pager reset --hard")
335 self.__run_command_in_repo("git --no-pager clean -f")
340 s="nothing to commit (working directory clean)"
341 return Command(command, self.options).output_of(True).find(s) >= 0
342 return self.__run_in_repo(check_commit)
345 return os.path.exists(os.path.join(self.path, ".git"))
349 """ Generic repository """
350 supported_repo_types = [SvnRepository, GitRepository]
352 def __init__(self, path, options):
354 self.options = options
355 for repo in self.supported_repo_types:
356 self.repo = repo(self.path, self.options)
357 if self.repo.is_valid():
361 def has_moved_to_git(cls, module, config):
362 module = git_to_svn_name(module)
363 # check if the module is already in Git
364 # return SvnRepository.remote_exists("%s/%s/aaaa-has-moved-to-git" % (config['svnpath'], module))
365 return GitRepository.remote_exists(Module.git_remote_dir(module))
369 def remote_exists(cls, remote):
370 for repo in Repository.supported_repo_types:
371 if repo.remote_exists(remote):
375 def __getattr__(self, attr):
376 return getattr(self.repo, attr)
380 # support for tagged module is minimal, and is for the Build class only
383 svn_magic_line="--This line, and those below, will be ignored--"
384 setting_tag_format = "Setting tag %s"
386 redirectors=[ # ('module_name_varname','name'),
387 ('module_version_varname','version'),
388 ('module_taglevel_varname','taglevel'), ]
390 # where to store user's config
391 config_storage="CONFIG"
396 configKeys=[ ('svnpath',"Enter your toplevel svnpath",
397 "svn+ssh://%s@svn.planet-lab.org/svn/"%commands.getoutput("id -un")),
398 ('gitserver', "Enter your git server's hostname", "git.onelab.eu"),
399 ('gituser', "Enter your user name (login name) on git server", commands.getoutput("id -un")),
400 ("build", "Enter the name of your build module","build"),
401 ('username',"Enter your firstname and lastname for changelogs",""),
402 ("email","Enter your email address for changelogs",""),
406 def prompt_config_option(cls, key, message, default):
407 cls.config[key]=raw_input("%s [%s] : "%(message,default)).strip() or default
410 def prompt_config (cls):
411 for (key,message,default) in cls.configKeys:
413 while not cls.config[key]:
414 cls.prompt_config_option(key, message, default)
417 # for parsing module spec name:branch
418 matcher_branch_spec=re.compile("\A(?P<name>[\w\.-]+):(?P<branch>[\w\.-]+)\Z")
419 # special form for tagged module - for Build
420 matcher_tag_spec=re.compile("\A(?P<name>[\w-]+)@(?P<tagname>[\w\.-]+)\Z")
422 matcher_rpm_define=re.compile("%(define|global)\s+(\S+)\s+(\S*)\s*")
424 def __init__ (self,module_spec,options):
426 attempt=Module.matcher_branch_spec.match(module_spec)
428 self.name=attempt.group('name')
429 self.branch=attempt.group('branch')
431 attempt=Module.matcher_tag_spec.match(module_spec)
433 self.name=attempt.group('name')
434 self.tagname=attempt.group('tagname')
436 self.name=module_spec
438 # when available prefer to use git module name internally
439 self.name = svn_to_git_name(self.name)
442 self.module_dir="%s/%s"%(options.workdir,self.name)
443 self.repository = None
446 def run (self,command):
447 return Command(command,self.options).run()
448 def run_fatal (self,command):
449 return Command(command,self.options).run_fatal()
450 def run_prompt (self,message,fun, *args):
451 fun_msg = "%s(%s)" % (fun.func_name, ",".join(args))
452 if not self.options.verbose:
454 choice=prompt(message,True,('s','how'))
458 elif choice is False:
459 print 'About to run function:', fun_msg
461 question=message+" - want to run function: " + fun_msg
462 if prompt(question,True):
465 def friendly_name (self):
466 if hasattr(self,'branch'):
467 return "%s:%s"%(self.name,self.branch)
468 elif hasattr(self,'tagname'):
469 return "%s@%s"%(self.name,self.tagname)
474 def git_remote_dir (cls, name):
475 return "%s@%s:/git/%s.git" % (cls.config['gituser'], cls.config['gitserver'], name)
478 def svn_remote_dir (cls, name):
479 name = git_to_svn_name(name)
480 svn = cls.config['svnpath']
481 if svn.endswith('/'):
482 return "%s%s" % (svn, name)
483 return "%s/%s" % (svn, name)
485 def svn_selected_remote(self):
486 svn_name = git_to_svn_name(self.name)
487 remote = self.svn_remote_dir(svn_name)
488 if hasattr(self,'branch'):
489 remote = "%s/branches/%s" % (remote, self.branch)
490 elif hasattr(self,'tagname'):
491 remote = "%s/tags/%s" % (remote, self.tagname)
493 remote = "%s/trunk" % remote
498 def init_homedir (cls, options):
499 if options.verbose and options.mode not in Main.silent_modes:
500 print 'Checking for', options.workdir
501 storage="%s/%s"%(options.workdir, cls.config_storage)
502 # sanity check. Either the topdir exists AND we have a config/storage
503 # or topdir does not exist and we create it
504 # to avoid people use their own daily svn repo
505 if os.path.isdir(options.workdir) and not os.path.isfile(storage):
506 print """The directory %s exists and has no CONFIG file
507 If this is your regular working directory, please provide another one as the
508 module-* commands need a fresh working dir. Make sure that you do not use
509 that for other purposes than tagging""" % options.workdir
512 def checkout_build():
513 print "Checking out build module..."
514 remote = cls.git_remote_dir(cls.config['build'])
515 local = os.path.join(options.workdir, cls.config['build'])
516 GitRepository.checkout(remote, local, options, depth=1)
521 for (key,message,default) in Module.configKeys:
522 f.write("%s=%s\n"%(key,Module.config[key]))
525 print 'Stored',storage
526 Command("cat %s"%storage,options).run()
531 for line in f.readlines():
532 (key,value)=re.compile("^(.+)=(.+)$").match(line).groups()
533 Module.config[key]=value
536 if not os.path.isdir (options.workdir):
537 print "Cannot find",options.workdir,"let's create it"
538 Command("mkdir -p %s" % options.workdir, options).run_silent()
544 # check missing config options
546 for (key,message,default) in cls.configKeys:
547 if not Module.config.has_key(key):
548 print "Configuration changed for module-tools"
549 cls.prompt_config_option(key, message, default)
553 Command("rm -rf %s" % options.workdir, options).run_silent()
554 Command("mkdir -p %s" % options.workdir, options).run_silent()
558 build_dir = os.path.join(options.workdir, cls.config['build'])
559 if not os.path.isdir(build_dir):
562 build = Repository(build_dir, options)
563 if not build.is_clean():
564 print "build module needs a revert"
569 if options.verbose and options.mode not in Main.silent_modes:
570 print '******** Using config'
571 for (key,message,default) in Module.configKeys:
572 print '\t',key,'=',Module.config[key]
574 def init_module_dir (self):
575 if self.options.verbose:
576 print 'Checking for',self.module_dir
578 if not os.path.isdir (self.module_dir):
579 if Repository.has_moved_to_git(self.name, Module.config):
580 self.repository = GitRepository.checkout(self.git_remote_dir(self.name),
584 remote = self.svn_selected_remote()
585 self.repository = SvnRepository.checkout(remote,
587 self.options, recursive=False)
589 self.repository = Repository(self.module_dir, self.options)
590 if self.repository.type == "svn":
591 # check if module has moved to git
592 if Repository.has_moved_to_git(self.name, Module.config):
593 Command("rm -rf %s" % self.module_dir, self.options).run_silent()
594 self.init_module_dir()
595 # check if we have the required branch/tag
596 if self.repository.url() != self.svn_selected_remote():
597 Command("rm -rf %s" % self.module_dir, self.options).run_silent()
598 self.init_module_dir()
600 elif self.repository.type == "git":
601 if hasattr(self,'branch'):
602 self.repository.to_branch(self.branch)
603 elif hasattr(self,'tagname'):
604 self.repository.to_tag(self.tagname)
607 raise Exception, 'Cannot find %s - check module name'%self.module_dir
610 def revert_module_dir (self):
611 if self.options.fast_checks:
612 if self.options.verbose: print 'Skipping revert of %s' % self.module_dir
614 if self.options.verbose:
615 print 'Checking whether', self.module_dir, 'needs being reverted'
617 if not self.repository.is_clean():
618 self.repository.revert()
620 def update_module_dir (self):
621 if self.options.fast_checks:
622 if self.options.verbose: print 'Skipping update of %s' % self.module_dir
624 if self.options.verbose:
625 print 'Updating', self.module_dir
627 if hasattr(self,'branch'):
628 self.repository.update(branch=self.branch)
629 elif hasattr(self,'tagname'):
630 self.repository.update(branch=self.tagname)
632 self.repository.update()
634 def main_specname (self):
635 attempt="%s/%s.spec"%(self.module_dir,self.name)
636 if os.path.isfile (attempt):
638 pattern1="%s/*.spec"%self.module_dir
639 level1=glob(pattern1)
642 pattern2="%s/*/*.spec"%self.module_dir
643 level2=glob(pattern2)
647 raise Exception, 'Cannot guess specfile for module %s -- patterns were %s or %s'%(self.name,pattern1,pattern2)
649 def all_specnames (self):
650 level1=glob("%s/*.spec" % self.module_dir)
651 if level1: return level1
652 level2=glob("%s/*/*.spec" % self.module_dir)
655 def parse_spec (self, specfile, varnames):
656 if self.options.verbose:
657 print 'Parsing',specfile,
663 for line in f.readlines():
664 attempt=Module.matcher_rpm_define.match(line)
666 (define,var,value)=attempt.groups()
670 if self.options.debug:
671 print 'found',len(result),'keys'
672 for (k,v) in result.iteritems():
676 # stores in self.module_name_varname the rpm variable to be used for the module's name
677 # and the list of these names in self.varnames
678 def spec_dict (self):
679 specfile=self.main_specname()
680 redirector_keys = [ varname for (varname,default) in Module.redirectors]
681 redirect_dict = self.parse_spec(specfile,redirector_keys)
682 if self.options.debug:
683 print '1st pass parsing done, redirect_dict=',redirect_dict
685 for (varname,default) in Module.redirectors:
686 if redirect_dict.has_key(varname):
687 setattr(self,varname,redirect_dict[varname])
688 varnames += [redirect_dict[varname]]
690 setattr(self,varname,default)
691 varnames += [ default ]
692 self.varnames = varnames
693 result = self.parse_spec (specfile,self.varnames)
694 if self.options.debug:
695 print '2st pass parsing done, varnames=',varnames,'result=',result
698 def patch_spec_var (self, patch_dict,define_missing=False):
699 for specfile in self.all_specnames():
700 # record the keys that were changed
701 changed = dict ( [ (x,False) for x in patch_dict.keys() ] )
702 newspecfile=specfile+".new"
703 if self.options.verbose:
704 print 'Patching',specfile,'for',patch_dict.keys()
706 new=open(newspecfile,"w")
708 for line in spec.readlines():
709 attempt=Module.matcher_rpm_define.match(line)
711 (define,var,value)=attempt.groups()
712 if var in patch_dict.keys():
713 if self.options.debug:
714 print 'rewriting %s as %s'%(var,patch_dict[var])
715 new.write('%%%s %s %s\n'%(define,var,patch_dict[var]))
720 for (key,was_changed) in changed.iteritems():
722 if self.options.debug:
723 print 'rewriting missing %s as %s'%(key,patch_dict[key])
724 new.write('\n%%define %s %s\n'%(key,patch_dict[key]))
727 os.rename(newspecfile,specfile)
729 # returns all lines until the magic line
730 def unignored_lines (self, logfile):
732 white_line_matcher = re.compile("\A\s*\Z")
733 for logline in file(logfile).readlines():
734 if logline.strip() == Module.svn_magic_line:
736 elif white_line_matcher.match(logline):
739 result.append(logline.strip()+'\n')
742 # creates a copy of the input with only the unignored lines
743 def stripped_magic_line_filename (self, filein, fileout ,new_tag_name):
745 f.write(self.setting_tag_format%new_tag_name + '\n')
746 for line in self.unignored_lines(filein):
750 def insert_changelog (self, logfile, oldtag, newtag):
751 for specfile in self.all_specnames():
752 newspecfile=specfile+".new"
753 if self.options.verbose:
754 print 'Inserting changelog from %s into %s'%(logfile,specfile)
756 new=open(newspecfile,"w")
757 for line in spec.readlines():
759 if re.compile('%changelog').match(line):
760 dateformat="* %a %b %d %Y"
761 datepart=time.strftime(dateformat)
762 logpart="%s <%s> - %s"%(Module.config['username'],
763 Module.config['email'],
765 new.write(datepart+" "+logpart+"\n")
766 for logline in self.unignored_lines(logfile):
767 new.write("- " + logline)
771 os.rename(newspecfile,specfile)
773 def show_dict (self, spec_dict):
774 if self.options.verbose:
775 for (k,v) in spec_dict.iteritems():
778 def last_tag (self, spec_dict):
780 return "%s-%s" % (spec_dict[self.module_version_varname],
781 spec_dict[self.module_taglevel_varname])
783 raise Exception,'Something is wrong with module %s, cannot determine %s - exiting'%(self.name,err)
785 def tag_name (self, spec_dict, old_svn_name=False):
786 base_tag_name = self.name
788 base_tag_name = git_to_svn_name(self.name)
789 return "%s-%s" % (base_tag_name, self.last_tag(spec_dict))
792 ##############################
793 # using fine_grain means replacing only those instances that currently refer to this tag
794 # otherwise, <module>-{SVNPATH,GITPATH} is replaced unconditionnally
795 def patch_tags_file (self, tagsfile, oldname, newname,fine_grain=True):
796 newtagsfile=tagsfile+".new"
798 new=open(newtagsfile,"w")
801 # fine-grain : replace those lines that refer to oldname
803 if self.options.verbose:
804 print 'Replacing %s into %s\n\tin %s .. '%(oldname,newname,tagsfile),
805 matcher=re.compile("^(.*)%s(.*)"%oldname)
806 for line in tags.readlines():
807 if not matcher.match(line):
810 (begin,end)=matcher.match(line).groups()
811 new.write(begin+newname+end+"\n")
813 # brute-force : change uncommented lines that define <module>-SVNPATH
815 if self.options.verbose:
816 print 'Searching for -SVNPATH or -GITPATH lines referring to /%s/\n\tin %s .. '%(self.name,tagsfile),
817 pattern="\A\s*(?P<make_name>[^\s]+)-(SVNPATH|GITPATH)\s*(=|:=)\s*(?P<url_main>[^\s]+)/%s[^\s]+"\
819 matcher_module=re.compile(pattern)
820 for line in tags.readlines():
821 attempt=matcher_module.match(line)
823 if line.find("-GITPATH") >= 0:
824 modulepath = "%s-GITPATH"%(attempt.group('make_name'))
825 replacement = "%-32s:= %s/%s.git@%s\n"%(modulepath,attempt.group('url_main'),self.name,newname)
827 modulepath = "%s-SVNPATH"%(attempt.group('make_name'))
828 replacement = "%-32s:= %s/%s/tags/%s\n"%(modulepath,attempt.group('url_main'),self.name,newname)
829 if self.options.verbose:
830 print ' ' + modulepath,
831 new.write(replacement)
837 os.rename(newtagsfile,tagsfile)
838 if self.options.verbose: print "%d changes"%matches
841 def check_tag(self, tagname, need_it=False, old_svn_tag_name=None):
842 if self.options.verbose:
843 print "Checking %s repository tag: %s - " % (self.repository.type, tagname),
845 found_tagname = tagname
846 found = self.repository.tag_exists(tagname)
847 if not found and old_svn_tag_name:
848 if self.options.verbose:
850 print "Checking %s repository tag: %s - " % (self.repository.type, old_svn_tag_name),
851 found = self.repository.tag_exists(old_svn_tag_name)
853 found_tagname = old_svn_tag_name
855 if (found and need_it) or (not found and not need_it):
856 if self.options.verbose:
858 if found: print "- found"
859 else: print "- not found"
861 if self.options.verbose:
864 raise Exception, "tag (%s) is already there" % tagname
866 raise Exception, "can not find required tag (%s)" % tagname
871 ##############################
873 self.init_module_dir()
874 self.revert_module_dir()
875 self.update_module_dir()
877 spec_dict = self.spec_dict()
878 self.show_dict(spec_dict)
881 old_tag_name = self.tag_name(spec_dict)
882 old_svn_tag_name = self.tag_name(spec_dict, old_svn_name=True)
884 if (self.options.new_version):
885 # new version set on command line
886 spec_dict[self.module_version_varname] = self.options.new_version
887 spec_dict[self.module_taglevel_varname] = 0
890 new_taglevel = str ( int (spec_dict[self.module_taglevel_varname]) + 1)
891 spec_dict[self.module_taglevel_varname] = new_taglevel
893 new_tag_name = self.tag_name(spec_dict)
896 old_tag_name = self.check_tag(old_tag_name, need_it=True, old_svn_tag_name=old_svn_tag_name)
897 new_tag_name = self.check_tag(new_tag_name, need_it=False)
900 diff_output = self.repository.diff_with_tag(old_tag_name)
901 if len(diff_output) == 0:
902 if not prompt ("No pending difference in module %s, want to tag anyway"%self.name,False):
905 # side effect in trunk's specfile
906 self.patch_spec_var(spec_dict)
908 # prepare changelog file
909 # we use the standard subversion magic string (see svn_magic_line)
910 # so we can provide useful information, such as version numbers and diff
912 changelog="/tmp/%s-%d.edit"%(self.name,os.getpid())
913 changelog_svn="/tmp/%s-%d.svn"%(self.name,os.getpid())
914 setting_tag_line=Module.setting_tag_format%new_tag_name
915 file(changelog,"w").write("""
918 Please write a changelog for this new tag in the section above
919 """%(Module.svn_magic_line,setting_tag_line))
921 if not self.options.verbose or prompt('Want to see diffs while writing changelog',True):
922 file(changelog,"a").write('DIFF=========\n' + diff_output)
924 if self.options.debug:
928 self.run("%s %s"%(self.options.editor,changelog))
929 # strip magic line in second file - looks like svn has changed its magic line with 1.6
930 # so we do the job ourselves
931 self.stripped_magic_line_filename(changelog,changelog_svn,new_tag_name)
932 # insert changelog in spec
933 if self.options.changelog:
934 self.insert_changelog (changelog,old_tag_name,new_tag_name)
937 build_path = os.path.join(self.options.workdir,
938 Module.config['build'])
939 build = Repository(build_path, self.options)
940 if self.options.build_branch:
941 build.to_branch(self.options.build_branch)
942 if not build.is_clean():
945 tagsfiles=glob(build.path+"/*-tags*.mk")
946 tagsdict=dict( [ (x,'todo') for x in tagsfiles ] )
950 for tagsfile in tagsfiles:
951 status=tagsdict[tagsfile]
952 basename=os.path.basename(tagsfile)
953 print ".................... Dealing with %s"%basename
954 while tagsdict[tagsfile] == 'todo' :
955 choice = prompt ("insert %s in %s "%(new_tag_name,basename),default_answer,
956 [ ('y','es'), ('n', 'ext'), ('f','orce'),
957 ('d','iff'), ('r','evert'), ('c', 'at'), ('h','elp') ] ,
960 self.patch_tags_file(tagsfile,old_tag_name,new_tag_name,fine_grain=True)
962 print 'Done with %s'%os.path.basename(tagsfile)
963 tagsdict[tagsfile]='done'
965 self.patch_tags_file(tagsfile,old_tag_name,new_tag_name,fine_grain=False)
967 print build.diff(f=tagsfile)
969 build.revert(f=tagsfile)
971 self.run("cat %s"%tagsfile)
974 print """y: change %(name)s-{SVNPATH,GITPATH} only if it currently refers to %(old_tag_name)s
975 f: unconditionnally change any line that assigns %(name)s-SVNPATH to using %(new_tag_name)s
976 d: show current diff for this tag file
977 r: revert that tag file
978 c: cat the current tag file
979 n: move to next file"""%locals()
981 if prompt("Want to review changes on tags files",False):
982 tagsdict = dict ( [ (x, 'todo') for x in tagsfiles ] )
987 def diff_all_changes():
989 print self.repository.diff()
991 def commit_all_changes(log):
992 self.repository.commit(log)
995 self.run_prompt("Review module and build", diff_all_changes)
996 self.run_prompt("Commit module and build", commit_all_changes, changelog_svn)
997 self.run_prompt("Create tag", self.repository.tag, new_tag_name, changelog_svn)
999 if self.options.debug:
1000 print 'Preserving',changelog,'and stripped',changelog_svn
1002 os.unlink(changelog)
1003 os.unlink(changelog_svn)
1006 ##############################
1007 def do_version (self):
1008 self.init_module_dir()
1009 self.revert_module_dir()
1010 self.update_module_dir()
1011 spec_dict = self.spec_dict()
1012 if self.options.www:
1013 self.html_store_title('Version for module %s (%s)' % (self.friendly_name(),
1014 self.last_tag(spec_dict)))
1015 for varname in self.varnames:
1016 if not spec_dict.has_key(varname):
1017 self.html_print ('Could not find %%define for %s'%varname)
1020 self.html_print ("%-16s %s"%(varname,spec_dict[varname]))
1021 if self.options.verbose:
1022 self.html_print ("%-16s %s"%('main specfile:',self.main_specname()))
1023 self.html_print ("%-16s %s"%('specfiles:',self.all_specnames()))
1024 self.html_print_end()
1027 ##############################
1029 self.init_module_dir()
1030 self.revert_module_dir()
1031 self.update_module_dir()
1032 spec_dict = self.spec_dict()
1033 self.show_dict(spec_dict)
1036 tag_name = self.tag_name(spec_dict)
1037 old_svn_tag_name = self.tag_name(spec_dict, old_svn_name=True)
1040 tag_name = self.check_tag(tag_name, need_it=True, old_svn_tag_name=old_svn_tag_name)
1042 if self.options.verbose:
1043 print 'Getting diff'
1044 diff_output = self.repository.diff_with_tag(tag_name)
1046 if self.options.list:
1050 thename=self.friendly_name()
1052 if self.options.www and diff_output:
1053 self.html_store_title("Diffs in module %s (%s) : %d chars"%(\
1054 thename,self.last_tag(spec_dict),len(diff_output)))
1056 self.html_store_raw ('<p> < (left) %s </p>' % tag_name)
1057 self.html_store_raw ('<p> > (right) %s </p>' % thename)
1058 self.html_store_pre (diff_output)
1059 elif not self.options.www:
1060 print 'x'*30,'module',thename
1061 print 'x'*20,'<',tag_name
1062 print 'x'*20,'>',thename
1065 ##############################
1066 # store and restitute html fragments
1068 def html_href (url,text): return '<a href="%s">%s</a>'%(url,text)
1071 def html_anchor (url,text): return '<a name="%s">%s</a>'%(url,text)
1074 def html_quote (text):
1075 return text.replace('&','&').replace('<','<').replace('>','>')
1077 # only the fake error module has multiple titles
1078 def html_store_title (self, title):
1079 if not hasattr(self,'titles'): self.titles=[]
1080 self.titles.append(title)
1082 def html_store_raw (self, html):
1083 if not hasattr(self,'body'): self.body=''
1086 def html_store_pre (self, text):
1087 if not hasattr(self,'body'): self.body=''
1088 self.body += '<pre>' + self.html_quote(text) + '</pre>'
1090 def html_print (self, txt):
1091 if not self.options.www:
1094 if not hasattr(self,'in_list') or not self.in_list:
1095 self.html_store_raw('<ul>')
1097 self.html_store_raw('<li>'+txt+'</li>')
1099 def html_print_end (self):
1100 if self.options.www:
1101 self.html_store_raw ('</ul>')
1104 def html_dump_header(title):
1105 nowdate=time.strftime("%Y-%m-%d")
1106 nowtime=time.strftime("%H:%M (%Z)")
1107 print """<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1108 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
1111 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1112 <style type="text/css">
1113 body { font-family:georgia, serif; }
1114 h1 {font-size: large; }
1115 p.title {font-size: x-large; }
1116 span.error {text-weight:bold; color: red; }
1120 <p class='title'> %s - status on %s at %s</p>
1122 """%(title,title,nowdate,nowtime)
1125 def html_dump_middle():
1129 def html_dump_footer():
1130 print "</body></html"
1132 def html_dump_toc(self):
1133 if hasattr(self,'titles'):
1134 for title in self.titles:
1135 print '<li>',self.html_href ('#'+self.friendly_name(),title),'</li>'
1137 def html_dump_body(self):
1138 if hasattr(self,'titles'):
1139 for title in self.titles:
1140 print '<hr /><h1>',self.html_anchor(self.friendly_name(),title),'</h1>'
1141 if hasattr(self,'body'):
1143 print '<p class="top">',self.html_href('#','Back to top'),'</p>'
1146 ##############################
1149 module_usage="""Usage: %prog [options] module_desc [ .. module_desc ]
1151 module-tools : a set of tools to manage subversion tags and specfile
1152 requires the specfile to either
1153 * define *version* and *taglevel*
1155 * define redirection variables module_version_varname / module_taglevel_varname
1157 by default, the trunk of modules is taken into account
1158 in this case, just mention the module name as <module_desc>
1160 if you wish to work on a branch rather than on the trunk,
1161 you can use something like e.g. Mom:2.1 as <module_desc>
1163 release_usage="""Usage: %prog [options] tag1 .. tagn
1164 Extract release notes from the changes in specfiles between several build tags, latest first
1166 release-changelog 4.2-rc25 4.2-rc24 4.2-rc23 4.2-rc22
1167 You can refer to a (build) branch by prepending a colon, like in
1168 release-changelog :4.2 4.2-rc25
1169 You can refer to the build trunk by just mentioning 'trunk', e.g.
1170 release-changelog -t coblitz-tags.mk coblitz-2.01-rc6 trunk
1172 common_usage="""More help:
1173 see http://svn.planet-lab.org/wiki/ModuleTools"""
1176 'list' : "displays a list of available tags or branches",
1177 'version' : "check latest specfile and print out details",
1178 'diff' : "show difference between module (trunk or branch) and latest tag",
1179 'tag' : """increment taglevel in specfile, insert changelog in specfile,
1180 create new tag and and monitor its adoption in build/*-tags*.mk""",
1181 'branch' : """create a branch for this module, from the latest tag on the trunk,
1182 and change trunk's version number to reflect the new branch name;
1183 you can specify the new branch name by using module:branch""",
1184 'sync' : """create a tag from the module
1185 this is a last resort option, mostly for repairs""",
1186 'changelog' : """extract changelog between build tags
1187 expected arguments are a list of tags""",
1190 silent_modes = ['list']
1191 release_modes = ['changelog']
1194 def optparse_list (option, opt, value, parser):
1196 setattr(parser.values,option.dest,getattr(parser.values,option.dest)+value.split())
1198 setattr(parser.values,option.dest,value.split())
1203 for function in Main.modes.keys():
1204 if sys.argv[0].find(function) >= 0:
1208 print "Unsupported command",sys.argv[0]
1209 print "Supported commands:" + " ".join(Main.modes.keys())
1212 if mode not in Main.release_modes:
1213 usage = Main.module_usage
1214 usage += Main.common_usage
1215 usage += "\nmodule-%s : %s"%(mode,Main.modes[mode])
1217 usage = Main.release_usage
1218 usage += Main.common_usage
1220 parser=OptionParser(usage=usage)
1222 if mode == "tag" or mode == 'branch':
1223 parser.add_option("-s","--set-version",action="store",dest="new_version",default=None,
1224 help="set new version and reset taglevel to 0")
1226 parser.add_option("-c","--no-changelog", action="store_false", dest="changelog", default=True,
1227 help="do not update changelog section in specfile when tagging")
1228 parser.add_option("-b","--build-branch", action="store", dest="build_branch", default=None,
1229 help="specify a build branch; used for locating the *tags*.mk files where adoption is to take place")
1230 if mode == "tag" or mode == "sync" :
1231 parser.add_option("-e","--editor", action="store", dest="editor", default=default_editor(),
1232 help="specify editor")
1234 if mode in ["diff","version"] :
1235 parser.add_option("-W","--www", action="store", dest="www", default=False,
1236 help="export diff in html format, e.g. -W trunk")
1239 parser.add_option("-l","--list", action="store_true", dest="list", default=False,
1240 help="just list modules that exhibit differences")
1242 default_modules_list=os.path.dirname(sys.argv[0])+"/modules.list"
1243 parser.add_option("-a","--all",action="store_true",dest="all_modules",default=False,
1244 help="run on all modules as found in %s"%default_modules_list)
1245 parser.add_option("-f","--file",action="store",dest="modules_list",default=None,
1246 help="run on all modules found in specified file")
1247 parser.add_option("-n","--dry-run",action="store_true",dest="dry_run",default=False,
1248 help="dry run - shell commands are only displayed")
1249 parser.add_option("-t","--distrotags",action="callback",callback=Main.optparse_list, dest="distrotags",
1250 default=[], nargs=1,type="string",
1251 help="""specify distro-tags files, e.g. onelab-tags-4.2.mk
1252 -- can be set multiple times, or use quotes""")
1254 parser.add_option("-w","--workdir", action="store", dest="workdir",
1255 default="%s/%s"%(os.getenv("HOME"),"modules"),
1256 help="""name for dedicated working dir - defaults to ~/modules
1257 ** THIS MUST NOT ** be your usual working directory""")
1258 parser.add_option("-F","--fast-checks",action="store_true",dest="fast_checks",default=False,
1259 help="skip safety checks, such as svn updates -- use with care")
1261 # default verbosity depending on function - temp
1262 verbose_modes= ['tag', 'sync', 'branch']
1264 if mode not in verbose_modes:
1265 parser.add_option("-v","--verbose", action="store_true", dest="verbose", default=False,
1266 help="run in verbose mode")
1268 parser.add_option("-q","--quiet", action="store_false", dest="verbose", default=True,
1269 help="run in quiet (non-verbose) mode")
1270 (options, args) = parser.parse_args()
1272 if not hasattr(options,'dry_run'):
1273 options.dry_run=False
1274 if not hasattr(options,'www'):
1280 if options.all_modules:
1281 options.modules_list=default_modules_list
1282 if options.modules_list:
1283 args=Command("grep -v '#' %s"%options.modules_list,options).output_of().split()
1287 Module.init_homedir(options)
1290 modules=[ Module(modname,options) for modname in args ]
1291 # hack: create a dummy Module to store errors/warnings
1292 error_module = Module('__errors__',options)
1294 for module in modules:
1295 if len(args)>1 and mode not in Main.silent_modes:
1297 print '========================================',module.friendly_name()
1298 # call the method called do_<mode>
1299 method=Module.__dict__["do_%s"%mode]
1304 title='<span class="error"> Skipping module %s - failure: %s </span>'%\
1305 (module.friendly_name(), str(e))
1306 error_module.html_store_title(title)
1309 traceback.print_exc()
1310 print 'Skipping module %s: '%modname,e
1314 modetitle="Changes to tag in %s"%options.www
1315 elif mode == "version":
1316 modetitle="Latest tags in %s"%options.www
1317 modules.append(error_module)
1318 error_module.html_dump_header(modetitle)
1319 for module in modules:
1320 module.html_dump_toc()
1321 Module.html_dump_middle()
1322 for module in modules:
1323 module.html_dump_body()
1324 Module.html_dump_footer()
1326 ####################
1327 if __name__ == "__main__" :
1330 except KeyboardInterrupt: