1377 - Blacklist dependencies from SCM tracking

ensure_dependencies.py

 #!/usr/bin/env python
 # coding: utf-8
 
 # This file is part of the Adblock Plus build tools,
 # Copyright (C) 2006-2014 Eyeo GmbH
 #
 # Adblock Plus is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3 as
 # published by the Free Software Foundation.
 #
@@ skipping 26 matching lines @@
   # File to update this script from (optional)
   _self = buildtools/ensure_dependencies.py
   # Check out elemhidehelper repository into extensions/elemhidehelper directory
   # at tag "1.2".
   extensions/elemhidehelper = elemhidehelper 1.2
   # Check out buildtools repository into buildtools directory at VCS-specific
   # revision IDs.
   buildtools = buildtools hg:016d16f7137b git:f3f8692f82e5
 """
 
-class SCM(object):
-  def _ensure_line_exists(self, ignore_file, pattern):

[Wladimir Palant, 2014/10/08 21:40:30]

The parameter should be called path, not ignore_file - this is a generic helper
function, without any real relation to ignore files.

-    with open(ignore_file, 'a+') as f:
-      file_content = [l.strip() for l in f.readlines()]
-      if not pattern in file_content:
-        file_content.append(pattern)
-        f.seek(0, os.SEEK_SET)
-        for l in file_content:
-          print >>f, l
-        f.truncate()
-
-class Mercurial(SCM):
+class Mercurial():
   def istype(self, repodir):
     return os.path.exists(os.path.join(repodir, ".hg"))
 
   def clone(self, source, target):
     if not source.endswith("/"):
       source += "/"
     subprocess.check_call(["hg", "clone", "--quiet", "--noupdate", source, target])
 
   def get_revision_id(self, repo, rev=None):
     command = ["hg", "id", "--repository", repo, "--id"]
@@ skipping 22 matching lines @@
       config.read(config_path)
 
       if not config.has_section("ui"):
         config.add_section("ui")
 
       config.set("ui", "ignore.dependencies", ignore_path)
       with open(config_path, "w") as stream:
         config.write(stream)
 
       module = os.path.relpath(target, repo)
-      self._ensure_line_exists(ignore_path, module)
-
-class Git(SCM):
+      _ensure_line_exists(ignore_path, module)
+
+class Git():
   def istype(self, repodir):
     return os.path.exists(os.path.join(repodir, ".git"))
 
   def clone(self, source, target):
     source = source.rstrip("/")
     if not source.endswith(".git"):
       source += ".git"
     subprocess.check_call(["git", "clone", "--quiet", source, target])
 
   def get_revision_id(self, repo, rev="HEAD"):
     command = ["git", "rev-parse", "--revs-only", rev]
     return subprocess.check_output(command, cwd=repo).strip()
 
   def pull(self, repo):
     subprocess.check_call(["git", "fetch", "--quiet", "--all", "--tags"], cwd=repo)
 
   def update(self, repo, rev):
     subprocess.check_call(["git", "checkout", "--quiet", rev], cwd=repo)
 
   def ignore(self, target, repo):
     module = os.path.relpath(target, repo)
     exclude_file = os.path.join(repo, ".git", "info", "exclude")
-    self._ensure_line_exists(exclude_file, module)
+    _ensure_line_exists(exclude_file, module)
 
 repo_types = OrderedDict((
   ("hg", Mercurial()),
   ("git", Git()),
 ))
 
 def parse_spec(path, line):
   if "=" not in line:
     logging.warning("Invalid line in file %s: %s" % (path, line))
     return None, None
@@ skipping 68 matching lines @@
   for key in roots:
     if key == parenttype or (key in repo_types and type is None):
       type = key
   if type is None:
     raise Exception("No valid source found to create %s" % target)
 
   url = urlparse.urljoin(roots[type], sourcename)
   logging.info("Cloning repository %s into %s" % (url, target))
   repo_types[type].clone(url, target)
 
+  for repo in repo_types.itervalues():
+    if repo.istype(parentrepo):
+      repo.ignore(target, parentrepo)
+
 def update_repo(target, revisions):
   type = get_repo_type(target)
   if type is None:
     logging.warning("Type of repository %s unknown, skipping update" % target)
     return
 
   if type in revisions:
     revision = revisions[type]
   elif "*" in revisions:
     revision = revisions["*"]
@@ skipping 24 matching lines @@
     logging.warning("Too much subrepository nesting, ignoring %s" % repo)
 
   if overrideroots is not None:
     config["_root"] = overrideroots
 
   for dir, revisions in config.iteritems():
     if dir.startswith("_") or revisions["_source"] in skipdependencies:
       continue
     target = safe_join(repodir, dir)
     ensure_repo(repodir, target, config.get("_root", {}), revisions["_source"])
-    for repo in repo_types.itervalues():
-      if repo.istype(repodir):
-        repo.ignore(target, repodir)

[Wladimir Palant, 2014/10/08 21:40:30]

Why was this code moved again? As noted before, it should only run when we
create the repository.

     update_repo(target, revisions)
     resolve_deps(target, level + 1, self_update=False, overrideroots=overrideroots, skipdependencies=skipdependencies)
 
   if self_update and "_self" in config and "*" in config["_self"]:
     source = safe_join(repodir, config["_self"]["*"])
     try:
       with io.open(source, "rb") as handle:
         sourcedata = handle.read()
     except IOError, e:
       if e.errno != errno.ENOENT:
         raise
       logging.warning("File %s doesn't exist, skipping self-update" % source)
       return
 
     target = __file__
     with io.open(target, "rb") as handle:
       targetdata = handle.read()
 
     if sourcedata != targetdata:
       logging.info("Updating %s from %s, don't forget to commit" % (source, target))
       with io.open(target, "wb") as handle:
         handle.write(sourcedata)
       if __name__ == "__main__":
         logging.info("Restarting %s" % target)
         os.execv(sys.executable, [sys.executable, target] + sys.argv[1:])
       else:
         logging.warning("Cannot restart %s automatically, please rerun" % target)
 
+def _ensure_line_exists(path, pattern):
+  with open(path, 'a+') as f:
+    file_content = [l.strip() for l in f.readlines()]
+    if not pattern in file_content:
+      file_content.append(pattern)
+      f.seek(0, os.SEEK_SET)
+      f.truncate()
+      for l in file_content:
+        print >>f, l
+
 if __name__ == "__main__":
   logging.basicConfig(format='%(levelname)s: %(message)s', level=logging.INFO)
   repos = sys.argv[1:]
   if not len(repos):
     repos = [os.getcwd()]
   for repo in repos:
     resolve_deps(repo)