src/chrome/common/extensions/docs/server2/api_models_test.py

   1 #!/usr/bin/env python
   2 # Copyright 2013 The Chromium Authors. All rights reserved.
   3 # Use of this source code is governed by a BSD-style license that can be
   4 # found in the LICENSE file.
   5
   6 import os
   7 import json
   8 import unittest
   9
  10 from api_models import APIModels
  11 from compiled_file_system import CompiledFileSystem
  12 from features_bundle import FeaturesBundle
  13 from file_system import FileNotFoundError
  14 from mock_file_system import MockFileSystem
  15 from object_store_creator import ObjectStoreCreator
  16 from test_file_system import TestFileSystem
  17 from test_util import ReadFile
  18
  19
  20 _TEST_DATA = {
  21   'api': {
  22     'devtools': {
  23       'inspected_window.json': ReadFile(os.path.join(
  24           'api', 'devtools', 'inspected_window.json')),
  25     },
  26     '_api_features.json': json.dumps({
  27       'alarms': {},
  28       'app': {},
  29       'app.runtime': {'noparent': True},
  30       'app.runtime.experimental': {},
  31       'app.runtime.experimental.foo': {},
  32       'declarativeWebRequest': {},
  33       'devtools.inspectedWindow': {},
  34       'experimental.accessibility': {},
  35       'storage': {},
  36     }),
  37     '_manifest_features.json': '{}',
  38     '_permission_features.json': '{}',
  39     'alarms.idl': ReadFile(os.path.join('api', 'alarms.idl')),
  40     'declarative_web_request.json': ReadFile(os.path.join(
  41         'api', 'declarative_web_request.json')),
  42     'experimental_accessibility.json': ReadFile(os.path.join(
  43         'api', 'experimental_accessibility.json')),
  44     'page_action.json': ReadFile(os.path.join('api', 'page_action.json')),
  45   },
  46   'docs': {
  47     'templates': {
  48       'json': {
  49         'manifest.json': '{}',
  50         'permissions.json': '{}',
  51       }
  52     }
  53   },
  54 }
  55
  56
  57 class APIModelsTest(unittest.TestCase):
  58   def setUp(self):
  59     object_store_creator = ObjectStoreCreator.ForTest()
  60     compiled_fs_factory = CompiledFileSystem.Factory(object_store_creator)
  61     self._mock_file_system = MockFileSystem(TestFileSystem(_TEST_DATA))
  62     features_bundle = FeaturesBundle(
  63         self._mock_file_system, compiled_fs_factory, object_store_creator)
  64     self._api_models = APIModels(
  65         features_bundle, compiled_fs_factory, self._mock_file_system)
  66
  67   def testGetNames(self):
  68     # Both 'app' and 'app.runtime' appear here because 'app.runtime' has
  69     # noparent:true, but 'app.runtime.experimental' etc doesn't so it's a
  70     # sub-feature of 'app.runtime' not a separate API.
  71     # 'devtools.inspectedWindow' is an API because there is no 'devtools'.
  72     self.assertEqual(
  73         ['alarms', 'app', 'app.runtime', 'declarativeWebRequest',
  74          'devtools.inspectedWindow', 'experimental.accessibility', 'storage'],
  75         sorted(self._api_models.GetNames()))
  76
  77   def testGetModel(self):
  78     def get_model_name(api_name):
  79       return self._api_models.GetModel(api_name).Get().name
  80     self.assertEqual('devtools.inspectedWindow',
  81                      get_model_name('devtools.inspectedWindow'))
  82     self.assertEqual('devtools.inspectedWindow',
  83                      get_model_name('devtools/inspected_window.json'))
  84     self.assertEqual('devtools.inspectedWindow',
  85                      get_model_name('api/devtools/inspected_window.json'))
  86     self.assertEqual('alarms', get_model_name('alarms'))
  87     self.assertEqual('alarms', get_model_name('alarms.idl'))
  88     self.assertEqual('alarms', get_model_name('api/alarms.idl'))
  89     self.assertEqual('declarativeWebRequest',
  90                      get_model_name('declarativeWebRequest'))
  91     self.assertEqual('declarativeWebRequest',
  92                      get_model_name('declarative_web_request.json'))
  93     self.assertEqual('declarativeWebRequest',
  94                      get_model_name('api/declarative_web_request.json'))
  95     self.assertEqual('experimental.accessibility',
  96                      get_model_name('experimental.accessibility'))
  97     self.assertEqual('experimental.accessibility',
  98                      get_model_name('experimental_accessibility.json'))
  99     self.assertEqual('experimental.accessibility',
 100                      get_model_name('api/experimental_accessibility.json'))
 101     self.assertEqual('pageAction', get_model_name('pageAction'))
 102     self.assertEqual('pageAction', get_model_name('page_action.json'))
 103     self.assertEqual('pageAction', get_model_name('api/page_action.json'))
 104
 105   def testGetNonexistentModel(self):
 106     self.assertRaises(FileNotFoundError,
 107                       self._api_models.GetModel('notfound').Get)
 108     self.assertRaises(FileNotFoundError,
 109                       self._api_models.GetModel('notfound.json').Get)
 110     self.assertRaises(FileNotFoundError,
 111                       self._api_models.GetModel('api/notfound.json').Get)
 112     self.assertRaises(FileNotFoundError,
 113                       self._api_models.GetModel('api/alarms.json').Get)
 114     self.assertRaises(FileNotFoundError,
 115                       self._api_models.GetModel('storage').Get)
 116     self.assertRaises(FileNotFoundError,
 117                       self._api_models.GetModel('api/storage.json').Get)
 118     self.assertRaises(FileNotFoundError,
 119                       self._api_models.GetModel('api/storage.idl').Get)
 120
 121   def testSingleFile(self):
 122     # 2 stats (1 for JSON and 1 for IDL), 1 read (for IDL file which existed).
 123     future = self._api_models.GetModel('alarms')
 124     self.assertTrue(*self._mock_file_system.CheckAndReset(
 125         read_count=1, stat_count=2))
 126
 127     # 1 read-resolve (for the IDL file).
 128     #
 129     # The important part here and above is that it's only doing a single read;
 130     # any more would break the contract that only a single file is accessed -
 131     # see the SingleFile annotation in api_models._CreateAPIModel.
 132     future.Get()
 133     self.assertTrue(*self._mock_file_system.CheckAndReset(
 134         read_resolve_count=1))
 135
 136     # 2 stats (1 for JSON and 1 for IDL), no reads (still cached).
 137     future = self._api_models.GetModel('alarms')
 138     self.assertTrue(*self._mock_file_system.CheckAndReset(stat_count=2))
 139     future.Get()
 140     self.assertTrue(*self._mock_file_system.CheckAndReset())
 141
 142
 143 if __name__ == '__main__':
 144   unittest.main()