haystack/test/test_rest_api.py

import pytest
from fastapi.testclient import TestClient
from pathlib import Path
from haystack import Finder
from haystack.retriever.sparse import ElasticsearchRetriever

# TODO: Add integration tests for other APIs


def get_test_client_and_override_dependencies(reader, document_store):
    from rest_api.application import app
    from rest_api.controller import search, file_upload

    search.document_store = document_store
    search.retriever = ElasticsearchRetriever(document_store=document_store)
    search.FINDERS = {1: Finder(reader=reader, retriever=search.retriever)}
    file_upload.document_store = document_store

    return TestClient(app)


@pytest.mark.slow
@pytest.mark.elasticsearch
@pytest.mark.parametrize("document_store_with_docs", ["elasticsearch"], indirect=True)
@pytest.mark.parametrize("reader", ["farm"], indirect=True)
def test_qa_api_filters(reader, document_store_with_docs):
    client = get_test_client_and_override_dependencies(reader, document_store_with_docs)

    query_with_no_filter_value = {"questions": ["Where does Carla lives?"]}
    response = client.post(url="/models/1/doc-qa", json=query_with_no_filter_value)
    assert 200 == response.status_code
    response_json = response.json()
    assert response_json["results"][0]["answers"][0]["answer"] == "Berlin"

    query_with_single_filter_value = {"questions": ["Where does Carla lives?"], "filters": {"name": "filename1"}}
    response = client.post(url="/models/1/doc-qa", json=query_with_single_filter_value)
    assert 200 == response.status_code
    response_json = response.json()
    assert response_json["results"][0]["answers"][0]["answer"] == "Berlin"

    query_with_a_list_of_filter_values = {
        "questions": ["Where does Carla lives?"],
        "filters": {"name": ["filename1", "filename2"]},
    }
    response = client.post(url="/models/1/doc-qa", json=query_with_a_list_of_filter_values)
    assert 200 == response.status_code
    response_json = response.json()
    assert response_json["results"][0]["answers"][0]["answer"] == "Berlin"

    query_with_non_existing_filter_value = {
        "questions": ["Where does Carla lives?"],
        "filters": {"name": ["invalid-name"]},
    }
    response = client.post(url="/models/1/doc-qa", json=query_with_non_existing_filter_value)
    assert 200 == response.status_code
    response_json = response.json()
    assert len(response_json["results"][0]["answers"]) == 0


@pytest.mark.slow
@pytest.mark.elasticsearch
@pytest.mark.parametrize("document_store_with_docs", ["elasticsearch"], indirect=True)
@pytest.mark.parametrize("reader", ["farm"], indirect=True)
def test_query_api_filters(reader, document_store_with_docs):
    client = get_test_client_and_override_dependencies(reader, document_store_with_docs)

    query = {
        "size": 1,
        "query": {
            "bool": {
                "should": [
                    {
                        "multi_match": {
                            "query": "Where Paul lives?"
                        }
                    }
                ],
                "filter": [
                    {
                        "terms": {
                            "name": "filename2"
                        }
                    }
                ]
            }
        }
    }

    response = client.post(url="/models/1/query?top_k_reader=1", json=query)
    assert 200 == response.status_code
    response_json = response.json()
    assert 1 == response_json['hits']['total']['value']
    assert 1 == len(response_json['hits']['hits'])
    assert response_json['hits']['hits'][0]["_score"] is not None
    assert response_json['hits']['hits'][0]["_source"]["meta"] is not None
    assert response_json['hits']['hits'][0]["_id"] is not None
    assert "New York" == response_json['hits']['hits'][0]["_source"]["answer"]
    assert "My name is Paul and I live in New York" == response_json['hits']['hits'][0]["_source"]["context"]


@pytest.mark.slow
@pytest.mark.elasticsearch
@pytest.mark.parametrize("document_store", ["elasticsearch"], indirect=True)
def test_file_upload(document_store):
    assert document_store.get_document_count() == 0
    client = get_test_client_and_override_dependencies(reader=None, document_store=document_store)
    file_to_upload = {'file': Path("samples/pdf/sample_pdf_1.pdf").open('rb')}
    response = client.post(url="/file-upload", files=file_to_upload)
    assert 200 == response.status_code
    assert document_store.get_document_count() > 0