tools/json_schema_compiler/js_externs_generator_test.py

   1 #!/usr/bin/env python
   2 # Copyright 2015 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 idl_schema
   7 import json_parse
   8 from js_externs_generator import JsExternsGenerator
   9 from datetime import datetime
  10 import model
  11 import unittest
  12
  13
  14 # The contents of a fake idl file.
  15 fake_idl = """
  16 // Copyright 2014 The Chromium Authors. All rights reserved.
  17 // Use of this source code is governed by a BSD-style license that can be
  18 // found in the LICENSE file.
  19
  20 // A totally fake API.
  21 namespace fakeApi {
  22   enum Greek {
  23     ALPHA,
  24     BETA,
  25     GAMMA,
  26     DELTA
  27   };
  28
  29   dictionary Bar {
  30     long num;
  31   };
  32
  33   dictionary Baz {
  34     DOMString str;
  35     long num;
  36     boolean b;
  37     Greek letter;
  38     Greek? optionalLetter;
  39     long[] arr;
  40     Bar[]? optionalObjArr;
  41     Greek[] enumArr;
  42     any[] anythingGoes;
  43     Bar obj;
  44     long? maybe;
  45     (DOMString or Greek or long[]) choice;
  46   };
  47
  48   callback VoidCallback = void();
  49
  50   callback BazGreekCallback = void(Baz baz, Greek greek);
  51
  52   interface Functions {
  53     // Does something exciting! And what's more, this is a multiline function
  54     // comment! It goes onto multiple lines!
  55     // |baz| : The baz to use.
  56     static void doSomething(Baz baz, VoidCallback callback);
  57
  58     // |callback| : The callback which will most assuredly in all cases be
  59     // called; that is, of course, iff such a callback was provided and is
  60     // not at all null.
  61     static void bazGreek(optional BazGreekCallback callback);
  62
  63     [deprecated="Use a new method."] static DOMString returnString();
  64   };
  65
  66   interface Events {
  67     // Fired when we realize it's a trap!
  68     static void onTrapDetected(Baz baz);
  69   };
  70 };
  71 """
  72
  73 # The output we expect from our fake idl file.
  74 expected_output = """// Copyright %s The Chromium Authors. All rights reserved.
  75 // Use of this source code is governed by a BSD-style license that can be
  76 // found in the LICENSE file.
  77
  78 /** @fileoverview Externs generated from namespace: fakeApi */
  79
  80 /**
  81  * @const
  82  */
  83 chrome.fakeApi = {};
  84
  85 /**
  86  * @enum {string}
  87  * @see https://developer.chrome.com/extensions/fakeApi#type-Greek
  88  */
  89 chrome.fakeApi.Greek = {
  90   ALPHA: 'ALPHA',
  91   BETA: 'BETA',
  92   GAMMA: 'GAMMA',
  93   DELTA: 'DELTA',
  94 };
  95
  96 /**
  97  * @typedef {{
  98  *   num: number
  99  * }}
 100  * @see https://developer.chrome.com/extensions/fakeApi#type-Bar
 101  */
 102 var Bar;
 103
 104 /**
 105  * @typedef {{
 106  *   str: string,
 107  *   num: number,
 108  *   b: boolean,
 109  *   letter: !chrome.fakeApi.Greek,
 110  *   optionalLetter: (!chrome.fakeApi.Greek|undefined),
 111  *   arr: !Array<number>,
 112  *   optionalObjArr: (!Array<Bar>|undefined),
 113  *   enumArr: !Array<!chrome.fakeApi.Greek>,
 114  *   anythingGoes: !Array<*>,
 115  *   obj: Bar,
 116  *   maybe: (number|undefined),
 117  *   choice: (string|!chrome.fakeApi.Greek|!Array<number>)
 118  * }}
 119  * @see https://developer.chrome.com/extensions/fakeApi#type-Baz
 120  */
 121 var Baz;
 122
 123 /**
 124  * Does something exciting! And what's more, this is a multiline function
 125  * comment! It goes onto multiple lines!
 126  * @param {Baz} baz The baz to use.
 127  * @param {function():void} callback
 128  * @see https://developer.chrome.com/extensions/fakeApi#method-doSomething
 129  */
 130 chrome.fakeApi.doSomething = function(baz, callback) {};
 131
 132 /**
 133  * @param {function(Baz, !chrome.fakeApi.Greek):void=} callback The callback
 134  *     which will most assuredly in all cases be called; that is, of course, iff
 135  *     such a callback was provided and is not at all null.
 136  * @see https://developer.chrome.com/extensions/fakeApi#method-bazGreek
 137  */
 138 chrome.fakeApi.bazGreek = function(callback) {};
 139
 140 /**
 141  * @return {string}
 142  * @deprecated Use a new method.
 143  * @see https://developer.chrome.com/extensions/fakeApi#method-returnString
 144  */
 145 chrome.fakeApi.returnString = function() {};
 146
 147 /**
 148  * Fired when we realize it's a trap!
 149  * @type {!ChromeEvent}
 150  * @see https://developer.chrome.com/extensions/fakeApi#event-onTrapDetected
 151  */
 152 chrome.fakeApi.onTrapDetected;
 153 """ % datetime.now().year
 154
 155
 156 fake_json = """// Copyright 2014 The Chromium Authors. All rights reserved.
 157 // Use of this source code is governed by a BSD-style license that can be
 158 // found in the LICENSE file.
 159
 160 [
 161   {
 162     "namespace": "fakeJson",
 163     "description": "Fake JSON API Stuff",
 164     "functions": [ {
 165       "name": "funcWithInlineObj",
 166       "type": "function",
 167       "parameters": [
 168         {
 169           "type": "object",
 170           "name": "inlineObj",
 171           "description": "Evil inline object! With a super duper duper long\
 172  string description that causes problems!",
 173           "properties": {
 174             "foo": {
 175               "type": "boolean",
 176               "optional": "true",
 177               "description": "The foo."
 178             },
 179             "bar": {
 180               "type": "integer",
 181               "description": "The bar."
 182             },
 183             "baz": {
 184               "type": "object",
 185               "description": "Inception object.",
 186               "properties": {
 187                 "depth": {
 188                   "type": "integer"
 189                 }
 190               }
 191             }
 192           }
 193         },
 194         {
 195           "name": "callback",
 196           "type": "function",
 197           "parameters": [
 198             {
 199               "type": "object",
 200               "name": "returnObj",
 201               "properties": {
 202                 "str": { "type": "string"}
 203               }
 204             }
 205           ],
 206           "description": "The callback to this heinous method"
 207         }
 208       ],
 209       "returns": {
 210         "type": "object",
 211         "properties": {
 212           "str": { "type": "string" },
 213           "int": { "type": "number" }
 214         }
 215       }
 216     } ]
 217   }
 218 ]"""
 219
 220 json_expected = """// Copyright %s The Chromium Authors. All rights reserved.
 221 // Use of this source code is governed by a BSD-style license that can be
 222 // found in the LICENSE file.
 223
 224 /** @fileoverview Externs generated from namespace: fakeJson */
 225
 226 /**
 227  * @const
 228  */
 229 chrome.fakeJson = {};
 230
 231 /**
 232  * @param {{
 233  *   foo: (boolean|undefined),
 234  *   bar: number,
 235  *   baz: {
 236  *     depth: number
 237  *   }
 238  * }} inlineObj Evil inline object! With a super duper duper long string
 239  *     description that causes problems!
 240  * @param {function({
 241  *   str: string
 242  * }):void} callback The callback to this heinous method
 243  * @return {{
 244  *   str: string,
 245  *   int: number
 246  * }}
 247  * @see https://developer.chrome.com/extensions/fakeJson#method-funcWithInlineObj
 248  */
 249 chrome.fakeJson.funcWithInlineObj = function(inlineObj, callback) {};
 250 """ % datetime.now().year
 251
 252
 253 class JsExternGeneratorTest(unittest.TestCase):
 254   def _GetNamespace(self, fake_content, filename, is_idl):
 255     """Returns a namespace object for the given content"""
 256     api_def = (idl_schema.Process(fake_content, filename) if is_idl
 257         else json_parse.Parse(fake_content))
 258     m = model.Model()
 259     return m.AddNamespace(api_def[0], filename)
 260
 261   def setUp(self):
 262     self.maxDiff = None # Lets us see the full diff when inequal.
 263
 264   def testBasic(self):
 265     namespace = self._GetNamespace(fake_idl, 'fake_api.idl', True)
 266     self.assertMultiLineEqual(expected_output,
 267                               JsExternsGenerator().Generate(namespace).Render())
 268
 269   def testJsonWithInlineObjects(self):
 270     namespace = self._GetNamespace(fake_json, 'fake_api.json', False)
 271     self.assertMultiLineEqual(json_expected,
 272                               JsExternsGenerator().Generate(namespace).Render())
 273
 274
 275 if __name__ == '__main__':
 276   unittest.main()