def _make_namespace_with_a_union():
# type: (...) -> ApiNamespace
ns = ApiNamespace('ns_with_a_union')
u1 = Union(name='Union', namespace=ns, ast_node=None, closed=True)
u1.set_attributes(
doc=None,
fields=[
UnionField(name="first", doc=None, data_type=Void(),
ast_node=None),
UnionField(name="last", doc=None, data_type=Void(), ast_node=None),
],
)
ns.add_data_type(u1)
# A more interesting case with non-void variants.
shape_union = Union(name='Shape', namespace=ns, ast_node=None, closed=True)
shape_union.set_attributes(
doc=None,
fields=[
UnionField(name="point", doc=None, data_type=Void(),
ast_node=None),
UnionField(name="circle",
doc=None,
data_type=Float64(),
ast_node=None),
],
)
ns.add_data_type(shape_union)
return ns
def _make_namespace_with_empty_union():
# type: (...) -> ApiNamespace
ns = ApiNamespace('ns_with_empty_union')
union = Union(name='EmptyUnion', namespace=ns, ast_node=None, closed=True)
union.set_attributes(
doc=None,
fields=[],
)
ns.add_data_type(union)
return ns
def test_union(self):
ns = ApiNamespace('files')
update_parent_rev = Struct(
'UpdateParentRev',
None,
ns,
)
update_parent_rev.set_attributes(
"Overwrite existing file if the parent rev matches.",
[
StructField('parent_rev', String(),
'The revision to be updated.', None)
],
)
update_parent_rev._add_example(
AstExample(path=None,
lineno=None,
lexpos=None,
label='default',
text=None,
fields={
'parent_rev':
AstExampleField(None, None, None, 'parent_rev',
'xyz123')
}))
# test variants with only tags, as well as those with structs.
conflict = Union(
'WriteConflictPolicy',
None,
ns,
True,
)
conflict.set_attributes(
'Policy for managing write conflicts.',
[
UnionField('reject', Void(),
'On a write conflict, reject the new file.', None),
UnionField(
'overwrite', Void(),
'On a write conflict, overwrite the existing file.', None),
UnionField(
'update_if_matching_parent_rev', update_parent_rev,
'On a write conflict, overwrite the existing file.', None),
],
)
conflict._add_example(
AstExample(path=None,
lineno=None,
lexpos=None,
label='default',
text=None,
fields={
'update_if_matching_parent_rev':
AstExampleField(
None, None, None,
'update_if_matching_parent_rev',
AstExampleRef(None, None, None, 'default'))
}))
conflict._compute_examples()
# test that only null value is returned for an example of a Void type
self.assertEqual(conflict.get_examples()['reject'].value,
{'.tag': 'reject'})
# test that dict is returned for a tagged struct variant
self.assertEqual(conflict.get_examples()['default'].value, {
'.tag': 'update_if_matching_parent_rev',
'parent_rev': 'xyz123'
})
def test_no_preserve_aliases_from_api(self):
api = Api(version=None)
api.ensure_namespace('preserve_alias')
ns = api.namespaces['preserve_alias']
namespace_id = Alias('NamespaceId', ns, None)
namespace_id.data_type = String()
shared_folder_id = Alias('SharedFolderId', ns, None)
shared_folder_id.set_attributes(None, namespace_id)
path_root_id = Alias('PathRootId', ns, None)
path_root_id.set_attributes(None, shared_folder_id)
ns.add_alias(namespace_id)
ns.add_alias(shared_folder_id)
ns.add_alias(path_root_id)
test_struct = Struct('TestStruct', ns, None)
test_struct.set_attributes(
None, [StructField('field1', path_root_id, None, None)])
test_union = Union('TestUnion', ns, None, None)
test_union.set_attributes(
None, [UnionField('test', path_root_id, None, None)])
ns.add_data_type(test_struct)
ns.add_data_type(test_union)
struct_alias = Alias('StructAlias', ns, None)
struct_alias.set_attributes(None, test_struct)
ns.add_alias(struct_alias)
api = remove_aliases_from_api(api)
# Ensure namespace exists
self.assertEqual(len(api.namespaces), 1)
self.assertTrue('preserve_alias' in api.namespaces)
ns = api.namespaces['preserve_alias']
# Ensure aliases are gone
self.assertEqual(len(ns.aliases), 0)
data_types = {
data_type._name: data_type
for data_type in ns.data_types
}
# Ensure struct and union field aliases resolve to proper types
test_struct = data_types.get('TestStruct')
self.assertIsInstance(test_struct, Struct)
self.assertTrue(len(test_struct.fields), 1)
field = test_struct.fields[0]
self.assertEqual(field.name, 'field1')
self.assertIsInstance(field.data_type, String)
test_union = data_types['TestUnion']
self.assertTrue(len(test_union.fields), 1)
field = test_union.fields[0]
self.assertEqual(field.name, 'test')
self.assertIsInstance(field.data_type, String)
def test_no_preserve_aliases_from_api(self):
api = Api(version=None)
# Ensure imports come after 'preserve_alias' lexiographicaly
# to catch namespace ordering bugs
api.ensure_namespace('preserve_alias')
api.ensure_namespace('zzzz')
ns = api.namespaces['preserve_alias']
imported = api.namespaces['zzzz']
# Setup aliases
namespace_id = Alias('NamespaceId', ns, None)
namespace_id.data_type = String()
shared_folder_id = Alias('SharedFolderId', ns, None)
shared_folder_id.set_attributes(None, namespace_id)
path_root_id = Alias('PathRootId', ns, None)
path_root_id.set_attributes(None, shared_folder_id)
nullable_alias = Alias('NullableAlias', ns, None)
nullable_alias.set_attributes(None, Nullable(path_root_id))
foo_alias = Alias('FooAlias', None, None)
foo_alias.set_attributes(None, String())
bar_alias = Alias('BarAlias', None, None)
bar_alias.set_attributes(None, foo_alias)
ns.add_alias(namespace_id)
ns.add_alias(shared_folder_id)
ns.add_alias(path_root_id)
ns.add_alias(nullable_alias)
imported.add_alias(foo_alias)
imported.add_alias(bar_alias)
# Setup composite types
test_struct = Struct('TestStruct', ns, None)
test_struct.set_attributes(None, [
StructField('field_alias', path_root_id, None, None),
StructField('field_nullable_alias', nullable_alias, None, None),
StructField('field_list_of_alias', List(path_root_id), None, None)
])
test_union = Union('TestUnion', ns, None, None)
test_union.set_attributes(
None, [UnionField('test', path_root_id, None, None)])
dependent_struct = Struct('DependentStruct', ns, None)
dependent_struct.set_attributes(None, [
StructField('field_alias', imported.alias_by_name['BarAlias'],
None, None)
])
ns.add_data_type(test_struct)
ns.add_data_type(test_union)
ns.add_data_type(dependent_struct)
# Setup aliases on composite types
struct_alias = Alias('StructAlias', ns, None)
struct_alias.set_attributes(None, test_struct)
ns.add_alias(struct_alias)
api = remove_aliases_from_api(api)
# Ensure namespace exists
self.assertEqual(len(api.namespaces), 2)
self.assertTrue('preserve_alias' in api.namespaces)
self.assertTrue('zzzz' in api.namespaces)
ns = api.namespaces['preserve_alias']
imported = api.namespaces['zzzz']
# Ensure aliases are gone
self.assertEqual(len(ns.aliases), 0)
self.assertEqual(len(imported.aliases), 0)
data_types = {
data_type._name: data_type
for data_type in ns.data_types
}
# Ensure struct and union field aliases resolve to proper types
test_struct = data_types.get('TestStruct')
self.assertIsInstance(test_struct, Struct)
self.assertEqual(len(test_struct.fields), 3)
for field in test_struct.fields:
if field.name == 'field_list_of_alias':
self.assertIsInstance(field.data_type, List)
list_type = field.data_type.data_type
self.assertIsInstance(list_type, String)
elif field.name == 'field_nullable_alias':
field_type = field.data_type
self.assertIsInstance(field_type, Nullable)
self.assertIsInstance(field_type.data_type, String)
else:
self.assertIsInstance(field.data_type, String)
test_union = data_types['TestUnion']
self.assertTrue(len(test_union.fields), 1)
field = test_union.fields[0]
self.assertEqual(field.name, 'test')
self.assertIsInstance(field.data_type, String)
# Ensure struct using imported alias resolves properly
dependent_struct = data_types.get('DependentStruct')
self.assertIsInstance(dependent_struct, Struct)
self.assertEqual(len(dependent_struct.fields), 1)
field = dependent_struct.fields[0]
self.assertIsInstance(field.data_type, String)
def test_preserve_aliases_from_api(self):
api = Api(version=None)
# Ensure imports come after 'preserve_alias' lexiographicaly
# to catch namespace ordering bugs
api.ensure_namespace('preserve_alias')
api.ensure_namespace('zzzz')
ns = api.namespaces['preserve_alias']
imported = api.namespaces['zzzz']
namespace_id = Alias('NamespaceId', ns, None)
namespace_id.data_type = String()
shared_folder_id = Alias('SharedFolderId', ns, None)
shared_folder_id.set_attributes(None, namespace_id)
path_root_id = Alias('PathRootId', ns, None)
path_root_id.set_attributes(None, shared_folder_id)
foo_alias = Alias('FooAlias', None, None)
foo_alias.set_attributes(None, String())
bar_alias = Alias('BarAlias', None, None)
bar_alias.set_attributes(None, foo_alias)
ns.add_alias(namespace_id)
ns.add_alias(shared_folder_id)
ns.add_alias(path_root_id)
imported.add_alias(foo_alias)
imported.add_alias(bar_alias)
test_struct = Struct('TestStruct', ns, None)
test_struct.set_attributes(
None, [StructField('field1', path_root_id, None, None)])
test_union = Union('TestUnion', ns, None, None)
test_union.set_attributes(
None, [UnionField('test', path_root_id, None, None)])
dependent_struct = Struct('DependentStruct', ns, None)
dependent_struct.set_attributes(None, [
StructField('field_alias', imported.alias_by_name['BarAlias'],
None, None)
])
ns.add_data_type(test_struct)
ns.add_data_type(test_union)
ns.add_data_type(dependent_struct)
struct_alias = Alias('StructAlias', ns, None)
struct_alias.set_attributes(None, test_struct)
ns.add_alias(struct_alias)
# Ensure namespace exists
self.assertEqual(len(api.namespaces), 2)
self.assertTrue('preserve_alias' in api.namespaces)
self.assertTrue('zzzz' in api.namespaces)
ns = api.namespaces['preserve_alias']
imported = api.namespaces['zzzz']
# Ensure aliases exist
self.assertEqual(len(ns.aliases), 4)
self.assertEqual(len(imported.aliases), 2)
aliases = {alias._name: alias for alias in ns.aliases}
imported_aliases = {alias.name: alias for alias in imported.aliases}
data_types = {
data_type._name: data_type
for data_type in ns.data_types
}
# Ensure aliases are in the namespace
self.assertTrue('NamespaceId' in aliases)
self.assertTrue('SharedFolderId' in aliases)
self.assertTrue('PathRootId' in aliases)
self.assertTrue('StructAlias' in aliases)
self.assertTrue('FooAlias' in imported_aliases)
self.assertTrue('BarAlias' in imported_aliases)
# Ensure aliases resolve to proper types
self.assertIsInstance(aliases['NamespaceId'].data_type, String)
self.assertIsInstance(aliases['SharedFolderId'].data_type, Alias)
self.assertIsInstance(aliases['PathRootId'].data_type, Alias)
self.assertIsInstance(aliases['StructAlias'].data_type, Struct)
self.assertIsInstance(imported_aliases['FooAlias'].data_type, String)
self.assertIsInstance(imported_aliases['BarAlias'].data_type, Alias)
# Ensure struct and union field aliases resolve to proper types
self.assertIsInstance(data_types['TestStruct'], Struct)
test_struct = data_types.get('TestStruct')
dependent_struct = data_types.get('DependentStruct')
self.assertTrue(len(test_struct.fields), 1)
self.assertTrue(len(dependent_struct.fields), 1)
field = test_struct.fields[0]
self.assertEqual(field.name, 'field1')
self.assertIsInstance(field.data_type, Alias)
field = dependent_struct.fields[0]
self.assertEqual(field.name, 'field_alias')
self.assertIsInstance(field.data_type, Alias)
test_union = data_types['TestUnion']
self.assertTrue(len(test_union.fields), 1)
field = test_union.fields[0]
self.assertEqual(field.name, 'test')
self.assertIsInstance(field.data_type, Alias)
