mirror of
https://github.com/searxng/searxng
synced 2024-10-30 21:20:28 +00:00
fd814aac86
This patch was inspired by the discussion around PR-2882 [2]. The goals of this
patch are:
1. Convert plugin searx.plugin.limiter to normal code [1]
2. isolation of botdetection from the limiter [2]
3. searx/{tools => botdetection}/config.py and drop searx.tools
4. in URL /config, 'limiter.enabled' is true only if the limiter is really
enabled (Redis is available).
This patch moves all the code that belongs to botdetection into namespace
searx.botdetection and code that belongs to limiter is placed in namespace
searx.limiter.
Tthe limiter used to be a plugin at some point botdetection was added, it was
not a plugin. The modularization of these two components was long overdue.
With the clear modularization, the documentation could then also be organized
according to the architecture.
[1] https://github.com/searxng/searxng/pull/2882
[2] https://github.com/searxng/searxng/pull/2882#issuecomment-1741716891
To test:
- check the app works without the limiter, check `/config`
- check the app works with the limiter and with the token, check `/config`
- make docs.live .. and read
- http://0.0.0.0:8000/admin/searx.limiter.html
- http://0.0.0.0:8000/src/searx.botdetection.html#botdetection
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
164 lines
6.1 KiB
Python
164 lines
6.1 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
from searx import (
|
|
plugins,
|
|
limiter,
|
|
botdetection,
|
|
)
|
|
|
|
from mock import Mock
|
|
from tests import SearxTestCase
|
|
|
|
|
|
def get_search_mock(query, **kwargs):
|
|
return Mock(search_query=Mock(query=query, **kwargs), result_container=Mock(answers=dict()))
|
|
|
|
|
|
class PluginMock:
|
|
default_on = False
|
|
name = 'Default plugin'
|
|
description = 'Default plugin description'
|
|
|
|
|
|
class PluginStoreTest(SearxTestCase):
|
|
def test_PluginStore_init(self):
|
|
store = plugins.PluginStore()
|
|
self.assertTrue(isinstance(store.plugins, list) and len(store.plugins) == 0)
|
|
|
|
def test_PluginStore_register(self):
|
|
store = plugins.PluginStore()
|
|
testplugin = PluginMock()
|
|
store.register(testplugin)
|
|
|
|
self.assertTrue(len(store.plugins) == 1)
|
|
|
|
def test_PluginStore_call(self):
|
|
store = plugins.PluginStore()
|
|
testplugin = PluginMock()
|
|
store.register(testplugin)
|
|
setattr(testplugin, 'asdf', Mock())
|
|
request = Mock()
|
|
store.call([], 'asdf', request, Mock())
|
|
|
|
self.assertFalse(testplugin.asdf.called) # pylint: disable=E1101
|
|
|
|
store.call([testplugin], 'asdf', request, Mock())
|
|
self.assertTrue(testplugin.asdf.called) # pylint: disable=E1101
|
|
|
|
|
|
class SelfIPTest(SearxTestCase):
|
|
def test_PluginStore_init(self):
|
|
plugin = plugins.load_and_initialize_plugin('searx.plugins.self_info', False, (None, {}))
|
|
store = plugins.PluginStore()
|
|
store.register(plugin)
|
|
cfg = limiter.get_cfg()
|
|
botdetection.init(cfg, None)
|
|
|
|
self.assertTrue(len(store.plugins) == 1)
|
|
|
|
# IP test
|
|
request = Mock()
|
|
request.remote_addr = '127.0.0.1'
|
|
request.headers = {'X-Forwarded-For': '1.2.3.4, 127.0.0.1', 'X-Real-IP': '127.0.0.1'}
|
|
search = get_search_mock(
|
|
query='ip',
|
|
pageno=1,
|
|
)
|
|
store.call(store.plugins, 'post_search', request, search)
|
|
self.assertTrue('127.0.0.1' in search.result_container.answers["ip"]["answer"])
|
|
|
|
search = get_search_mock(query='ip', pageno=2)
|
|
store.call(store.plugins, 'post_search', request, search)
|
|
self.assertFalse('ip' in search.result_container.answers)
|
|
|
|
# User agent test
|
|
request = Mock(user_agent='Mock')
|
|
|
|
search = get_search_mock(query='user-agent', pageno=1)
|
|
store.call(store.plugins, 'post_search', request, search)
|
|
self.assertTrue('Mock' in search.result_container.answers["user-agent"]["answer"])
|
|
|
|
search = get_search_mock(query='user-agent', pageno=2)
|
|
store.call(store.plugins, 'post_search', request, search)
|
|
self.assertFalse('user-agent' in search.result_container.answers)
|
|
|
|
search = get_search_mock(query='user-agent', pageno=1)
|
|
store.call(store.plugins, 'post_search', request, search)
|
|
self.assertTrue('Mock' in search.result_container.answers["user-agent"]["answer"])
|
|
|
|
search = get_search_mock(query='user-agent', pageno=2)
|
|
store.call(store.plugins, 'post_search', request, search)
|
|
self.assertFalse('user-agent' in search.result_container.answers)
|
|
|
|
search = get_search_mock(query='What is my User-Agent?', pageno=1)
|
|
store.call(store.plugins, 'post_search', request, search)
|
|
self.assertTrue('Mock' in search.result_container.answers["user-agent"]["answer"])
|
|
|
|
search = get_search_mock(query='What is my User-Agent?', pageno=2)
|
|
store.call(store.plugins, 'post_search', request, search)
|
|
self.assertFalse('user-agent' in search.result_container.answers)
|
|
|
|
|
|
class HashPluginTest(SearxTestCase):
|
|
def test_PluginStore_init(self):
|
|
store = plugins.PluginStore()
|
|
plugin = plugins.load_and_initialize_plugin('searx.plugins.hash_plugin', False, (None, {}))
|
|
store.register(plugin)
|
|
|
|
self.assertTrue(len(store.plugins) == 1)
|
|
|
|
request = Mock(remote_addr='127.0.0.1')
|
|
|
|
# MD5
|
|
search = get_search_mock(query='md5 test', pageno=1)
|
|
store.call(store.plugins, 'post_search', request, search)
|
|
self.assertTrue(
|
|
'md5 hash digest: 098f6bcd4621d373cade4e832627b4f6' in search.result_container.answers['hash']['answer']
|
|
)
|
|
|
|
search = get_search_mock(query=b'md5 test', pageno=2)
|
|
store.call(store.plugins, 'post_search', request, search)
|
|
self.assertFalse('hash' in search.result_container.answers)
|
|
|
|
# SHA1
|
|
search = get_search_mock(query='sha1 test', pageno=1)
|
|
store.call(store.plugins, 'post_search', request, search)
|
|
self.assertTrue(
|
|
'sha1 hash digest: a94a8fe5ccb19ba61c4c0873d391e9879'
|
|
'82fbbd3' in search.result_container.answers['hash']['answer']
|
|
)
|
|
|
|
# SHA224
|
|
search = get_search_mock(query='sha224 test', pageno=1)
|
|
store.call(store.plugins, 'post_search', request, search)
|
|
self.assertTrue(
|
|
'sha224 hash digest: 90a3ed9e32b2aaf4c61c410eb9254261'
|
|
'19e1a9dc53d4286ade99a809' in search.result_container.answers['hash']['answer']
|
|
)
|
|
|
|
# SHA256
|
|
search = get_search_mock(query='sha256 test', pageno=1)
|
|
store.call(store.plugins, 'post_search', request, search)
|
|
self.assertTrue(
|
|
'sha256 hash digest: 9f86d081884c7d659a2feaa0c55ad015a'
|
|
'3bf4f1b2b0b822cd15d6c15b0f00a08' in search.result_container.answers['hash']['answer']
|
|
)
|
|
|
|
# SHA384
|
|
search = get_search_mock(query='sha384 test', pageno=1)
|
|
store.call(store.plugins, 'post_search', request, search)
|
|
self.assertTrue(
|
|
'sha384 hash digest: 768412320f7b0aa5812fce428dc4706b3c'
|
|
'ae50e02a64caa16a782249bfe8efc4b7ef1ccb126255d196047dfedf1'
|
|
'7a0a9' in search.result_container.answers['hash']['answer']
|
|
)
|
|
|
|
# SHA512
|
|
search = get_search_mock(query='sha512 test', pageno=1)
|
|
store.call(store.plugins, 'post_search', request, search)
|
|
self.assertTrue(
|
|
'sha512 hash digest: ee26b0dd4af7e749aa1a8ee3c10ae9923f6'
|
|
'18980772e473f8819a5d4940e0db27ac185f8a0e1d5f84f88bc887fd67b143732c304cc5'
|
|
'fa9ad8e6f57f50028a8ff' in search.result_container.answers['hash']['answer']
|
|
)
|