Dynamically generate a heading for Extension Docs API pages

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

 #!/usr/bin/env python
 # Copyright (c) 2012 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.
 
-import copy
+from copy import deepcopy
 import json
 import os
 import sys
 import unittest
 
 from api_data_source import (APIDataSource,
                              _JSCModel,
                              _FormatValue,
                              _RemoveNoDocs,
                              _InlineDocs)
 from compiled_file_system import CompiledFileSystem
 from file_system import FileNotFoundError
 from local_file_system import LocalFileSystem
 from object_store_creator import ObjectStoreCreator
 from reference_resolver import ReferenceResolver
+from test_file_system import TestFileSystem
+
+_INTRO_TABLES_DATA = {
+  'docs': {
+    'templates': {
+      'json': {
+        'intro_tables.json':
+          '{"tester": [{"Permissions": "<code>tester</code>"}]}'

[not at google - send to devlin, 2013/04/30 18:34:19]

what about Learn More? No Learn More? No Permissions?

where are the tests for the extra logic?

[epeterson, 2013/05/13 02:38:10]

Done.

+      }
+    }
+  }
+}
 
 def _MakeLink(href, text):
   return '<a href="%s">%s</a>' % (href, text)
 
 def _GetType(dict_, name):
   for type_ in dict_['types']:
     if type_['name'] == name:
       return type_
 
+class FakeAvailabilityDataSourceFactory(object):
+  def Create(self):
+    return {}
+
+def _FakeGetAvailability(self):
+  return 'Not Currently Available'
+
 class FakeSamplesDataSource(object):
   def Create(self, request):
     return {}
 
 class FakeAPIAndListDataSource(object):
   def __init__(self, json_data):
     self._json = json_data
 
   def Create(self, *args, **kwargs):
     return self
 
   def get(self, key):
     if key not in self._json:
       raise FileNotFoundError(key)
     return self._json[key]
 
   def GetAllNames(self):
     return self._json.keys()
 
 class APIDataSourceTest(unittest.TestCase):
   def setUp(self):
     self._base_path = os.path.join(sys.path[0], 'test_data', 'test_json')
+    _JSCModel._GetAvailability = _FakeGetAvailability

[not at google - send to devlin, 2013/04/30 18:34:19]

this is what passing in a fake availability data source is for. please don't
overwrite private methods of classes.

[epeterson, 2013/05/13 02:38:10]

Done.

 
   def _ReadLocalFile(self, filename):
     with open(os.path.join(self._base_path, filename), 'r') as f:
       return f.read()
 
   def _CreateRefResolver(self, filename):
     data_source = FakeAPIAndListDataSource(
         self._LoadJSON(filename))
     return ReferenceResolver.Factory(data_source,
                                      data_source,
                                      ObjectStoreCreator.TestFactory()).Create()
 
   def _LoadJSON(self, filename):
     return json.loads(self._ReadLocalFile(filename))
 
   def testCreateId(self):
     data_source = FakeAPIAndListDataSource(
         self._LoadJSON('test_file_data_source.json'))
+    fake_avail_factory = FakeAvailabilityDataSourceFactory()

[not at google - send to devlin, 2013/04/30 18:34:19]

inline

[epeterson, 2013/05/13 02:38:10]

Done.

     dict_ = _JSCModel(self._LoadJSON('test_file.json')[0],
                       self._CreateRefResolver('test_file_data_source.json'),
-                      False).ToDict()
+                      False,
+                      fake_avail_factory,
+                      TestFileSystem(deepcopy(_INTRO_TABLES_DATA))).ToDict()

[not at google - send to devlin, 2013/04/30 18:34:19]

save a reference in setUp?

[epeterson, 2013/05/13 02:38:10]

Done.

     self.assertEquals('type-TypeA', dict_['types'][0]['id'])
     self.assertEquals('property-TypeA-b',
                       dict_['types'][0]['properties'][0]['id'])
     self.assertEquals('method-get', dict_['functions'][0]['id'])
     self.assertEquals('event-EventA', dict_['events'][0]['id'])
 
   # TODO(kalman): re-enable this when we have a rebase option.
   def DISABLED_testToDict(self):
     filename = 'test_file.json'
     expected_json = self._LoadJSON('expected_' + filename)
     data_source = FakeAPIAndListDataSource(
         self._LoadJSON('test_file_data_source.json'))
     dict_ = _JSCModel(self._LoadJSON(filename)[0],
                       self._CreateRefResolver('test_file_data_source.json'),
-                      False).ToDict()
+                      False,
+                      fake_avail_factory,

[not at google - send to devlin, 2013/04/30 18:34:19]

the only reason this works is because the test is disabled :)

[epeterson, 2013/05/13 02:38:10]

Done.

+                      TestFileSystem(deepcopy(_INTRO_TABLES_DATA))).ToDict()
     self.assertEquals(expected_json, dict_)
 
   def testFormatValue(self):
     self.assertEquals('1,234,567', _FormatValue(1234567))
     self.assertEquals('67', _FormatValue(67))
     self.assertEquals('234,567', _FormatValue(234567))
 
   def testFormatDescription(self):
+    fake_avail_factory = FakeAvailabilityDataSourceFactory()
     dict_ = _JSCModel(self._LoadJSON('ref_test.json')[0],
                       self._CreateRefResolver('ref_test_data_source.json'),
-                      False).ToDict()
+                      False,
+                      fake_avail_factory,
+                      TestFileSystem(deepcopy(_INTRO_TABLES_DATA))).ToDict()

[not at google - send to devlin, 2013/04/30 18:34:19]

ditto inline, safe reference comment

[epeterson, 2013/05/13 02:38:10]

Done.

     self.assertEquals(_MakeLink('ref_test.html#type-type2', 'type2'),
                       _GetType(dict_, 'type1')['description'])
     self.assertEquals(
         'A %s, or %s' % (_MakeLink('ref_test.html#type-type3', 'type3'),
                          _MakeLink('ref_test.html#type-type2', 'type2')),
         _GetType(dict_, 'type2')['description'])
     self.assertEquals(
         '%s != %s' % (_MakeLink('other.html#type-type2', 'other.type2'),
                       _MakeLink('ref_test.html#type-type2', 'type2')),
         _GetType(dict_, 'type3')['description'])
@@ skipping 56 matching lines @@
             "marker": True,
             "type": "string"
           },
           "type": "array",
           "id": "KeyList",
           "description": "A list of keys"
         }
       ]
     }
 
-    inlined_schema = copy.deepcopy(schema)
+    inlined_schema = deepcopy(schema)
     _InlineDocs(inlined_schema)
     self.assertEqual(expected_schema, inlined_schema)
 
 
 if __name__ == '__main__':
   unittest.main()