[tests] JavaScript: extract searchindex.js-format test fixtures.

.gitignore

@@ -30,6 +30,7 @@ doc/_build/
 doc/locale/
 tests/.coverage
 tests/build/
+tests/js/roots/*/build
 tests/test-server.lock
 utils/regression_test.js
 

.ruff.toml

@@ -9,6 +9,7 @@ exclude = [
     ".tox",
     ".venv",
     "tests/roots/*",
+    "tests/js/roots/*",
     "build/*",
     "doc/_build/*",
     "sphinx/search/*",

CHANGES.rst

@@ -104,6 +104,7 @@ Testing
 
 * pytest: report the result of ``test_run_epubcheck`` as ``skipped`` instead of
   ``success`` when Java and/or the ``epubcheck.jar`` code are not available.
+* karma: refactor HTML search tests to use fixtures generated by Sphinx.
 
 Release 7.2.6 (released Sep 13, 2023)
 =====================================

karma.conf.js

@@ -19,7 +19,8 @@ module.exports = function(config) {
       'sphinx/themes/basic/static/doctools.js',
       'sphinx/themes/basic/static/searchtools.js',
       'sphinx/themes/basic/static/sphinx_highlight.js',
-      'tests/js/*.js'
+      'tests/js/*.js',
+      { pattern: 'tests/js/fixtures/*.js', included: false, served: true }
     ],
 
 

tests/js/roots/cpp/conf.py

@@ -0,0 +1,14 @@
+from sphinx.search import SearchLanguage, languages
+
+
+class NullStemmedLanguage(SearchLanguage):
+
+    def split(self, input: str) -> list[str]:
+        return input.split()
+
+    def stem(self, word: str) -> str:
+        return word.lower()
+
+
+languages["xx"] = NullStemmedLanguage
+html_search_language = "xx"

tests/js/roots/cpp/index.rst

@@ -0,0 +1,5 @@
+This is a sample C++ project used to generate a search engine index fixture.
+
+.. cpp:class:: public Sphinx
+
+   The description of Sphinx class.

tests/js/roots/multiterm/index.rst

@@ -0,0 +1,4 @@
+Main Page
+=========
+
+Welcome to the... main page!

tests/js/searchtools.js

@@ -1,16 +1,19 @@
 describe('Basic html theme search', function() {
 
+  function loadFixture(name) {
+      req = new XMLHttpRequest();
+      req.open("GET", `base/tests/js/fixtures/${name}`, false);
+      req.send(null);
+      return req.responseText;
+  }
+
   describe('terms search', function() {
 
     it('should find "C++" when in index', function() {
-      index = {
-        docnames:["index"],
-        filenames:["index.rst"],
-        terms:{'c++':0},
-        titles:["<no title>"],
-        titleterms:{}
-      }
-      Search.setIndex(index);
+      searchindex = loadFixture("index.cpp.js");
+      eval(searchindex);
+      index = Search._index;
+
       searchterms = ['c++'];
       excluded = [];
       terms = index.terms;
@@ -28,17 +31,9 @@ describe('Basic html theme search', function() {
     });
 
     it('should be able to search for multiple terms', function() {
-      index = {
-        alltitles: {
-          'Main Page': [[0, 'main-page']],
-        },
-        docnames:["index"],
-        filenames:["index.rst"],
-        terms:{main:0, page:0},
-        titles:["Main Page"],
-        titleterms:{ main:0, page:0 }
-      }
-      Search.setIndex(index);
+      searchindex = loadFixture("index.multiterm.js");
+      eval(searchindex);
+      index = Search._index;
 
       searchterms = ['main', 'page'];
       excluded = [];