client.py

   1 #!/usr/bin/python
   2 # This Source Code Form is subject to the terms of the Mozilla Public
   3 # License, v. 2.0. If a copy of the MPL was not distributed with this
   4 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
   5
   6 from __future__ import absolute_import, print_function
   7
   8 LIBFFI_DIRS = (("js/ctypes/libffi", "libffi"),)
   9 HG_EXCLUSIONS = [".hg", ".hgignore", ".hgtags"]
  10
  11 CVSROOT_LIBFFI = ":pserver:anoncvs@sources.redhat.com:/cvs/libffi"
  12
  13 import os
  14 import sys
  15 import datetime
  16 import shutil
  17 import glob
  18 from optparse import OptionParser
  19 from subprocess import check_call
  20
  21 topsrcdir = os.path.dirname(__file__)
  22 if topsrcdir == "":
  23     topsrcdir = "."
  24
  25
  26 def check_call_noisy(cmd, *args, **kwargs):
  27     print("Executing command:", cmd)
  28     check_call(cmd, *args, **kwargs)
  29
  30
  31 def do_hg_pull(dir, repository, hg):
  32     fulldir = os.path.join(topsrcdir, dir)
  33     # clone if the dir doesn't exist, pull if it does
  34     if not os.path.exists(fulldir):
  35         check_call_noisy([hg, "clone", repository, fulldir])
  36     else:
  37         cmd = [hg, "pull", "-u", "-R", fulldir]
  38         if repository is not None:
  39             cmd.append(repository)
  40         check_call_noisy(cmd)
  41     check_call(
  42         [hg, "parent", "-R", fulldir, "--template=Updated to revision {node}.\n"]
  43     )
  44
  45
  46 def do_hg_replace(dir, repository, tag, exclusions, hg):
  47     """
  48     Replace the contents of dir with the contents of repository, except for
  49     files matching exclusions.
  50     """
  51     fulldir = os.path.join(topsrcdir, dir)
  52     if os.path.exists(fulldir):
  53         shutil.rmtree(fulldir)
  54
  55     assert not os.path.exists(fulldir)
  56     check_call_noisy([hg, "clone", "-u", tag, repository, fulldir])
  57
  58     for thing in exclusions:
  59         for excluded in glob.iglob(os.path.join(fulldir, thing)):
  60             if os.path.isdir(excluded):
  61                 shutil.rmtree(excluded)
  62             else:
  63                 os.remove(excluded)
  64
  65
  66 def do_cvs_export(modules, tag, cvsroot, cvs):
  67     """Check out a CVS directory without CVS metadata, using "export"
  68     modules is a list of directories to check out and the corresponding
  69     cvs module, e.g. (('js/ctypes/libffi', 'libffi'),)
  70     """
  71     for module_tuple in modules:
  72         module = module_tuple[0]
  73         cvs_module = module_tuple[1]
  74         fullpath = os.path.join(topsrcdir, module)
  75         if os.path.exists(fullpath):
  76             print("Removing '%s'" % fullpath)
  77             shutil.rmtree(fullpath)
  78
  79         (parent, leaf) = os.path.split(module)
  80         print(
  81             "CVS export begin: "
  82             + datetime.datetime.utcnow().strftime("%Y-%m-%d %H:%M:%S UTC")
  83         )
  84         check_call_noisy(
  85             [cvs, "-d", cvsroot, "export", "-r", tag, "-d", leaf, cvs_module],
  86             cwd=os.path.join(topsrcdir, parent),
  87         )
  88         print(
  89             "CVS export end: "
  90             + datetime.datetime.utcnow().strftime("%Y-%m-%d %H:%M:%S UTC")
  91         )
  92
  93
  94 def toggle_trailing_blank_line(depname):
  95     """If the trailing line is empty, then we'll delete it.
  96     Otherwise we'll add a blank line."""
  97     lines = open(depname, "r").readlines()
  98     if not lines:
  99         print("unexpected short file", file=sys.stderr)
 100         return
 101
 102     if not lines[-1].strip():
 103         # trailing line is blank, removing it
 104         open(depname, "wb").writelines(lines[:-1])
 105     else:
 106         # adding blank line
 107         open(depname, "ab").write(b"\n")
 108
 109
 110 def get_trailing_blank_line_state(depname):
 111     lines = open(depname, "r").readlines()
 112     if not lines:
 113         print("unexpected short file", file=sys.stderr)
 114         return "no blank line"
 115
 116     if not lines[-1].strip():
 117         return "has blank line"
 118     return "no blank line"
 119
 120
 121 def update_nspr_or_nss(tag, depfile, destination, hgpath):
 122     destination = destination.rstrip("/")
 123     permanent_patch_dir = destination + "/patches"
 124     temporary_patch_dir = destination + ".patches"
 125     if os.path.exists(temporary_patch_dir):
 126         print("please clean up leftover directory " + temporary_patch_dir)
 127         sys.exit(2)
 128     warn_if_patch_exists(permanent_patch_dir)
 129     # protect patch directory from being removed by do_hg_replace
 130     if os.path.exists(permanent_patch_dir):
 131         shutil.move(permanent_patch_dir, temporary_patch_dir)
 132     # now update the destination
 133     print("reverting to HG version of %s to get its blank line state" % depfile)
 134     check_call_noisy([options.hg, "revert", depfile])
 135     old_state = get_trailing_blank_line_state(depfile)
 136     print("old state of %s is: %s" % (depfile, old_state))
 137     do_hg_replace(destination, hgpath, tag, HG_EXCLUSIONS, options.hg)
 138     new_state = get_trailing_blank_line_state(depfile)
 139     print("new state of %s is: %s" % (depfile, new_state))
 140     if old_state == new_state:
 141         print("toggling blank line in: ", depfile)
 142         toggle_trailing_blank_line(depfile)
 143     tag_file = destination + "/TAG-INFO"
 144     with open(tag_file, "w") as f:
 145         f.write(tag)
 146     # move patch directory back to a subdirectory
 147     if os.path.exists(temporary_patch_dir):
 148         shutil.move(temporary_patch_dir, permanent_patch_dir)
 149
 150
 151 def warn_if_patch_exists(path):
 152     # If the given patch directory exists and contains at least one file,
 153     # then print warning and wait for the user to acknowledge.
 154     if os.path.isdir(path) and os.listdir(path):
 155         print("========================================")
 156         print("WARNING: At least one patch file exists")
 157         print("in directory: " + path)
 158         print("You must manually re-apply all patches")
 159         print("after this script has completed!")
 160         print("========================================")
 161         input("Press Enter to continue...")
 162         return
 163
 164
 165 o = OptionParser(
 166     usage="client.py [options] update_nspr tagname | update_nss tagname | update_libffi tagname"
 167 )
 168 o.add_option(
 169     "--skip-mozilla",
 170     dest="skip_mozilla",
 171     action="store_true",
 172     default=False,
 173     help="Obsolete",
 174 )
 175
 176 o.add_option(
 177     "--cvs",
 178     dest="cvs",
 179     default=os.environ.get("CVS", "cvs"),
 180     help="The location of the cvs binary",
 181 )
 182 o.add_option(
 183     "--cvsroot",
 184     dest="cvsroot",
 185     help="The CVSROOT for libffi (default : %s)" % CVSROOT_LIBFFI,
 186 )
 187 o.add_option(
 188     "--hg",
 189     dest="hg",
 190     default=os.environ.get("HG", "hg"),
 191     help="The location of the hg binary",
 192 )
 193 o.add_option(
 194     "--repo", dest="repo", help="the repo to update from (default: upstream repo)"
 195 )
 196
 197 try:
 198     options, args = o.parse_args()
 199     action = args[0]
 200 except IndexError:
 201     o.print_help()
 202     sys.exit(2)
 203
 204 if action in ("checkout", "co"):
 205     print("Warning: client.py checkout is obsolete.", file=sys.stderr)
 206     pass
 207 elif action in ("update_nspr"):
 208     (tag,) = args[1:]
 209     depfile = "nsprpub/config/prdepend.h"
 210     if not options.repo:
 211         options.repo = "https://hg.mozilla.org/projects/nspr"
 212     update_nspr_or_nss(tag, depfile, "nsprpub", options.repo)
 213 elif action in ("update_nss"):
 214     (tag,) = args[1:]
 215     depfile = "security/nss/coreconf/coreconf.dep"
 216     if not options.repo:
 217         options.repo = "https://hg.mozilla.org/projects/nss"
 218     update_nspr_or_nss(tag, depfile, "security/nss", options.repo)
 219 elif action in ("update_libffi"):
 220     (tag,) = args[1:]
 221     if not options.cvsroot:
 222         options.cvsroot = CVSROOT_LIBFFI
 223     do_cvs_export(LIBFFI_DIRS, tag, options.cvsroot, options.cvs)
 224 else:
 225     o.print_help()
 226     sys.exit(2)