Docserver: Generate a table of extension/app API owners

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

+import posixpath

[not at google - send to devlin, 2014/08/08 14:42:27]

copyright

+
+from data_source import DataSource
+from extensions_paths import BROWSER_API_PATHS
+from future import Future
+
+
+_COMMENT_START_MARKER = '#'
+_OWNERS = 'OWNERS'
+
+
+def _ParseOwnersFile(content):
+  '''Returns a tuple (owners, notes), where
+  |owners| is a list of owners in |content|,
+  |notes| is a string formed from the comments in |content|.
+  '''
+  owners = []
+  notes = []
+  for line in content.splitlines():
+    # TODO(ahernandez): Don't ignore per-file.
+    if line.startswith('per-file') or line == '':
+      continue
+    if line.startswith(_COMMENT_START_MARKER):
+      notes.append(line[len(_COMMENT_START_MARKER):].lstrip())
+    else:
+      owners.append(line)
+  return owners, ' '.join(notes)
+
+
+class OwnersDataSource(DataSource):
+  def __init__(self, server_instance, _):
+    self._host_fs = server_instance.host_file_system_provider.GetTrunk()
+    self._owners_fs = server_instance.compiled_fs_factory.ForUnicode(
+        self._host_fs)
+
+  def _CollectOwnersData(self):
+    '''Walks through the file system, collecting owners data from
+    API directories.
+    '''
+    api_owners = []
+    for root in BROWSER_API_PATHS:
+      for base, dirs, files in self._host_fs.Walk(root):
+        if base == root:
+          continue
+        if _OWNERS in files:

[not at google - send to devlin, 2014/08/08 14:42:27]

we should only need to check 1 deep, not Walk over the whole thing - the nice
part about that will be warning for APIs that don't have owners (and by
"warning" I mean listing them in the table with a red <no owner> marker)

+          owners, notes = _ParseOwnersFile(self._owners_fs.GetFromFile(
+              posixpath.join(root, base, _OWNERS)).Get())
+          api_owners.append({

[not at google - send to devlin, 2014/08/08 14:45:20]

ooh another idea - TODO for now because I don't know how to do this yet - but we
should also mark any owners that aren't on the project anymore (I'm seeing
ikianerator in that table). I'm not sure if we can get that data externally
though.

+            'api_name': base,
+            'owners': ', '.join(owners),
+            'notes': notes
+          })
+          # There is only one OWNERS file per directory.
+          continue
+    return api_owners

[not at google - send to devlin, 2014/08/08 14:42:27]

we need to future-ise this.

+    
+  def get(self, key):
+    return {
+      'apis': self._CollectOwnersData()
+    }.get(key)
+
+  def Cron(self):
+    return Future(value=())