test_public_gateway_unit.py 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348
  1. import unittest
  2. from unittest.mock import MagicMock
  3. from constants import DEVICE_INVALID_MESSAGE
  4. from public_gateway import PublicGatewayApp
  5. class TestPublicGatewayApp(unittest.TestCase):
  6. def setUp(self):
  7. self.mock_session_store = MagicMock()
  8. self.mock_api_client = MagicMock()
  9. self.mock_api_client.list_enabled_tools.return_value = {
  10. 'code': 'MCP_0000',
  11. 'data': {
  12. 'tool_codes': [
  13. 'query_order',
  14. 'query_track',
  15. 'query_order_exact',
  16. 'list_order_filter_options',
  17. ],
  18. },
  19. }
  20. self.app = PublicGatewayApp(
  21. session_store=self.mock_session_store,
  22. api_client=self.mock_api_client,
  23. )
  24. def test_list_tools_returns_metadata(self):
  25. self.mock_session_store.get.return_value = {
  26. 'mcp_token': 'MT_token',
  27. }
  28. self.mock_api_client.list_enabled_tools.return_value = {
  29. 'code': 'MCP_0000',
  30. 'data': {
  31. 'tool_codes': [
  32. 'query_order',
  33. 'query_track',
  34. 'query_order_exact',
  35. 'list_order_filter_options',
  36. ],
  37. },
  38. }
  39. tools = self.app.list_tools('GWS_test')
  40. self.assertIsInstance(tools, list)
  41. self.assertGreater(len(tools), 0)
  42. tool_names = [tool['name'] for tool in tools]
  43. self.assertIn('query_order', tool_names)
  44. self.assertIn('query_track', tool_names)
  45. self.assertIn('query_order_exact', tool_names)
  46. self.assertIn('list_order_filter_options', tool_names)
  47. self.assertNotIn('bind_auth_code', tool_names)
  48. for tool in tools:
  49. self.assertIn('name', tool)
  50. self.assertIn('description', tool)
  51. self.assertIn('input_schema', tool)
  52. self.mock_session_store.touch_session.assert_called_once_with('GWS_test')
  53. def test_list_tools_intersects_enabled_codes_and_preserves_local_order(self):
  54. self.mock_session_store.get.return_value = {
  55. 'mcp_token': 'MT_token',
  56. }
  57. self.mock_api_client.list_enabled_tools.return_value = {
  58. 'code': 'MCP_0000',
  59. 'data': {
  60. 'tool_codes': [
  61. 'query_track',
  62. 'query_order_exact',
  63. 'unknown_tool',
  64. ],
  65. },
  66. }
  67. tools = self.app.list_tools('GWS_test')
  68. self.assertEqual(
  69. ['query_track', 'query_order_exact'],
  70. [tool['name'] for tool in tools],
  71. )
  72. self.mock_api_client.list_enabled_tools.assert_called_once()
  73. call = self.mock_api_client.list_enabled_tools.call_args
  74. self.assertEqual('MT_token', call.args[0])
  75. self.assertTrue(call.kwargs['request_id'].startswith('rq_'))
  76. def test_list_tools_rejects_missing_session_without_querying_registry(self):
  77. self.mock_session_store.get.return_value = None
  78. with self.assertRaisesRegex(RuntimeError, DEVICE_INVALID_MESSAGE):
  79. self.app.list_tools('GWS_missing')
  80. self.mock_api_client.list_enabled_tools.assert_not_called()
  81. self.mock_session_store.touch_session.assert_not_called()
  82. def test_list_tools_fails_closed_on_registry_error(self):
  83. self.mock_session_store.get.return_value = {'mcp_token': 'MT_token'}
  84. self.mock_api_client.list_enabled_tools.return_value = {
  85. 'code': 'MCP_9001',
  86. 'msg': 'registry unavailable',
  87. 'data': {},
  88. }
  89. with self.assertRaisesRegex(RuntimeError, 'registry unavailable'):
  90. self.app.list_tools('GWS_test')
  91. def test_enabled_tool_names_rejects_non_dict_response(self):
  92. with self.assertRaisesRegex(RuntimeError, 'invalid enabled tool response'):
  93. self.app._enabled_tool_names(None)
  94. def test_enabled_tool_names_rejects_missing_tool_code_list(self):
  95. response = {'code': 'MCP_0000', 'data': {}}
  96. with self.assertRaisesRegex(RuntimeError, 'invalid enabled tool response'):
  97. self.app._enabled_tool_names(response)
  98. def test_build_request_id_generates_id_when_empty(self):
  99. request_id = self.app.build_request_id('')
  100. self.assertTrue(request_id.startswith('rq_'))
  101. self.assertEqual(len(request_id), 3 + 16)
  102. def test_build_request_id_uses_provided_id(self):
  103. provided_id = 'custom_request_123'
  104. request_id = self.app.build_request_id(provided_id)
  105. self.assertEqual(request_id, provided_id)
  106. def test_call_tool_bind_auth_code_is_not_registered_in_public_mode(self):
  107. with self.assertRaises(KeyError) as context:
  108. self.app.call_tool('GWS_bind', 'bind_auth_code', {'auth_code': 'AC_test'})
  109. self.assertIn('tool not registered', str(context.exception))
  110. def test_call_tool_raises_on_unregistered_tool(self):
  111. with self.assertRaises(KeyError) as context:
  112. self.app.call_tool('GWS_test', 'nonexistent_tool', {})
  113. self.assertIn('tool not registered', str(context.exception))
  114. def test_call_tool_raises_when_session_not_found(self):
  115. self.mock_session_store.get.return_value = None
  116. with self.assertRaises(RuntimeError) as context:
  117. self.app.call_tool('GWS_nosession', 'query_order', {})
  118. self.assertEqual(str(context.exception), DEVICE_INVALID_MESSAGE)
  119. def test_call_tool_raises_when_no_token_in_session(self):
  120. self.mock_session_store.get.return_value = {
  121. 'admin_id': 123,
  122. 'company_id': 100
  123. }
  124. with self.assertRaises(RuntimeError) as context:
  125. self.app.call_tool('GWS_notoken', 'query_order', {})
  126. self.assertEqual(str(context.exception), DEVICE_INVALID_MESSAGE)
  127. def test_call_tool_success(self):
  128. gateway_session_id = 'GWS_valid'
  129. tool_name = 'query_order'
  130. arguments = {'order_no': 'ABC123'}
  131. self.mock_session_store.get.return_value = {
  132. 'mcp_token': 'MT_token123',
  133. 'admin_id': 456,
  134. 'company_id': 200
  135. }
  136. self.mock_api_client.call_tool.return_value = {
  137. 'code': '0',
  138. 'msg': 'success',
  139. 'data': {'order': 'details'}
  140. }
  141. self.mock_api_client.list_enabled_tools.return_value = {
  142. 'code': 'MCP_0000',
  143. 'data': {'tool_codes': ['query_order']},
  144. }
  145. result = self.app.call_tool(gateway_session_id, tool_name, arguments, 'rq_test')
  146. self.mock_api_client.call_tool.assert_called_once()
  147. call_args = self.mock_api_client.call_tool.call_args[1]
  148. self.assertEqual(call_args['token'], 'MT_token123')
  149. self.assertEqual(call_args['tool_code'], 'query_order')
  150. self.assertEqual(call_args['payload'], arguments)
  151. self.assertEqual(call_args['request_id'], 'rq_test')
  152. self.assertEqual(result['code'], '0')
  153. def test_base_tool_uses_base_api_client(self):
  154. base_client = MagicMock()
  155. app = PublicGatewayApp(
  156. session_store=self.mock_session_store,
  157. api_client=self.mock_api_client,
  158. base_api_client=base_client,
  159. )
  160. self.mock_session_store.get.return_value = {
  161. 'mcp_token': 'MT_token123',
  162. 'admin_id': 456,
  163. 'company_id': 200,
  164. }
  165. self.mock_api_client.list_enabled_tools.return_value = {
  166. 'code': 'MCP_0000',
  167. 'data': {'tool_codes': ['query_remote_address_list']},
  168. }
  169. base_client.call_tool.return_value = {'code': 'MCP_0000', 'data': {}}
  170. result = app.call_tool('GWS_valid', 'query_remote_address_list', {}, 'rq_base')
  171. base_client.call_tool.assert_called_once()
  172. self.mock_api_client.call_tool.assert_not_called()
  173. self.assertEqual('query_remote_address_list', base_client.call_tool.call_args.kwargs['tool_code'])
  174. self.assertEqual('MCP_0000', result['code'])
  175. def test_call_tool_succeeds_when_store_has_no_touch_method(self):
  176. class ReadOnlySessionStore:
  177. def get(self, gateway_session_id):
  178. return {
  179. 'mcp_token': 'MT_read_only',
  180. 'admin_id': 1,
  181. 'company_id': 2,
  182. }
  183. api_client = MagicMock()
  184. api_client.list_enabled_tools.return_value = {
  185. 'code': 'MCP_0000',
  186. 'data': {'tool_codes': ['query_order']},
  187. }
  188. api_client.call_tool.return_value = {'code': 'MCP_0000'}
  189. app = PublicGatewayApp(ReadOnlySessionStore(), api_client)
  190. result = app.call_tool(
  191. 'GWS_read_only',
  192. 'query_order',
  193. {'keyword': 'ORDER-1'},
  194. 'rq_read_only',
  195. )
  196. self.assertEqual('MCP_0000', result['code'])
  197. api_client.call_tool.assert_called_once()
  198. def test_list_tools_succeeds_when_store_has_no_touch_method(self):
  199. class ReadOnlySessionStore:
  200. def get(self, gateway_session_id):
  201. return {'mcp_token': 'MT_read_only'}
  202. api_client = MagicMock()
  203. api_client.list_enabled_tools.return_value = {
  204. 'code': 'MCP_0000',
  205. 'data': {'tool_codes': ['query_order']},
  206. }
  207. app = PublicGatewayApp(ReadOnlySessionStore(), api_client)
  208. tools = app.list_tools('GWS_read_only')
  209. self.assertEqual(['query_order'], [tool['name'] for tool in tools])
  210. def test_call_tool_rejects_dynamically_disabled_tool_before_forwarding(self):
  211. self.mock_session_store.get.return_value = {
  212. 'mcp_token': 'MT_token',
  213. 'admin_id': 1,
  214. 'company_id': 1,
  215. }
  216. self.mock_api_client.list_enabled_tools.return_value = {
  217. 'code': 'MCP_0000',
  218. 'data': {'tool_codes': ['query_track']},
  219. }
  220. with self.assertRaisesRegex(RuntimeError, 'tool disabled: query_order'):
  221. self.app.call_tool('GWS_test', 'query_order', {})
  222. self.mock_session_store.get.assert_called_once_with('GWS_test')
  223. self.mock_api_client.call_tool.assert_not_called()
  224. def test_call_tool_generates_request_id_when_not_provided(self):
  225. self.mock_session_store.get.return_value = {
  226. 'mcp_token': 'MT_token',
  227. 'admin_id': 1,
  228. 'company_id': 1
  229. }
  230. self.mock_api_client.call_tool.return_value = {'code': '0'}
  231. self.app.call_tool('GWS_test', 'query_order', {}, '')
  232. call_args = self.mock_api_client.call_tool.call_args[1]
  233. self.assertTrue(call_args['request_id'].startswith('rq_'))
  234. def test_call_tool_uses_provided_request_id(self):
  235. self.mock_session_store.get.return_value = {
  236. 'mcp_token': 'MT_token',
  237. 'admin_id': 1,
  238. 'company_id': 1
  239. }
  240. self.mock_api_client.call_tool.return_value = {'code': '0'}
  241. custom_request_id = 'rq_custom_123'
  242. self.app.call_tool('GWS_test', 'query_order', {}, custom_request_id)
  243. call_args = self.mock_api_client.call_tool.call_args[1]
  244. self.assertEqual(call_args['request_id'], custom_request_id)
  245. def test_call_tool_forwards_client_ip_to_api_client(self):
  246. self.mock_session_store.get.return_value = {
  247. 'mcp_token': 'MT_token',
  248. 'admin_id': 1,
  249. 'company_id': 1
  250. }
  251. self.mock_api_client.call_tool.return_value = {'code': '0'}
  252. self.app.call_tool('GWS_test', 'query_order', {}, 'rq_client_ip', client_ip='203.0.113.9')
  253. call_args = self.mock_api_client.call_tool.call_args[1]
  254. self.assertEqual(call_args['client_ip'], '203.0.113.9')
  255. def test_call_tool_logs_error_on_exception(self):
  256. gateway_session_id = 'GWS_error_test'
  257. tool_name = 'query_order'
  258. self.mock_session_store.get.return_value = {
  259. 'mcp_token': 'MT_token',
  260. 'admin_id': 999,
  261. 'company_id': 888
  262. }
  263. self.mock_api_client.call_tool.side_effect = RuntimeError('API connection failed')
  264. with self.assertLogs('public_gateway', level='ERROR') as logs:
  265. with self.assertRaises(RuntimeError) as context:
  266. self.app.call_tool(gateway_session_id, tool_name, {}, 'rq_err')
  267. self.assertIn('API connection failed', str(context.exception))
  268. self.assertNotIn('API connection failed', logs.output[0])
  269. record = logs.records[0]
  270. self.assertEqual('rq_err', record.request_id)
  271. self.assertEqual('query_order', record.tool_code)
  272. self.assertEqual('MCP_9001', record.response_code)
  273. self.assertEqual('UNEXPECTED_EXCEPTION', record.diagnostic_reason)
  274. self.assertEqual('RuntimeError', record.exception_class)
  275. if __name__ == '__main__':
  276. unittest.main()