test_webapp.py 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252
  1. # SPDX-License-Identifier: AGPL-3.0-or-later
  2. # pylint: disable=missing-module-docstring,disable=missing-class-docstring,invalid-name
  3. import json
  4. import babel
  5. from mock import Mock
  6. import searx.webapp
  7. import searx.search
  8. import searx.search.processors
  9. from searx.result_types._base import MainResult
  10. from searx.results import Timing
  11. from searx.preferences import Preferences
  12. from tests import SearxTestCase
  13. class ViewsTestCase(SearxTestCase): # pylint: disable=too-many-public-methods
  14. def setUp(self):
  15. super().setUp()
  16. # skip init function (no external HTTP request)
  17. def dummy(*args, **kwargs): # pylint: disable=unused-argument
  18. pass
  19. self.setattr4test(searx.search.processors, 'initialize_processor', dummy)
  20. # remove sha for the static file so the tests don't have to care about
  21. # the changing URLs
  22. self.setattr4test(searx.webapp, 'static_files', {})
  23. # set some defaults
  24. test_results = [
  25. MainResult(
  26. title="First Test",
  27. url="http://first.test.xyz",
  28. content="first test content",
  29. engine="startpage",
  30. ),
  31. MainResult(
  32. title="Second Test",
  33. url="http://second.test.xyz",
  34. content="second test content",
  35. engine="youtube",
  36. ),
  37. ]
  38. for r in test_results:
  39. r.normalize_result_fields()
  40. timings = [
  41. Timing(engine='startpage', total=0.8, load=0.7),
  42. Timing(engine='youtube', total=0.9, load=0.6),
  43. ]
  44. def search_mock(search_self, *args): # pylint: disable=unused-argument
  45. search_self.result_container = Mock(
  46. get_ordered_results=lambda: test_results,
  47. answers={},
  48. corrections=set(),
  49. suggestions=set(),
  50. infoboxes=[],
  51. unresponsive_engines=set(),
  52. results=test_results,
  53. number_of_results=3,
  54. results_length=lambda: len(test_results),
  55. get_timings=lambda: timings,
  56. redirect_url=None,
  57. engine_data={},
  58. )
  59. search_self.search_query.locale = babel.Locale.parse("en-US", sep='-')
  60. self.setattr4test(searx.search.Search, 'search', search_mock)
  61. original_preferences_get_value = Preferences.get_value
  62. def preferences_get_value(preferences_self, user_setting_name: str):
  63. if user_setting_name == 'theme':
  64. return 'simple'
  65. return original_preferences_get_value(preferences_self, user_setting_name)
  66. self.setattr4test(Preferences, 'get_value', preferences_get_value)
  67. # to see full diffs
  68. self.maxDiff = None # pylint: disable=invalid-name
  69. def test_index_empty(self):
  70. result = self.client.post('/')
  71. self.assertEqual(result.status_code, 200)
  72. self.assertIn(
  73. b'<div class="title"><h1>SearXNG</h1></div>',
  74. result.data,
  75. )
  76. def test_index_html_post(self):
  77. result = self.client.post('/', data={'q': 'test'})
  78. self.assertEqual(result.status_code, 308)
  79. self.assertEqual(result.location, '/search')
  80. def test_index_html_get(self):
  81. result = self.client.post('/?q=test')
  82. self.assertEqual(result.status_code, 308)
  83. self.assertEqual(result.location, '/search?q=test')
  84. def test_search_empty_html(self):
  85. result = self.client.post('/search', data={'q': ''})
  86. self.assertEqual(result.status_code, 200)
  87. self.assertIn(b'<div class="title"><h1>SearXNG</h1></div>', result.data)
  88. def test_search_empty_json(self):
  89. result = self.client.post('/search', data={'q': '', 'format': 'json'})
  90. self.assertEqual(result.status_code, 400)
  91. def test_search_empty_csv(self):
  92. result = self.client.post('/search', data={'q': '', 'format': 'csv'})
  93. self.assertEqual(result.status_code, 400)
  94. def test_search_empty_rss(self):
  95. result = self.client.post('/search', data={'q': '', 'format': 'rss'})
  96. self.assertEqual(result.status_code, 400)
  97. def test_search_html(self):
  98. result = self.client.post('/search', data={'q': 'test'})
  99. self.assertIn(
  100. b'<span class="url_o1"><span class="url_i1">http://second.test.xyz</span></span>',
  101. result.data,
  102. )
  103. self.assertIn(
  104. b'<p class="content">\n second <span class="highlight">test</span> ',
  105. result.data,
  106. )
  107. def test_index_json(self):
  108. result = self.client.post('/', data={'q': 'test', 'format': 'json'})
  109. self.assertEqual(result.status_code, 308)
  110. def test_search_json(self):
  111. result = self.client.post('/search', data={'q': 'test', 'format': 'json'})
  112. result_dict = json.loads(result.data.decode())
  113. self.assertEqual('test', result_dict['query'])
  114. self.assertEqual(len(result_dict['results']), 2)
  115. self.assertEqual(result_dict['results'][0]['content'], 'first test content')
  116. self.assertEqual(result_dict['results'][0]['url'], 'http://first.test.xyz')
  117. def test_index_csv(self):
  118. result = self.client.post('/', data={'q': 'test', 'format': 'csv'})
  119. self.assertEqual(result.status_code, 308)
  120. def test_search_csv(self):
  121. result = self.client.post('/search', data={'q': 'test', 'format': 'csv'})
  122. self.assertEqual(
  123. b'title,url,content,host,engine,score,type\r\n'
  124. b'First Test,http://first.test.xyz,first test content,first.test.xyz,startpage,,result\r\n' # noqa
  125. b'Second Test,http://second.test.xyz,second test content,second.test.xyz,youtube,,result\r\n', # noqa
  126. result.data,
  127. )
  128. def test_index_rss(self):
  129. result = self.client.post('/', data={'q': 'test', 'format': 'rss'})
  130. self.assertEqual(result.status_code, 308)
  131. def test_search_rss(self):
  132. result = self.client.post('/search', data={'q': 'test', 'format': 'rss'})
  133. self.assertIn(b'<description>Search results for "test" - SearXNG</description>', result.data)
  134. self.assertIn(b'<opensearch:totalResults>3</opensearch:totalResults>', result.data)
  135. self.assertIn(b'<title>First Test</title>', result.data)
  136. self.assertIn(b'<link>http://first.test.xyz</link>', result.data)
  137. self.assertIn(b'<description>first test content</description>', result.data)
  138. def test_redirect_about(self):
  139. result = self.client.get('/about')
  140. self.assertEqual(result.status_code, 302)
  141. def test_info_page(self):
  142. result = self.client.get('/info/en/search-syntax')
  143. self.assertEqual(result.status_code, 200)
  144. self.assertIn(b'<h1>Search syntax</h1>', result.data)
  145. def test_health(self):
  146. result = self.client.get('/healthz')
  147. self.assertEqual(result.status_code, 200)
  148. self.assertIn(b'OK', result.data)
  149. def test_preferences(self):
  150. result = self.client.get('/preferences')
  151. self.assertEqual(result.status_code, 200)
  152. self.assertIn(b'<form id="search_form" method="post" action="/preferences"', result.data)
  153. self.assertIn(b'<div id="categories_container">', result.data)
  154. self.assertIn(b'<legend id="pref_ui_locale">Interface language</legend>', result.data)
  155. def test_browser_locale(self):
  156. result = self.client.get('/preferences', headers={'Accept-Language': 'zh-tw;q=0.8'})
  157. self.assertEqual(result.status_code, 200)
  158. self.assertIn(
  159. b'<option value="zh-Hant-TW" selected="selected">',
  160. result.data,
  161. 'Interface locale ignored browser preference.',
  162. )
  163. self.assertIn(
  164. b'<option value="zh-Hant-TW" selected="selected">',
  165. result.data,
  166. 'Search language ignored browser preference.',
  167. )
  168. def test_browser_empty_locale(self):
  169. result = self.client.get('/preferences', headers={'Accept-Language': ''})
  170. self.assertEqual(result.status_code, 200)
  171. self.assertIn(
  172. b'<option value="en" selected="selected">', result.data, 'Interface locale ignored browser preference.'
  173. )
  174. def test_locale_occitan(self):
  175. result = self.client.get('/preferences?locale=oc')
  176. self.assertEqual(result.status_code, 200)
  177. self.assertIn(
  178. b'<option value="oc" selected="selected">', result.data, 'Interface locale ignored browser preference.'
  179. )
  180. def test_stats(self):
  181. result = self.client.get('/stats')
  182. self.assertEqual(result.status_code, 200)
  183. self.assertIn(b'<h1>Engine stats</h1>', result.data)
  184. def test_robots_txt(self):
  185. result = self.client.get('/robots.txt')
  186. self.assertEqual(result.status_code, 200)
  187. self.assertIn(b'Allow: /', result.data)
  188. def test_opensearch_xml(self):
  189. result = self.client.get('/opensearch.xml')
  190. self.assertEqual(result.status_code, 200)
  191. self.assertIn(
  192. b'<Description>SearXNG is a metasearch engine that respects your privacy.</Description>', result.data
  193. )
  194. def test_favicon(self):
  195. result = self.client.get('/favicon.ico')
  196. result.close()
  197. self.assertEqual(result.status_code, 200)
  198. def test_config(self):
  199. result = self.client.get('/config')
  200. self.assertEqual(result.status_code, 200)
  201. json_result = result.get_json()
  202. self.assertTrue(json_result)