tests/test_rest.py

"""Unit tests for REST API backend code in Annif"""

import importlib

import annif.rest


def test_rest_list_projects(app):
    with app.app_context():
        result = annif.rest.list_projects()[0]
        project_ids = [proj["project_id"] for proj in result["projects"]]
        # public project should be returned
        assert "dummy-fi" in project_ids
        # hidden project should not be returned
        assert "dummy-en" not in project_ids
        # private project should not be returned
        assert "dummy-private" not in project_ids
        # project with no access level setting should be returned
        assert "ensemble" in project_ids


def test_rest_show_info(app):
    with app.app_context():
        result = annif.rest.show_info()[0]
        version = importlib.metadata.version("annif")
        assert result == {"title": "Annif REST API", "version": version}


def test_rest_show_project_public(app):
    # public projects should be accessible via REST
    with app.app_context():
        result = annif.rest.show_project("dummy-fi")[0]
        assert result["project_id"] == "dummy-fi"


def test_rest_show_project_hidden(app):
    # hidden projects should be accessible if you know the project id
    with app.app_context():
        result = annif.rest.show_project("dummy-en")[0]
        assert result["project_id"] == "dummy-en"


def test_rest_show_project_private(app):
    # private projects should not be accessible via REST
    with app.app_context():
        result = annif.rest.show_project("dummy-private")
        assert result.status_code == 404


def test_rest_show_project_nonexistent(app):
    with app.app_context():
        result = annif.rest.show_project("nonexistent")
        assert result.status_code == 404


def test_rest_detect_language_english(app):
    # english text should be detected
    with app.app_context():
        result = annif.rest.detect_language(
            {"text": "example text", "languages": ["en", "fi", "sv"]}
        )[0]
        assert result["results"][0] == {"language": "en", "score": 1}


def test_rest_detect_language_unknown(app):
    # an unknown language should return None
    with app.app_context():
        result = annif.rest.detect_language(
            {"text": "exampley texty", "languages": ["fi", "sv"]}
        )[0]
        assert result["results"][0] == {"language": None, "score": 1}


def test_rest_detect_language_no_text(app):
    with app.app_context():
        result = annif.rest.detect_language({"text": "", "languages": ["en"]})[0]
        assert result["results"][0] == {"language": None, "score": 1}


def test_rest_detect_language_unsupported_candidates(app):
    with app.app_context():
        result = annif.rest.detect_language(
            {"text": "example text", "languages": ["unk"]}
        )
        assert result.status_code == 400


def test_rest_suggest_public(app):
    # public projects should be accessible via REST
    with app.app_context():
        result = annif.rest.suggest(
            "dummy-fi", {"text": "example text", "limit": 10, "threshold": 0.0}
        )[0]
        assert "results" in result


def test_rest_suggest_hidden(app):
    # hidden projects should be accessible if you know the project id
    with app.app_context():
        result = annif.rest.suggest(
            "dummy-en", {"text": "example text", "limit": 10, "threshold": 0.0}
        )[0]
        assert "results" in result


def test_rest_suggest_private(app):
    # private projects should not be accessible via REST
    with app.app_context():
        result = annif.rest.suggest(
            "dummy-private", {"text": "example text", "limit": 10, "threshold": 0.0}
        )
        assert result.status_code == 404


def test_rest_suggest_nonexistent(app):
    with app.app_context():
        result = annif.rest.suggest(
            "nonexistent", {"text": "example text", "limit": 10, "threshold": 0.0}
        )
        assert result.status_code == 404


def test_rest_suggest_novocab(app):
    with app.app_context():
        result = annif.rest.suggest(
            "novocab", {"text": "example text", "limit": 10, "threshold": 0.0}
        )
        assert result.status_code == 503


def test_rest_suggest_with_language_override(app):
    with app.app_context():
        result = annif.rest.suggest(
            "dummy-vocablang",
            {"text": "example text", "limit": 10, "threshold": 0.0, "language": "en"},
        )[0]
        assert result["results"][0]["label"] == "dummy"


def test_rest_suggest_with_language_override_bad_value(app):
    with app.app_context():
        result = annif.rest.suggest(
            "dummy-vocablang",
            {"text": "example text", "limit": 10, "threshold": 0.0, "language": "xx"},
        )
        assert result.status_code == 400


def test_rest_suggest_with_different_vocab_language(app):
    # project language is English - input should be in English
    # vocab language is Finnish - subject labels should be in Finnish
    with app.app_context():
        result = annif.rest.suggest(
            "dummy-vocablang", {"text": "example text", "limit": 10, "threshold": 0.0}
        )[0]
        assert result["results"][0]["label"] == "dummy-fi"


def test_rest_suggest_with_notations(app):
    with app.app_context():
        result = annif.rest.suggest(
            "dummy-fi", {"text": "example text", "limit": 10, "threshold": 0.0}
        )[0]
        assert result["results"][0]["notation"] is None


def test_rest_suggest_batch_one_doc(app):
    with app.app_context():
        result = annif.rest.suggest_batch(
            "dummy-fi", {"documents": [{"text": "example text"}]}
        )[0]
        assert len(result) == 1
        assert result[0]["results"][0]["label"] == "dummy-fi"
        assert result[0]["document_id"] is None


def test_rest_suggest_batch_one_doc_with_id(app):
    with app.app_context():
        result = annif.rest.suggest_batch(
            "dummy-fi",
            {"documents": [{"text": "example text", "document_id": "doc-0"}]},
        )[0]
        assert len(result) == 1
        assert result[0]["results"][0]["label"] == "dummy-fi"
        assert result[0]["document_id"] == "doc-0"


def test_rest_suggest_batch_two_docs(app):
    with app.app_context():
        result = annif.rest.suggest_batch(
            "dummy-fi",
            {
                "documents": [
                    {"text": "example text"},
                    {"text": "another example text"},
                ]
            },
        )[0]
        assert len(result) == 2
        assert result[1]["results"][0]["label"] == "dummy-fi"


def test_rest_suggest_batch_with_language_override(app):
    with app.app_context():
        result = annif.rest.suggest_batch(
            "dummy-vocablang",
            {
                "documents": [{"text": "example text"}],
            },
            language="en",
        )[0]
        assert result[0]["results"][0]["label"] == "dummy"


def test_rest_suggest_batch_with_limit_override(app):
    with app.app_context():
        result = annif.rest.suggest_batch(
            "dummy-fi",
            {
                "documents": [{"text": "example text"}],
            },
            limit=0,
        )[0]
        assert len(result[0]["results"]) == 0


def test_rest_learn_empty(app):
    with app.app_context():
        response = annif.rest.learn("dummy-en", [])
        assert response == (
            None,
            204,
            {"Content-Type": "application/json"},
        )  # success, no output


def test_rest_learn(app):
    documents = [
        {
            "text": "the quick brown fox",
            "subjects": [{"uri": "http://example.org/none", "label": "none"}],
        }
    ]
    with app.app_context():
        response = annif.rest.learn("dummy-en", documents)
        assert response == (
            None,
            204,
            {"Content-Type": "application/json"},
        )  # success, no output

        result = annif.rest.suggest(
            "dummy-en", {"text": "example text", "limit": 10, "threshold": 0.0}
        )[0]
        assert "results" in result
        assert result["results"][0]["uri"] == "http://example.org/none"
        assert result["results"][0]["label"] == "none"


def test_rest_learn_novocab(app):
    with app.app_context():
        result = annif.rest.learn("novocab", [])
        assert result.status_code == 503


def test_rest_learn_nonexistent(app):
    with app.app_context():
        result = annif.rest.learn("nonexistent", [])
        assert result.status_code == 404


def test_rest_learn_not_supported(app):
    with app.app_context():
        result = annif.rest.learn("tfidf-fi", [])
        assert result.status_code == 503