def _make_namespace_with_nested_types(): # type: (...) -> ApiNamespace ns = ApiNamespace('ns_w_nested_types') struct = Struct(name='NestedTypes', namespace=ns, token=None) struct.set_attributes( doc=None, fields=[ StructField( name='NullableList', data_type=Nullable( List(UInt64()) ), doc=None, token=None, ), StructField( name='ListOfNullables', data_type=List( Nullable(UInt64()) ), doc=None, token=None, ) ] ) ns.add_data_type(struct) return ns
def _make_namespace_with_empty_union(): # type: (...) -> ApiNamespace ns = ApiNamespace('ns_with_empty_union') union = Union(name='EmptyUnion', namespace=ns, token=None, closed=True) union.set_attributes( doc=None, fields=[], ) ns.add_data_type(union) return ns
def _make_namespace_with_alias(): # type: (...) -> ApiNamespace ns = ApiNamespace('ns_with_alias') struct1 = Struct(name='Struct1', namespace=ns, token=None) struct1.set_attributes(None, [StructField('f1', Boolean(), None, None)]) ns.add_data_type(struct1) alias = Alias(name='AliasToStruct1', namespace=ns, token=None) alias.set_attributes(doc=None, data_type=struct1) ns.add_alias(alias) return ns
def _make_namespace_with_a_union(): # type: (...) -> ApiNamespace ns = ApiNamespace('ns_with_a_union') u1 = Union(name='Union', namespace=ns, token=None, closed=True) u1.set_attributes( doc=None, fields=[ UnionField( name="first", doc=None, data_type=Void(), token=None ), UnionField( name="last", doc=None, data_type=Void(), token=None ), ], ) ns.add_data_type(u1) # A more interesting case with non-void variants. shape_union = Union(name='Shape', namespace=ns, token=None, closed=True) shape_union.set_attributes( doc=None, fields=[ UnionField( name="point", doc=None, data_type=Void(), token=None ), UnionField( name="circle", doc=None, data_type=Float64(), token=None ), ], ) ns.add_data_type(shape_union) return ns
def test_api_namespace(self): ns = ApiNamespace('files') a1 = Struct('A1', None, ns) a1.set_attributes(None, [StructField('f1', Boolean(), None, None)]) a2 = Struct('A2', None, ns) a2.set_attributes(None, [StructField('f2', Boolean(), None, None)]) l = List(a1) s = String() route = ApiRoute('test/route', None) route.set_attributes(None, None, l, a2, s, None) ns.add_route(route) # Test that only user-defined types are returned. route_io = ns.get_route_io_data_types() self.assertIn(a1, route_io) self.assertIn(a2, route_io) self.assertNotIn(l, route_io) self.assertNotIn(s, route_io)
def _make_namespace_with_many_structs(): # type: (...) -> ApiNamespace ns = ApiNamespace('ns_with_many_structs') struct1 = Struct(name='Struct1', namespace=ns, token=None) struct1.set_attributes(None, [StructField('f1', Boolean(), None, None)]) ns.add_data_type(struct1) struct2 = Struct(name='Struct2', namespace=ns, token=None) struct2.set_attributes( doc=None, fields=[ StructField('f2', List(UInt64()), None, None), StructField('f3', Timestamp(ISO_8601_FORMAT), None, None) ] ) ns.add_data_type(struct2) return ns
def _make_namespace_with_a_union(): # type: (...) -> ApiNamespace ns = ApiNamespace('ns_with_a_union') u1 = Union(name='Union', namespace=ns, token=None, closed=True) u1.set_attributes( doc=None, fields=[ UnionField(name="first", doc=None, data_type=Void(), token=None), UnionField(name="last", doc=None, data_type=Void(), token=None), ], ) ns.add_data_type(u1) # A more interesting case with non-void variants. shape_union = Union(name='Shape', namespace=ns, token=None, closed=True) shape_union.set_attributes( doc=None, fields=[ UnionField(name="point", doc=None, data_type=Void(), token=None), UnionField(name="circle", doc=None, data_type=Float64(), token=None), ], ) ns.add_data_type(shape_union) return ns
def _make_namespace_with_many_structs(): # type: (...) -> ApiNamespace ns = ApiNamespace('ns_with_many_structs') struct1 = Struct(name='Struct1', namespace=ns, token=None) struct1.set_attributes(None, [StructField('f1', Boolean(), None, None)]) ns.add_data_type(struct1) struct2 = Struct(name='Struct2', namespace=ns, token=None) struct2.set_attributes(doc=None, fields=[ StructField('f2', List(UInt64()), None, None), StructField('f3', Timestamp(ISO_8601_FORMAT), None, None) ]) ns.add_data_type(struct2) 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( StoneExample(path=None, lineno=None, lexpos=None, label='default', text=None, fields={ 'parent_rev': StoneExampleField(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( StoneExample(path=None, lineno=None, lexpos=None, label='default', text=None, fields={ 'update_if_matching_parent_rev': StoneExampleField( None, None, None, 'update_if_matching_parent_rev', StoneExampleRef(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_struct(self): ns = ApiNamespace('test') quota_info = Struct( 'QuotaInfo', None, ns, ) quota_info.set_attributes( "Information about a user's space quota.", [ StructField('quota', UInt64(), 'Total amount of space.', None), ], ) # add an example that doesn't fit the definition of a struct with self.assertRaises(InvalidSpec) as cm: quota_info._add_example( StoneExample(path=None, lineno=None, lexpos=None, label='default', text=None, fields={ 'bad_field': StoneExampleField(None, None, None, 'bad_field', 'xyz123') })) self.assertIn('has unknown field', cm.exception.msg) quota_info._add_example( StoneExample(path=None, lineno=None, lexpos=None, label='default', text=None, fields={ 'quota': StoneExampleField(None, None, None, 'quota', 64000) })) # set null for a required field with self.assertRaises(InvalidSpec) as cm: quota_info._add_example( StoneExample(path=None, lineno=None, lexpos=None, label='null', text=None, fields={ 'quota': StoneExampleField(None, None, None, 'quota', None) })) self.assertEqual( "Bad example for field 'quota': null is not a valid integer", cm.exception.msg) self.assertTrue(quota_info._has_example('default')) quota_info.nullable = True # test for structs within structs account_info = Struct( 'AccountInfo', None, ns, ) account_info.set_attributes( "Information about an account.", [ StructField('account_id', String(), 'Unique identifier for account.', None), StructField('quota_info', quota_info, 'Quota', None) ], ) account_info._add_example( StoneExample(path=None, lineno=None, lexpos=None, label='default', text=None, fields={ 'account_id': StoneExampleField(None, None, None, 'account_id', 'xyz123'), 'quota_info': StoneExampleField( None, None, None, 'quota_info', StoneExampleRef(None, None, None, 'default')) })) account_info._compute_examples() # ensure that an example for quota_info is propagated up self.assertIn('quota_info', account_info.get_examples()['default'].value)