IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

HTML search: Ensure that `checkRanking` fails when the final entry is not found (#12608)

Browse Source 
The ``checkRanking`` function in our test suite has a bug; it's currently possible for the final item in the expected ranking list *not* to be found in the result-set, and yet for the function to pass.

**Expected Behaviour**
The ``checkRanking`` function should confirm that all of the items specified in the ``expectedRanking`` argument appear within the ``results`` argument, and in the list-iteration-order provided.  If they do not, then an assertion error should be raised, failing the test.

**Actual Behaviour**
If all items up until the final entry in the ``expectedRanking`` argument are found in the expected order, but the final entry itself is not found at all in the ``results``, then no assertion error is raised, and the test passes.
This commit is contained in:
James Addison
2024-07-17 16:29:55 +01:00
committed by GitHub
parent fe9be8be5f
commit 47757c4062
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
tests/js/searchtools.js
View File

@@ -22,6 +22,7 @@ describe('Basic html theme search', function() {
}
expect(remainingItems.length).toEqual(0);
expect(nextExpected).toEqual(undefined);
}
describe('terms search', function() {
@@ -137,7 +138,7 @@ describe('Basic html theme search', function() {
expectedRanking = [
['relevance', 'Relevance', ''], /* main title */
['index', 'relevance.Example.relevance', '#module-relevance'], /* py:class attribute */
['index', 'relevance.Example.relevance', '#relevance.Example.relevance'], /* py:class attribute */
];
searchParameters = Search._parseQuery('relevance');