searxng/tests/unit/test_webapp.py

260 lines
9.6 KiB
Python
Raw Normal View History

2014-01-31 06:08:24 +00:00
# -*- coding: utf-8 -*-
2014-02-05 19:24:31 +00:00
import json
from urllib.parse import ParseResult
from mock import Mock
2022-01-17 07:06:31 +00:00
from searx.results import Timing
import searx.search.processors
from searx.search import Search
2022-05-07 13:11:05 +00:00
from searx.preferences import Preferences
from tests import SearxTestCase
2014-01-31 06:08:24 +00:00
class ViewsTestCase(SearxTestCase):
def setUp(self):
# skip init function (no external HTTP request)
def dummy(*args, **kwargs):
pass
self.setattr4test(searx.search.processors, 'initialize_processor', dummy)
from searx import webapp # pylint disable=import-outside-toplevel
2014-01-31 06:08:24 +00:00
webapp.app.config['TESTING'] = True # to get better error messages
self.app = webapp.app.test_client()
# remove sha for the static file
# so the tests don't have to care about the changing URLs
for k in webapp.static_files:
webapp.static_files[k] = None
2014-01-31 06:08:24 +00:00
# set some defaults
test_results = [
2014-01-31 06:08:24 +00:00
{
'content': 'first test content',
'title': 'First Test',
'url': 'http://first.test.xyz',
'engines': ['youtube', 'startpage'],
'engine': 'startpage',
'parsed_url': ParseResult(
scheme='http', netloc='first.test.xyz', path='/', params='', query='', fragment=''
),
'template': 'default.html',
},
{
2014-01-31 06:08:24 +00:00
'content': 'second test content',
'title': 'Second Test',
'url': 'http://second.test.xyz',
'engines': ['youtube', 'startpage'],
'engine': 'youtube',
'parsed_url': ParseResult(
scheme='http', netloc='second.test.xyz', path='/', params='', query='', fragment=''
),
'template': 'default.html',
2014-01-31 06:08:24 +00:00
},
]
2022-01-17 07:06:31 +00:00
timings = [
Timing(engine='startpage', total=0.8, load=0.7),
Timing(engine='youtube', total=0.9, load=0.6),
]
2015-03-11 20:23:28 +00:00
def search_mock(search_self, *args):
search_self.result_container = Mock(
get_ordered_results=lambda: test_results,
answers=dict(),
corrections=set(),
suggestions=set(),
infoboxes=[],
unresponsive_engines=set(),
results=test_results,
results_number=lambda: 3,
results_length=lambda: len(test_results),
get_timings=lambda: timings,
redirect_url=None,
engine_data={},
)
2015-03-11 20:23:28 +00:00
self.setattr4test(Search, 'search', search_mock)
2015-03-11 20:23:28 +00:00
2022-05-07 13:11:05 +00:00
original_preferences_get_value = Preferences.get_value
2022-05-07 13:11:05 +00:00
def preferences_get_value(preferences_self, user_setting_name: str):
if user_setting_name == 'theme':
return 'simple'
return original_preferences_get_value(preferences_self, user_setting_name)
self.setattr4test(Preferences, 'get_value', preferences_get_value)
2014-01-31 06:08:24 +00:00
self.maxDiff = None # to see full diffs
def test_index_empty(self):
result = self.app.post('/')
self.assertEqual(result.status_code, 200)
self.assertIn(
b'<div class="title"><h1>SearXNG</h1></div>',
result.data,
)
2014-01-31 06:08:24 +00:00
def test_index_html_post(self):
2014-01-31 06:08:24 +00:00
result = self.app.post('/', data={'q': 'test'})
self.assertEqual(result.status_code, 308)
self.assertEqual(result.location, '/search')
def test_index_html_get(self):
result = self.app.post('/?q=test')
self.assertEqual(result.status_code, 308)
self.assertEqual(result.location, '/search?q=test')
def test_search_empty_html(self):
result = self.app.post('/search', data={'q': ''})
self.assertEqual(result.status_code, 200)
self.assertIn(b'<div class="title"><h1>SearXNG</h1></div>', result.data)
def test_search_empty_json(self):
result = self.app.post('/search', data={'q': '', 'format': 'json'})
self.assertEqual(result.status_code, 400)
def test_search_empty_csv(self):
result = self.app.post('/search', data={'q': '', 'format': 'csv'})
self.assertEqual(result.status_code, 400)
def test_search_empty_rss(self):
result = self.app.post('/search', data={'q': '', 'format': 'rss'})
self.assertEqual(result.status_code, 400)
def test_search_html(self):
result = self.app.post('/search', data={'q': 'test'})
2014-01-31 06:08:24 +00:00
self.assertIn(
b'<span class="url_o1"><span class="url_i1">http://second.test.xyz</span></span>',
result.data,
2014-01-31 06:08:24 +00:00
)
self.assertIn(
b'<p class="content">\n second <span class="highlight">test</span> ',
result.data,
2014-01-31 06:08:24 +00:00
)
2015-03-11 20:23:28 +00:00
def test_index_json(self):
2014-01-31 06:08:24 +00:00
result = self.app.post('/', data={'q': 'test', 'format': 'json'})
self.assertEqual(result.status_code, 308)
2014-01-31 06:08:24 +00:00
def test_search_json(self):
result = self.app.post('/search', data={'q': 'test', 'format': 'json'})
result_dict = json.loads(result.data.decode())
2014-01-31 06:08:24 +00:00
self.assertEqual('test', result_dict['query'])
self.assertEqual(len(result_dict['results']), 2)
2016-11-30 17:43:03 +00:00
self.assertEqual(result_dict['results'][0]['content'], 'first test content')
self.assertEqual(result_dict['results'][0]['url'], 'http://first.test.xyz')
2014-01-31 06:08:24 +00:00
2015-03-11 20:23:28 +00:00
def test_index_csv(self):
2014-01-31 06:08:24 +00:00
result = self.app.post('/', data={'q': 'test', 'format': 'csv'})
self.assertEqual(result.status_code, 308)
def test_search_csv(self):
result = self.app.post('/search', data={'q': 'test', 'format': 'csv'})
2014-01-31 06:08:24 +00:00
self.assertEqual(
2020-03-13 00:05:02 +00:00
b'title,url,content,host,engine,score,type\r\n'
b'First Test,http://first.test.xyz,first test content,first.test.xyz,startpage,,result\r\n' # noqa
b'Second Test,http://second.test.xyz,second test content,second.test.xyz,youtube,,result\r\n', # noqa
result.data,
2014-01-31 06:08:24 +00:00
)
2015-03-11 20:23:28 +00:00
def test_index_rss(self):
2014-01-31 06:08:24 +00:00
result = self.app.post('/', data={'q': 'test', 'format': 'rss'})
self.assertEqual(result.status_code, 308)
2020-11-15 09:26:15 +00:00
def test_search_rss(self):
result = self.app.post('/search', data={'q': 'test', 'format': 'rss'})
2014-01-31 06:08:24 +00:00
self.assertIn(b'<description>Search results for "test" - searx</description>', result.data)
2014-01-31 06:08:24 +00:00
self.assertIn(b'<opensearch:totalResults>3</opensearch:totalResults>', result.data)
2014-01-31 06:08:24 +00:00
self.assertIn(b'<title>First Test</title>', result.data)
2014-01-31 06:08:24 +00:00
self.assertIn(b'<link>http://first.test.xyz</link>', result.data)
2014-01-31 06:08:24 +00:00
self.assertIn(b'<description>first test content</description>', result.data)
2014-01-31 06:08:24 +00:00
def test_redirect_about(self):
result = self.app.get('/about')
self.assertEqual(result.status_code, 302)
def test_info_page(self):
result = self.app.get('/info/en/search-syntax')
2014-01-31 06:08:24 +00:00
self.assertEqual(result.status_code, 200)
self.assertIn(b'<h1>Search syntax</h1>', result.data)
2014-01-31 06:08:24 +00:00
2021-10-02 15:00:37 +00:00
def test_health(self):
result = self.app.get('/healthz')
self.assertEqual(result.status_code, 200)
self.assertIn(b'OK', result.data)
2014-01-31 06:08:24 +00:00
def test_preferences(self):
result = self.app.get('/preferences')
self.assertEqual(result.status_code, 200)
self.assertIn(b'<form id="search_form" method="post" action="/preferences"', result.data)
self.assertIn(
b'<input type="checkbox" id="checkbox_general" name="category_general" checked="checked"/>', result.data
)
2022-02-05 07:56:42 +00:00
self.assertIn(b'<legend id="pref_locale">Interface language</legend>', result.data)
2014-01-31 06:08:24 +00:00
def test_browser_locale(self):
result = self.app.get('/preferences', headers={'Accept-Language': 'zh-tw;q=0.8'})
self.assertEqual(result.status_code, 200)
self.assertIn(
b'<option value="zh-Hant-TW" selected="selected">',
result.data,
'Interface locale ignored browser preference.',
)
self.assertIn(
b'<option value="zh-Hant-TW" selected="selected">',
result.data,
'Search language ignored browser preference.',
)
def test_brower_empty_locale(self):
result = self.app.get('/preferences', headers={'Accept-Language': ''})
self.assertEqual(result.status_code, 200)
self.assertIn(
b'<option value="en" selected="selected">', result.data, 'Interface locale ignored browser preference.'
)
def test_locale_occitan(self):
result = self.app.get('/preferences?locale=oc')
self.assertEqual(result.status_code, 200)
self.assertIn(
b'<option value="oc" selected="selected">', result.data, 'Interface locale ignored browser preference.'
)
2014-01-31 06:08:24 +00:00
def test_stats(self):
result = self.app.get('/stats')
self.assertEqual(result.status_code, 200)
self.assertIn(b'<h1>Engine stats</h1>', result.data)
2014-01-31 06:08:24 +00:00
def test_robots_txt(self):
result = self.app.get('/robots.txt')
self.assertEqual(result.status_code, 200)
2016-11-30 17:43:03 +00:00
self.assertIn(b'Allow: /', result.data)
2014-01-31 06:08:24 +00:00
def test_opensearch_xml(self):
result = self.app.get('/opensearch.xml')
self.assertEqual(result.status_code, 200)
[fix] improve OpenSearch description Some HTTP-Clients do have issues with the ``opensearch.xml`` from SearXNG (related [1][2]) while other OpenSearch descriptions[3] (e.g. from qwant) work flawles. Inspired by the OpenSearch description from qwant and with informations from the specification[4] the ``opensearch.xml`` has been *improved*. - convert `<Url>` methods from lower case to upper case (`POST`|`GET`) - add `<moz:SearchForm>` and `xmlns:moz="http://www.mozilla.org/2006/browser/search/"` - add `<Query role="example" searchTerms="SearXNG" />` [4] OpenSearch description documents should include at least one Query element of `role="example"` that is expected to return search results. Search clients may use this example query to validate that the search engine is working properly. - modified `<LongName>` to SearXNG - modified `<Description>` the word 'hackable' scares uninitiated users and was removed - add the `type="image/png"` to `<Image>` Test can be done by:: make run Visit http://127.0.0.1:8888/ and add the search engine to your WEB-Browser / test with different WEB-Browser from desktop and Smartphones (are there any iOS user here, please test on Safari and Chrome). [1] https://app.element.io/#/room/#searxng:matrix.org/$xN_abdKhNqUlgXRBrb_9F3pqOxnSzGQ1TG0s0G9hQVw [2] https://github.com/searxng/searxng/issues/431 [3] https://developer.mozilla.org/en-US/docs/Web/OpenSearch [4] https://github.com/dewitt/opensearch/blob/master/opensearch-1-1-draft-6.md#the-query-element Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-08-11 16:37:12 +00:00
self.assertIn(
b'<Description>SearXNG is a metasearch engine that respects your privacy.</Description>', result.data
)
2014-01-31 06:08:24 +00:00
def test_favicon(self):
result = self.app.get('/favicon.ico')
self.assertEqual(result.status_code, 200)
2019-05-18 10:58:05 +00:00
def test_config(self):
result = self.app.get('/config')
self.assertEqual(result.status_code, 200)
json_result = result.get_json()
self.assertTrue(json_result)