Unittest for suggestions #709
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The failure of Packages CI flow on |
Packages/build-deb CI flows failed on ubuntu-bionic and ubuntu-focal
with the following mismatch in the ServerTest.suggestions unit-test:
```
[ RUN ] ServerTest.suggestions
../test/server.cpp:715: Failure
Expected equality of these values:
r->body
Which is: ...
removeEOLWhitespaceMarkers(expectedResponse)
Which is: ...
With diff:
@@ -2,5 +2,5 @@
{
\"value\" : \"Ray (movie)\",
- \"label\" : \"Ray (<b>movie</b>...\",
+ \"label\" : \"Ray (<b>movie</b>)\",
\"kind\" : \"path\"
, \"path\" : \"A/Ray_(movie)\"
Test context:
url: /ROOT/suggest?content=zimfile&term=movie
```
For some reason (probably, a bug), the implementation of
`Xapian::MSet::snippet()` on those platforms decided that a single closing
parenthesis is more than is appropriate for inclusion in the snippet and
replaced it with a (longer) ellipsis.
Taking advantage of the necessity to work around that bug, the
ServerTest.suggestions's functional coverage was enhanced - the
problematic test point was replaced with a new one using a phrase
instead of a single term.
Codecov Report
@@ Coverage Diff @@
## master #709 +/- ##
=======================================
Coverage 57.96% 57.96%
=======================================
Files 54 54
Lines 3566 3566
Branches 2006 2006
=======================================
Hits 2067 2067
Misses 1498 1498
Partials 1 1 Continue to review full report at Codecov.
|
|
CI is now clean. This PR is ready for review. I added the commit addressing the CI failure as a non-fixup commit and intend to keep it as such since it documents an issue with Xapian. |
mgautierfr
approved these changes
Feb 16, 2022
Comment on lines
+48
to
+53
| // Output generated via mustache templates sometimes contains end-of-line | ||
| // whitespace. This complicates representing the expected output of a unit-test | ||
| // as C++ raw strings in editors that are configured to delete EOL whitespace. | ||
| // A workaround is to put special markers (//EOLWHITESPACEMARKER) at the end | ||
| // of such lines in the expected output string and remove them at runtime. | ||
| // This is exactly what this function is for. |
There was a problem hiding this comment.
This is silly but I don't know how to do otherwise.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is part of a larger campaign of extending the
kiwix-servetest-suite, so that major changes related to kiwix/kiwix-tools#59 and #650 can be implemented in a safer environment.