module-tools.py

   1 #!/usr/bin/python -u
   2
   3 import sys, os
   4 import re
   5 import time
   6 from glob import glob
   7 from optparse import OptionParser
   8
   9 # HARDCODED NAME CHANGES
  10 #
  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 = {
  14     "PLEWWW": "plewww",
  15     "PLCAPI": "plcapi",
  16     "BootManager": "bootmanager",
  17     "BootCD": "bootcd",
  18     "VserverReference": "vserver-reference",
  19     "BootstrapFS": "bootstrapfs",
  20     "MyPLC": "myplc",
  21     "CoDemux": "codemux",
  22     "NodeManager": "nodemanager",
  23     "NodeUpdate": "nodeupdate"
  24     }
  25
  26 def svn_to_git_name(module):
  27     if RENAMED_SVN_MODULES.has_key(module):
  28         return RENAMED_SVN_MODULES[module]
  29     return module
  30
  31 def git_to_svn_name(module):
  32     for key in RENAMED_SVN_MODULES:
  33         if module == RENAMED_SVN_MODULES[key]:
  34             return key
  35     return module
  36
  37
  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 ]
  43
  44     choices = []
  45     if 'y' not in chars:
  46         if default is True: choices.append('[y]')
  47         else : choices.append('y')
  48     if 'n' not in chars:
  49         if default is False: choices.append('[n]')
  50         else : choices.append('n')
  51
  52     for (char,choice) in other_choices:
  53         if default == char:
  54             choices.append("["+char+"]"+choice)
  55         else:
  56             choices.append("<"+char+">"+choice)
  57     try:
  58         answer=raw_input(question + " " + "/".join(choices) + " ? ")
  59         if not answer:
  60             return default
  61         answer=answer[0].lower()
  62         if answer == 'y':
  63             if 'y' in chars: return 'y'
  64             else: return True
  65         elif answer == 'n':
  66             if 'n' in chars: return 'n'
  67             else: return False
  68         elif other_choices:
  69             for (char,choice) in other_choices:
  70                 if answer == char:
  71                     return char
  72             if allow_outside:
  73                 return answer
  74         return prompt(question,default,other_choices)
  75     except:
  76         raise
  77
  78 def default_editor():
  79     try:
  80         editor = os.environ['EDITOR']
  81     except:
  82         editor = "emacs"
  83     return editor
  84
  85 ### fold long lines
  86 fold_length=132
  87
  88 def print_fold (line):
  89     while len(line) >= fold_length:
  90         print line[:fold_length],'\\'
  91         line=line[fold_length:]
  92     print line
  93
  94 class Command:
  95     def __init__ (self,command,options):
  96         self.command=command
  97         self.options=options
  98         self.tmp="/tmp/command-%d"%os.getpid()
  99
 100     def run (self):
 101         if self.options.dry_run:
 102             print 'dry_run',self.command
 103             return 0
 104         if self.options.verbose and self.options.mode not in Main.silent_modes:
 105             print '+',self.command
 106             sys.stdout.flush()
 107         return os.system(self.command)
 108
 109     def run_silent (self):
 110         if self.options.dry_run:
 111             print 'dry_run',self.command
 112             return 0
 113         if self.options.verbose:
 114             print '+',self.command,' .. ',
 115             sys.stdout.flush()
 116         retcod=os.system(self.command + " &> " + self.tmp)
 117         if retcod != 0:
 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:
 122             print "OK"
 123         os.unlink(self.tmp)
 124         return retcod
 125
 126     def run_fatal(self):
 127         if self.run_silent() !=0:
 128             raise Exception,"Command %s failed"%self.command
 129
 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,' .. ',
 138             sys.stdout.flush()
 139         command=self.command
 140         if with_stderr:
 141             command += " &> "
 142         else:
 143             command += " > "
 144         command += tmp
 145         os.system(command)
 146         result=file(tmp).read()
 147         os.unlink(tmp)
 148         if self.options.debug:
 149             print 'Done',
 150         return result
 151
 152
 153 class SvnRepository:
 154     type = "svn"
 155
 156     def __init__(self, path, options):
 157         self.path = path
 158         self.options = options
 159
 160     def name(self):
 161         return os.path.basename(self.path)
 162
 163     def url(self):
 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()
 168
 169     def repo_root(self):
 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())
 175
 176     @classmethod
 177     def checkout(cls, remote, local, options, recursive=False):
 178         if recursive:
 179             svncommand = "svn co %s %s" % (remote, local)
 180         else:
 181             svncommand = "svn co -N %s %s" % (remote, local)
 182         Command("rm -rf %s" % local, options).run_silent()
 183         Command(svncommand, options).run_fatal()
 184
 185         return SvnRepository(local, options)
 186
 187     @classmethod
 188     def remote_exists(cls, remote):
 189         return os.system("svn list %s &> /dev/null" % remote) == 0
 190
 191     def tag_exists(self, tagname):
 192         url = "%s/tags/%s" % (self.repo_root(), tagname)
 193         return SvnRepository.remote_exists(url)
 194
 195     def update(self, subdir="", recursive=True, branch=None):
 196         path = os.path.join(self.path, subdir)
 197         if recursive:
 198             svncommand = "svn up %s" % path
 199         else:
 200             svncommand = "svn up -N %s" % path
 201         Command(svncommand, self.options).run_fatal()
 202
 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()
 208
 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)
 212
 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)
 216
 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()
 221
 222     def diff(self, f=""):
 223         if f:
 224             f = os.path.join(self.path, f)
 225         else:
 226             f = self.path
 227         return Command("svn diff %s" % f, self.options).output_of(True)
 228
 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)
 233
 234     def revert(self, f=""):
 235         if f:
 236             Command("svn revert %s" % os.path.join(self.path, f), self.options).run_fatal()
 237         else:
 238             # revert all
 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()
 242
 243     def is_clean(self):
 244         command="svn status %s" % self.path
 245         return len(Command(command,self.options).output_of(True)) == 0
 246
 247     def is_valid(self):
 248         return os.path.exists(os.path.join(self.path, ".svn"))
 249
 250
 251 class GitRepository:
 252     type = "git"
 253
 254     def __init__(self, path, options):
 255         self.path = path
 256         self.options = options
 257
 258     def name(self):
 259         return os.path.basename(self.path)
 260
 261     def url(self):
 262         self.repo_root()
 263
 264     def repo_root(self):
 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]
 270
 271     @classmethod
 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)
 276
 277     @classmethod
 278     def remote_exists(cls, remote):
 279         return os.system("git --no-pager ls-remote %s &> /dev/null" % remote) == 0
 280
 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)
 285         return len(out) > 0
 286
 287     def __run_in_repo(self, fun, *args, **kwargs):
 288         cwd = os.getcwd()
 289         os.chdir(self.path)
 290         ret = fun(*args, **kwargs)
 291         os.chdir(cwd)
 292         return ret
 293
 294     def __run_command_in_repo(self, command, ignore_errors=False):
 295         c = Command(command, self.options)
 296         if ignore_errors:
 297             return self.__run_in_repo(c.output_of)
 298         else:
 299             return self.__run_in_repo(c.run_fatal)
 300
 301     def update(self, subdir=None, recursive=None, branch="master"):
 302         if branch == "master":
 303             self.__run_command_in_repo("git checkout %s" % branch)
 304         else:
 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)
 309
 310     def to_branch(self, branch, remote=True):
 311         if remote:
 312             branch = "origin/%s" % branch
 313         return self.__run_command_in_repo("git checkout %s" % branch)
 314
 315     def to_tag(self, tag):
 316         return self.__run_command_in_repo("git checkout %s" % tag)
 317
 318     def tag(self, tagname, logfile):
 319         self.__run_command_in_repo("git tag %s -F %s" % (tagname, logfile))
 320         self.commit(logfile)
 321
 322     def diff(self, f=""):
 323         c = Command("git diff %s" % f, self.options)
 324         return self.__run_in_repo(c.output_of, with_stderr=True)
 325
 326     def diff_with_tag(self, tagname):
 327         c = Command("git diff %s" % tagname, self.options)
 328         return self.__run_in_repo(c.output_of, with_stderr=True)
 329
 330     def commit(self, logfile):
 331         self.__run_command_in_repo("git add .", ignore_errors=True)
 332         self.__run_command_in_repo("git add -u", ignore_errors=True)
 333         self.__run_command_in_repo("git commit -F  %s" % logfile, ignore_errors=True)
 334         self.__run_command_in_repo("git push")
 335         self.__run_command_in_repo("git push --tags")
 336
 337     def revert(self, f=""):
 338         if f:
 339             self.__run_command_in_repo("git checkout %s" % f)
 340         else:
 341             # revert all
 342             self.__run_command_in_repo("git --no-pager reset --hard")
 343             self.__run_command_in_repo("git --no-pager clean -f")
 344
 345     def is_clean(self):
 346         def check_commit():
 347             command="git status"
 348             s="nothing to commit (working directory clean)"
 349             return Command(command, self.options).output_of(True).find(s) >= 0
 350         return self.__run_in_repo(check_commit)
 351
 352     def is_valid(self):
 353         return os.path.exists(os.path.join(self.path, ".git"))
 354
 355
 356 class Repository:
 357     """ Generic repository """
 358     supported_repo_types = [SvnRepository, GitRepository]
 359
 360     def __init__(self, path, options):
 361         self.path = path
 362         self.options = options
 363         for repo in self.supported_repo_types:
 364             self.repo = repo(self.path, self.options)
 365             if self.repo.is_valid():
 366                 break
 367
 368     @classmethod
 369     def has_moved_to_git(cls, module, config):
 370         module = svn_to_git_name(module)
 371         # check if the module is already in Git
 372 #        return SvnRepository.remote_exists("%s/%s/aaaa-has-moved-to-git" % (config['svnpath'], module))
 373         return GitRepository.remote_exists(Module.git_remote_dir(module))
 374
 375
 376     @classmethod
 377     def remote_exists(cls, remote):
 378         for repo in Repository.supported_repo_types:
 379             if repo.remote_exists(remote):
 380                 return True
 381         return False
 382
 383     def __getattr__(self, attr):
 384         return getattr(self.repo, attr)
 385
 386
 387
 388 # support for tagged module is minimal, and is for the Build class only
 389 class Module:
 390
 391     svn_magic_line="--This line, and those below, will be ignored--"
 392     setting_tag_format = "Setting tag %s"
 393
 394     redirectors=[ # ('module_name_varname','name'),
 395                   ('module_version_varname','version'),
 396                   ('module_taglevel_varname','taglevel'), ]
 397
 398     # where to store user's config
 399     config_storage="CONFIG"
 400     #
 401     config={}
 402
 403     import commands
 404     configKeys=[ ('svnpath',"Enter your toplevel svnpath",
 405                   "svn+ssh://%s@svn.planet-lab.org/svn/"%commands.getoutput("id -un")),
 406                  ('gitserver', "Enter your git server's hostname", "git.onelab.eu"),
 407                  ('gituser', "Enter your user name (login name) on git server", commands.getoutput("id -un")),
 408                  ("build", "Enter the name of your build module","build"),
 409                  ('username',"Enter your firstname and lastname for changelogs",""),
 410                  ("email","Enter your email address for changelogs",""),
 411                  ]
 412
 413     @classmethod
 414     def prompt_config_option(cls, key, message, default):
 415         cls.config[key]=raw_input("%s [%s] : "%(message,default)).strip() or default
 416
 417     @classmethod
 418     def prompt_config (cls):
 419         for (key,message,default) in cls.configKeys:
 420             cls.config[key]=""
 421             while not cls.config[key]:
 422                 cls.prompt_config_option(key, message, default)
 423
 424
 425     # for parsing module spec name:branch
 426     matcher_branch_spec=re.compile("\A(?P<name>[\w\.-]+):(?P<branch>[\w\.-]+)\Z")
 427     # special form for tagged module - for Build
 428     matcher_tag_spec=re.compile("\A(?P<name>[\w-]+)@(?P<tagname>[\w\.-]+)\Z")
 429     # parsing specfiles
 430     matcher_rpm_define=re.compile("%(define|global)\s+(\S+)\s+(\S*)\s*")
 431
 432     def __init__ (self,module_spec,options):
 433         # parse module spec
 434         attempt=Module.matcher_branch_spec.match(module_spec)
 435         if attempt:
 436             self.name=attempt.group('name')
 437             self.branch=attempt.group('branch')
 438         else:
 439             attempt=Module.matcher_tag_spec.match(module_spec)
 440             if attempt:
 441                 self.name=attempt.group('name')
 442                 self.tagname=attempt.group('tagname')
 443             else:
 444                 self.name=module_spec
 445
 446         # when available prefer to use git module name internally
 447         self.name = svn_to_git_name(self.name)
 448
 449         self.options=options
 450         self.module_dir="%s/%s"%(options.workdir,self.name)
 451         self.repository = None
 452         self.build = None
 453
 454     def run (self,command):
 455         return Command(command,self.options).run()
 456     def run_fatal (self,command):
 457         return Command(command,self.options).run_fatal()
 458     def run_prompt (self,message,fun, *args):
 459         fun_msg = "%s(%s)" % (fun.func_name, ",".join(args))
 460         if not self.options.verbose:
 461             while True:
 462                 choice=prompt(message,True,('s','how'))
 463                 if choice is True:
 464                     fun(*args)
 465                     return
 466                 elif choice is False:
 467                     print 'About to run function:', fun_msg
 468         else:
 469             question=message+" - want to run function: " + fun_msg
 470             if prompt(question,True):
 471                 fun(*args)
 472
 473     def friendly_name (self):
 474         if hasattr(self,'branch'):
 475             return "%s:%s"%(self.name,self.branch)
 476         elif hasattr(self,'tagname'):
 477             return "%s@%s"%(self.name,self.tagname)
 478         else:
 479             return self.name
 480
 481     @classmethod
 482     def git_remote_dir (cls, name):
 483         return "%s@%s:/git/%s.git" % (cls.config['gituser'], cls.config['gitserver'], name)
 484
 485     @classmethod
 486     def svn_remote_dir (cls, name):
 487         name = git_to_svn_name(name)
 488         svn = cls.config['svnpath']
 489         if svn.endswith('/'):
 490             return "%s%s" % (svn, name)
 491         return "%s/%s" % (svn, name)
 492
 493     def svn_selected_remote(self):
 494         svn_name = git_to_svn_name(self.name)
 495         remote = self.svn_remote_dir(svn_name)
 496         if hasattr(self,'branch'):
 497             remote = "%s/branches/%s" % (remote, self.branch)
 498         elif hasattr(self,'tagname'):
 499             remote = "%s/tags/%s" % (remote, self.tagname)
 500         else:
 501             remote = "%s/trunk" % remote
 502         return remote
 503
 504     ####################
 505     @classmethod
 506     def init_homedir (cls, options):
 507         if options.verbose and options.mode not in Main.silent_modes:
 508             print 'Checking for', options.workdir
 509         storage="%s/%s"%(options.workdir, cls.config_storage)
 510         # sanity check. Either the topdir exists AND we have a config/storage
 511         # or topdir does not exist and we create it
 512         # to avoid people use their own daily svn repo
 513         if os.path.isdir(options.workdir) and not os.path.isfile(storage):
 514             print """The directory %s exists and has no CONFIG file
 515 If this is your regular working directory, please provide another one as the
 516 module-* commands need a fresh working dir. Make sure that you do not use
 517 that for other purposes than tagging""" % options.workdir
 518             sys.exit(1)
 519
 520         def checkout_build():
 521             print "Checking out build module..."
 522             remote = cls.git_remote_dir(cls.config['build'])
 523             local = os.path.join(options.workdir, cls.config['build'])
 524             GitRepository.checkout(remote, local, options, depth=1)
 525             print "OK"
 526
 527         def store_config():
 528             f=file(storage,"w")
 529             for (key,message,default) in Module.configKeys:
 530                 f.write("%s=%s\n"%(key,Module.config[key]))
 531             f.close()
 532             if options.debug:
 533                 print 'Stored',storage
 534                 Command("cat %s"%storage,options).run()
 535
 536         def read_config():
 537             # read config
 538             f=open(storage)
 539             for line in f.readlines():
 540                 (key,value)=re.compile("^(.+)=(.+)$").match(line).groups()
 541                 Module.config[key]=value
 542             f.close()
 543
 544         if not os.path.isdir (options.workdir):
 545             print "Cannot find",options.workdir,"let's create it"
 546             Command("mkdir -p %s" % options.workdir, options).run_silent()
 547             cls.prompt_config()
 548             checkout_build()
 549             store_config()
 550         else:
 551             read_config()
 552             # check missing config options
 553             old_layout = False
 554             for (key,message,default) in cls.configKeys:
 555                 if not Module.config.has_key(key):
 556                     print "Configuration changed for module-tools"
 557                     cls.prompt_config_option(key, message, default)
 558                     old_layout = True
 559
 560             if old_layout:
 561                 Command("rm -rf %s" % options.workdir, options).run_silent()
 562                 Command("mkdir -p %s" % options.workdir, options).run_silent()
 563                 checkout_build()
 564                 store_config()
 565
 566             build_dir = os.path.join(options.workdir, cls.config['build'])
 567             if not os.path.isdir(build_dir):
 568                 checkout_build()
 569             else:
 570                 build = Repository(build_dir, options)
 571                 if not build.is_clean():
 572                     print "build module needs a revert"
 573                     build.revert()
 574                     print "OK"
 575                 build.update()
 576
 577         if options.verbose and options.mode not in Main.silent_modes:
 578             print '******** Using config'
 579             for (key,message,default) in Module.configKeys:
 580                 print '\t',key,'=',Module.config[key]
 581
 582     def init_module_dir (self):
 583         if self.options.verbose:
 584             print 'Checking for',self.module_dir
 585
 586         if not os.path.isdir (self.module_dir):
 587             if Repository.has_moved_to_git(self.name, Module.config):
 588                 self.repository = GitRepository.checkout(self.git_remote_dir(self.name),
 589                                                          self.module_dir,
 590                                                          self.options)
 591             else:
 592                 remote = self.svn_selected_remote()
 593                 self.repository = SvnRepository.checkout(remote,
 594                                                          self.module_dir,
 595                                                          self.options, recursive=False)
 596
 597         self.repository = Repository(self.module_dir, self.options)
 598         if self.repository.type == "svn":
 599             # check if module has moved to git
 600             if Repository.has_moved_to_git(self.name, Module.config):
 601                 Command("rm -rf %s" % self.module_dir, self.options).run_silent()
 602                 self.init_module_dir()
 603             # check if we have the required branch/tag
 604             if self.repository.url() != self.svn_selected_remote():
 605                 Command("rm -rf %s" % self.module_dir, self.options).run_silent()
 606                 self.init_module_dir()
 607
 608         elif self.repository.type == "git":
 609             if hasattr(self,'branch'):
 610                 self.repository.to_branch(self.branch)
 611             elif hasattr(self,'tagname'):
 612                 self.repository.to_tag(self.tagname)
 613
 614         else:
 615             raise Exception, 'Cannot find %s - check module name'%self.module_dir
 616
 617
 618     def revert_module_dir (self):
 619         if self.options.fast_checks:
 620             if self.options.verbose: print 'Skipping revert of %s' % self.module_dir
 621             return
 622         if self.options.verbose:
 623             print 'Checking whether', self.module_dir, 'needs being reverted'
 624
 625         if not self.repository.is_clean():
 626             self.repository.revert()
 627
 628     def update_module_dir (self):
 629         if self.options.fast_checks:
 630             if self.options.verbose: print 'Skipping update of %s' % self.module_dir
 631             return
 632         if self.options.verbose:
 633             print 'Updating', self.module_dir
 634
 635         if hasattr(self,'branch'):
 636             self.repository.update(branch=self.branch)
 637         elif hasattr(self,'tagname'):
 638             self.repository.update(branch=self.tagname)
 639         else:
 640             self.repository.update()
 641
 642     def main_specname (self):
 643         attempt="%s/%s.spec"%(self.module_dir,self.name)
 644         if os.path.isfile (attempt):
 645             return attempt
 646         pattern1="%s/*.spec"%self.module_dir
 647         level1=glob(pattern1)
 648         if level1:
 649             return level1[0]
 650         pattern2="%s/*/*.spec"%self.module_dir
 651         level2=glob(pattern2)
 652
 653         if level2:
 654             return level2[0]
 655         raise Exception, 'Cannot guess specfile for module %s -- patterns were %s or %s'%(self.name,pattern1,pattern2)
 656
 657     def all_specnames (self):
 658         level1=glob("%s/*.spec" % self.module_dir)
 659         if level1: return level1
 660         level2=glob("%s/*/*.spec" % self.module_dir)
 661         return level2
 662
 663     def parse_spec (self, specfile, varnames):
 664         if self.options.verbose:
 665             print 'Parsing',specfile,
 666             for var in varnames:
 667                 print "[%s]"%var,
 668             print ""
 669         result={}
 670         f=open(specfile)
 671         for line in f.readlines():
 672             attempt=Module.matcher_rpm_define.match(line)
 673             if attempt:
 674                 (define,var,value)=attempt.groups()
 675                 if var in varnames:
 676                     result[var]=value
 677         f.close()
 678         if self.options.debug:
 679             print 'found',len(result),'keys'
 680             for (k,v) in result.iteritems():
 681                 print k,'=',v
 682         return result
 683
 684     # stores in self.module_name_varname the rpm variable to be used for the module's name
 685     # and the list of these names in self.varnames
 686     def spec_dict (self):
 687         specfile=self.main_specname()
 688         redirector_keys = [ varname for (varname,default) in Module.redirectors]
 689         redirect_dict = self.parse_spec(specfile,redirector_keys)
 690         if self.options.debug:
 691             print '1st pass parsing done, redirect_dict=',redirect_dict
 692         varnames=[]
 693         for (varname,default) in Module.redirectors:
 694             if redirect_dict.has_key(varname):
 695                 setattr(self,varname,redirect_dict[varname])
 696                 varnames += [redirect_dict[varname]]
 697             else:
 698                 setattr(self,varname,default)
 699                 varnames += [ default ]
 700         self.varnames = varnames
 701         result = self.parse_spec (specfile,self.varnames)
 702         if self.options.debug:
 703             print '2st pass parsing done, varnames=',varnames,'result=',result
 704         return result
 705
 706     def patch_spec_var (self, patch_dict,define_missing=False):
 707         for specfile in self.all_specnames():
 708             # record the keys that were changed
 709             changed = dict ( [ (x,False) for x in patch_dict.keys() ] )
 710             newspecfile=specfile+".new"
 711             if self.options.verbose:
 712                 print 'Patching',specfile,'for',patch_dict.keys()
 713             spec=open (specfile)
 714             new=open(newspecfile,"w")
 715
 716             for line in spec.readlines():
 717                 attempt=Module.matcher_rpm_define.match(line)
 718                 if attempt:
 719                     (define,var,value)=attempt.groups()
 720                     if var in patch_dict.keys():
 721                         if self.options.debug:
 722                             print 'rewriting %s as %s'%(var,patch_dict[var])
 723                         new.write('%%%s %s %s\n'%(define,var,patch_dict[var]))
 724                         changed[var]=True
 725                         continue
 726                 new.write(line)
 727             if define_missing:
 728                 for (key,was_changed) in changed.iteritems():
 729                     if not was_changed:
 730                         if self.options.debug:
 731                             print 'rewriting missing %s as %s'%(key,patch_dict[key])
 732                         new.write('\n%%define %s %s\n'%(key,patch_dict[key]))
 733             spec.close()
 734             new.close()
 735             os.rename(newspecfile,specfile)
 736
 737     # returns all lines until the magic line
 738     def unignored_lines (self, logfile):
 739         result=[]
 740         white_line_matcher = re.compile("\A\s*\Z")
 741         for logline in file(logfile).readlines():
 742             if logline.strip() == Module.svn_magic_line:
 743                 break
 744             elif white_line_matcher.match(logline):
 745                 continue
 746             else:
 747                 result.append(logline.strip()+'\n')
 748         return result
 749
 750     # creates a copy of the input with only the unignored lines
 751     def stripped_magic_line_filename (self, filein, fileout ,new_tag_name):
 752        f=file(fileout,'w')
 753        f.write(self.setting_tag_format%new_tag_name + '\n')
 754        for line in self.unignored_lines(filein):
 755            f.write(line)
 756        f.close()
 757
 758     def insert_changelog (self, logfile, oldtag, newtag):
 759         for specfile in self.all_specnames():
 760             newspecfile=specfile+".new"
 761             if self.options.verbose:
 762                 print 'Inserting changelog from %s into %s'%(logfile,specfile)
 763             spec=open (specfile)
 764             new=open(newspecfile,"w")
 765             for line in spec.readlines():
 766                 new.write(line)
 767                 if re.compile('%changelog').match(line):
 768                     dateformat="* %a %b %d %Y"
 769                     datepart=time.strftime(dateformat)
 770                     logpart="%s <%s> - %s"%(Module.config['username'],
 771                                                  Module.config['email'],
 772                                                  newtag)
 773                     new.write(datepart+" "+logpart+"\n")
 774                     for logline in self.unignored_lines(logfile):
 775                         new.write("- " + logline)
 776                     new.write("\n")
 777             spec.close()
 778             new.close()
 779             os.rename(newspecfile,specfile)
 780
 781     def show_dict (self, spec_dict):
 782         if self.options.verbose:
 783             for (k,v) in spec_dict.iteritems():
 784                 print k,'=',v
 785
 786     def last_tag (self, spec_dict):
 787         try:
 788             return "%s-%s" % (spec_dict[self.module_version_varname],
 789                               spec_dict[self.module_taglevel_varname])
 790         except KeyError,err:
 791             raise Exception,'Something is wrong with module %s, cannot determine %s - exiting'%(self.name,err)
 792
 793     def tag_name (self, spec_dict, old_svn_name=False):
 794         base_tag_name = self.name
 795         if old_svn_name:
 796             base_tag_name = git_to_svn_name(self.name)
 797         return "%s-%s" % (base_tag_name, self.last_tag(spec_dict))
 798
 799
 800 ##############################
 801     # using fine_grain means replacing only those instances that currently refer to this tag
 802     # otherwise, <module>-{SVNPATH,GITPATH} is replaced unconditionnally
 803     def patch_tags_file (self, tagsfile, oldname, newname,fine_grain=True):
 804         newtagsfile=tagsfile+".new"
 805         tags=open (tagsfile)
 806         new=open(newtagsfile,"w")
 807
 808         matches=0
 809         # fine-grain : replace those lines that refer to oldname
 810         if fine_grain:
 811             if self.options.verbose:
 812                 print 'Replacing %s into %s\n\tin %s .. '%(oldname,newname,tagsfile),
 813             matcher=re.compile("^(.*)%s(.*)"%oldname)
 814             for line in tags.readlines():
 815                 if not matcher.match(line):
 816                     new.write(line)
 817                 else:
 818                     (begin,end)=matcher.match(line).groups()
 819                     new.write(begin+newname+end+"\n")
 820                     matches += 1
 821         # brute-force : change uncommented lines that define <module>-SVNPATH
 822         else:
 823             if self.options.verbose:
 824                 print 'Searching for -SVNPATH or -GITPATH lines referring to /%s/\n\tin %s .. '%(self.name,tagsfile),
 825             pattern="\A\s*(?P<make_name>[^\s]+)-(SVNPATH|GITPATH)\s*(=|:=)\s*(?P<url_main>[^\s]+)/%s[^\s]+"\
 826                                           %(self.name)
 827             matcher_module=re.compile(pattern)
 828             for line in tags.readlines():
 829                 attempt=matcher_module.match(line)
 830                 if attempt:
 831                     if line.find("-GITPATH") >= 0:
 832                         modulepath = "%s-GITPATH"%(attempt.group('make_name'))
 833                         replacement = "%-32s:= %s/%s.git@%s\n"%(modulepath,attempt.group('url_main'),self.name,newname)
 834                     else:
 835                         modulepath = "%s-SVNPATH"%(attempt.group('make_name'))
 836                         replacement = "%-32s:= %s/%s/tags/%s\n"%(modulepath,attempt.group('url_main'),self.name,newname)
 837                     if self.options.verbose:
 838                         print ' ' + modulepath,
 839                     new.write(replacement)
 840                     matches += 1
 841                 else:
 842                     new.write(line)
 843         tags.close()
 844         new.close()
 845         os.rename(newtagsfile,tagsfile)
 846         if self.options.verbose: print "%d changes"%matches
 847         return matches
 848
 849     def check_tag(self, tagname, need_it=False, old_svn_tag_name=None):
 850         if self.options.verbose:
 851             print "Checking %s repository tag: %s - " % (self.repository.type, tagname),
 852
 853         found_tagname = tagname
 854         found = self.repository.tag_exists(tagname)
 855         if not found and old_svn_tag_name:
 856             if self.options.verbose:
 857                 print "KO"
 858                 print "Checking %s repository tag: %s - " % (self.repository.type, old_svn_tag_name),
 859             found = self.repository.tag_exists(old_svn_tag_name)
 860             if found:
 861                 found_tagname = old_svn_tag_name
 862
 863         if (found and need_it) or (not found and not need_it):
 864             if self.options.verbose:
 865                 print "OK",
 866                 if found: print "- found"
 867                 else: print "- not found"
 868         else:
 869             if self.options.verbose:
 870                 print "KO"
 871             if found:
 872                 raise Exception, "tag (%s) is already there" % tagname
 873             else:
 874                 raise Exception, "can not find required tag (%s)" % tagname
 875
 876         return found_tagname
 877
 878
 879 ##############################
 880     def do_tag (self):
 881         self.init_module_dir()
 882         self.revert_module_dir()
 883         self.update_module_dir()
 884         # parse specfile
 885         spec_dict = self.spec_dict()
 886         self.show_dict(spec_dict)
 887
 888         # side effects
 889         old_tag_name = self.tag_name(spec_dict)
 890         old_svn_tag_name = self.tag_name(spec_dict, old_svn_name=True)
 891
 892         if (self.options.new_version):
 893             # new version set on command line
 894             spec_dict[self.module_version_varname] = self.options.new_version
 895             spec_dict[self.module_taglevel_varname] = 0
 896         else:
 897             # increment taglevel
 898             new_taglevel = str ( int (spec_dict[self.module_taglevel_varname]) + 1)
 899             spec_dict[self.module_taglevel_varname] = new_taglevel
 900
 901         new_tag_name = self.tag_name(spec_dict)
 902
 903         # sanity check
 904         old_tag_name = self.check_tag(old_tag_name, need_it=True, old_svn_tag_name=old_svn_tag_name)
 905         new_tag_name = self.check_tag(new_tag_name, need_it=False)
 906
 907         # checking for diffs
 908         diff_output = self.repository.diff_with_tag(old_tag_name)
 909         if len(diff_output) == 0:
 910             if not prompt ("No pending difference in module %s, want to tag anyway"%self.name,False):
 911                 return
 912
 913         # side effect in trunk's specfile
 914         self.patch_spec_var(spec_dict)
 915
 916         # prepare changelog file
 917         # we use the standard subversion magic string (see svn_magic_line)
 918         # so we can provide useful information, such as version numbers and diff
 919         # in the same file
 920         changelog="/tmp/%s-%d.edit"%(self.name,os.getpid())
 921         changelog_svn="/tmp/%s-%d.svn"%(self.name,os.getpid())
 922         setting_tag_line=Module.setting_tag_format%new_tag_name
 923         file(changelog,"w").write("""
 924 %s
 925 %s
 926 Please write a changelog for this new tag in the section above
 927 """%(Module.svn_magic_line,setting_tag_line))
 928
 929         if not self.options.verbose or prompt('Want to see diffs while writing changelog',True):
 930             file(changelog,"a").write('DIFF=========\n' + diff_output)
 931
 932         if self.options.debug:
 933             prompt('Proceed ?')
 934
 935         # edit it
 936         self.run("%s %s"%(self.options.editor,changelog))
 937         # strip magic line in second file - looks like svn has changed its magic line with 1.6
 938         # so we do the job ourselves
 939         self.stripped_magic_line_filename(changelog,changelog_svn,new_tag_name)
 940         # insert changelog in spec
 941         if self.options.changelog:
 942             self.insert_changelog (changelog,old_tag_name,new_tag_name)
 943
 944         ## update build
 945         build_path = os.path.join(self.options.workdir,
 946                                   Module.config['build'])
 947         build = Repository(build_path, self.options)
 948         if self.options.build_branch:
 949             build.to_branch(self.options.build_branch)
 950         if not build.is_clean():
 951             build.revert()
 952
 953         tagsfiles=glob(build.path+"/*-tags*.mk")
 954         tagsdict=dict( [ (x,'todo') for x in tagsfiles ] )
 955         default_answer = 'y'
 956         tagsfiles.sort()
 957         while True:
 958             for tagsfile in tagsfiles:
 959                 status=tagsdict[tagsfile]
 960                 basename=os.path.basename(tagsfile)
 961                 print ".................... Dealing with %s"%basename
 962                 while tagsdict[tagsfile] == 'todo' :
 963                     choice = prompt ("insert %s in %s    "%(new_tag_name,basename),default_answer,
 964                                      [ ('y','es'), ('n', 'ext'), ('f','orce'),
 965                                        ('d','iff'), ('r','evert'), ('c', 'at'), ('h','elp') ] ,
 966                                      allow_outside=True)
 967                     if choice == 'y':
 968                         self.patch_tags_file(tagsfile,old_tag_name,new_tag_name,fine_grain=True)
 969                     elif choice == 'n':
 970                         print 'Done with %s'%os.path.basename(tagsfile)
 971                         tagsdict[tagsfile]='done'
 972                     elif choice == 'f':
 973                         self.patch_tags_file(tagsfile,old_tag_name,new_tag_name,fine_grain=False)
 974                     elif choice == 'd':
 975                         print build.diff(f=tagsfile)
 976                     elif choice == 'r':
 977                         build.revert(f=tagsfile)
 978                     elif choice == 'c':
 979                         self.run("cat %s"%tagsfile)
 980                     else:
 981                         name=self.name
 982                         print """y: change %(name)s-{SVNPATH,GITPATH} only if it currently refers to %(old_tag_name)s
 983 f: unconditionnally change any line that assigns %(name)s-SVNPATH to using %(new_tag_name)s
 984 d: show current diff for this tag file
 985 r: revert that tag file
 986 c: cat the current tag file
 987 n: move to next file"""%locals()
 988
 989             if prompt("Want to review changes on tags files",False):
 990                 tagsdict = dict ( [ (x, 'todo') for x in tagsfiles ] )
 991                 default_answer='d'
 992             else:
 993                 break
 994
 995         def diff_all_changes():
 996             print build.diff()
 997             print self.repository.diff()
 998
 999         def commit_all_changes(log):
1000             self.repository.commit(log)
1001             build.commit(log)
1002
1003         self.run_prompt("Review module and build", diff_all_changes)
1004         self.run_prompt("Commit module and build", commit_all_changes, changelog_svn)
1005         self.run_prompt("Create tag", self.repository.tag, new_tag_name, changelog_svn)
1006
1007         if self.options.debug:
1008             print 'Preserving',changelog,'and stripped',changelog_svn
1009         else:
1010             os.unlink(changelog)
1011             os.unlink(changelog_svn)
1012
1013
1014 ##############################
1015     def do_version (self):
1016         self.init_module_dir()
1017         self.revert_module_dir()
1018         self.update_module_dir()
1019         spec_dict = self.spec_dict()
1020         if self.options.www:
1021             self.html_store_title('Version for module %s (%s)' % (self.friendly_name(),
1022                                                                   self.last_tag(spec_dict)))
1023         for varname in self.varnames:
1024             if not spec_dict.has_key(varname):
1025                 self.html_print ('Could not find %%define for %s'%varname)
1026                 return
1027             else:
1028                 self.html_print ("%-16s %s"%(varname,spec_dict[varname]))
1029         if self.options.verbose:
1030             self.html_print ("%-16s %s"%('main specfile:',self.main_specname()))
1031             self.html_print ("%-16s %s"%('specfiles:',self.all_specnames()))
1032         self.html_print_end()
1033
1034
1035 ##############################
1036     def do_diff (self):
1037         self.init_module_dir()
1038         self.revert_module_dir()
1039         self.update_module_dir()
1040         spec_dict = self.spec_dict()
1041         self.show_dict(spec_dict)
1042
1043         # side effects
1044         tag_name = self.tag_name(spec_dict)
1045         old_svn_tag_name = self.tag_name(spec_dict, old_svn_name=True)
1046
1047         # sanity check
1048         tag_name = self.check_tag(tag_name, need_it=True, old_svn_tag_name=old_svn_tag_name)
1049
1050         if self.options.verbose:
1051             print 'Getting diff'
1052         diff_output = self.repository.diff_with_tag(tag_name)
1053
1054         if self.options.list:
1055             if diff_output:
1056                 print self.name
1057         else:
1058             thename=self.friendly_name()
1059             do_print=False
1060             if self.options.www and diff_output:
1061                 self.html_store_title("Diffs in module %s (%s) : %d chars"%(\
1062                         thename,self.last_tag(spec_dict),len(diff_output)))
1063
1064                 self.html_store_raw ('<p> &lt; (left) %s </p>' % tag_name)
1065                 self.html_store_raw ('<p> &gt; (right) %s </p>' % thename)
1066                 self.html_store_pre (diff_output)
1067             elif not self.options.www:
1068                 print 'x'*30,'module',thename
1069                 print 'x'*20,'<',tag_name
1070                 print 'x'*20,'>',thename
1071                 print diff_output
1072
1073 ##############################
1074     # store and restitute html fragments
1075     @staticmethod
1076     def html_href (url,text): return '<a href="%s">%s</a>'%(url,text)
1077
1078     @staticmethod
1079     def html_anchor (url,text): return '<a name="%s">%s</a>'%(url,text)
1080
1081     @staticmethod
1082     def html_quote (text):
1083         return text.replace('&','&#38;').replace('<','&lt;').replace('>','&gt;')
1084
1085     # only the fake error module has multiple titles
1086     def html_store_title (self, title):
1087         if not hasattr(self,'titles'): self.titles=[]
1088         self.titles.append(title)
1089
1090     def html_store_raw (self, html):
1091         if not hasattr(self,'body'): self.body=''
1092         self.body += html
1093
1094     def html_store_pre (self, text):
1095         if not hasattr(self,'body'): self.body=''
1096         self.body += '<pre>' + self.html_quote(text) + '</pre>'
1097
1098     def html_print (self, txt):
1099         if not self.options.www:
1100             print txt
1101         else:
1102             if not hasattr(self,'in_list') or not self.in_list:
1103                 self.html_store_raw('<ul>')
1104                 self.in_list=True
1105             self.html_store_raw('<li>'+txt+'</li>')
1106
1107     def html_print_end (self):
1108         if self.options.www:
1109             self.html_store_raw ('</ul>')
1110
1111     @staticmethod
1112     def html_dump_header(title):
1113         nowdate=time.strftime("%Y-%m-%d")
1114         nowtime=time.strftime("%H:%M (%Z)")
1115         print """<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1116 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
1117 <head>
1118 <title> %s </title>
1119 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1120 <style type="text/css">
1121 body { font-family:georgia, serif; }
1122 h1 {font-size: large; }
1123 p.title {font-size: x-large; }
1124 span.error {text-weight:bold; color: red; }
1125 </style>
1126 </head>
1127 <body>
1128 <p class='title'> %s - status on %s at %s</p>
1129 <ul>
1130 """%(title,title,nowdate,nowtime)
1131
1132     @staticmethod
1133     def html_dump_middle():
1134         print "</ul>"
1135
1136     @staticmethod
1137     def html_dump_footer():
1138         print "</body></html"
1139
1140     def html_dump_toc(self):
1141         if hasattr(self,'titles'):
1142             for title in self.titles:
1143                 print '<li>',self.html_href ('#'+self.friendly_name(),title),'</li>'
1144
1145     def html_dump_body(self):
1146         if hasattr(self,'titles'):
1147             for title in self.titles:
1148                 print '<hr /><h1>',self.html_anchor(self.friendly_name(),title),'</h1>'
1149         if hasattr(self,'body'):
1150             print self.body
1151             print '<p class="top">',self.html_href('#','Back to top'),'</p>'
1152
1153
1154 ##############################
1155 class Main:
1156
1157     module_usage="""Usage: %prog [options] module_desc [ .. module_desc ]
1158
1159 module-tools : a set of tools to manage subversion tags and specfile
1160   requires the specfile to either
1161   * define *version* and *taglevel*
1162   OR alternatively
1163   * define redirection variables module_version_varname / module_taglevel_varname
1164 Trunk:
1165   by default, the trunk of modules is taken into account
1166   in this case, just mention the module name as <module_desc>
1167 Branches:
1168   if you wish to work on a branch rather than on the trunk,
1169   you can use something like e.g. Mom:2.1 as <module_desc>
1170 """
1171     release_usage="""Usage: %prog [options] tag1 .. tagn
1172   Extract release notes from the changes in specfiles between several build tags, latest first
1173   Examples:
1174       release-changelog 4.2-rc25 4.2-rc24 4.2-rc23 4.2-rc22
1175   You can refer to a (build) branch by prepending a colon, like in
1176       release-changelog :4.2 4.2-rc25
1177   You can refer to the build trunk by just mentioning 'trunk', e.g.
1178       release-changelog -t coblitz-tags.mk coblitz-2.01-rc6 trunk
1179 """
1180     common_usage="""More help:
1181   see http://svn.planet-lab.org/wiki/ModuleTools"""
1182
1183     modes={
1184         'list' : "displays a list of available tags or branches",
1185         'version' : "check latest specfile and print out details",
1186         'diff' : "show difference between module (trunk or branch) and latest tag",
1187         'tag'  : """increment taglevel in specfile, insert changelog in specfile,
1188                 create new tag and and monitor its adoption in build/*-tags*.mk""",
1189         'branch' : """create a branch for this module, from the latest tag on the trunk,
1190                   and change trunk's version number to reflect the new branch name;
1191                   you can specify the new branch name by using module:branch""",
1192         'sync' : """create a tag from the module
1193                 this is a last resort option, mostly for repairs""",
1194         'changelog' : """extract changelog between build tags
1195                 expected arguments are a list of tags""",
1196         }
1197
1198     silent_modes = ['list']
1199     release_modes = ['changelog']
1200
1201     @staticmethod
1202     def optparse_list (option, opt, value, parser):
1203         try:
1204             setattr(parser.values,option.dest,getattr(parser.values,option.dest)+value.split())
1205         except:
1206             setattr(parser.values,option.dest,value.split())
1207
1208     def run(self):
1209
1210         mode=None
1211         for function in Main.modes.keys():
1212             if sys.argv[0].find(function) >= 0:
1213                 mode = function
1214                 break
1215         if not mode:
1216             print "Unsupported command",sys.argv[0]
1217             print "Supported commands:" + " ".join(Main.modes.keys())
1218             sys.exit(1)
1219
1220         if mode not in Main.release_modes:
1221             usage = Main.module_usage
1222             usage += Main.common_usage
1223             usage += "\nmodule-%s : %s"%(mode,Main.modes[mode])
1224         else:
1225             usage = Main.release_usage
1226             usage += Main.common_usage
1227
1228         parser=OptionParser(usage=usage)
1229
1230         if mode == "tag" or mode == 'branch':
1231             parser.add_option("-s","--set-version",action="store",dest="new_version",default=None,
1232                               help="set new version and reset taglevel to 0")
1233         if mode == "tag" :
1234             parser.add_option("-c","--no-changelog", action="store_false", dest="changelog", default=True,
1235                               help="do not update changelog section in specfile when tagging")
1236             parser.add_option("-b","--build-branch", action="store", dest="build_branch", default=None,
1237                               help="specify a build branch; used for locating the *tags*.mk files where adoption is to take place")
1238         if mode == "tag" or mode == "sync" :
1239             parser.add_option("-e","--editor", action="store", dest="editor", default=default_editor(),
1240                               help="specify editor")
1241
1242         if mode in ["diff","version"] :
1243             parser.add_option("-W","--www", action="store", dest="www", default=False,
1244                               help="export diff in html format, e.g. -W trunk")
1245
1246         if mode == "diff" :
1247             parser.add_option("-l","--list", action="store_true", dest="list", default=False,
1248                               help="just list modules that exhibit differences")
1249
1250         default_modules_list=os.path.dirname(sys.argv[0])+"/modules.list"
1251         parser.add_option("-a","--all",action="store_true",dest="all_modules",default=False,
1252                           help="run on all modules as found in %s"%default_modules_list)
1253         parser.add_option("-f","--file",action="store",dest="modules_list",default=None,
1254                           help="run on all modules found in specified file")
1255         parser.add_option("-n","--dry-run",action="store_true",dest="dry_run",default=False,
1256                           help="dry run - shell commands are only displayed")
1257         parser.add_option("-t","--distrotags",action="callback",callback=Main.optparse_list, dest="distrotags",
1258                           default=[], nargs=1,type="string",
1259                           help="""specify distro-tags files, e.g. onelab-tags-4.2.mk
1260 -- can be set multiple times, or use quotes""")
1261
1262         parser.add_option("-w","--workdir", action="store", dest="workdir",
1263                           default="%s/%s"%(os.getenv("HOME"),"modules"),
1264                           help="""name for dedicated working dir - defaults to ~/modules
1265 ** THIS MUST NOT ** be your usual working directory""")
1266         parser.add_option("-F","--fast-checks",action="store_true",dest="fast_checks",default=False,
1267                           help="skip safety checks, such as svn updates -- use with care")
1268
1269         # default verbosity depending on function - temp
1270         verbose_modes= ['tag', 'sync', 'branch']
1271
1272         if mode not in verbose_modes:
1273             parser.add_option("-v","--verbose", action="store_true", dest="verbose", default=False,
1274                               help="run in verbose mode")
1275         else:
1276             parser.add_option("-q","--quiet", action="store_false", dest="verbose", default=True,
1277                               help="run in quiet (non-verbose) mode")
1278         (options, args) = parser.parse_args()
1279         options.mode=mode
1280         if not hasattr(options,'dry_run'):
1281             options.dry_run=False
1282         if not hasattr(options,'www'):
1283             options.www=False
1284         options.debug=False
1285
1286         ########## module-*
1287         if len(args) == 0:
1288             if options.all_modules:
1289                 options.modules_list=default_modules_list
1290             if options.modules_list:
1291                 args=Command("grep -v '#' %s"%options.modules_list,options).output_of().split()
1292             else:
1293                 parser.print_help()
1294                 sys.exit(1)
1295         Module.init_homedir(options)
1296
1297
1298         modules=[ Module(modname,options) for modname in args ]
1299         # hack: create a dummy Module to store errors/warnings
1300         error_module = Module('__errors__',options)
1301
1302         for module in modules:
1303             if len(args)>1 and mode not in Main.silent_modes:
1304                 if not options.www:
1305                     print '========================================',module.friendly_name()
1306             # call the method called do_<mode>
1307             method=Module.__dict__["do_%s"%mode]
1308             try:
1309                 method(module)
1310             except Exception,e:
1311                 if options.www:
1312                     title='<span class="error"> Skipping module %s - failure: %s </span>'%\
1313                         (module.friendly_name(), str(e))
1314                     error_module.html_store_title(title)
1315                 else:
1316                     import traceback
1317                     traceback.print_exc()
1318                     print 'Skipping module %s: '%modname,e
1319
1320         if options.www:
1321             if mode == "diff":
1322                 modetitle="Changes to tag in %s"%options.www
1323             elif mode == "version":
1324                 modetitle="Latest tags in %s"%options.www
1325             modules.append(error_module)
1326             error_module.html_dump_header(modetitle)
1327             for module in modules:
1328                 module.html_dump_toc()
1329             Module.html_dump_middle()
1330             for module in modules:
1331                 module.html_dump_body()
1332             Module.html_dump_footer()
1333
1334 ####################
1335 if __name__ == "__main__" :
1336     try:
1337         Main().run()
1338     except KeyboardInterrupt:
1339         print '\nBye'