summaryrefslogtreecommitdiffstats
path: root/chrome/common/extensions/docs/server2/api_models_test.py
blob: c0336cfb611e1e881810ea6de3bc13ff276fdc26 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
#!/usr/bin/env python
# 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.

import json
import unittest

from api_models import APIModels
from compiled_file_system import CompiledFileSystem
from extensions_paths import API_PATHS, CHROME_API, CHROME_EXTENSIONS
from features_bundle import FeaturesBundle
from file_system import FileNotFoundError
from mock_file_system import MockFileSystem
from object_store_creator import ObjectStoreCreator
from test_file_system import TestFileSystem
from test_util import ReadFile


_TEST_DATA = {
  'api': {
    'devtools': {
      'inspected_window.json': ReadFile(
          CHROME_API, 'devtools', 'inspected_window.json'),
    },
    '_api_features.json': json.dumps({
      'alarms': {},
      'app': {},
      'app.runtime': {'noparent': True},
      'app.runtime.foo': {},
      'declarativeWebRequest': {},
      'devtools.inspectedWindow': {},
      'input': {},
      'input.ime': {},
      'storage': {},
    }),
    '_manifest_features.json': '{}',
    '_permission_features.json': '{}',
    'alarms.idl': ReadFile(CHROME_API, 'alarms.idl'),
    'declarative_web_request.json': ReadFile(
        CHROME_API, 'declarative_web_request.json'),
    'input_ime.json': ReadFile(CHROME_API, 'input_ime.json'),
    'page_action.json': ReadFile(CHROME_API, 'page_action.json'),
  },
  'docs': {
    'templates': {
      'json': {
        'manifest.json': '{}',
        'permissions.json': '{}',
      }
    }
  },
}


class APIModelsTest(unittest.TestCase):
  def setUp(self):
    object_store_creator = ObjectStoreCreator.ForTest()
    compiled_fs_factory = CompiledFileSystem.Factory(object_store_creator)
    self._mock_file_system = MockFileSystem(
        TestFileSystem(_TEST_DATA, relative_to=CHROME_EXTENSIONS))
    features_bundle = FeaturesBundle(
        self._mock_file_system, compiled_fs_factory, object_store_creator)
    self._api_models = APIModels(
        features_bundle, compiled_fs_factory, self._mock_file_system)

  def testGetNames(self):
    # Both 'app' and 'app.runtime' appear here because 'app.runtime' has
    # noparent:true, but 'app.runtime.foo' etc doesn't so it's a sub-feature of
    # 'app.runtime' not a separate API. 'devtools.inspectedWindow' is an API
    # because there is no 'devtools'.
    self.assertEqual(
        ['alarms', 'app', 'app.runtime', 'declarativeWebRequest',
         'devtools.inspectedWindow', 'input', 'storage'],
        sorted(self._api_models.GetNames()))

  def testGetModel(self):
    def get_model_name(api_name):
      return self._api_models.GetModel(api_name).Get().name
    self.assertEqual('devtools.inspectedWindow',
                     get_model_name('devtools.inspectedWindow'))
    self.assertEqual('devtools.inspectedWindow',
                     get_model_name('devtools/inspected_window.json'))
    self.assertEqual('devtools.inspectedWindow',
                     get_model_name(CHROME_API +
                                    'devtools/inspected_window.json'))
    self.assertEqual('alarms', get_model_name('alarms'))
    self.assertEqual('alarms', get_model_name('alarms.idl'))
    self.assertEqual('alarms', get_model_name(CHROME_API + 'alarms.idl'))
    self.assertEqual('declarativeWebRequest',
                     get_model_name('declarativeWebRequest'))
    self.assertEqual('declarativeWebRequest',
                     get_model_name('declarative_web_request.json'))
    self.assertEqual('declarativeWebRequest',
                     get_model_name(CHROME_API +
                                    'declarative_web_request.json'))
    self.assertEqual('input.ime', get_model_name('input.ime'))
    self.assertEqual('input.ime', get_model_name('input_ime.json'))
    self.assertEqual('input.ime',
                     get_model_name(CHROME_API + 'input_ime.json'))
    self.assertEqual('pageAction', get_model_name('pageAction'))
    self.assertEqual('pageAction', get_model_name('page_action.json'))
    self.assertEqual('pageAction', get_model_name(CHROME_API +
                                                  'page_action.json'))

  def testGetNonexistentModel(self):
    self.assertRaises(FileNotFoundError,
                      self._api_models.GetModel('notfound').Get)
    self.assertRaises(FileNotFoundError,
                      self._api_models.GetModel('notfound.json').Get)
    self.assertRaises(FileNotFoundError,
                      self._api_models.GetModel(CHROME_API +
                                                'notfound.json').Get)
    self.assertRaises(FileNotFoundError,
                      self._api_models.GetModel(CHROME_API +
                                                'alarms.json').Get)
    self.assertRaises(FileNotFoundError,
                      self._api_models.GetModel('storage').Get)
    self.assertRaises(FileNotFoundError,
                      self._api_models.GetModel(CHROME_API +
                                                'storage.json').Get)
    self.assertRaises(FileNotFoundError,
                      self._api_models.GetModel(CHROME_API +
                                                'storage.idl').Get)

  def testSingleFile(self):
    # 2 stats (1 for JSON and 1 for IDL) for each available API path.
    # 1 read (for IDL file which existed).
    future = self._api_models.GetModel('alarms')
    self.assertTrue(*self._mock_file_system.CheckAndReset(
        read_count=1, stat_count=len(API_PATHS)*2))

    # 1 read-resolve (for the IDL file).
    #
    # The important part here and above is that it's only doing a single read;
    # any more would break the contract that only a single file is accessed -
    # see the SingleFile annotation in api_models._CreateAPIModel.
    future.Get()
    self.assertTrue(*self._mock_file_system.CheckAndReset(
        read_resolve_count=1))

    # 2 stats (1 for JSON and 1 for IDL) for each available API path.
    # No reads (still cached).
    future = self._api_models.GetModel('alarms')
    self.assertTrue(*self._mock_file_system.CheckAndReset(
        stat_count=len(API_PATHS)*2))
    future.Get()
    self.assertTrue(*self._mock_file_system.CheckAndReset())


if __name__ == '__main__':
  unittest.main()