Docserver: Make MockFileSystem not iterate over the entire file system as part

chrome/common/extensions/docs/server2/test_file_system.py

 # Copyright 2013 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.
 
 from file_system import FileSystem, FileNotFoundError, StatInfo
 from future import Future
 
 
 def MoveTo(base, obj):
   '''Returns an object as |obj| moved to |base|. That is,
@@ skipping 10 matching lines @@
 
 def MoveAllTo(base, obj):
   '''Moves every value in |obj| to |base|. See MoveTo.
   '''
   result = {}
   for key, value in obj.iteritems():
     result[key] = MoveTo(base, value)
   return result
 
 
+def _List(file_system):
+  '''Returns a list of '/' separated paths derived from |file_system|.
+  For example, {'index.html': '', 'www': {'file.txt': ''}} would return
+  ['index.html', 'www/file.txt'].
+  '''
+  assert isinstance(file_system, dict)
+  result = {}
+  def update_result(item, path):
+    if isinstance(item, dict):
+      if path != '':
+        path += '/'
+      file_listing = [p if isinstance(content, basestring) else (p + '/')
+                      for p, content in item.iteritems()]
+      # Support non-canonical paths until the server has purged all

[Yoyo Zhou, 2014/02/05 00:32:33]

Sounds like there's a TODO in here.

[not at google - send to devlin, 2014/02/05 03:55:53]

Done.

+      # non-canonical paths.
+      result[path], result['/' + path] = file_listing, file_listing
+      for subpath, subitem in item.iteritems():
+        update_result(subitem, path + subpath)
+    elif isinstance(item, basestring):
+      result[path] = item
+      # See above comment.
+      result['/' + path] = result[path]

[Yoyo Zhou, 2014/02/05 00:32:33]

nit: this is written differently from the above

[not at google - send to devlin, 2014/02/05 03:55:53]

Done.

+    else:
+      raise ValueError('Unsupported item type: %s' % type(item))
+  update_result(file_system, '')
+  return result
+
+
+class _StatTracker(object):
+  '''Maintains the versions of paths in a file system. The versions of files
+  are changed either by |Increment| or |SetVersion|. The versions of
+  directories are derived from the versions of files within it.
+  '''
+
+  def __init__(self):
+    self._path_stats = {}
+    self._global_stat = 0
+
+  def Increment(self, path=None, by=1):
+    if path is None:
+      self._global_stat += by
+    else:
+      self.SetVersion(path, self._path_stats.get(path, 0) + by)
+
+  def SetVersion(self, path, new_version):
+    if path == '' or path.endswith('/'):

[Yoyo Zhou, 2014/02/05 00:32:33]

path_util.IsDirectory

[not at google - send to devlin, 2014/02/05 03:55:53]

Ah! Yeah so I did this and in fact it mooted the TODOs above since it required
me to actually enforce that path restriction after all. So I could delete a few
of the tests.

+      raise ValueError('Only files have an incrementable stat, '
+                       'but "%s" is a directory' % path)
+
+    # Update version of that file.
+    self._path_stats[path] = new_version
+
+    # Update all parent directory versions as well.
+    slash_index = 0  # (deliberately including '' in the dir paths)
+    while slash_index != -1:
+      dir_path = path[:slash_index] + '/'
+      self._path_stats[dir_path] = max(self._path_stats.get(dir_path, 0),
+                                       new_version)
+      if dir_path == '/':
+        # Legacy support for '/' being the root of the file system rather
+        # than ''. Eventually when the path normalisation logic is complete
+        # this will be impossible and this logic will change slightly.
+        self._path_stats[''] = self._path_stats['/']
+      slash_index = path.find('/', slash_index + 1)
+
+  def GetVersion(self, path):
+    return self._global_stat + self._path_stats.get(path, 0)
+
+
 class TestFileSystem(FileSystem):
   '''A FileSystem backed by an object. Create with an object representing file
   paths such that {'a': {'b': 'hello'}} will resolve Read('a/b') as 'hello',
   Read('a/') as ['b'], and Stat determined by a value incremented via
   IncrementStat.
   '''
 
   def __init__(self, obj, relative_to=None, identity=None):
     assert obj is not None
-    self._obj = obj if relative_to is None else MoveTo(relative_to, obj)
+    if relative_to is not None:
+      obj = MoveTo(relative_to, obj)
     self._identity = identity or type(self).__name__
-    self._path_stats = {}
-    self._global_stat = 0
+    self._path_values = _List(obj)
+    self._stat_tracker = _StatTracker()
 
   #
   # FileSystem implementation.
   #
 
   def Read(self, paths):
-    test_fs = self
-    class Delegate(object):
-      def Get(self):
-        return dict((path, test_fs._ResolvePath(path)) for path in paths)
-    return Future(delegate=Delegate())
+    for path in paths:
+      if path not in self._path_values:
+        return FileNotFoundError.RaiseInFuture(path)
+    return Future(value=dict((k, v) for k, v in self._path_values.iteritems()
+                             if k in paths))
 
   def Refresh(self):
     return Future(value=())
 
-  def _ResolvePath(self, path):
-    def Resolve(parts):
-      '''Resolves |parts| of a path info |self._obj|.
-      '''
-      result = self._obj.get(parts[0])
-      for part in parts[1:]:
-        if not isinstance(result, dict):
-          raise FileNotFoundError(
-              '%s at %s did not resolve to a dict, instead %s' %
-              (path, part, result))
-        result = result.get(part)
-      return result
-
-    def GetPaths(obj):
-      '''Lists the paths within |obj|; this is basially keys() but with
-      directory paths (i.e. dicts) with a trailing /.
-      '''
-      def ToPath(k, v):
-        if isinstance(v, basestring):
-          return k
-        if isinstance(v, dict):
-          return '%s/' % k
-        raise ValueError('Cannot convert type %s to path', type(v))
-      return [ToPath(k, v) for k, v in obj.items()]
-
-    path = path.lstrip('/')
-
-    if path == '':
-      return GetPaths(self._obj)
-
-    parts = path.split('/')
-    if parts[-1] != '':
-      file_contents = Resolve(parts)
-      if not isinstance(file_contents, basestring):
-        raise FileNotFoundError(
-            '%s (%s) did not resolve to a string, instead %s' %
-            (path, parts, file_contents))
-      return file_contents
-
-    dir_contents = Resolve(parts[:-1])
-    if not isinstance(dir_contents, dict):
-      raise FileNotFoundError(
-          '%s (%s) did not resolve to a dict, instead %s' %
-          (path, parts, dir_contents))
-
-    return GetPaths(dir_contents)
-
   def Stat(self, path):
-    read_result = self.Read([path]).Get().get(path)
-    stat_result = StatInfo(self._SinglePathStat(path))
+    read_result = self.ReadSingle(path).Get()
+    stat_result = StatInfo(str(self._stat_tracker.GetVersion(path)))
     if isinstance(read_result, list):
       stat_result.child_versions = dict(
-          (file_result, self._SinglePathStat('%s%s' % (path, file_result)))
+          (file_result,
+           str(self._stat_tracker.GetVersion('%s%s' % (path, file_result))))
           for file_result in read_result)
     return stat_result
 
-  def _SinglePathStat(self, path):
-    return str(self._global_stat + self._path_stats.get(path, 0))
-
   #
   # Testing methods.
   #
 
   def IncrementStat(self, path=None, by=1):
-    if path is not None:
-      self._path_stats[path] = self._path_stats.get(path, 0) + by
-    else:
-      self._global_stat += by
+    self._stat_tracker.Increment(path, by=by)
 
   def GetIdentity(self):
     return self._identity