Add support for "documented_in" annotation in json api schema

chrome/common/extensions/docs/server2/reference_resolver_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 file_system import FileNotFoundError
+from future import Future
 from reference_resolver import ReferenceResolver
 from test_object_store import TestObjectStore
 from test_util import Server2Path
 
 
-class FakeAPIDataSource(object):
+class _FakeAPIDataSource(object):
   def __init__(self, json_data):
     self._json = json_data
 
   def get(self, key, disable_refs=False):
     assert disable_refs, 'ReferenceResolve should be disabling refs'
     if key not in self._json:
       raise FileNotFoundError(key)
     return self._json[key]
 
 
-class FakeAPIModels(object):
+class _FakeNamespace(object):
+  def __init__(self):
+    self.documentation_options = {}
+
+
+class _FakeAPIModels(object):
   def __init__(self, names):
     self._names = names
 
   def GetNames(self):
     return self._names
 
+  def GetModel(self, name):
+    return Future(value=_FakeNamespace())
 
-class APIDataSourceTest(unittest.TestCase):
+
+class ReferenceResolverTest(unittest.TestCase):
   def setUp(self):
     self._base_path = Server2Path('test_data', 'test_json')
 
   def _ReadLocalFile(self, filename):
     with open(os.path.join(self._base_path, filename), 'r') as f:
       return f.read()
 
   def testGetLink(self):
     test_data = json.loads(self._ReadLocalFile('fake_data_source.json'))
-    resolver = ReferenceResolver(FakeAPIDataSource(test_data),
-                                 FakeAPIModels(test_data.keys()),
+    resolver = ReferenceResolver(_FakeAPIDataSource(test_data),
+                                 _FakeAPIModels(test_data.keys()),
                                  TestObjectStore('test'))
     self.assertEqual({
-      'href': 'foo.html',
+      'href': 'foo',
       'text': 'foo',
       'name': 'foo'
     }, resolver.GetLink('foo', namespace='baz'))
     self.assertEqual({
-      'href': 'foo.html#type-foo_t1',
+      'href': 'foo#type-foo_t1',
       'text': 'foo.foo_t1',
       'name': 'foo_t1'
     }, resolver.GetLink('foo.foo_t1', namespace='baz'))
     self.assertEqual({
-      'href': 'baz.html#event-baz_e1',
+      'href': 'baz#event-baz_e1',
       'text': 'baz_e1',
       'name': 'baz_e1'
     }, resolver.GetLink('baz.baz_e1', namespace='baz'))
     self.assertEqual({
-      'href': 'baz.html#event-baz_e1',
+      'href': 'baz#event-baz_e1',
       'text': 'baz_e1',
       'name': 'baz_e1'
     }, resolver.GetLink('baz_e1', namespace='baz'))
     self.assertEqual({
-      'href': 'foo.html#method-foo_f1',
+      'href': 'foo#method-foo_f1',
       'text': 'foo.foo_f1',
       'name': 'foo_f1'
     }, resolver.GetLink('foo.foo_f1', namespace='baz'))
     self.assertEqual({
-      'href': 'foo.html#property-foo_p3',
+      'href': 'foo#property-foo_p3',
       'text': 'foo.foo_p3',
       'name': 'foo_p3'
     }, resolver.GetLink('foo.foo_p3', namespace='baz'))
     self.assertEqual({
-      'href': 'bar.bon.html#type-bar_bon_t3',
+      'href': 'bar.bon#type-bar_bon_t3',
       'text': 'bar.bon.bar_bon_t3',
       'name': 'bar_bon_t3'
     }, resolver.GetLink('bar.bon.bar_bon_t3', namespace='baz'))
     self.assertEqual({
-      'href': 'bar.bon.html#property-bar_bon_p3',
+      'href': 'bar.bon#property-bar_bon_p3',
       'text': 'bar_bon_p3',
       'name': 'bar_bon_p3'
     }, resolver.GetLink('bar_bon_p3', namespace='bar.bon'))
     self.assertEqual({
-      'href': 'bar.bon.html#property-bar_bon_p3',
+      'href': 'bar.bon#property-bar_bon_p3',
       'text': 'bar_bon_p3',
       'name': 'bar_bon_p3'
     }, resolver.GetLink('bar.bon.bar_bon_p3', namespace='bar.bon'))
     self.assertEqual({
-      'href': 'bar.html#event-bar_e2',
+      'href': 'bar#event-bar_e2',
       'text': 'bar_e2',
       'name': 'bar_e2'
     }, resolver.GetLink('bar.bar_e2', namespace='bar'))
     self.assertEqual({
-      'href': 'bar.html#type-bon',
+      'href': 'bar#type-bon',
       'text': 'bon',
       'name': 'bon'
     }, resolver.GetLink('bar.bon', namespace='bar'))
     self.assertEqual({
-      'href': 'foo.html#event-foo_t3-foo_t3_e1',
+      'href': 'foo#event-foo_t3-foo_t3_e1',
       'text': 'foo_t3.foo_t3_e1',
       'name': 'foo_t3_e1'
     }, resolver.GetLink('foo_t3.foo_t3_e1', namespace='foo'))
     self.assertEqual({
-      'href': 'foo.html#event-foo_t3-foo_t3_e1',
+      'href': 'foo#event-foo_t3-foo_t3_e1',
       'text': 'foo_t3.foo_t3_e1',
       'name': 'foo_t3_e1'
     }, resolver.GetLink('foo.foo_t3.foo_t3_e1', namespace='foo'))
     self.assertEqual({
-      'href': 'foo.html#event-foo_t3-foo_t3_e1',
+      'href': 'foo#event-foo_t3-foo_t3_e1',
       'text': 'foo_t3.foo_t3_e1',
       'name': 'foo_t3_e1'
     }, resolver.GetLink('foo.foo_p1.foo_t3_e1', namespace='foo'))
     self.assertEqual({
-      'href': 'bar.html#property-bar_t1-bar_t1_p1',
+      'href': 'bar#property-bar_t1-bar_t1_p1',
       'text': 'bar.bar_t1.bar_t1_p1',
       'name': 'bar_t1_p1'
     }, resolver.GetLink('bar.bar_p3.bar_t1_p1', namespace='foo'))
     self.assertEqual({
-      'href': 'bar.html#property-bar_t1-bar_t1_p1',
+      'href': 'bar#property-bar_t1-bar_t1_p1',
       'text': 'bar_t1.bar_t1_p1',
       'name': 'bar_t1_p1'
     }, resolver.GetLink('bar_p3.bar_t1_p1', namespace='bar'))
     self.assertEqual(
         None,
         resolver.GetLink('bar.bar_p3.bar_t2_p1', namespace='bar'))
     self.assertEqual(
         None,
         resolver.GetLink('bar.bon.bar_e3', namespace='bar'))
     self.assertEqual(
         None,
         resolver.GetLink('bar_p3', namespace='baz.bon'))
     self.assertEqual(
         None,
         resolver.GetLink('falafel.faf', namespace='a'))
     self.assertEqual(
         None,
         resolver.GetLink('bar_p3', namespace='foo'))
     self.assertEqual(
-        'Hello <a href="bar.bon.html#property-bar_bon_p3">bar_bon_p3</a>, '
-            '<a href="bar.bon.html#property-bar_bon_p3">Bon Bon</a>, '
-            '<a href="bar.bon.html#property-bar_bon_p3">bar_bon_p3</a>',
+        'Hello <a href="bar.bon#property-bar_bon_p3">bar_bon_p3</a>, '
+            '<a href="bar.bon#property-bar_bon_p3">Bon Bon</a>, '
+            '<a href="bar.bon#property-bar_bon_p3">bar_bon_p3</a>',
         resolver.ResolveAllLinks(
             'Hello $ref:bar_bon_p3, $ref:[bar_bon_p3 Bon Bon], $ref:bar_bon_p3',
             namespace='bar.bon'))
     self.assertEqual(
-        'I like <a href="bar.html#property-bar_t1-bar_t1_p1">food</a>.',
+        'I like <a href="bar#property-bar_t1-bar_t1_p1">food</a>.',
         resolver.ResolveAllLinks('I like $ref:[bar.bar_p3.bar_t1_p1 food].',
                                  namespace='foo'))
     self.assertEqual(
-        'Ref <a href="foo.html">It\'s foo!</a>',
+        'Ref <a href="foo">It\'s foo!</a>',
         resolver.ResolveAllLinks('Ref $ref:[foo It\'s foo!]', namespace='bar'))
     self.assertEqual(
-        'Ref <a href="bar.html#type-bon">Bon</a>',
+        'Ref <a href="bar#type-bon">Bon</a>',
         resolver.ResolveAllLinks('Ref $ref:[bar.bon Bon]', namespace='bar'))
 
     # Different kinds of whitespace can be significant inside <pre> tags.
     self.assertEqual(
-        '<pre><a href="bar.html#type-bon">bar.bon</a>({\nkey: value})',
+        '<pre><a href="bar#type-bon">bar.bon</a>({\nkey: value})',
         resolver.ResolveAllLinks('<pre>$ref:[bar.bon]({\nkey: value})',
                                  namespace='baz'))
 
     # Allow bare "$ref:foo.bar." at the end of a string.
     self.assertEqual(
-        '<a href="bar.html#type-bon">bar.bon</a>.',
+        '<a href="bar#type-bon">bar.bon</a>.',
         resolver.ResolveAllLinks('$ref:bar.bon.',
                                  namespace='baz'))
 
     # If a request is provided it should construct an appropriate relative link.
     self.assertEqual(
-        'Hi <a href="../../bar.bon.html#property-bar_bon_p3">bar_bon_p3</a>, '
-            '<a href="../../bar.bon.html#property-bar_bon_p3">Bon Bon</a>, '
-            '<a href="../../bar.bon.html#property-bar_bon_p3">bar_bon_p3</a>',
+        'Hi <a href="../../bar.bon#property-bar_bon_p3">bar_bon_p3</a>, '
+            '<a href="../../bar.bon#property-bar_bon_p3">Bon Bon</a>, '
+            '<a href="../../bar.bon#property-bar_bon_p3">bar_bon_p3</a>',
         resolver.ResolveAllLinks(
             'Hi $ref:bar_bon_p3, $ref:[bar_bon_p3 Bon Bon], $ref:bar_bon_p3',
             relative_to='big/long/path/bar.html',
             namespace='bar.bon'))
     self.assertEqual(
-        'Hi <a href="bar.bon.html#property-bar_bon_p3">bar_bon_p3</a>, '
-            '<a href="bar.bon.html#property-bar_bon_p3">Bon Bon</a>, '
-            '<a href="bar.bon.html#property-bar_bon_p3">bar_bon_p3</a>',
+        'Hi <a href="bar.bon#property-bar_bon_p3">bar_bon_p3</a>, '
+            '<a href="bar.bon#property-bar_bon_p3">Bon Bon</a>, '
+            '<a href="bar.bon#property-bar_bon_p3">bar_bon_p3</a>',
         resolver.ResolveAllLinks(
             'Hi $ref:bar_bon_p3, $ref:[bar_bon_p3 Bon Bon], $ref:bar_bon_p3',
             relative_to='',
             namespace='bar.bon'))
     self.assertEqual(
-        'Hi <a href="bar.bon.html#property-bar_bon_p3">bar_bon_p3</a>, '
-            '<a href="bar.bon.html#property-bar_bon_p3">Bon Bon</a>, '
-            '<a href="bar.bon.html#property-bar_bon_p3">bar_bon_p3</a>',
+        'Hi <a href="bar.bon#property-bar_bon_p3">bar_bon_p3</a>, '
+            '<a href="bar.bon#property-bar_bon_p3">Bon Bon</a>, '
+            '<a href="bar.bon#property-bar_bon_p3">bar_bon_p3</a>',
         resolver.ResolveAllLinks(
             'Hi $ref:bar_bon_p3, $ref:[bar_bon_p3 Bon Bon], $ref:bar_bon_p3',
             relative_to='bar.html',
             namespace='bar.bon'))
     self.assertEqual(
-        'Hi <a href="bar.bon.html#property-bar_bon_p3">bar_bon_p3</a>, '
-            '<a href="bar.bon.html#property-bar_bon_p3">Bon Bon</a>, '
-            '<a href="bar.bon.html#property-bar_bon_p3">bar_bon_p3</a>',
+        'Hi <a href="bar.bon#property-bar_bon_p3">bar_bon_p3</a>, '
+            '<a href="bar.bon#property-bar_bon_p3">Bon Bon</a>, '
+            '<a href="bar.bon#property-bar_bon_p3">bar_bon_p3</a>',
         resolver.ResolveAllLinks(
             'Hi $ref:bar_bon_p3, $ref:[bar_bon_p3 Bon Bon], $ref:bar_bon_p3',
             relative_to='foo/bar.html',
             namespace='bar.bon'))
     self.assertEqual(
-        'Hi <a href="../bar.bon.html#property-bar_bon_p3">bar_bon_p3</a>, '
-            '<a href="../bar.bon.html#property-bar_bon_p3">Bon Bon</a>, '
-            '<a href="../bar.bon.html#property-bar_bon_p3">bar_bon_p3</a>',
+        'Hi <a href="../bar.bon#property-bar_bon_p3">bar_bon_p3</a>, '
+            '<a href="../bar.bon#property-bar_bon_p3">Bon Bon</a>, '
+            '<a href="../bar.bon#property-bar_bon_p3">bar_bon_p3</a>',
         resolver.ResolveAllLinks(
             'Hi $ref:bar_bon_p3, $ref:[bar_bon_p3 Bon Bon], $ref:bar_bon_p3',
             relative_to='foo/baz/bar.html',
             namespace='bar.bon'))
 
 if __name__ == '__main__':
   unittest.main()