mirror of
https://github.com/searxng/searxng.git
synced 2024-06-02 13:29:22 +00:00
86b4d2f2d0
We have been using a static type checker (pyright) for a long time, but its check was not yet a prerequisite for passing the quality gate. It was checked in the CI, but the error messages were only logged. As is always the case in life, with checks that you have to do but which have no consequences; you neglect them :-) We didn't activate the checks back then because we (even today) have too much monkey patching in our code (not only in the engines, httpx and others objects are also affected). We want to replace monkey patching with clear interfaces for a long time, the basis for this is increased typing and we can only achieve this if we make type checking an integral part of the quality gate. This PR activates the type check; in order to pass the check, a few typings were corrected in the code, but most type inconsistencies were deactivated via inline comments. This was particularly necessary in places where the code uses properties that stick to the objects (monkey patching). The sticking of properties only happens in a few places, but the access to these properties extends over the entire code, which is why there are many `# type: ignore` markers in the code ... which we will hopefully be able to remove again successively in the future. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
80 lines
2.3 KiB
Python
80 lines
2.3 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""Shared testing code."""
|
|
|
|
# pylint: disable=missing-function-docstring
|
|
|
|
import sys
|
|
import os
|
|
import subprocess
|
|
import traceback
|
|
import pathlib
|
|
|
|
from splinter import Browser
|
|
|
|
import tests as searx_tests
|
|
from tests.robot import test_webapp
|
|
|
|
|
|
class SearxRobotLayer:
|
|
"""Searx Robot Test Layer"""
|
|
|
|
def setUp(self):
|
|
os.setpgrp() # create new process group, become its leader
|
|
|
|
tests_path = pathlib.Path(searx_tests.__file__).resolve().parent
|
|
|
|
# get program paths
|
|
webapp = str(tests_path.parent / 'searx' / 'webapp.py')
|
|
exe = 'python'
|
|
|
|
# The Flask app is started by Flask.run(...), don't enable Flask's debug
|
|
# mode, the debugger from Flask will cause wired process model, where
|
|
# the server never dies. Further read:
|
|
#
|
|
# - debug mode: https://flask.palletsprojects.com/quickstart/#debug-mode
|
|
# - Flask.run(..): https://flask.palletsprojects.com/api/#flask.Flask.run
|
|
|
|
os.environ['SEARXNG_DEBUG'] = '0'
|
|
|
|
# set robot settings path
|
|
os.environ['SEARXNG_SETTINGS_PATH'] = str(tests_path / 'robot' / 'settings_robot.yml')
|
|
|
|
# run the server
|
|
self.server = subprocess.Popen( # pylint: disable=consider-using-with
|
|
[exe, webapp], stdout=subprocess.PIPE, stderr=subprocess.STDOUT
|
|
)
|
|
if hasattr(self.server.stdout, 'read1'):
|
|
print(self.server.stdout.read1(1024).decode()) # type: ignore
|
|
|
|
def tearDown(self):
|
|
os.kill(self.server.pid, 9)
|
|
# remove previously set environment variable
|
|
del os.environ['SEARXNG_SETTINGS_PATH']
|
|
|
|
|
|
def run_robot_tests(tests):
|
|
print('Running {0} tests'.format(len(tests)))
|
|
for test in tests:
|
|
with Browser(
|
|
'firefox',
|
|
headless=True,
|
|
profile_preferences={'intl.accept_languages': 'en'},
|
|
) as browser: # type: ignore
|
|
test(browser)
|
|
|
|
|
|
def main():
|
|
test_layer = SearxRobotLayer()
|
|
try:
|
|
test_layer.setUp()
|
|
run_robot_tests([getattr(test_webapp, x) for x in dir(test_webapp) if x.startswith('test_')])
|
|
except Exception: # pylint: disable=broad-except
|
|
print('Error occured: {0}'.format(traceback.format_exc()))
|
|
sys.exit(1)
|
|
finally:
|
|
test_layer.tearDown()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|