def test_route_with_version_number_conflict(self):
# type: () -> None
api, ns = self._get_api()
# Add a conflicting route
route3 = ApiRoute('get_metadata_v2', 1, None)
route3.set_attributes(None, None, Void(), Int32(), Void(), {})
ns.add_route(route3)
backend = JavascriptClientBackend(
target_folder_path='output',
args=['files', '-c', 'DropboxBase'])
with self.assertRaises(RuntimeError) as cm:
backend.generate(api)
self.assertTrue(str(cm.exception).startswith(
'There is a name conflict between'))
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)])
l1 = List(a1)
s = String()
route = ApiRoute('test/route', 1, None)
route.set_attributes(None, None, l1, 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(l1, route_io)
self.assertNotIn(s, route_io)
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)])
l1 = List(a1)
s = String()
route = ApiRoute('test/route', 1, None)
route.set_attributes(None, None, l1, 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(l1, route_io)
self.assertNotIn(s, route_io)
def _get_api(self):
# type () -> Api
api = Api(version='0.1b1')
api.route_schema = Struct(u'Route', 'stone_cfg', None)
route1 = ApiRoute('get_metadata', 1, None)
route1.set_attributes(None, ':route:`get_metadata`', Void(), Void(), Void(), {})
route2 = ApiRoute('get_metadata', 2, None)
route2.set_attributes(None, ':route:`get_metadata:2`', Void(), Int32(), Void(), {})
ns = ApiNamespace('files')
ns.add_route(route1)
ns.add_route(route2)
api.namespaces[ns.name] = ns
return api, ns
def test_route_with_auth_mode1(self):
# type: () -> None
route1 = ApiRoute('get_metadata', 1, None)
route1.set_attributes(None, ':route:`get_metadata:2`', Void(), Void(), Void(),
{'auth': 'app'})
route2 = ApiRoute('get_metadata', 2, None)
route2.set_attributes(None, None, Void(), Int32(), Void(),
{'auth': 'user, app'})
ns = ApiNamespace('files')
ns.add_route(route1)
ns.add_route(route2)
result = self._evaluate_namespace_with_auth_mode(ns, 'user')
expected = textwrap.dedent('''\
# ------------------------------------------
# Routes in files namespace
def files_get_metadata_v2(self):
arg = None
r = self.request(
files.get_metadata_v2,
'files',
arg,
None,
)
return r
''')
self.assertEqual(result, expected)
def test_route_with_version_number_name_conflict(self):
# type: () -> None
route1 = ApiRoute('get_metadata', 2, None)
route1.set_attributes(None, None, Void(), Int32(), Void(), {})
route2 = ApiRoute('get_metadata_v2', 1, None)
route2.set_attributes(None, None, Void(), Void(), Void(), {})
ns = ApiNamespace('files')
ns.add_route(route1)
ns.add_route(route2)
with self.assertRaises(RuntimeError) as cm:
self._evaluate_namespace(ns)
self.assertEqual(
'There is a name conflict between {!r} and {!r}'.format(
route1, route2), str(cm.exception))
def test_route_with_auth_mode2(self):
# type: () -> None
route1 = ApiRoute('get_metadata', 1, None)
route1.set_attributes(None, ':route:`get_metadata:2`', Void(), Void(),
Void(), {'auth': 'user'})
route2 = ApiRoute('get_metadata', 2, None)
route2.set_attributes(None, None, Void(), Int32(), Void(),
{'auth': 'user, app'})
ns = ApiNamespace('files')
ns.add_route(route1)
ns.add_route(route2)
result = self._evaluate_namespace_with_auth_mode(ns, 'user')
expected = textwrap.dedent('''\
# ------------------------------------------
# Routes in files namespace
def files_get_metadata(self):
"""
:meth:`files_get_metadata_v2`
:rtype: None
"""
arg = None
r = self.request(
files.get_metadata,
'files',
arg,
None,
)
return None
def files_get_metadata_v2(self):
arg = None
r = self.request(
files.get_metadata_v2,
'files',
arg,
None,
)
return r
''')
self.assertEqual(result, expected)
def test_route_with_version_number(self):
# type: () -> None
route1 = ApiRoute('alpha/get_metadata', 1, None)
route1.set_attributes(None, None, Void(), Void(), Void(), {})
route2 = ApiRoute('alpha/get_metadata', 2, None)
route2.set_attributes(None, None, Void(), Int32(), Void(), {})
ns = ApiNamespace('files')
ns.add_route(route1)
ns.add_route(route2)
result = self._evaluate_namespace(ns)
expected = textwrap.dedent("""\
alpha_get_metadata = bb.Route(
'alpha/get_metadata',
1,
False,
bv.Void(),
bv.Void(),
bv.Void(),
{},
)
alpha_get_metadata_v2 = bb.Route(
'alpha/get_metadata',
2,
False,
bv.Void(),
bv.Int32(),
bv.Void(),
{},
)
ROUTES = {
'alpha/get_metadata': alpha_get_metadata,
'alpha/get_metadata:2': alpha_get_metadata_v2,
}
""")
self.assertEqual(result, expected)
def test_route_with_auth_mode3(self):
# type: () -> None
route1 = ApiRoute('get_metadata', 1, None)
route1.set_attributes(None, ':route:`get_metadata:2`', Void(), Void(),
Void(), {'auth': 'app'})
route2 = ApiRoute('get_metadata', 2, None)
route2.set_attributes(None, None, Void(), Int32(), Void(),
{'auth': 'app, team'})
ns = ApiNamespace('files')
ns.add_route(route1)
ns.add_route(route2)
result = self._evaluate_namespace_with_auth_mode(ns, 'user')
expected = textwrap.dedent('''\
# ------------------------------------------
# Routes in files namespace
''')
self.assertEqual(result, expected)
def test_route_with_version_number_name_conflict(self):
# type: () -> None
route1 = ApiRoute('alpha/get_metadata', 2, None)
route1.set_attributes(None, None, Void(), Int32(), Void(), {})
route2 = ApiRoute('alpha/get_metadata_v2', 1, None)
route2.set_attributes(None, None, Void(), Void(), Void(), {})
ns = ApiNamespace('files')
ns.add_route(route1)
ns.add_route(route2)
with self.assertRaises(RuntimeError) as cm:
self._evaluate_namespace(ns)
self.assertEqual(
'There is a name conflict between {!r} and {!r}'.format(route1, route2),
str(cm.exception))
def test_route_with_version_number(self):
# type: () -> None
route1 = ApiRoute('get_metadata', 1, None)
route1.set_attributes(None, None, Void(), Void(), Void(), {})
route2 = ApiRoute('get_metadata', 2, None)
route2.set_attributes(None, None, Void(), Int32(), Void(), {})
ns = ApiNamespace('files')
ns.add_route(route1)
ns.add_route(route2)
result = self._evaluate_namespace(ns)
expected = textwrap.dedent("""\
def files_get_metadata(self):
arg = None
r = self.request(
files.get_metadata,
'files',
arg,
None,
)
return None
def files_get_metadata_v2(self):
arg = None
r = self.request(
files.get_metadata_v2,
'files',
arg,
None,
)
return r
""")
self.assertEqual(result, expected)
def test_route_with_version_number(self):
# type: () -> None
route1 = ApiRoute('get_metadata', 1, None)
route1.set_attributes(None, ':route:`get_metadata:2`', Void(), Void(), Void(), {})
route2 = ApiRoute('get_metadata', 2, None)
route2.set_attributes(None, None, Void(), Int32(), Void(), {})
ns = ApiNamespace('files')
ns.add_route(route1)
ns.add_route(route2)
result = self._evaluate_namespace(ns)
expected = textwrap.dedent('''\
def files_get_metadata(self):
"""
:meth:`files_get_metadata_v2`
:rtype: None
"""
arg = None
r = self.request(
files.get_metadata,
'files',
arg,
None,
)
return None
def files_get_metadata_v2(self):
arg = None
r = self.request(
files.get_metadata_v2,
'files',
arg,
None,
)
return r
''')
self.assertEqual(result, expected)
def test_route_with_version_number(self):
# type: () -> None
route1 = ApiRoute('alpha/get_metadata', 1, None)
route1.set_attributes(None, None, Void(), Void(), Void(), {})
route2 = ApiRoute('alpha/get_metadata', 2, None)
route2.set_attributes(None, None, Void(), Int32(), Void(), {})
ns = ApiNamespace('files')
ns.add_route(route1)
ns.add_route(route2)
result = self._evaluate_namespace(ns)
expected = textwrap.dedent("""\
alpha_get_metadata = bb.Route(
'alpha/get_metadata',
1,
False,
bv.Void(),
bv.Void(),
bv.Void(),
{},
)
alpha_get_metadata_v2 = bb.Route(
'alpha/get_metadata',
2,
False,
bv.Void(),
bv.Int32(),
bv.Void(),
{},
)
ROUTES = {
'alpha/get_metadata': alpha_get_metadata,
'alpha/get_metadata:2': alpha_get_metadata_v2,
}
""")
self.assertEqual(result, expected)