|
| 1 | +# Copyright (c) MultiSafepay, Inc. All rights reserved. |
| 2 | + |
| 3 | +# This file is licensed under the Open Software License (OSL) version 3.0. |
| 4 | +# For a copy of the license, see the LICENSE.txt file in the project root. |
| 5 | + |
| 6 | +# See the DISCLAIMER.md file for disclaimer details. |
| 7 | + |
| 8 | +"""Unit tests for OrderManager.cancel_transaction behavior.""" |
| 9 | + |
| 10 | +from unittest.mock import MagicMock |
| 11 | + |
| 12 | +from multisafepay.api.base.response.api_response import ApiResponse |
| 13 | +from multisafepay.api.base.response.custom_api_response import ( |
| 14 | + CustomApiResponse, |
| 15 | +) |
| 16 | +from multisafepay.api.paths.orders.order_id.cancel.request.cancel_transaction_request import ( |
| 17 | + CancelTransactionRequest, |
| 18 | +) |
| 19 | +from multisafepay.api.paths.orders.order_id.cancel.response.cancel_transaction import ( |
| 20 | + CancelTransaction, |
| 21 | +) |
| 22 | +from multisafepay.api.paths.orders.order_manager import OrderManager |
| 23 | +from multisafepay.client.client import Client |
| 24 | +from multisafepay.client.credential_resolver import AuthScope |
| 25 | + |
| 26 | +ORDER_ID = "cloud-pos-cancel-1" |
| 27 | +TERMINAL_GROUP_ID = "Default" |
| 28 | + |
| 29 | + |
| 30 | +def _build_cancel_api_response() -> ApiResponse: |
| 31 | + return ApiResponse( |
| 32 | + headers={}, |
| 33 | + status_code=200, |
| 34 | + body={ |
| 35 | + "success": True, |
| 36 | + "data": { |
| 37 | + "status": "void", |
| 38 | + "financial_status": "void", |
| 39 | + "created": "2026-01-01T00:00:00", |
| 40 | + "modified": "2026-01-01T00:00:01", |
| 41 | + }, |
| 42 | + }, |
| 43 | + ) |
| 44 | + |
| 45 | + |
| 46 | +def test_cancel_transaction_with_terminal_group_scope() -> None: |
| 47 | + """Use terminal-group auth scope when terminal_group_id is provided.""" |
| 48 | + client = MagicMock() |
| 49 | + client.create_post_request.return_value = _build_cancel_api_response() |
| 50 | + |
| 51 | + manager = OrderManager(client) |
| 52 | + response = manager.cancel_transaction( |
| 53 | + cancel_transaction_request=ORDER_ID, |
| 54 | + terminal_group_id=TERMINAL_GROUP_ID, |
| 55 | + ) |
| 56 | + |
| 57 | + called_auth_scope = client.create_post_request.call_args.kwargs[ |
| 58 | + "auth_scope" |
| 59 | + ] |
| 60 | + |
| 61 | + assert isinstance(response, CustomApiResponse) |
| 62 | + assert isinstance(response.get_data(), CancelTransaction) |
| 63 | + assert response.get_data().status == "void" |
| 64 | + assert called_auth_scope == AuthScope( |
| 65 | + scope=Client.AUTH_SCOPE_TERMINAL_GROUP, |
| 66 | + group_id=TERMINAL_GROUP_ID, |
| 67 | + ) |
| 68 | + |
| 69 | + |
| 70 | +def test_cancel_transaction_without_terminal_group_scope() -> None: |
| 71 | + """Omit auth scope when terminal_group_id is not provided.""" |
| 72 | + client = MagicMock() |
| 73 | + client.create_post_request.return_value = _build_cancel_api_response() |
| 74 | + |
| 75 | + manager = OrderManager(client) |
| 76 | + response = manager.cancel_transaction( |
| 77 | + cancel_transaction_request=ORDER_ID, |
| 78 | + ) |
| 79 | + |
| 80 | + called_auth_scope = client.create_post_request.call_args.kwargs[ |
| 81 | + "auth_scope" |
| 82 | + ] |
| 83 | + |
| 84 | + assert isinstance(response, CustomApiResponse) |
| 85 | + assert called_auth_scope is None |
| 86 | + |
| 87 | + |
| 88 | +def test_cancel_transaction_accepts_request_object() -> None: |
| 89 | + """Accept CancelTransactionRequest as input instead of raw string.""" |
| 90 | + client = MagicMock() |
| 91 | + client.create_post_request.return_value = _build_cancel_api_response() |
| 92 | + |
| 93 | + request = CancelTransactionRequest(order_id=ORDER_ID) |
| 94 | + |
| 95 | + manager = OrderManager(client) |
| 96 | + response = manager.cancel_transaction( |
| 97 | + cancel_transaction_request=request, |
| 98 | + terminal_group_id=TERMINAL_GROUP_ID, |
| 99 | + ) |
| 100 | + |
| 101 | + called_endpoint = client.create_post_request.call_args.args[0] |
| 102 | + |
| 103 | + assert isinstance(response, CustomApiResponse) |
| 104 | + assert ORDER_ID in called_endpoint |
| 105 | + assert called_endpoint.endswith("/cancel") |
| 106 | + |
| 107 | + |
| 108 | +def test_cancel_transaction_encodes_order_id() -> None: |
| 109 | + """Verify order ID with special chars is encoded in the endpoint.""" |
| 110 | + client = MagicMock() |
| 111 | + client.create_post_request.return_value = _build_cancel_api_response() |
| 112 | + |
| 113 | + manager = OrderManager(client) |
| 114 | + manager.cancel_transaction( |
| 115 | + cancel_transaction_request="order/special&chars", |
| 116 | + ) |
| 117 | + |
| 118 | + called_endpoint = client.create_post_request.call_args.args[0] |
| 119 | + assert "order%2Fspecial%26chars" in called_endpoint |
0 commit comments