| #!/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 idl_schema |
| import unittest |
| |
| from json_parse import OrderedDict |
| |
| def getFunction(schema, name): |
| for item in schema['functions']: |
| if item['name'] == name: |
| return item |
| raise KeyError('Missing function %s' % name) |
| |
| |
| def getParams(schema, name): |
| function = getFunction(schema, name) |
| return function['parameters'] |
| |
| |
| def getReturns(schema, name): |
| function = getFunction(schema, name) |
| return function['returns'] |
| |
| |
| def getType(schema, id): |
| for item in schema['types']: |
| if item['id'] == id: |
| return item |
| |
| |
| class IdlSchemaTest(unittest.TestCase): |
| def setUp(self): |
| loaded = idl_schema.Load('test/idl_basics.idl') |
| self.assertEquals(1, len(loaded)) |
| self.assertEquals('idl_basics', loaded[0]['namespace']) |
| self.idl_basics = loaded[0] |
| self.maxDiff = None |
| |
| def testSimpleCallbacks(self): |
| schema = self.idl_basics |
| expected = [{'type': 'function', 'name': 'cb', 'parameters':[]}] |
| self.assertEquals(expected, getParams(schema, 'function4')) |
| |
| expected = [{'type': 'function', 'name': 'cb', |
| 'parameters':[{'name': 'x', 'type': 'integer'}]}] |
| self.assertEquals(expected, getParams(schema, 'function5')) |
| |
| expected = [{'type': 'function', 'name': 'cb', |
| 'parameters':[{'name': 'arg', '$ref': 'MyType1'}]}] |
| self.assertEquals(expected, getParams(schema, 'function6')) |
| |
| def testCallbackWithArrayArgument(self): |
| schema = self.idl_basics |
| expected = [{'type': 'function', 'name': 'cb', |
| 'parameters':[{'name': 'arg', 'type': 'array', |
| 'items':{'$ref': 'MyType2'}}]}] |
| self.assertEquals(expected, getParams(schema, 'function12')) |
| |
| |
| def testArrayOfCallbacks(self): |
| schema = idl_schema.Load('test/idl_function_types.idl')[0] |
| expected = [{'type': 'array', 'name': 'callbacks', |
| 'items':{'type': 'function', 'name': 'MyCallback', |
| 'parameters':[{'type': 'integer', 'name': 'x'}]}}] |
| self.assertEquals(expected, getParams(schema, 'whatever')) |
| |
| def testLegalValues(self): |
| self.assertEquals({ |
| 'x': {'name': 'x', 'type': 'integer', 'enum': [1,2], |
| 'description': 'This comment tests "double-quotes".', |
| 'jsexterns': None}, |
| 'y': {'name': 'y', 'type': 'string'}, |
| 'z': {'name': 'z', 'type': 'string'}, |
| 'a': {'name': 'a', 'type': 'string'}, |
| 'b': {'name': 'b', 'type': 'string'}, |
| 'c': {'name': 'c', 'type': 'string'}}, |
| getType(self.idl_basics, 'MyType1')['properties']) |
| |
| def testIOThreadFunc(self): |
| schema = self.idl_basics |
| |
| func = getFunction(schema, 'function32') |
| self.assertTrue(func is not None) |
| self.assertTrue(func['forIOThread']) |
| |
| func = getFunction(schema, 'function1') |
| self.assertTrue(func is not None) |
| self.assertTrue('forIOThread' not in func) |
| |
| def testMemberOrdering(self): |
| self.assertEquals( |
| ['x', 'y', 'z', 'a', 'b', 'c'], |
| getType(self.idl_basics, 'MyType1')['properties'].keys()) |
| |
| def testEnum(self): |
| schema = self.idl_basics |
| expected = {'enum': [{'name': 'name1', 'description': 'comment1'}, |
| {'name': 'name2'}], |
| 'description': 'Enum description', |
| 'type': 'string', 'id': 'EnumType'} |
| self.assertEquals(expected, getType(schema, expected['id'])) |
| |
| expected = [{'name': 'type', '$ref': 'EnumType'}, |
| {'type': 'function', 'name': 'cb', |
| 'parameters':[{'name': 'type', '$ref': 'EnumType'}]}] |
| self.assertEquals(expected, getParams(schema, 'function13')) |
| |
| expected = [{'items': {'$ref': 'EnumType'}, 'name': 'types', |
| 'type': 'array'}] |
| self.assertEquals(expected, getParams(schema, 'function14')) |
| |
| def testScopedArguments(self): |
| schema = self.idl_basics |
| expected = [{'name': 'value', '$ref': 'idl_other_namespace.SomeType'}] |
| self.assertEquals(expected, getParams(schema, 'function20')) |
| |
| expected = [{'items': {'$ref': 'idl_other_namespace.SomeType'}, |
| 'name': 'values', |
| 'type': 'array'}] |
| self.assertEquals(expected, getParams(schema, 'function21')) |
| |
| expected = [{'name': 'value', |
| '$ref': 'idl_other_namespace.sub_namespace.AnotherType'}] |
| self.assertEquals(expected, getParams(schema, 'function22')) |
| |
| expected = [{'items': {'$ref': 'idl_other_namespace.sub_namespace.' |
| 'AnotherType'}, |
| 'name': 'values', |
| 'type': 'array'}] |
| self.assertEquals(expected, getParams(schema, 'function23')) |
| |
| def testNoCompile(self): |
| schema = self.idl_basics |
| func = getFunction(schema, 'function15') |
| self.assertTrue(func is not None) |
| self.assertTrue(func['nocompile']) |
| |
| def testNoDefine(self): |
| schema = self.idl_basics |
| func = getFunction(schema, 'function31') |
| self.assertTrue(func is not None) |
| self.assertTrue(func['nodefine']) |
| |
| def testNoDocOnEnum(self): |
| schema = self.idl_basics |
| enum_with_nodoc = getType(schema, 'EnumTypeWithNoDoc') |
| self.assertTrue(enum_with_nodoc is not None) |
| self.assertTrue(enum_with_nodoc['nodoc']) |
| |
| def testInternalNamespace(self): |
| idl_basics = self.idl_basics |
| self.assertEquals('idl_basics', idl_basics['namespace']) |
| self.assertTrue(idl_basics['internal']) |
| self.assertFalse(idl_basics['nodoc']) |
| |
| def testReturnTypes(self): |
| schema = self.idl_basics |
| self.assertEquals({'name': 'function24', 'type': 'integer'}, |
| getReturns(schema, 'function24')) |
| self.assertEquals({'name': 'function25', '$ref': 'MyType1', |
| 'optional': True}, |
| getReturns(schema, 'function25')) |
| self.assertEquals({'name': 'function26', 'type': 'array', |
| 'items': {'$ref': 'MyType1'}}, |
| getReturns(schema, 'function26')) |
| self.assertEquals({'name': 'function27', '$ref': 'EnumType', |
| 'optional': True}, |
| getReturns(schema, 'function27')) |
| self.assertEquals({'name': 'function28', 'type': 'array', |
| 'items': {'$ref': 'EnumType'}}, |
| getReturns(schema, 'function28')) |
| self.assertEquals({'name': 'function29', '$ref': |
| 'idl_other_namespace.SomeType', |
| 'optional': True}, |
| getReturns(schema, 'function29')) |
| self.assertEquals({'name': 'function30', 'type': 'array', |
| 'items': {'$ref': 'idl_other_namespace.SomeType'}}, |
| getReturns(schema, 'function30')) |
| |
| def testChromeOSPlatformsNamespace(self): |
| schema = idl_schema.Load('test/idl_namespace_chromeos.idl')[0] |
| self.assertEquals('idl_namespace_chromeos', schema['namespace']) |
| expected = ['chromeos'] |
| self.assertEquals(expected, schema['platforms']) |
| |
| def testAllPlatformsNamespace(self): |
| schema = idl_schema.Load('test/idl_namespace_all_platforms.idl')[0] |
| self.assertEquals('idl_namespace_all_platforms', schema['namespace']) |
| expected = ['chromeos', 'chromeos_touch', 'linux', 'mac', 'win'] |
| self.assertEquals(expected, schema['platforms']) |
| |
| def testNonSpecificPlatformsNamespace(self): |
| schema = idl_schema.Load('test/idl_namespace_non_specific_platforms.idl')[0] |
| self.assertEquals('idl_namespace_non_specific_platforms', |
| schema['namespace']) |
| expected = None |
| self.assertEquals(expected, schema['platforms']) |
| |
| def testSpecificImplementNamespace(self): |
| schema = idl_schema.Load('test/idl_namespace_specific_implement.idl')[0] |
| self.assertEquals('idl_namespace_specific_implement', |
| schema['namespace']) |
| expected = 'idl_namespace_specific_implement.idl' |
| self.assertEquals(expected, schema['compiler_options']['implemented_in']) |
| |
| def testSpecificImplementOnChromeOSNamespace(self): |
| schema = idl_schema.Load( |
| 'test/idl_namespace_specific_implement_chromeos.idl')[0] |
| self.assertEquals('idl_namespace_specific_implement_chromeos', |
| schema['namespace']) |
| expected_implemented_path = 'idl_namespace_specific_implement_chromeos.idl' |
| expected_platform = ['chromeos'] |
| self.assertEquals(expected_implemented_path, |
| schema['compiler_options']['implemented_in']) |
| self.assertEquals(expected_platform, schema['platforms']) |
| |
| def testCallbackComment(self): |
| schema = self.idl_basics |
| self.assertEquals('A comment on a callback.', |
| getParams(schema, 'function16')[0]['description']) |
| self.assertEquals( |
| 'A parameter.', |
| getParams(schema, 'function16')[0]['parameters'][0]['description']) |
| self.assertEquals( |
| 'Just a parameter comment, with no comment on the callback.', |
| getParams(schema, 'function17')[0]['parameters'][0]['description']) |
| self.assertEquals( |
| 'Override callback comment.', |
| getParams(schema, 'function18')[0]['description']) |
| |
| def testFunctionComment(self): |
| schema = self.idl_basics |
| func = getFunction(schema, 'function3') |
| self.assertEquals(('This comment should appear in the documentation, ' |
| 'despite occupying multiple lines.'), |
| func['description']) |
| self.assertEquals( |
| [{'description': ('So should this comment about the argument. ' |
| '<em>HTML</em> is fine too.'), |
| 'name': 'arg', |
| '$ref': 'MyType1'}], |
| func['parameters']) |
| func = getFunction(schema, 'function4') |
| self.assertEquals( |
| '<p>This tests if "double-quotes" are escaped correctly.</p>' |
| '<p>It also tests a comment with two newlines.</p>', |
| func['description']) |
| |
| def testReservedWords(self): |
| schema = idl_schema.Load('test/idl_reserved_words.idl')[0] |
| |
| foo_type = getType(schema, 'Foo') |
| self.assertEquals([{'name': 'float'}, {'name': 'DOMString'}], |
| foo_type['enum']) |
| |
| enum_type = getType(schema, 'enum') |
| self.assertEquals([{'name': 'callback'}, {'name': 'namespace'}], |
| enum_type['enum']) |
| |
| dictionary = getType(schema, 'dictionary') |
| self.assertEquals('integer', dictionary['properties']['long']['type']) |
| |
| mytype = getType(schema, 'MyType') |
| self.assertEquals('string', mytype['properties']['interface']['type']) |
| |
| params = getParams(schema, 'static') |
| self.assertEquals('Foo', params[0]['$ref']) |
| self.assertEquals('enum', params[1]['$ref']) |
| |
| def testObjectTypes(self): |
| schema = idl_schema.Load('test/idl_object_types.idl')[0] |
| |
| foo_type = getType(schema, 'FooType') |
| self.assertEquals('object', foo_type['type']) |
| self.assertEquals('integer', foo_type['properties']['x']['type']) |
| self.assertEquals('object', foo_type['properties']['y']['type']) |
| self.assertEquals( |
| 'any', |
| foo_type['properties']['y']['additionalProperties']['type']) |
| self.assertEquals('object', foo_type['properties']['z']['type']) |
| self.assertEquals( |
| 'any', |
| foo_type['properties']['z']['additionalProperties']['type']) |
| self.assertEquals('Window', foo_type['properties']['z']['isInstanceOf']) |
| |
| bar_type = getType(schema, 'BarType') |
| self.assertEquals('object', bar_type['type']) |
| self.assertEquals('any', bar_type['properties']['x']['type']) |
| |
| def testObjectTypesInFunctions(self): |
| schema = idl_schema.Load('test/idl_object_types.idl')[0] |
| |
| params = getParams(schema, 'objectFunction1') |
| self.assertEquals('object', params[0]['type']) |
| self.assertEquals('any', params[0]['additionalProperties']['type']) |
| self.assertEquals('ImageData', params[0]['isInstanceOf']) |
| |
| params = getParams(schema, 'objectFunction2') |
| self.assertEquals('any', params[0]['type']) |
| |
| def testObjectTypesWithOptionalFields(self): |
| schema = idl_schema.Load('test/idl_object_types.idl')[0] |
| |
| baz_type = getType(schema, 'BazType') |
| self.assertEquals(True, baz_type['properties']['x']['optional']) |
| self.assertEquals('integer', baz_type['properties']['x']['type']) |
| self.assertEquals(True, baz_type['properties']['foo']['optional']) |
| self.assertEquals('FooType', baz_type['properties']['foo']['$ref']) |
| |
| def testObjectTypesWithUnions(self): |
| schema = idl_schema.Load('test/idl_object_types.idl')[0] |
| |
| union_type = getType(schema, 'UnionType') |
| expected = { |
| 'type': 'object', |
| 'id': 'UnionType', |
| 'properties': { |
| 'x': { |
| 'name': 'x', |
| 'optional': True, |
| 'choices': [ |
| {'type': 'integer'}, |
| {'$ref': 'FooType'}, |
| ] |
| }, |
| 'y': { |
| 'name': 'y', |
| 'choices': [ |
| {'type': 'string'}, |
| {'type': 'object', |
| 'additionalProperties': {'type': 'any'}} |
| ] |
| }, |
| 'z': { |
| 'name': 'z', |
| 'choices': [ |
| {'type': 'object', 'isInstanceOf': 'ImageData', |
| 'additionalProperties': {'type': 'any'}}, |
| {'type': 'integer'} |
| ] |
| } |
| }, |
| } |
| |
| self.assertEquals(expected, union_type) |
| |
| def testUnionsWithModifiers(self): |
| schema = idl_schema.Load('test/idl_object_types.idl')[0] |
| |
| union_type = getType(schema, 'ModifiedUnionType') |
| expected = { |
| 'type': 'object', |
| 'id': 'ModifiedUnionType', |
| 'properties': { |
| 'x': { |
| 'name': 'x', |
| 'nodoc': True, |
| 'choices': [ |
| {'type': 'integer'}, |
| {'type': 'string'} |
| ] |
| } |
| } |
| } |
| |
| self.assertEquals(expected, union_type) |
| |
| def testUnionsWithFunctions(self): |
| schema = idl_schema.Load('test/idl_function_types.idl')[0] |
| |
| union_params = getParams(schema, 'union_params') |
| expected = [{ |
| 'name': 'x', |
| 'choices': [ |
| {'type': 'integer'}, |
| {'type': 'string'} |
| ] |
| }] |
| |
| self.assertEquals(expected, union_params) |
| |
| def testUnionsWithCallbacks(self): |
| schema = idl_schema.Load('test/idl_function_types.idl')[0] |
| |
| blah_params = getParams(schema, 'blah') |
| expected = [{ |
| 'type': 'function', 'name': 'callback', 'parameters': [{ |
| 'name': 'x', |
| 'choices': [ |
| {'type': 'integer'}, |
| {'type': 'string'} |
| ]} |
| ] |
| }] |
| self.assertEquals(expected, blah_params) |
| |
| badabish_params = getParams(schema, 'badabish') |
| expected = [{ |
| 'type': 'function', 'name': 'callback', 'parameters': [{ |
| 'name': 'x', 'optional': True, 'choices': [ |
| {'type': 'integer'}, |
| {'type': 'string'} |
| ] |
| }] |
| }] |
| |
| self.assertEquals(expected, badabish_params) |
| |
| def testProperties(self): |
| schema = idl_schema.Load('test/idl_properties.idl')[0] |
| self.assertEquals(OrderedDict([ |
| ('first', OrderedDict([ |
| ('description', 'Integer property.'), |
| ('jsexterns', None), |
| ('type', 'integer'), |
| ('value', 42), |
| ])), |
| ('second', OrderedDict([ |
| ('description', 'Double property.'), |
| ('jsexterns', None), |
| ('type', 'number'), |
| ('value', 42.1), |
| ])), |
| ('third', OrderedDict([ |
| ('description', 'String property.'), |
| ('jsexterns', None), |
| ('type', 'string'), |
| ('value', 'hello world'), |
| ])), |
| ('fourth', OrderedDict([ |
| ('description', 'Unvalued property.'), |
| ('jsexterns', None), |
| ('type', 'integer'), |
| ])), |
| ]), schema.get('properties')) |
| |
| |
| if __name__ == '__main__': |
| unittest.main() |
