mirror of
				https://github.com/searxng/searxng.git
				synced 2025-10-30 18:22:31 -04:00 
			
		
		
		
	Another trip into the hell of dependencies: docutils tends to put major changes
in minor patches: the executables have been renamed / e.g.
     rst2html.py --> rts2html
so we have to use docutils at least from version 0.21.2, but this version of
docutils is only supported by myst-parser from version 3.0.1 on.
Additionally, docutils decided to drop python 3.8 in version 0.21 [1]
Further, linuxdoc needed an update to cope with docutils 0.21 [2]
[1] https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-21-2024-04-09
[2] https://github.com/return42/linuxdoc/pull/36
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
		
	
			
		
			
				
	
	
		
			119 lines
		
	
	
		
			3.4 KiB
		
	
	
	
		
			Bash
		
	
	
		
			Executable File
		
	
	
	
	
			
		
		
	
	
			119 lines
		
	
	
		
			3.4 KiB
		
	
	
	
		
			Bash
		
	
	
		
			Executable File
		
	
	
	
	
| #!/usr/bin/env bash
 | |
| # SPDX-License-Identifier: AGPL-3.0-or-later
 | |
| 
 | |
| test.help(){
 | |
|     cat <<EOF
 | |
| test.:
 | |
|   yamllint  : lint YAML files (YAMLLINT_FILES)
 | |
|   pylint    : lint ./searx, ./searxng_extra and ./tests
 | |
|   pyright   : static type check of python sources
 | |
|   black     : check black code format
 | |
|   unit      : run unit tests
 | |
|   coverage  : run unit tests with coverage
 | |
|   robot     : run robot test
 | |
|   rst       : test .rst files incl. README.rst
 | |
|   clean     : clean intermediate test stuff
 | |
| EOF
 | |
| }
 | |
| 
 | |
| test.yamllint() {
 | |
|     build_msg TEST "[yamllint] \$YAMLLINT_FILES"
 | |
|     pyenv.cmd yamllint --strict --format parsable "${YAMLLINT_FILES[@]}"
 | |
|     dump_return $?
 | |
| }
 | |
| 
 | |
| test.pylint() {
 | |
|     # shellcheck disable=SC2086
 | |
|     (   set -e
 | |
|         pyenv.activate
 | |
|         PYLINT_OPTIONS="--rcfile .pylintrc"
 | |
| 
 | |
|         build_msg TEST "[pylint] ./searx/engines"
 | |
|         pylint ${PYLINT_OPTIONS} ${PYLINT_VERBOSE} \
 | |
|             --additional-builtins="traits,supported_languages,language_aliases,logger,categories" \
 | |
|             searx/engines
 | |
| 
 | |
|         build_msg TEST "[pylint] ./searx ./searxng_extra ./tests"
 | |
|         pylint ${PYLINT_OPTIONS} ${PYLINT_VERBOSE} \
 | |
| 	    --ignore=searx/engines \
 | |
| 	    searx searx/searxng.msg \
 | |
|             searxng_extra searxng_extra/docs_prebuild \
 | |
|             tests
 | |
|     )
 | |
|     dump_return $?
 | |
| }
 | |
| 
 | |
| test.pyright() {
 | |
|     build_msg TEST "[pyright] static type check of python sources"
 | |
|     node.env.dev
 | |
|     # We run Pyright in the virtual environment because Pyright
 | |
|     # executes "python" to determine the Python version.
 | |
|     build_msg TEST "[pyright] suppress warnings related to intentional monkey patching"
 | |
|     pyenv.cmd npx --no-install pyright -p pyrightconfig-ci.json \
 | |
|         | grep -v ".py$" \
 | |
|         | grep -v '/engines/.*.py.* - warning: "logger" is not defined'\
 | |
|         | grep -v '/plugins/.*.py.* - error: "logger" is not defined'\
 | |
|         | grep -v '/engines/.*.py.* - warning: "supported_languages" is not defined' \
 | |
|         | grep -v '/engines/.*.py.* - warning: "language_aliases" is not defined' \
 | |
|         | grep -v '/engines/.*.py.* - warning: "categories" is not defined'
 | |
|     dump_return $?
 | |
| }
 | |
| 
 | |
| test.black() {
 | |
|     build_msg TEST "[black] \$BLACK_TARGETS"
 | |
|     pyenv.cmd black --check --diff "${BLACK_OPTIONS[@]}" "${BLACK_TARGETS[@]}"
 | |
|     dump_return $?
 | |
| }
 | |
| 
 | |
| test.unit() {
 | |
|     build_msg TEST 'tests/unit'
 | |
|     pyenv.cmd python -m nose2 -s tests/unit
 | |
|     dump_return $?
 | |
| }
 | |
| 
 | |
| test.coverage() {
 | |
|     build_msg TEST 'unit test coverage'
 | |
|     (   set -e
 | |
|         pyenv.activate
 | |
|         python -m nose2 -C --log-capture --with-coverage --coverage searx -s tests/unit
 | |
|         coverage report
 | |
|         coverage html
 | |
|     )
 | |
|     dump_return $?
 | |
| }
 | |
| 
 | |
| test.robot() {
 | |
|     build_msg TEST 'robot'
 | |
|     gecko.driver
 | |
|     PYTHONPATH=. pyenv.cmd python -m tests.robot
 | |
|     dump_return $?
 | |
| }
 | |
| 
 | |
| 
 | |
| test.rst() {
 | |
|     build_msg TEST "[reST markup] ${RST_FILES[*]}"
 | |
| 
 | |
|     local rst2html=rst2html
 | |
|     if [ "3.8" == "$(python -c 'import sys; print(".".join([str(x) for x in sys.version_info[:2]]))')" ]; then
 | |
|        rst2html=rst2html.py
 | |
|     fi
 | |
| 
 | |
|     for rst in "${RST_FILES[@]}"; do
 | |
|         pyenv.cmd "${rst2html}" --halt error "$rst" > /dev/null || die 42 "fix issue in $rst"
 | |
|     done
 | |
| }
 | |
| 
 | |
| test.pybabel() {
 | |
|     TEST_BABEL_FOLDER="build/test/pybabel"
 | |
|     build_msg TEST "[extract messages] pybabel"
 | |
|     mkdir -p "${TEST_BABEL_FOLDER}"
 | |
|     pyenv.cmd pybabel extract -F babel.cfg -o "${TEST_BABEL_FOLDER}/messages.pot" searx
 | |
| }
 | |
| 
 | |
| test.clean() {
 | |
|     build_msg CLEAN  "test stuff"
 | |
|     rm -rf geckodriver.log .coverage coverage/
 | |
|     dump_return $?
 | |
| }
 | |
| 
 |