|
| 1 | +"""Test cases for the getScheduleInfo TCK handler and its parameter parsing.""" |
| 2 | + |
| 3 | +from __future__ import annotations |
| 4 | + |
| 5 | +import importlib |
| 6 | +from unittest.mock import MagicMock, patch |
| 7 | + |
| 8 | +import pytest |
| 9 | + |
| 10 | +from hiero_sdk_python.account.account_id import AccountId |
| 11 | +from hiero_sdk_python.exceptions import PrecheckError |
| 12 | +from hiero_sdk_python.hbar import Hbar |
| 13 | +from hiero_sdk_python.schedule.schedule_id import ScheduleId |
| 14 | +from hiero_sdk_python.transaction.transaction_id import TransactionId |
| 15 | +from tck.handlers import registry, schedule as schedule_handlers |
| 16 | +from tck.handlers.schedule import get_schedule_info |
| 17 | +from tck.param.schedule import GetScheduleInfoParams |
| 18 | +from tck.response.schedule import ScheduleInfoResponse |
| 19 | + |
| 20 | + |
| 21 | +pytestmark = pytest.mark.unit |
| 22 | + |
| 23 | + |
| 24 | +def _mock_schedule_info(**overrides): |
| 25 | + """A MagicMock standing in for a populated ScheduleInfo.""" |
| 26 | + defaults = { |
| 27 | + "schedule_id": ScheduleId(0, 0, 100), |
| 28 | + "creator_account_id": AccountId(0, 0, 10), |
| 29 | + "payer_account_id": AccountId(0, 0, 20), |
| 30 | + "scheduled_transaction_id": TransactionId(AccountId(0, 0, 20), MagicMock(seconds=1700000000, nanos=0)), |
| 31 | + "signers": [], |
| 32 | + "admin_key": None, |
| 33 | + "expiration_time": MagicMock(seconds=1700000500), |
| 34 | + "executed_at": None, |
| 35 | + "deleted_at": None, |
| 36 | + "schedule_memo": "a memo", |
| 37 | + "wait_for_expiry": True, |
| 38 | + } |
| 39 | + defaults.update(overrides) |
| 40 | + return MagicMock(**defaults) |
| 41 | + |
| 42 | + |
| 43 | +def _mock_query(): |
| 44 | + """A MagicMock standing in for ScheduleInfoQuery's fluent setter chain.""" |
| 45 | + query = MagicMock() |
| 46 | + query.set_grpc_deadline.return_value = query |
| 47 | + query.set_schedule_id.return_value = query |
| 48 | + query.set_query_payment.return_value = query |
| 49 | + query.set_max_query_payment.return_value = query |
| 50 | + return query |
| 51 | + |
| 52 | + |
| 53 | +def test_get_schedule_info_is_registered(): |
| 54 | + # Re-import to re-run the @rpc_method decorator, in case another test module's |
| 55 | + # teardown (e.g. handlers_test.py) cleared the shared registry after this module |
| 56 | + # was first imported. |
| 57 | + importlib.reload(schedule_handlers) |
| 58 | + handler = registry.get_handler("getScheduleInfo") |
| 59 | + assert handler is not None and callable(handler) |
| 60 | + |
| 61 | + |
| 62 | +def test_parse_json_params(): |
| 63 | + params = GetScheduleInfoParams.parse_json_params( |
| 64 | + { |
| 65 | + "sessionId": "session-1", |
| 66 | + "scheduleId": "0.0.100", |
| 67 | + "queryPayment": "1000", |
| 68 | + "maxQueryPayment": "5000", |
| 69 | + "getCost": True, |
| 70 | + } |
| 71 | + ) |
| 72 | + |
| 73 | + assert params.scheduleId == "0.0.100" |
| 74 | + assert params.queryPayment == "1000" |
| 75 | + assert params.maxQueryPayment == "5000" |
| 76 | + assert params.getCost is True |
| 77 | + |
| 78 | + minimal = GetScheduleInfoParams.parse_json_params({"sessionId": "session-1"}) |
| 79 | + assert minimal.scheduleId is None |
| 80 | + assert minimal.queryPayment is None |
| 81 | + assert minimal.maxQueryPayment is None |
| 82 | + assert minimal.getCost is None |
| 83 | + |
| 84 | + |
| 85 | +def test_get_schedule_info_maps_fields(): |
| 86 | + params = GetScheduleInfoParams(sessionId="session-1", scheduleId="0.0.100") |
| 87 | + query = _mock_query() |
| 88 | + query.execute.return_value = _mock_schedule_info() |
| 89 | + |
| 90 | + with ( |
| 91 | + patch("tck.handlers.schedule.get_client", return_value=MagicMock()), |
| 92 | + patch("tck.handlers.schedule.ScheduleInfoQuery", return_value=query), |
| 93 | + ): |
| 94 | + result = get_schedule_info(params) |
| 95 | + |
| 96 | + query.set_schedule_id.assert_called_once_with(ScheduleId.from_string("0.0.100")) |
| 97 | + assert isinstance(result, ScheduleInfoResponse) |
| 98 | + assert result.scheduleId == "0.0.100" |
| 99 | + assert result.creatorAccountId == "0.0.10" |
| 100 | + assert result.payerAccountId == "0.0.20" |
| 101 | + assert result.scheduledTransactionId == "0.0.20@1700000000.0" |
| 102 | + assert result.expirationTime == "1700000500" |
| 103 | + assert result.scheduleMemo == "a memo" |
| 104 | + assert result.waitForExpiry is True |
| 105 | + assert result.cost is None |
| 106 | + |
| 107 | + |
| 108 | +def test_get_schedule_info_keeps_nullable_fields_as_none(): |
| 109 | + """A pending, non-deleted schedule must keep executedAt/deletedAt as None, not empty strings.""" |
| 110 | + params = GetScheduleInfoParams(sessionId="session-1", scheduleId="0.0.100") |
| 111 | + query = _mock_query() |
| 112 | + query.execute.return_value = _mock_schedule_info(executed_at=None, deleted_at=None, admin_key=None) |
| 113 | + |
| 114 | + with ( |
| 115 | + patch("tck.handlers.schedule.get_client", return_value=MagicMock()), |
| 116 | + patch("tck.handlers.schedule.ScheduleInfoQuery", return_value=query), |
| 117 | + ): |
| 118 | + result = get_schedule_info(params) |
| 119 | + |
| 120 | + assert result.executedAt is None |
| 121 | + assert result.deletedAt is None |
| 122 | + assert result.adminKey is None |
| 123 | + |
| 124 | + |
| 125 | +def test_get_schedule_info_applies_query_payments(): |
| 126 | + params = GetScheduleInfoParams( |
| 127 | + sessionId="session-1", scheduleId="0.0.100", queryPayment="1000", maxQueryPayment="5000" |
| 128 | + ) |
| 129 | + query = _mock_query() |
| 130 | + query.execute.return_value = _mock_schedule_info() |
| 131 | + |
| 132 | + with ( |
| 133 | + patch("tck.handlers.schedule.get_client", return_value=MagicMock()), |
| 134 | + patch("tck.handlers.schedule.ScheduleInfoQuery", return_value=query), |
| 135 | + ): |
| 136 | + get_schedule_info(params) |
| 137 | + |
| 138 | + query.set_query_payment.assert_called_once_with(Hbar.from_tinybars(1000)) |
| 139 | + query.set_max_query_payment.assert_called_once_with(Hbar.from_tinybars(5000)) |
| 140 | + |
| 141 | + |
| 142 | +def test_get_schedule_info_get_cost_returns_cost_only(): |
| 143 | + """getCost=true must return only the cost, without executing the full query.""" |
| 144 | + params = GetScheduleInfoParams(sessionId="session-1", scheduleId="0.0.100", getCost=True) |
| 145 | + query = _mock_query() |
| 146 | + query.get_cost.return_value = Hbar.from_tinybars(250) |
| 147 | + |
| 148 | + with ( |
| 149 | + patch("tck.handlers.schedule.get_client", return_value=MagicMock()), |
| 150 | + patch("tck.handlers.schedule.ScheduleInfoQuery", return_value=query), |
| 151 | + ): |
| 152 | + result = get_schedule_info(params) |
| 153 | + |
| 154 | + query.get_cost.assert_called_once() |
| 155 | + query.execute.assert_not_called() |
| 156 | + assert result == ScheduleInfoResponse(cost="250") |
| 157 | + |
| 158 | + |
| 159 | +def test_get_schedule_info_propagates_query_failure(): |
| 160 | + """A non-existent scheduleId (INVALID_SCHEDULE_ID) must surface, not be swallowed.""" |
| 161 | + params = GetScheduleInfoParams(sessionId="session-1", scheduleId="1000000.0.0") |
| 162 | + query = _mock_query() |
| 163 | + query.execute.side_effect = PrecheckError(status=1, transaction_id="0.0.1@1.1", message="INVALID_SCHEDULE_ID") |
| 164 | + |
| 165 | + with ( |
| 166 | + patch("tck.handlers.schedule.get_client", return_value=MagicMock()), |
| 167 | + patch("tck.handlers.schedule.ScheduleInfoQuery", return_value=query), |
| 168 | + pytest.raises(PrecheckError), |
| 169 | + ): |
| 170 | + get_schedule_info(params) |
| 171 | + |
| 172 | + |
| 173 | +def test_get_schedule_info_invalid_schedule_id_raises(): |
| 174 | + """A malformed scheduleId should fail via ScheduleId.from_string before hitting the network.""" |
| 175 | + params = GetScheduleInfoParams(sessionId="session-1", scheduleId="not-a-schedule-id") |
| 176 | + |
| 177 | + with patch("tck.handlers.schedule.get_client", return_value=MagicMock()), pytest.raises(ValueError): |
| 178 | + get_schedule_info(params) |
0 commit comments