test_revocation_registry.py

from unittest.mock import ANY

import pytest
from aries_cloudcontroller import (
    AcaPyClient,
    ApiException,
    ClearPendingRevocationsRequest,
    CredRevRecordResult,
    IssuerCredRevRecord,
    IssuerRevRegRecord,
    PublishRevocations,
    RevokeRequest,
    RevRegResult,
    TransactionRecord,
    TxnOrPublishRevocationsResult,
    V20CredExRecordDetail,
    V20CredExRecordIndy,
)
from mockito import verify, when

import app.services.revocation_registry as rg
from app.exceptions import CloudApiException
from app.models.issuer import ClearPendingRevocationsResult
from app.tests.util.mock import to_async

cred_def_id = "VagGATdBsVdBeFKeoYPe7H:3:CL:141:5d211963-3478-4de4-b8b6-9072759a71c8"
cred_ex_id = "5mJRavkcQFrqgKqKKZua3z:3:CL:30:tag"
cred_rev_id = "1234"
cred_id = "c7c909f4-f670-49bd-9d81-53fba6bb23b8"
max_cred_num = 32767
revocation_registry_id = (
    "VagGATdBsVdBeFKeoYPe7H:4:VagGATdBsVdBeFKeoYPe7H:3:CL:141:"
    "QIOPN:CL_ACCUM:5d211963-3478-4de4-b8b6-9072759a71c8"
)
revocation_registry_credential_map = {"rev_reg_id1": ["cred_rev_id1", "cred_rev_id2"]}
conn_id = "12345"
transaction_id = "1234"


@pytest.mark.anyio
async def test_get_active_revocation_registry_for_credential(
    mock_agent_controller: AcaPyClient,
):
    # Success
    when(mock_agent_controller.revocation).get_active_registry_for_cred_def(
        cred_def_id=cred_def_id
    ).thenReturn(
        to_async(
            RevRegResult(
                result=IssuerRevRegRecord(
                    cred_def_id=cred_def_id, max_cred_num=max_cred_num
                )
            )
        )
    )
    active_rev_reg_result = await rg.get_active_revocation_registry_for_credential(
        controller=mock_agent_controller, credential_definition_id=cred_def_id
    )

    assert isinstance(active_rev_reg_result, IssuerRevRegRecord)
    assert active_rev_reg_result.cred_def_id == cred_def_id
    assert active_rev_reg_result.max_cred_num == max_cred_num

    # Fail
    with pytest.raises(
        CloudApiException, match="Error retrieving revocation registry"
    ) as exc:
        when(mock_agent_controller.revocation).get_active_registry_for_cred_def(
            cred_def_id=cred_def_id
        ).thenReturn(to_async(None))
        await rg.get_active_revocation_registry_for_credential(
            mock_agent_controller, credential_definition_id=cred_def_id
        )
        assert exc.value.status_code == 500


@pytest.mark.anyio
async def test_revoke_credential(mock_agent_controller: AcaPyClient):
    # Success
    when(mock_agent_controller.revocation).revoke_credential(
        body=RevokeRequest(cred_ex_id=cred_id, publish=False)
    ).thenReturn(to_async({}))

    revoke_credential_result = await rg.revoke_credential(
        controller=mock_agent_controller,
        credential_exchange_id=cred_id,
        auto_publish_to_ledger=False,
    )

    assert revoke_credential_result.cred_rev_ids_published == {}

    # Fail
    error_msg = "dummy_message"
    with pytest.raises(
        CloudApiException, match=f"Failed to revoke credential: {error_msg}"
    ) as exc:
        when(mock_agent_controller.revocation).revoke_credential(
            body=RevokeRequest(cred_ex_id=cred_id, publish=False)
        ).thenRaise(ApiException(reason=error_msg, status=500))
        await rg.revoke_credential(
            controller=mock_agent_controller,
            credential_exchange_id=cred_id,
            auto_publish_to_ledger=False,
        )
        assert exc.value.status_code == 500


@pytest.mark.anyio
async def test_publish_pending_revocations_success(mock_agent_controller: AcaPyClient):
    # Simulate successful validation
    when(rg).validate_rev_reg_ids(
        controller=mock_agent_controller,
        revocation_registry_credential_map=revocation_registry_credential_map,
    ).thenReturn(to_async())

    # Simulate successful publish revocations call
    when(mock_agent_controller.revocation).publish_revocations(
        body=PublishRevocations(rrid2crid=revocation_registry_credential_map)
    ).thenReturn(
        to_async(
            TxnOrPublishRevocationsResult(
                txn=[
                    TransactionRecord(
                        transaction_id="97a46fab-5499-42b3-a2a1-7eb9faad31c0"
                    )
                ]
            )
        )
    )

    await rg.publish_pending_revocations(
        controller=mock_agent_controller,
        revocation_registry_credential_map=revocation_registry_credential_map,
    )

    # You may also verify that publish_revocations was called with expected arguments
    verify(mock_agent_controller.revocation, times=1).publish_revocations(
        body=PublishRevocations(rrid2crid=revocation_registry_credential_map)
    )


@pytest.mark.anyio
async def test_publish_pending_revocations_failure(mock_agent_controller: AcaPyClient):
    error_message = "Failed to publish due to network error"
    status_code = 500

    # Simulate successful validation
    when(rg).validate_rev_reg_ids(
        controller=mock_agent_controller,
        revocation_registry_credential_map=revocation_registry_credential_map,
    ).thenReturn(to_async())

    # Simulate failure in publish revocations call
    when(mock_agent_controller.revocation).publish_revocations(
        body=PublishRevocations(rrid2crid=revocation_registry_credential_map)
    ).thenRaise(ApiException(reason=error_message, status=status_code))

    with pytest.raises(
        CloudApiException,
        match=f"Failed to publish pending revocations: {error_message}",
    ) as exc:
        await rg.publish_pending_revocations(
            controller=mock_agent_controller,
            revocation_registry_credential_map=revocation_registry_credential_map,
        )

    assert exc.value.status_code == status_code

    # You may also verify that publish_revocations was attempted
    verify(mock_agent_controller.revocation, times=1).publish_revocations(
        body=PublishRevocations(rrid2crid=revocation_registry_credential_map)
    )


@pytest.mark.anyio
async def test_clear_pending_revocations_success(mock_agent_controller: AcaPyClient):
    expected_result_map = {"rev_reg_id1": []}

    # Simulate successful validation
    when(rg).validate_rev_reg_ids(
        controller=mock_agent_controller,
        revocation_registry_credential_map=revocation_registry_credential_map,
    ).thenReturn(to_async(None))

    # Mock clear_pending_revocations call to return successful result
    when(mock_agent_controller.revocation).clear_pending_revocations(
        body=ClearPendingRevocationsRequest(purge=revocation_registry_credential_map)
    ).thenReturn(to_async(PublishRevocations(rrid2crid=expected_result_map)))

    result = await rg.clear_pending_revocations(
        controller=mock_agent_controller,
        revocation_registry_credential_map=revocation_registry_credential_map,
    )

    assert isinstance(result, ClearPendingRevocationsResult)
    assert result.revocation_registry_credential_map == expected_result_map

    # Verify that clear_pending_revocations was called with the expected arguments
    verify(mock_agent_controller.revocation, times=1).clear_pending_revocations(
        body=ClearPendingRevocationsRequest(purge=revocation_registry_credential_map)
    )


@pytest.mark.anyio
async def test_clear_pending_revocations_failure(mock_agent_controller: AcaPyClient):
    error_message = "Failed to clear due to network error"
    status_code = 500

    # Simulate successful validation
    when(rg).validate_rev_reg_ids(
        controller=mock_agent_controller,
        revocation_registry_credential_map=revocation_registry_credential_map,
    ).thenReturn(to_async(None))

    # Simulate failure in clear_pending_revocations call
    when(mock_agent_controller.revocation).clear_pending_revocations(
        body=ClearPendingRevocationsRequest(purge=revocation_registry_credential_map)
    ).thenRaise(ApiException(reason=error_message, status=status_code))

    with pytest.raises(
        CloudApiException,
        match=f"Failed to clear pending revocations: {error_message}",
    ) as exc:
        await rg.clear_pending_revocations(
            controller=mock_agent_controller,
            revocation_registry_credential_map=revocation_registry_credential_map,
        )

    assert exc.value.status_code == status_code

    # Verify that clear_pending_revocations was attempted
    verify(mock_agent_controller.revocation, times=1).clear_pending_revocations(
        body=ClearPendingRevocationsRequest(purge=revocation_registry_credential_map)
    )


@pytest.mark.anyio
async def test_get_credential_revocation_record_success(
    mock_agent_controller: AcaPyClient,
):
    expected_result = IssuerCredRevRecord(
        cred_ex_id=cred_ex_id,
        cred_rev_id=cred_rev_id,
        rev_reg_id=revocation_registry_id,
    )

    # Mock successful response from ACA-Py
    when(mock_agent_controller.revocation).get_revocation_status(
        cred_ex_id=cred_ex_id,
        cred_rev_id=cred_rev_id,
        rev_reg_id=revocation_registry_id,
    ).thenReturn(to_async(CredRevRecordResult(result=expected_result)))

    result = await rg.get_credential_revocation_record(
        controller=mock_agent_controller,
        credential_exchange_id=cred_ex_id,
        credential_revocation_id=cred_rev_id,
        revocation_registry_id=revocation_registry_id,
    )

    assert result == expected_result


@pytest.mark.anyio
async def test_get_credential_revocation_record_api_exception(
    mock_agent_controller: AcaPyClient,
):
    error_message = "Failed to get revocation status"
    status_code = 500

    # Mock ApiException from ACA-Py
    when(mock_agent_controller.revocation).get_revocation_status(
        cred_ex_id=cred_ex_id, cred_rev_id=ANY, rev_reg_id=ANY
    ).thenRaise(ApiException(reason=error_message, status=status_code))

    with pytest.raises(
        CloudApiException, match=f"Failed to get revocation status: {error_message}"
    ) as exc_info:
        await rg.get_credential_revocation_record(
            controller=mock_agent_controller,
            credential_exchange_id=cred_ex_id,
        )

    assert exc_info.value.status_code == status_code


@pytest.mark.anyio
async def test_get_credential_revocation_record_invalid_result_type(
    mock_agent_controller: AcaPyClient,
):
    # Mock unexpected response type from ACA-Py
    when(mock_agent_controller.revocation).get_revocation_status(
        cred_ex_id=cred_ex_id, cred_rev_id=ANY, rev_reg_id=ANY
    ).thenReturn(to_async("unexpected_type"))

    with pytest.raises(
        CloudApiException,
        match="Error retrieving revocation status for credential exchange ID",
    ):
        await rg.get_credential_revocation_record(
            controller=mock_agent_controller,
            credential_exchange_id=cred_ex_id,
        )


@pytest.mark.anyio
async def test_get_credential_definition_id_from_exchange_id(
    mock_agent_controller: AcaPyClient,
):
    # Success v2
    when(mock_agent_controller.issue_credential_v2_0).get_record(
        cred_ex_id=cred_ex_id
    ).thenReturn(
        to_async(
            V20CredExRecordDetail(
                indy=V20CredExRecordIndy(rev_reg_id=revocation_registry_id)
            )
        )
    )

    cred_def_id_result = await rg.get_credential_definition_id_from_exchange_id(
        controller=mock_agent_controller, credential_exchange_id=cred_ex_id
    )

    assert cred_def_id_result
    assert isinstance(cred_def_id_result, str)
    assert cred_def_id_result == cred_def_id

    # Not found
    when(mock_agent_controller.issue_credential_v2_0).get_record(
        cred_ex_id=cred_ex_id
    ).thenRaise(CloudApiException(detail=""))

    cred_def_id_result = await rg.get_credential_definition_id_from_exchange_id(
        controller=mock_agent_controller, credential_exchange_id=cred_ex_id
    )

    assert cred_def_id_result is None

    # Not found general exception
    when(mock_agent_controller.issue_credential_v2_0).get_record(
        cred_ex_id=cred_ex_id
    ).thenRaise(Exception())

    cred_def_id_result = await rg.get_credential_definition_id_from_exchange_id(
        controller=mock_agent_controller, credential_exchange_id=cred_ex_id
    )

    assert cred_def_id_result is None


@pytest.mark.anyio
async def test_validate_rev_reg_ids_success(mock_agent_controller: AcaPyClient):
    # Mock successful retrieval of revocation registry
    when(mock_agent_controller.revocation).get_registry(...).thenReturn(
        to_async(
            RevRegResult(
                result=IssuerRevRegRecord(
                    pending_pub=revocation_registry_credential_map.get("rev_reg_id1")
                )
            )
        )
    )

    await rg.validate_rev_reg_ids(
        mock_agent_controller, revocation_registry_credential_map
    )


@pytest.mark.anyio
async def test_validate_rev_reg_ids_non_existent(mock_agent_controller: AcaPyClient):
    # Mock ApiException for non-existent revocation registry ID
    when(mock_agent_controller.revocation).get_registry(
        rev_reg_id="invalid_rev_reg_id"
    ).thenRaise(ApiException(status=404, reason="Registry ID does not exist"))

    with pytest.raises(
        CloudApiException, match="The rev_reg_id `invalid_rev_reg_id` does not exist"
    ) as exc_info:
        await rg.validate_rev_reg_ids(
            mock_agent_controller, {"invalid_rev_reg_id": ["cred_rev_id_4"]}
        )

    assert exc_info.value.status_code == 404


@pytest.mark.anyio
async def test_validate_rev_reg_ids_no_pending_publications(
    mock_agent_controller: AcaPyClient,
):
    # Mock response with no pending publications
    when(mock_agent_controller.revocation).get_registry(
        rev_reg_id="valid_rev_reg_id_1"
    ).thenReturn(to_async(RevRegResult(result=IssuerRevRegRecord(pending_pub=None))))

    with pytest.raises(
        CloudApiException, match="No pending publications found"
    ) as exc_info:
        await rg.validate_rev_reg_ids(
            mock_agent_controller, {"valid_rev_reg_id_1": ["cred_rev_id_1"]}
        )

    assert exc_info.value.status_code == 404


@pytest.mark.anyio
async def test_validate_rev_reg_ids_cred_rev_id_not_pending(
    mock_agent_controller: AcaPyClient,
):
    # Mock response where cred_rev_id is not in pending_pub
    when(mock_agent_controller.revocation).get_registry(
        rev_reg_id="valid_rev_reg_id_1"
    ).thenReturn(
        to_async(RevRegResult(result=IssuerRevRegRecord(pending_pub=["cred_rev_id_2"])))
    )

    with pytest.raises(
        CloudApiException, match="is not pending publication"
    ) as exc_info:
        await rg.validate_rev_reg_ids(
            mock_agent_controller, {"valid_rev_reg_id_1": ["cred_rev_id_1"]}
        )

    assert exc_info.value.status_code == 404


@pytest.mark.anyio
async def test_get_pending_revocations_success(
    mock_agent_controller: AcaPyClient,
):
    rev_reg_id = ("mocked_rev_reg_id",)
    # Mock successful response from ACA-Py
    when(mock_agent_controller.revocation).get_registry(
        rev_reg_id=rev_reg_id
    ).thenReturn(
        to_async(
            RevRegResult(
                result=IssuerRevRegRecord(
                    rev_reg_id=rev_reg_id, max_cred_num=max_cred_num
                )
            )
        )
    )

    await rg.get_pending_revocations(
        controller=mock_agent_controller, rev_reg_id=rev_reg_id
    )


@pytest.mark.anyio
async def test_get_pending_revocations_failure(
    mock_agent_controller: AcaPyClient,
):
    error_message = "Failed to get revocation registry"
    status_code = 500

    rev_reg_id = "mocked_rev_reg_id"
    # Mock ApiException from ACA-Py
    when(mock_agent_controller.revocation).get_registry(
        rev_reg_id=rev_reg_id
    ).thenRaise(ApiException(reason=error_message, status=status_code))

    with pytest.raises(
        CloudApiException,
        match=f"500: Failed to get pending revocations: {error_message}",
    ) as exc_info:
        await rg.get_pending_revocations(
            controller=mock_agent_controller, rev_reg_id=rev_reg_id
        )

    assert exc_info.value.status_code == status_code