Move ExecutionQueue and WorkItem to gclient_utils.py

gclient.py

 #!/usr/bin/python
 # Copyright (c) 2010 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Meta checkout manager supporting both Subversion and GIT.
 
 Files
   .gclient      : Current client configuration, written by 'config' command.
                   Format is a Python script defining 'solutions', a list whose
@@ skipping 41 matching lines @@
 __version__ = "0.5.2"
 
 import logging
 import optparse
 import os
 import posixpath
 import pprint
 import re
 import subprocess
 import sys
-import threading
 import urlparse
 import urllib
 
 import breakpad
 
 import gclient_scm
 import gclient_utils
 from third_party.repo.progress import Progress
 
 
 def attr(attr, data):
   """Sets an attribute on a function."""
   def hook(fn):
     setattr(fn, attr, data)
     return fn
   return hook
 
 
 ## GClient implementation.
 
-class WorkItem(object):
-  """One work item."""
-  requirements = []
-  name = None
-
-  def run(self):
-    pass
-
-
-class ExecutionQueue(object):
-  """Dependencies sometime needs to be run out of order due to From() keyword.
-
-  This class manages that all the required dependencies are run before running
-  each one.
-
-  Methods of this class are multithread safe.
-  """
-  def __init__(self, progress):
-    self.lock = threading.Lock()
-    # List of Dependency.
-    self.queued = []
-    # List of strings representing each Dependency.name that was run.
-    self.ran = []
-    # List of items currently running.
-    self.running = []
-    self.progress = progress
-    if self.progress:
-      self.progress.update()
-
-  def enqueue(self, d):
-    """Enqueue one Dependency to be executed later once its requirements are
-    satisfied.
-    """
-    assert isinstance(d, WorkItem)
-    try:
-      self.lock.acquire()
-      self.queued.append(d)
-      total = len(self.queued) + len(self.ran) + len(self.running)
-    finally:
-      self.lock.release()
-    if self.progress:
-      self.progress._total = total + 1
-      self.progress.update(0)
-
-  def flush(self, *args, **kwargs):
-    """Runs all enqueued items until all are executed."""
-    while self._run_one_item(*args, **kwargs):
-      pass
-    queued = []
-    running = []
-    try:
-      self.lock.acquire()
-      if self.queued:
-        queued = self.queued
-        self.queued = []
-      if self.running:
-        running = self.running
-        self.running = []
-    finally:
-      self.lock.release()
-    if self.progress:
-      self.progress.end()
-    if queued:
-      raise gclient_utils.Error('Entries still queued: %s' % str(queued))
-    if running:
-      raise gclient_utils.Error('Entries still queued: %s' % str(running))
-
-  def _run_one_item(self, *args, **kwargs):
-    """Removes one item from the queue that has all its requirements completed
-    and execute it.
-
-    Returns False if no item could be run.
-    """
-    i = 0
-    d = None
-    try:
-      self.lock.acquire()
-      while i != len(self.queued) and not d:
-        d = self.queued.pop(i)
-        for r in d.requirements:
-          if not r in self.ran:
-            self.queued.insert(i, d)
-            d = None
-            break
-        i += 1
-      if not d:
-        return False
-      self.running.append(d)
-    finally:
-      self.lock.release()
-    d.run(*args, **kwargs)
-    try:
-      self.lock.acquire()
-      # TODO(maruel): http://crbug.com/51711
-      #assert not d.name in self.ran
-      if not d.name in self.ran:
-        self.ran.append(d.name)
-      self.running.remove(d)
-      if self.progress:
-        self.progress.update(1)
-    finally:
-      self.lock.release()
-    return True
-
 
 class GClientKeywords(object):
   class FromImpl(object):
     """Used to implement the From() syntax."""
 
     def __init__(self, module_name, sub_target_name=None):
       """module_name is the dep module we want to include from.  It can also be
       the name of a subdirectory to include from.
 
       sub_target_name is an optional parameter if the module name in the other
@@ skipping 35 matching lines @@
 
     def Lookup(self, var_name):
       """Implements the Var syntax."""
       if var_name in self._custom_vars:
         return self._custom_vars[var_name]
       elif var_name in self._local_scope.get("vars", {}):
         return self._local_scope["vars"][var_name]
       raise gclient_utils.Error("Var is not defined: %s" % var_name)
 
 
-class Dependency(GClientKeywords, WorkItem):
+class Dependency(GClientKeywords, gclient_utils.WorkItem):
   """Object that represents a dependency checkout."""
   DEPS_FILE = 'DEPS'
 
   def __init__(self, parent, name, url, safesync_url, custom_deps,
                custom_vars, deps_file, should_process):
     GClientKeywords.__init__(self)
     self.parent = parent
     self.name = name
     self.url = url
     self.parsed_url = None
@@ skipping 555 matching lines @@
     Args:
       command: The command to use (e.g., 'status' or 'diff')
       args: list of str - extra arguments to add to the command line.
     """
     if not self.dependencies:
       raise gclient_utils.Error('No solution specified')
     revision_overrides = self._EnforceRevisions()
     pm = None
     if command == 'update' and not self._options.verbose:
       pm = Progress('Syncing projects', 1)
-    work_queue = ExecutionQueue(pm)
+    work_queue = gclient_utils.ExecutionQueue(pm)
     for s in self.dependencies:
       work_queue.enqueue(s)
     work_queue.flush(self._options, revision_overrides, command, args,
         work_queue)
 
     # Once all the dependencies have been processed, it's now safe to run the
     # hooks.
     if not self._options.nohooks:
       self.RunHooksRecursively(self._options)
 
@@ skipping 24 matching lines @@
                 entry_fixed, self.root_dir()))
             gclient_utils.RemoveDirectory(e_dir)
       # record the current list of entries for next time
       self._SaveEntries()
     return 0
 
   def PrintRevInfo(self):
     if not self.dependencies:
       raise gclient_utils.Error('No solution specified')
     # Load all the settings.
-    work_queue = ExecutionQueue(None)
+    work_queue = gclient_utils.ExecutionQueue(None)
     for s in self.dependencies:
       work_queue.enqueue(s)
     work_queue.flush(self._options, {}, None, [], work_queue)
 
     def GetURLAndRev(dep):
       """Returns the revision-qualified SCM url for a Dependency."""
       if dep.parsed_url is None:
         return None
       if isinstance(dep.parsed_url, self.FileImpl):
         original_url = dep.parsed_url.file_location
@@ skipping 447 matching lines @@
     return CMDhelp(parser, argv)
   except gclient_utils.Error, e:
     print >> sys.stderr, 'Error: %s' % str(e)
     return 1
 
 
 if '__main__' == __name__:
   sys.exit(Main(sys.argv[1:]))
 
 # vim: ts=2:sw=2:tw=80:et: