test_rest_api.py 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360
  1. import json
  2. import os
  3. import unittest
  4. from flask import Flask
  5. from flask_testing import LiveServerTestCase
  6. from mock import mock
  7. from kalliope._version import version_str
  8. from kalliope.core import LIFOBuffer
  9. from kalliope.core.ConfigurationManager import BrainLoader
  10. from kalliope.core.ConfigurationManager import SettingLoader
  11. from kalliope.core.Models import Singleton
  12. from kalliope.core.RestAPI.FlaskAPI import FlaskAPI
  13. class TestRestAPI(LiveServerTestCase):
  14. def tearDown(self):
  15. Singleton._instances = {}
  16. # clean the lifo
  17. LIFOBuffer.lifo_list = list()
  18. def create_app(self):
  19. """
  20. executed once at the beginning of the test
  21. """
  22. # be sure that the singleton haven't been loaded before
  23. Singleton._instances = {}
  24. current_path = os.getcwd()
  25. if "/Tests" in os.getcwd():
  26. full_path_brain_to_test = current_path + os.sep + "brains/brain_test_api.yml"
  27. self.audio_file = "files/bonjour.wav"
  28. else:
  29. full_path_brain_to_test = current_path + os.sep + "Tests/brains/brain_test_api.yml"
  30. self.audio_file = "Tests/files/bonjour.wav"
  31. # rest api config
  32. sl = SettingLoader()
  33. sl.settings.rest_api.password_protected = False
  34. sl.settings.active = True
  35. sl.settings.port = 5000
  36. sl.settings.allowed_cors_origin = "*"
  37. sl.settings.default_synapse = None
  38. # prepare a test brain
  39. brain_to_test = full_path_brain_to_test
  40. brain_loader = BrainLoader(file_path=brain_to_test)
  41. brain = brain_loader.brain
  42. self.app = Flask(__name__)
  43. self.app.config['TESTING'] = True
  44. self.flask_api = FlaskAPI(self.app, port=5000, brain=brain)
  45. self.client = self.app.test_client()
  46. return self.flask_api.app
  47. def test_server_is_up_and_running(self):
  48. # response = urllib2.urlopen(self.get_server_url())
  49. response = self.client.get(self.get_server_url())
  50. self.assertEqual(response.status_code, 200)
  51. def test_get_main_page(self):
  52. url = self.get_server_url() + "/"
  53. response = self.client.get(url)
  54. expected_content = {
  55. "Kalliope version": "%s" % version_str
  56. }
  57. self.assertEqual(json.dumps(expected_content, sort_keys=True),
  58. json.dumps(json.loads(response.get_data().decode('utf-8')), sort_keys=True))
  59. def test_get_all_synapses(self):
  60. url = self.get_server_url()+"/synapses"
  61. response = self.client.get(url)
  62. expected_content = {
  63. "synapses": [
  64. {
  65. "name": "test",
  66. "neurons": [
  67. {
  68. "name": "say",
  69. "parameters": {
  70. "message": [
  71. "test message"
  72. ]
  73. }
  74. }
  75. ],
  76. "signals": [
  77. {
  78. "name": "order",
  79. "parameters": "test_order"
  80. }
  81. ]
  82. },
  83. {
  84. "name": "test2",
  85. "neurons": [
  86. {
  87. "name": "say",
  88. "parameters": {
  89. "message": [
  90. "test message"
  91. ]
  92. }
  93. }
  94. ],
  95. "signals": [
  96. {
  97. "name": "order",
  98. "parameters": "bonjour"
  99. }
  100. ]
  101. },
  102. {
  103. "name": "test4",
  104. "neurons": [
  105. {
  106. "name": "say",
  107. "parameters": {
  108. "message": [
  109. "test message {{parameter1}}"
  110. ]
  111. }
  112. }
  113. ],
  114. "signals": [
  115. {
  116. "name": "order",
  117. "parameters": "test_order_with_parameter"
  118. }
  119. ]
  120. },
  121. {
  122. "name": "test3",
  123. "neurons": [
  124. {
  125. "name": "say",
  126. "parameters": {
  127. "message": [
  128. "test message"
  129. ]
  130. }
  131. }
  132. ],
  133. "signals": [
  134. {
  135. "name": "order",
  136. "parameters": "test_order_3"
  137. }
  138. ]
  139. }
  140. ]
  141. }
  142. # a lot of char ti process
  143. self.maxDiff = None
  144. self.assertEqual(response.status_code, 200)
  145. self.assertEqual(json.dumps(expected_content, sort_keys=True),
  146. json.dumps(json.loads(response.get_data().decode('utf-8')), sort_keys=True))
  147. def test_get_one_synapse(self):
  148. url = self.get_server_url() + "/synapses/test"
  149. response = self.client.get(url)
  150. expected_content ={
  151. "synapses": {
  152. "name": "test",
  153. "neurons": [
  154. {
  155. "name": "say",
  156. "parameters": {
  157. "message": [
  158. "test message"
  159. ]
  160. }
  161. }
  162. ],
  163. "signals": [
  164. {
  165. "name": "order",
  166. "parameters": "test_order"
  167. }
  168. ]
  169. }
  170. }
  171. self.assertEqual(json.dumps(expected_content, sort_keys=True),
  172. json.dumps(json.loads(response.get_data().decode('utf-8')), sort_keys=True))
  173. def test_get_synapse_not_found(self):
  174. url = self.get_server_url() + "/synapses/test-none"
  175. result = self.client.get(url)
  176. expected_content = {
  177. "error": {
  178. "synapse name not found": "test-none"
  179. }
  180. }
  181. self.assertEqual(expected_content, json.loads(result.get_data().decode('utf-8')))
  182. self.assertEqual(result.status_code, 404)
  183. def test_run_synapse_by_name(self):
  184. url = self.get_server_url() + "/synapses/start/id/test"
  185. result = self.client.post(url)
  186. expected_content = {'status': 'complete',
  187. 'matched_synapses':
  188. [{'matched_order': None,
  189. 'neuron_module_list':
  190. [{'generated_message': 'test message', 'neuron_name': 'Say'}],
  191. 'synapse_name': 'test'}],
  192. 'user_order': None
  193. }
  194. self.assertEqual(json.dumps(expected_content, sort_keys=True),
  195. json.dumps(json.loads(result.get_data().decode('utf-8')), sort_keys=True))
  196. self.assertEqual(result.status_code, 201)
  197. # run a synapse by its name with parameter
  198. url = self.get_server_url() + "/synapses/start/id/test4"
  199. headers = {"Content-Type": "application/json"}
  200. data = {"parameters": {"parameter1": "replaced_value"}}
  201. result = self.client.post(url, headers=headers, data=json.dumps(data))
  202. expected_content = {
  203. "matched_synapses": [
  204. {
  205. "matched_order": None,
  206. "neuron_module_list": [
  207. {
  208. "generated_message": "test message replaced_value",
  209. "neuron_name": "Say"
  210. }
  211. ],
  212. "synapse_name": "test4"
  213. }
  214. ],
  215. "status": "complete",
  216. "user_order": None
  217. }
  218. self.assertEqual(json.dumps(expected_content, sort_keys=True),
  219. json.dumps(json.loads(result.get_data().decode('utf-8')), sort_keys=True))
  220. self.assertEqual(result.status_code, 201)
  221. def test_post_synapse_not_found(self):
  222. url = self.get_server_url() + "/synapses/start/id/test-none"
  223. result = self.client.post(url)
  224. expected_content = {
  225. "error": {
  226. "synapse name not found": "test-none"
  227. }
  228. }
  229. self.assertEqual(json.dumps(expected_content, sort_keys=True),
  230. json.dumps(json.loads(result.get_data().decode('utf-8')), sort_keys=True))
  231. self.assertEqual(result.status_code, 404)
  232. def test_run_synapse_with_order(self):
  233. url = self.get_server_url() + "/synapses/start/order"
  234. headers = {"Content-Type": "application/json"}
  235. data = {"order": "test_order"}
  236. result = self.client.post(url, headers=headers, data=json.dumps(data))
  237. expected_content = {'status': 'complete',
  238. 'matched_synapses':
  239. [
  240. {
  241. 'matched_order': "test_order",
  242. 'neuron_module_list':
  243. [
  244. {
  245. 'generated_message': 'test message', 'neuron_name': 'Say'
  246. }
  247. ],
  248. 'synapse_name': 'test'
  249. }
  250. ],
  251. 'user_order': "test_order"
  252. }
  253. self.assertEqual(json.dumps(expected_content, sort_keys=True),
  254. json.dumps(json.loads(result.get_data().decode('utf-8')), sort_keys=True))
  255. self.assertEqual(result.status_code, 201)
  256. def test_post_synapse_by_order_not_found(self):
  257. url = self.get_server_url() + "/synapses/start/order"
  258. data = {"order": "non existing order"}
  259. headers = {"Content-Type": "application/json"}
  260. result = self.client.post(url,
  261. headers=headers,
  262. data=json.dumps(data))
  263. expected_content = {'status': None, 'matched_synapses': [], 'user_order': u'non existing order'}
  264. self.assertEqual(json.dumps(expected_content, sort_keys=True),
  265. json.dumps(json.loads(result.get_data().decode('utf-8')), sort_keys=True))
  266. self.assertEqual(result.status_code, 201)
  267. # TODO this doesn't work on travis but works locally with python -m unittest discover
  268. # def test_post_synapse_by_audio(self):
  269. # url = self.get_server_url() + "/synapses/start/audio"
  270. # with open(os.path.join(self.audio_file), 'rb') as fp:
  271. # file = FileStorage(fp)
  272. # data = {
  273. # 'file': file
  274. # }
  275. # result = self.client.post(url, data=data, content_type='multipart/form-data')
  276. #
  277. # expected_content = {
  278. # "synapses": [
  279. # {
  280. # "name": "test2",
  281. # "neurons": [
  282. # {
  283. # "name": "say",
  284. # "parameters": {
  285. # "message": [
  286. # "test message"
  287. # ]
  288. # }
  289. # }
  290. # ],
  291. # "signals": [
  292. # {
  293. # "order": "bonjour"
  294. # }
  295. # ]
  296. # }
  297. # ]
  298. # }
  299. #
  300. # self.assertEqual(json.dumps(expected_content), json.dumps(json.loads(result.get_data())))
  301. # self.assertEqual(result.status_code, 201)
  302. def test_convert_to_wav(self):
  303. """
  304. Test the api function to convert incoming sound file to wave.
  305. """
  306. with mock.patch("os.system") as mock_os_system:
  307. # Scenario 1 : input wav file
  308. temp_file = "/tmp/kalliope/tempfile.wav" # tempfile.NamedTemporaryFile(suffix=".wav")
  309. result_file = FlaskAPI._convert_to_wav(temp_file)
  310. self.assertEqual(temp_file, result_file)
  311. mock_os_system.assert_not_called()
  312. # Scenario 2 : input not a wav file
  313. temp_file = "/tmp/kalliope/tempfile.amr" # tempfile.NamedTemporaryFile(suffix=".wav")
  314. expected_result = "/tmp/kalliope/tempfile.wav"
  315. result_file = FlaskAPI._convert_to_wav(temp_file)
  316. self.assertEqual(expected_result, result_file)
  317. mock_os_system.assert_called_once_with("avconv -y -i " + temp_file + " " + expected_result)
  318. if __name__ == '__main__':
  319. unittest.main()
  320. # suite = unittest.TestSuite()
  321. # suite.addTest(TestRestAPI("test_run_synapse_by_name"))
  322. # runner = unittest.TextTestRunner()
  323. # runner.run(suite)