more tweaks in module-tools.py for tagging plcapi + plewww
authorThierry Parmentelat <thierry.parmentelat@inria.fr>
Sat, 30 Apr 2022 17:41:25 +0000 (19:41 +0200)
committerThierry Parmentelat <thierry.parmentelat@inria.fr>
Sat, 30 Apr 2022 17:41:25 +0000 (19:41 +0200)
1  2 
module-tools.py

diff --combined module-tools.py
@@@ -7,7 -7,7 +7,7 @@@ import tempfil
  from glob import glob
  from optparse import OptionParser
  
 -# e.g. other_choices = [ ('d','iff') , ('g','uess') ] - lowercase 
 +# e.g. other_choices = [ ('d','iff') , ('g','uess') ] - lowercase
  def prompt(question, default=True, other_choices=[], allow_outside=False):
      if not isinstance(other_choices, list):
          other_choices = [ other_choices ]
@@@ -109,7 -109,7 +109,7 @@@ class Command
              raise Exception("Command {} failed".format(self.command))
  
      # returns stdout, like bash's $(mycommand)
--    def output_of(self, with_stderr=False):
++    def output_of(self, with_stderr=False, binary=False):
          if self.options.dry_run:
              print('dry_run', self.command)
              return 'dry_run output'
              command += " > "
          command += tmp
          os.system(command)
--        with open(tmp) as f:
++        mode = "r" if not binary else "rb"
++        with open(tmp, mode) as f:
              result=f.read()
          os.unlink(tmp)
          if self.options.debug:
              print('Done', end=' ')
          return result
 -    
 +
  class GitRepository:
      type = "git"
  
              self.__run_command_in_repo("git checkout {}".format(branch))
          else:
              self.to_branch(branch, remote=True)
 -        self.__run_command_in_repo("git fetch origin --tags")
 +        self.__run_command_in_repo("git fetch origin --tags", ignore_errors=True)
          self.__run_command_in_repo("git fetch origin")
          if not self.__is_commit_id(branch):
              # we don't need to merge anything for commit ids.
  
      def diff(self, f=""):
          c = Command("git diff {}".format(f), self.options)
--        return self.__run_in_repo(c.output_of, with_stderr=True)
++        try:
++            return self.__run_in_repo(c.output_of, with_stderr=True)
++        except:
++            return self.__run_in_repo(c.output_of, with_stderr=True, binary=True)
  
      def diff_with_tag(self, tagname):
          c = Command("git diff {}".format(tagname), self.options)
--        return self.__run_in_repo(c.output_of, with_stderr=True)
++        try:
++            return self.__run_in_repo(c.output_of, with_stderr=True)
++        except:
++            return self.__run_in_repo(c.output_of, with_stderr=True, binary=True)
  
      def commit(self, logfile, branch="master"):
          self.__run_command_in_repo("git add .", ignore_errors=True)
              self.__run_command_in_repo("git push")
          else:
              self.__run_command_in_repo("git push origin {}:{}".format(branch, branch))
--        self.__run_command_in_repo("git push --tags")
++        self.__run_command_in_repo("git push --tags", ignore_errors=True)
  
      def revert(self, f=""):
          if f:
  
      def is_valid(self):
          return os.path.exists(os.path.join(self.path, ".git"))
 -    
 +
  
  class Repository:
 -    """ 
 -    Generic repository 
 +    """
 +    Generic repository
      From old times when we had svn and git
      """
      supported_repo_types = [ GitRepository ]
@@@ -290,7 -290,7 +297,7 @@@ class Module
  
      edit_magic_line = "--This line, and those below, will be ignored--"
      setting_tag_format = "Setting tag {}"
 -    
 +
      redirectors = [
          # ('module_name_varname', 'name'),
          ('module_version_varname', 'version'),
  
      # where to store user's config
      config_storage = "CONFIG"
 -    # 
 +    #
      config = {}
  
      import subprocess
                  cls.prompt_config_option(key, message, default)
  
      # for parsing module spec name:branch
 -    matcher_branch_spec = re.compile("\A(?P<name>[\w\.\-\/]+):(?P<branch>[\w\.\-]+)\Z")                                                                                                                         
 +    matcher_branch_spec = re.compile("\A(?P<name>[\w\.\-\/]+):(?P<branch>[\w\.\-]+)\Z")
      # special form for tagged module - for Build
      matcher_tag_spec = re.compile("\A(?P<name>[\w\.\-\/]+)@(?P<tagname>[\w\.\-]+)\Z")
  
          if os.path.isdir(options.workdir) and not os.path.isfile(storage):
              print("""The directory {} exists and has no CONFIG file
  If this is your regular working directory, please provide another one as the
 -module-* commands need a fresh working dir. Make sure that you do not use 
 +module-* commands need a fresh working dir. Make sure that you do not use
  that for other purposes than tagging""".format(options.workdir))
              sys.exit(1)
  
              with open(storage) as f:
                  for line in f.readlines():
                      key, value = re.compile("^(.+)=(.+)$").match(line).groups()
 -                    Module.config[key] = value                
 +                    Module.config[key] = value
  
              # owerride config variables using options.
              if options.build_module:
                      print("Configuration changed for module-tools")
                      cls.prompt_config_option(key, message, default)
                      old_layout = True
 -                    
 +
              if old_layout:
                  Command("rm -rf {}".format(options.workdir), options).run_silent()
                  Command("mkdir -p {}".format(options.workdir), options).run_silent()
                  self.repository.to_tag(self.tagname)
          else:
              raise Exception('Cannot find {} - or not a git module'.format(self.module_dir))
 -                
 +
  
      def revert_module_dir(self):
          if self.options.fast_checks:
              return
          if self.options.verbose:
              print('Checking whether', self.module_dir, 'needs being reverted')
 -        
 +
          if not self.repository.is_clean():
              self.repository.revert()
  
              for k, v in result.items():
                  print('{} = {}'.format(k, v))
          return result
 -                
 +
      # stores in self.module_name_varname the rpm variable to be used for the module's name
      # and the list of these names in self.varnames
      def spec_dict(self):
                  varnames += [redirect_dict[varname]]
              else:
                  setattr(self, varname, default)
 -                varnames += [ default ] 
 +                varnames += [ default ]
          self.varnames = varnames
          result = self.parse_spec(specfile, self.varnames)
          if self.options.debug:
                                  new.write("- " + logline)
                              new.write("\n")
              os.rename(newspecfile,specfile)
 -            
 +
      def show_dict(self, spec_dict):
          if self.options.verbose:
              for k, v in spec_dict.items():
  
      def tag_name(self, spec_dict):
          return "{}-{}".format(self.name, self.last_tag(spec_dict))
 -    
 +
  
      pattern_format="\A\s*{module}-(GITPATH)\s*(=|:=)\s*(?P<url_main>[^\s]+)/{module}[^\s]+"
  
                                        .format(self.name))
                                  return
                              if self.options.verbose:
 -                                print(' ' + modulepath, end=' ') 
 +                                print(' ' + modulepath, end=' ')
                              new.write(replacement)
                              matches += 1
                          else:
                              new.write(line)
 -                            
 +
          os.rename(newtagsfile,tagsfile)
          if self.options.verbose:
              print("{} changes".format(matches))
          # parse specfile
          spec_dict = self.spec_dict()
          self.show_dict(spec_dict)
 -        
 +
          # compute previous tag - if not bypassed
          if not self.options.bypass:
              old_tag_name = self.tag_name(spec_dict)
          # side effect in head's specfile
          self.patch_spec_var(spec_dict)
  
 -        # prepare changelog file 
 +        # prepare changelog file
          # we use the standard subversion magic string (see edit_magic_line)
          # so we can provide useful information, such as version numbers and diff
          # in the same file
  Please write a changelog for this new tag in the section above
  """.format(Module.edit_magic_line, setting_tag_line))
  
 -        if self.options.bypass: 
 +        if self.options.bypass:
              pass
          elif prompt('Want to see diffs while writing changelog', True):
              with open(changelog_plain, "a") as f:
                  f.write('DIFF=========\n' + diff_output)
 -        
 +
          if self.options.debug:
              prompt('Proceed ?')
  
 -        # edit it        
 +        # edit it
          self.run("{} {}".format(self.options.editor, changelog_plain))
          # strip magic line in second file
          self.strip_magic_line_filename(changelog_plain, changelog_strip, new_tag_name)
                  while tagsdict[tagsfile] == 'todo' :
                      choice = prompt("insert {} in {}    ".format(new_tag_name, basename),
                                       default_answer,
 -                                     [ ('y','es'), ('n', 'ext'), ('f','orce'), 
 +                                     [ ('y','es'), ('n', 'ext'), ('f','orce'),
                                         ('d','iff'), ('r','evert'), ('c', 'at'), ('h','elp') ] ,
                                       allow_outside=True)
                      if choice == 'y':
@@@ -969,11 -969,11 +976,11 @@@ n: move to next file""".format(**locals
  
  ##############################
      # store and restitute html fragments
 -    @staticmethod 
 +    @staticmethod
      def html_href(url,text):
          return '<a href="{}">{}</a>'.format(url, text)
  
 -    @staticmethod 
 +    @staticmethod
      def html_anchor(url,text):
          return '<a name="{}">{}</a>'.format(url,text)
  
@@@ -1050,12 -1050,12 +1057,12 @@@ span.error {{text-weight:bold; color: r
                  print('<hr /><h1>', self.html_anchor(self.friendly_name(),title), '</h1>')
          if hasattr(self,'body'):
              print(self.body)
 -            print('<p class="top">', self.html_href('#','Back to top'), '</p>')            
 +            print('<p class="top">', self.html_href('#','Back to top'), '</p>')
  
  
  
  class Build(Module):
 -    
 +
      def __get_modules(self, tagfile):
          self.init_module_dir()
          modules = {}
                      module_type = "tag"
                  elif url.find('/branches/') >= 0:
                      module_type = "branch"
 -            
 +
              modules[module] = {"module_type" : module_type,
                                 "path_type": path_type,
                                 "tag_or_branch": tag_or_branch,
                                 "url":url}
          return modules
 -                
 -        
 +
 +
  
  def modules_diff(first, second):
      diff = {}
  
      for module in first:
 -        if module not in second: 
 +        if module not in second:
              print("=== module {} missing in right-hand side ===".format(module))
              continue
          if first[module]['tag_or_branch'] != second[module]['tag_or_branch']:
@@@ -1172,7 -1172,7 +1179,7 @@@ def release_changelog(options, buildtag
          specfile = m.main_specname()
          (tmpfd, tmpfile) = tempfile.mkstemp()
          os.system("cp -f /{} {}".format(specfile, tmpfile))
 -        
 +
          m = get_module(module, second)
          # patch for ipfw that, being managed in a separate repo, won't work for now
          try:
@@@ -1204,7 -1204,7 +1211,7 @@@ def adopt_tag(options, args)
      modules=[]
      for module in options.modules:
          modules += module.split()
 -    for module in modules: 
 +    for module in modules:
          modobj=Module(module,options)
          for tags_file in args:
              if options.verbose:
@@@ -1221,13 -1221,13 +1228,13 @@@ class Main
  module-tools : a set of tools to manage subversion tags and specfile
    requires the specfile to either
    * define *version* and *taglevel*
 -  OR alternatively 
 +  OR alternatively
    * define redirection variables module_version_varname / module_taglevel_varname
  Master:
    by default, the 'master' branch of modules is the target
    in this case, just mention the module name as <module_desc>
  Branches:
 -  if you wish to work on another branch, 
 +  if you wish to work on another branch,
    you can use something like e.g. Mom:2.1 as <module_desc>
  """
      release_usage="""Usage: %prog [options] tag1 .. tagn
      common_usage="""More help:
    see http://svn.planet-lab.org/wiki/ModuleTools"""
  
 -    modes = { 
 +    modes = {
          'list' : "displays a list of available tags or branches",
          'version' : "check latest specfile and print out details",
          'diff' : "show difference between module (trunk or branch) and latest tag",
          'tag'  : """increment taglevel in specfile, insert changelog in specfile,
                  create new tag and and monitor its adoption in build/*-tags.mk""",
 -        'branch' : """create a branch for this module, from the latest tag on the trunk, 
 +        'branch' : """create a branch for this module, from the latest tag on the trunk,
                    and change trunk's version number to reflect the new branch name;
                    you can specify the new branch name by using module:branch""",
          'sync' : """create a tag from the module
              usage += Main.common_usage
  
          parser=OptionParser(usage=usage)
 -        
 +
          # the 'adopt' mode is really special and doesn't share any option
          if mode == 'adopt':
              parser.add_option("-m","--module",action="append",dest="modules",default=[],
                                help="modules, can be used several times or with quotes")
              parser.add_option("-t","--tag",action="store", dest="tag", default='master',
                                help="specify the tag to adopt, default is 'master'")
 -            parser.add_option("-v","--verbose", action="store_true", dest="verbose", default=False, 
 +            parser.add_option("-v","--verbose", action="store_true", dest="verbose", default=False,
                                help="run in verbose mode")
              (options, args) = parser.parse_args()
              options.workdir='unused'
                  parser.print_help()
                  sys.exit(1)
              adopt_tag(options,args)
 -            return 
 +            return
  
          # the other commands (module-* and release-changelog) share the same skeleton
          if mode in [ 'tag', 'branch'] :
          if mode == 'diff' :
              parser.add_option("-l","--list", action="store_true", dest="list", default=False,
                                help="just list modules that exhibit differences")
 -            
 +
          default_modules_list=os.path.dirname(sys.argv[0])+"/modules.list"
          parser.add_option("-a","--all",action="store_true",dest="all_modules",default=False,
                            help="run on all modules as found in {}".format(default_modules_list))
                            help="""specify distro-tags files, e.g. onelab-tags-4.2.mk
  -- can be set multiple times, or use quotes""")
  
 -        parser.add_option("-w","--workdir", action="store", dest="workdir", 
 +        parser.add_option("-w","--workdir", action="store", dest="workdir",
                            default="{}/{}".format(os.getenv("HOME"),"modules"),
                            help="""name for dedicated working dir - defaults to ~/modules
  ** THIS MUST NOT ** be your usual working directory""")
  
          # default verbosity depending on function - temp
          verbose_modes= ['tag', 'sync', 'branch']
 -        
 +
          if mode not in verbose_modes:
 -            parser.add_option("-v","--verbose", action="store_true", dest="verbose", default=False, 
 +            parser.add_option("-v","--verbose", action="store_true", dest="verbose", default=False,
                                help="run in verbose mode")
          else:
              parser.add_option("-q","--quiet", action="store_false", dest="verbose", default=True,
              options.www=False
          options.debug=False
  
 -        
 +
  
          ########## module-*
          if len(args) == 0:
                  parser.print_help()
                  sys.exit(1)
          Module.init_homedir(options)
 -        
 +
  
          if mode in Main.regular_modes:
              modules = [ Module(modname, options) for modname in args ]
                          import traceback
                          traceback.print_exc()
                          print('Skipping module {}: {}'.format(module.name,e))
 -    
 +
              if options.www:
                  if mode == "diff":
                      modetitle="Changes to tag in {}".format(options.www)
              # we typically have here latest latest-1 latest-2
              for (tag_new,tag_old) in zip ( args[:-1], args [1:]):
                  release_changelog(options, tag_old, tag_new)
 -            
 -    
 +
 +
  ####################
  if __name__ == "__main__" :
      try: