key_test.py

"""Tests for the Key class."""

from __future__ import annotations

import requests_mock

from tests.utils.object_assertions import (
    assert_match_object,
    assert_object_lists_match,
    assert_to_contain_object,
)
from typesense.api_call import ApiCall
from typesense.key import Key
from typesense.keys import Keys
from typesense.types.key import ApiKeyDeleteSchema, ApiKeySchema


def test_init(fake_api_call: ApiCall) -> None:
    """Test that the Key object is initialized correctly."""
    key = Key(fake_api_call, 3)

    assert key.key_id == 3
    assert_match_object(key.api_call, fake_api_call)
    assert_object_lists_match(
        key.api_call.node_manager.nodes,
        fake_api_call.node_manager.nodes,
    )
    assert_match_object(
        key.api_call.config.nearest_node,
        fake_api_call.config.nearest_node,
    )
    assert key._endpoint_path == "/keys/3"  # noqa: WPS437


def test_retrieve(fake_key: Key) -> None:
    """Test that the Key object can retrieve an key."""
    json_response: ApiKeySchema = {
        "actions": ["documents:search"],
        "collections": ["companies"],
        "description": "Search-only key",
    }

    with requests_mock.Mocker() as mock:
        mock.get(
            "/keys/1",
            json=json_response,
        )

        response = fake_key.retrieve()

        assert len(mock.request_history) == 1
        assert mock.request_history[0].method == "GET"
        assert mock.request_history[0].url == "http://nearest:8108/keys/1"
        assert response == json_response


def test_delete(fake_key: Key) -> None:
    """Test that the Key object can delete an key."""
    json_response: ApiKeyDeleteSchema = {"id": 1}
    with requests_mock.Mocker() as mock:
        mock.delete(
            "/keys/1",
            json=json_response,
        )

        response = fake_key.delete()

        assert len(mock.request_history) == 1
        assert mock.request_history[0].method == "DELETE"
        assert mock.request_history[0].url == "http://nearest:8108/keys/1"
        assert response == json_response


def test_actual_retrieve(
    actual_keys: Keys,
    delete_all_keys: None,
    delete_all: None,
    create_key_id: int,
) -> None:
    """Test that the Key object can retrieve an key from Typesense Server."""
    response = actual_keys[create_key_id].retrieve()

    assert_to_contain_object(
        response,
        {
            "actions": ["documents:search"],
            "collections": ["companies"],
            "description": "Search-only key",
            "id": create_key_id,
        },
    )


def test_actual_delete(
    actual_keys: Keys,
    delete_all_keys: None,
    delete_all: None,
    create_key_id: int,
) -> None:
    """Test that the Key object can delete an key from Typesense Server."""
    response = actual_keys[create_key_id].delete()

    assert response == {"id": create_key_id}