volpage tests

[thesunshade]

The following test should be successful:

[settings]
endpoint = "https://staging.suttacentral.net//api/search/instant"
delay = 10

[defaults]
limit = 10
site-language = "en"
restrict = "all"
match-partial = false
selected-languages = ["en", "pli"]

[[test-case]]
description = "Find volpage:SN ii 4"
query = "volpage:SN ii 4"
expected.suttaplex = "sn12.3"

However it gives this error:

ERROR   1259ms Find volpage:SN ii 4
  Could not parse JSON response: error decoding response body: data did not match any variant of untagged enum Hit at line 1 column 494

This is what the search results look like on the site:

Note the searches that are expected to work:

[jhanarato]

Sorry, I completely missed this.

We can add a new search result variant to handle this. The test case will look like this:

[[test-case]]
description = "Find volpage:SN ii 4"
query = "volpage:SN ii 4"
expected.volpage = "sn12.3"

and will handle this response from the server:

    "hits": [
        {
            "acronym": "SN 12.1",
            "uid": "sn12.1",
            "lang": null,
            "name": "Dependent Origination ",
            "volpage": "PTS SN ii 1",
            "alt_volpage": null,
            "all_reference": null,
            "url": "/sn12.1",
            "highlight": {
                "content": [
                    ""
                ]
            },
            "root_name": "Paṭiccasamuppādasutta"
        },

[jhanarato]

I think @thesunshade was right with the original suggestion:

[[test-case]]
description = "Find volpage:SN ii 4"
query = "volpage:SN ii 4"
expected.suttaplex = "sn12.3"

The results from this kind of search are indeed suttaplexes.

[jhanarato]

It looks like there's some business logic in the front end that parses the query before making the request to the API.

search-test will have to know in advance what kind of search is being performed before hitting the server.

Shall we assume that when a query begins with volpage: search-test will assume that the response are volpage results?

[thesunshade]

Shall we assume that when a query begins with volpage:

It's not explicit, but I don't know why someone would do a volpage and also have a keyword.

search-test will assume that the response are volpage results?

I think so.

Thanks!! I must confess I almost never actually use this kind of search, so I am not as familiar with it as I would like.

[jhanarato]

Thanks!! I must confess I almost never actually use this kind of search, so I am not as familiar with it as I would like.

Good to know. I'll tackle this eventually, but if we can get a suite of test for general search results first, that would be great.

[jhanarato]

I'm going with a volpage expected, like so:

[[test-case]]
description = "Find volpage:SN ii 4"
query = "volpage:SN ii 4"
expected.volpage = "PTS SN ii 1"

This will avoid having to mimic the front end business logic. If expected.volpage is specified, we use a different parser.

Next steps:

1. Add expected.volpage to the TOML specification.
2. Refactor to allow different parsers to be used.

The second will also be useful if we introduce new versions of the search API.

[jhanarato]

@thesunshade said this would be a legitimate passing test:

[[test-case]]
description = "Find volpage:SN ii 4"
query = "volpage:SN ii 4"
expected.volpage = "PTS SN ii 1"
expected.min_rank = 1