Docserver: Display API features that are available to content scripts

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 json
 import os
 import sys
 import unittest
 
 from api_data_source import (_JSCModel,
                              _FormatValue,
                              _GetEventByNameFromEvents)
+from api_models import ContentScriptAPI
 from api_schema_graph import APISchemaGraph
 from availability_finder import AvailabilityFinder, AvailabilityInfo
 from branch_utility import BranchUtility, ChannelInfo
 from compiled_file_system import CompiledFileSystem
 from extensions_paths import CHROME_EXTENSIONS
 from fake_host_file_system_provider import FakeHostFileSystemProvider
 from fake_url_fetcher import FakeUrlFetcher
 from features_bundle import FeaturesBundle
 from file_system import FileNotFoundError
 from future import Future
@@ skipping 103 matching lines @@
     events['types'][0]['functions'].append(add_rules)
     self.assertEqual(add_rules,
                      _GetEventByNameFromEvents(events)['addRules'])
 
     events['types'][0]['functions'].append(add_rules)
     # Duplicates are an error.
     self.assertRaises(AssertionError, _GetEventByNameFromEvents, events)
 
   def testCreateId(self):
     fake_avail_finder = _FakeAvailabilityFinder(self._fake_availability)
-    dict_ = _JSCModel(self._api_models.GetModel('tester').Get(),
+    dict_ = _JSCModel(self._api_models,
+                      self._api_models.GetModel('tester').Get(),
                       fake_avail_finder,
                       self._json_cache,
                       _FakeTemplateCache(),
                       self._features_bundle,
                       None).ToDict()
     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):
     fake_avail_finder = _FakeAvailabilityFinder(self._fake_availability)
     expected_json = self._LoadJSON('expected_tester.json')
-    dict_ = _JSCModel(self._api_models.GetModel('tester').Get(),
+    dict_ = _JSCModel(self._api_models,
+                      self._api_models.GetModel('tester').Get(),
                       fake_avail_finder,
                       self._json_cache,
                       _FakeTemplateCache(),
                       self._features_bundle,
                       None).ToDict()
     self.assertEquals(expected_json, dict_)
 
   def testAddRules(self):
     fake_avail_finder = _FakeAvailabilityFinder(self._fake_availability)
-    dict_ = _JSCModel(self._api_models.GetModel('add_rules_tester').Get(),
+    dict_ = _JSCModel(self._api_models,
+                      self._api_models.GetModel('add_rules_tester').Get(),
                       fake_avail_finder,
                       #self._fake_availability,
                       self._json_cache,
                       _FakeTemplateCache(),
                       self._features_bundle,
                       self._FakeLoadAddRulesSchema()).ToDict()
 
     # Check that the first event has the addRulesFunction defined.
     self.assertEquals('add_rules_tester', dict_['name'])
     self.assertEquals('rules', dict_['events'][0]['name'])
     self.assertEquals('notable_name_to_check_for',
                       dict_['events'][0]['byName']['addRules'][
                           'parameters'][0]['name'])
 
     # Check that the second event has addListener defined.
     self.assertEquals('noRules', dict_['events'][1]['name'])
     self.assertEquals('add_rules_tester', dict_['name'])
     self.assertEquals('noRules', dict_['events'][1]['name'])
     self.assertEquals('callback',
                       dict_['events'][0]['byName']['addListener'][
                           'parameters'][0]['name'])
 
   def testGetIntroList(self):
     fake_avail_finder = _FakeAvailabilityFinder(self._fake_availability)
-    model = _JSCModel(self._api_models.GetModel('tester').Get(),
+    model = _JSCModel(self._api_models,
+                      self._api_models.GetModel('tester').Get(),
                       fake_avail_finder,
                       self._json_cache,
                       _FakeTemplateCache(),
                       self._features_bundle,
                       None)
+    expected_content_script_support = ContentScriptAPI('tester')
     expected_list = [
       { 'title': 'Description',
         'content': [
           { 'text': 'a test api' }
         ]
       },
       { 'title': 'Availability',
         'content': [
           { 'partial': 'handlebar chrome/common/extensions/docs/' +
                        'templates/private/intro_tables/stable_message.html',
@@ skipping 10 matching lines @@
           { 'text': 'is an API for testing things.' }
         ]
       },
       { 'title': 'Manifest',
         'content': [
           { 'class': 'code',
             'text': '"tester": {...}'
           }
         ]
       },
+      { 'title': 'Content Scripts',
+        'content': [
+          {
+            'partial': 'handlebar chrome/common/extensions/docs' +
+                       '/templates/private/intro_tables/content_scripts.html',
+            'contentScriptSupport': expected_content_script_support.__dict__

[not at google - send to devlin, 2014/07/15 21:34:39]

I'd rather you test the dict output directly rather than relying on whatever
ContentScriptAPI.__dict__ spits out. i.e. what you had before?

+          }
+        ]
+      },
       { 'title': 'Learn More',
         'content': [
           { 'link': 'https://tester.test.com/welcome.html',
             'text': 'Welcome!'
           }
         ]
       }
     ]
     self.assertEquals(model._GetIntroTableList(), expected_list)
 
     # Tests the same data with a scheduled availability.
     fake_avail_finder = _FakeAvailabilityFinder(
         AvailabilityInfo(ChannelInfo('beta', '1453', 27), scheduled=28))
-    model = _JSCModel(self._api_models.GetModel('tester').Get(),
-        fake_avail_finder,
-        self._json_cache,
-        _FakeTemplateCache(),
-        self._features_bundle,
-        None)
+    model = _JSCModel(self._api_models,
+                      self._api_models.GetModel('tester').Get(),
+                      fake_avail_finder,
+                      self._json_cache,
+                      _FakeTemplateCache(),
+                      self._features_bundle,
+                      None)
     expected_list[1] = {
       'title': 'Availability',
       'content': [
         { 'partial': 'handlebar chrome/common/extensions/docs/' +
                      'templates/private/intro_tables/beta_message.html',
           'version': 27,
           'scheduled': 28
         }
       ]
     }
@@ skipping 17 matching lines @@
     api_availabilities = {
       'bluetooth': 28,
       'contextMenus': 'trunk',
       'jsonStableAPI': 20,
       'idle': 5,
       'input.ime': 18,
       'tabs': 18
     }
     for api_name, availability in api_availabilities.iteritems():
       model_dict = _JSCModel(
+          self._api_models,
           self._api_models.GetModel(api_name).Get(),
           self._avail_finder,
           self._json_cache,
           _FakeTemplateCache(),
           _FakeFeaturesBundle(),
           None).ToDict()
       self.assertEquals(availability,
                         model_dict['introList'][1]['content'][0]['version'])
 
 
@@ skipping 47 matching lines @@
 
   def testGetAPINodeAvailability(self):
     def assertEquals(node, actual):
       node_availabilities = {
           'tabs.get': None,
           'tabs.getCurrent': 19
       }
       self.assertEquals(node_availabilities[node], actual)
 
     model_dict = _JSCModel(
+        self._api_models,
         self._api_models.GetModel('tabs').Get(),
         self._avail_finder,
         self._json_cache,
         _FakeTemplateCache(),
         _FakeFeaturesBundle(),
         None).ToDict()
 
     # Test nodes that have the same availability as their parent.
     assertEquals('tabs.get', model_dict['functions'][1]['availability'])
     # Test nodes with varying availabilities.
     assertEquals('tabs.getCurrent',
                  model_dict['functions'][0]['availability']['version'])
 
 
 if __name__ == '__main__':
   unittest.main()