HTML search: add test coverage on partial-matching

sphinx-doc · Aug 11, 2024 · 7274236 · 7274236
1 parent c3c8a23
commit 7274236
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 2 deletions.
diff --git a/tests/js/fixtures/partial/searchindex.js b/tests/js/fixtures/partial/searchindex.js
diff --git a/tests/js/roots/partial/index.rst b/tests/js/roots/partial/index.rst
@@ -1,7 +1,7 @@
 sphinx_utils module
 ===================
 
-Partial (also known as "prefix") matches on document titles should be possible
+Partial matches on document titles and document terms should both be possible
 using the JavaScript search functionality included when HTML documentation
 projects are built.
 

diff --git a/tests/js/searchtools.spec.js b/tests/js/searchtools.spec.js
@@ -73,6 +73,24 @@ describe('Basic html theme search', function() {
       expect(Search.performTermsSearch(searchterms, excluded)).toEqual(hits);
     });
 
+    it('should partially-match within "possible" when in term index', function() {
+      eval(loadFixture("partial/searchindex.js"));
+
+      [_searchQuery, searchterms, excluded, ..._remainingItems] = Search._parseQuery('ossibl');
+      terms = Search._index.terms;
+      titleterms = Search._index.titleterms;
+
+      hits = [[
+        "index",
+        "sphinx_utils module",
+        "",
+        null,
+        2,
+        "index.rst"
+      ]];
+      expect(Search.performTermsSearch(searchterms, excluded, terms, titleterms)).toEqual(hits);
+    });
+
   });
 
   describe('aggregation of search results', function() {