Skip to content

Commit

Permalink
Add unit test for anoncreds upgrade fail
Browse files Browse the repository at this point in the history 
Signed-off-by: jamshale <jamiehalebc@gmail.com>
  • Loading branch information
@jamshale
jamshale committed Apr 10, 2024
1 parent eda4c4b commit 6d4781a
Showing 1 changed file with 166 additions and 2 deletions.
168 changes: 166 additions & 2 deletions aries_cloudagent/wallet/tests/test_anoncreds_upgrade.py
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
import asyncio
from time import time
from unittest import IsolatedAsyncioTestCase

from aries_cloudagent.tests import mock

from ...anoncreds.issuer import CATEGORY_CRED_DEF_PRIVATE
from ...core.in_memory.profile import InMemoryProfile
from ...core.in_memory.profile import InMemoryProfile, InMemoryProfileSession
from ...indy.credx.issuer import CATEGORY_CRED_DEF_KEY_PROOF
from ...messaging.credential_definitions.util import CRED_DEF_SENT_RECORD_TYPE
from ...messaging.schemas.util import SCHEMA_SENT_RECORD_TYPE
Expand Down Expand Up @@ -161,7 +162,7 @@ async def test_upgrade_wallet_to_anoncreds(self):
anoncreds_upgrade,
"convert_records_to_anoncreds",
mock.CoroutineMock(side_effect=[Exception("Error")]),
) as mock_convert_records_to_anoncreds, mock.patch.object(
), mock.patch.object(
anoncreds_upgrade, "retry_converting_records", mock.CoroutineMock()
) as mock_retry_converting_records:
async with self.profile.session() as session:
Expand Down Expand Up @@ -208,3 +209,166 @@ async def test_update_if_subwallet_and_set_storage_type_with_base_wallet(self):
)
_, storage_type_record = next(iter(self.profile.records.items()))
assert storage_type_record.value == "askar-anoncreds"

async def test_failed_upgrade(self):
async with self.profile.session() as session:
storage = session.inject(BaseStorage)

schema_id = "GHjSbphAcdsrZrLjSvsjMp:2:faber-simple:1.1"
schema_id_parts = schema_id.split(":")
schema_tags = {
"schema_id": schema_id,
"schema_issuer_did": schema_id_parts[0],
"schema_name": schema_id_parts[-2],
"schema_version": schema_id_parts[-1],
"epoch": str(int(time())),
}
await storage.add_record(
StorageRecord(SCHEMA_SENT_RECORD_TYPE, schema_id, schema_tags)
)
await storage.add_record(
StorageRecord(
RECORD_TYPE_ACAPY_STORAGE_TYPE,
"askar",
)
)
await storage.add_record(
StorageRecord(
RECORD_TYPE_ACAPY_UPGRADING,
"true",
)
)

credential_definition_id = "GHjSbphAcdsrZrLjSvsjMp:3:CL:8:default"
cred_def_tags = {
"schema_id": schema_id,
"schema_issuer_did": schema_id_parts[0],
"schema_name": schema_id_parts[-2],
"schema_version": schema_id_parts[-1],
"issuer_did": "GHjSbphAcdsrZrLjSvsjMp",
"cred_def_id": credential_definition_id,
"epoch": str(int(time())),
}
await storage.add_record(
StorageRecord(
CRED_DEF_SENT_RECORD_TYPE, credential_definition_id, cred_def_tags
)
)
storage.get_record = mock.CoroutineMock(
side_effect=[
StorageRecord(
CATEGORY_CRED_DEF_PRIVATE,
{"p_key": {"p": "123...782", "q": "234...456"}, "r_key": None},
{},
),
StorageRecord(
CATEGORY_CRED_DEF_KEY_PROOF,
{"c": "103...961", "xz_cap": "563...205", "xr_cap": []},
{},
),
]
)
anoncreds_upgrade.IndyLedgerRequestsExecutor = mock.MagicMock()
anoncreds_upgrade.IndyLedgerRequestsExecutor.return_value.get_ledger_for_identifier = mock.CoroutineMock(
return_value=(
None,
mock.MagicMock(
get_schema=mock.CoroutineMock(
return_value={
"attrNames": [
"name",
"age",
],
},
),
get_credential_definition=mock.CoroutineMock(
return_value={
"type": "CL",
"tag": "default",
"value": {
"primary": {
"n": "123",
},
},
},
),
),
)
)

with mock.patch.object(
anoncreds_upgrade, "upgrade_and_delete_schema_records"
), mock.patch.object(
anoncreds_upgrade, "upgrade_and_delete_cred_def_records"
), mock.patch.object(
InMemoryProfileSession, "rollback"
) as mock_rollback, mock.patch.object(
InMemoryProfileSession,
"commit",
# Don't wait for sleep in retry to speed up test
) as mock_commit, mock.patch.object(
asyncio, "sleep"
):
"""
Only tests schemas and cred_defs failing to upgrade because the other objects are
hard to mock. These tests should be enough to cover them as the logic is the same.
"""

# Schemas fails to upgrade
anoncreds_upgrade.upgrade_and_delete_schema_records = mock.CoroutineMock(
# Needs to fail 5 times because of the retry logic
side_effect=[
Exception("Error"),
Exception("Error"),
Exception("Error"),
Exception("Error"),
Exception("Error"),
]
)
await anoncreds_upgrade.upgrade_wallet_to_anoncreds(self.profile)
assert mock_rollback.called
assert not mock_commit.called
# Upgrading record should not be deleted
with self.assertRaises(Exception):
await storage.find_record(
type_filter=RECORD_TYPE_ACAPY_UPGRADING, tag_query={}
)

storage_type_record = await storage.find_record(
type_filter=RECORD_TYPE_ACAPY_STORAGE_TYPE, tag_query={}
)
# Storage type should not be updated
assert storage_type_record.value == "askar"
# Upgrade singleton should be empty
upgrade_singleton = UpgradeSingleton()
assert upgrade_singleton.current_upgrades.__len__() == 0

# Cred_defs fails to upgrade
anoncreds_upgrade.upgrade_and_delete_cred_def_records = (
mock.CoroutineMock(
side_effect=[
Exception("Error"),
Exception("Error"),
Exception("Error"),
Exception("Error"),
Exception("Error"),
]
)
)
await anoncreds_upgrade.upgrade_wallet_to_anoncreds(self.profile)
assert mock_rollback.called
assert not mock_commit.called
# Upgrading record should not be deleted
with self.assertRaises(Exception):
await storage.find_record(
type_filter=RECORD_TYPE_ACAPY_UPGRADING, tag_query={}
)

storage_type_record = await storage.find_record(
type_filter=RECORD_TYPE_ACAPY_STORAGE_TYPE, tag_query={}
)
# Storage type should not be updated
assert storage_type_record.value == "askar"
# Upgrade singleton should be empty
upgrade_singleton = UpgradeSingleton()
assert upgrade_singleton.current_upgrades.__len__() == 0

0 comments on commit 6d4781a

Please sign in to comment.