first commit

tests/robot/__init__.py

@@ -0,0 +1,2 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+# pylint: disable=missing-module-docstring,disable=missing-class-docstring,invalid-name

tests/robot/__main__.py

@@ -0,0 +1,69 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+# pylint: disable=missing-module-docstring,disable=missing-class-docstring,invalid-name
+"""Shared testing code."""
+
+import sys
+import os
+import subprocess
+import traceback
+import pathlib
+import shutil
+
+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'
+
+        # 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())
+
+    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)))
+    print(f'{shutil.which("geckodriver")}')
+    print(f'{shutil.which("firefox")}')
+
+    for test in tests:
+        with Browser('firefox', headless=True, profile_preferences={'intl.accept_languages': 'en'}) as browser:
+            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 occurred: {0}'.format(traceback.format_exc()))
+        sys.exit(1)
+    finally:
+        test_layer.tearDown()
+
+
+if __name__ == '__main__':
+    main()

tests/robot/settings_robot.yml

@@ -0,0 +1,58 @@
+general:
+  debug: false
+  instance_name: "searx_test"
+
+brand:
+  git_url: https://github.com/searxng/searxng
+  git_branch: master
+  issue_url: https://github.com/searxng/searxng/issues
+  new_issue_url: https://github.com/searxng/searxng/issues/new
+  docs_url: https://docs.searxng.org
+  public_instances: https://searx.space
+  wiki_url: https://github.com/searxng/searxng/wiki
+
+search:
+  language: "all"
+
+server:
+  port: 11111
+  bind_address: 127.0.0.1
+  secret_key: "changedultrasecretkey"
+  base_url: false
+  http_protocol_version: "1.0"
+
+ui:
+  static_path: ""
+  templates_path: ""
+  default_theme: simple
+
+preferences:
+  lock: []
+
+outgoing:
+  request_timeout: 1.0  # seconds
+  useragent_suffix: ""
+
+categories_as_tabs:
+  general:
+  dummy:
+
+engines:
+  - name: general dummy
+    engine: dummy
+    categories: general
+    shortcut: gd
+
+  - name: dummy dummy
+    engine: dummy
+    categories: dummy
+    shortcut: dd
+
+doi_resolvers:
+  oadoi.org: 'https://oadoi.org/'
+  doi.org: 'https://doi.org/'
+  sci-hub.se: 'https://sci-hub.se/'
+  sci-hub.st: 'https://sci-hub.st/'
+  sci-hub.ru: 'https://sci-hub.ru/'
+
+default_doi_resolver: 'oadoi.org'

tests/robot/test_webapp.py

@@ -0,0 +1,77 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+# pylint: disable=missing-module-docstring,disable=missing-class-docstring,invalid-name
+
+from time import sleep
+
+url = "http://localhost:11111/"
+
+
+def test_index(browser):
+    # Visit URL
+    browser.visit(url)
+    assert browser.is_text_present('SearXNG')
+
+
+def test_404(browser):
+    # Visit URL
+    browser.visit(url + 'missing_link')
+    assert browser.is_text_present('Page not found')
+
+
+def test_about(browser):
+    browser.visit(url)
+    browser.links.find_by_text('SearXNG').click()
+    assert browser.is_text_present('Why use it?')
+
+
+def test_preferences(browser):
+    browser.visit(url)
+    browser.links.find_by_href('/preferences').click()
+    assert browser.is_text_present('Preferences')
+    assert browser.is_text_present('COOKIES')
+
+    assert browser.is_element_present_by_xpath('//label[@for="checkbox_dummy"]')
+
+
+def test_preferences_engine_select(browser):
+    browser.visit(url)
+    browser.links.find_by_href('/preferences').click()
+
+    assert browser.is_element_present_by_xpath('//label[@for="tab-engines"]')
+    browser.find_by_xpath('//label[@for="tab-engines"]').first.click()
+
+    assert not browser.find_by_xpath('//input[@id="engine_general_dummy__general"]').first.checked
+    browser.find_by_xpath('//label[@for="engine_general_dummy__general"]').first.check()
+    browser.find_by_xpath('//input[@type="submit"]').first.click()
+
+    # waiting for the redirect - without this the test is flaky..
+    sleep(1)
+
+    browser.visit(url)
+    browser.links.find_by_href('/preferences').click()
+    browser.find_by_xpath('//label[@for="tab-engines"]').first.click()
+
+    assert browser.find_by_xpath('//input[@id="engine_general_dummy__general"]').first.checked
+
+
+def test_preferences_locale(browser):
+    browser.visit(url)
+    browser.links.find_by_href('/preferences').click()
+
+    browser.find_by_xpath('//label[@for="tab-ui"]').first.click()
+    browser.select('locale', 'fr')
+    browser.find_by_xpath('//input[@type="submit"]').first.click()
+
+    # waiting for the redirect - without this the test is flaky..
+    sleep(1)
+
+    browser.visit(url)
+    browser.links.find_by_href('/preferences').click()
+    browser.is_text_present('Préférences')
+
+
+def test_search(browser):
+    browser.visit(url)
+    browser.fill('q', 'test search query')
+    browser.find_by_xpath('//button[@type="submit"]').first.click()
+    assert browser.is_text_present('No results were found')