Exclude runtime typechecks from unit tests

jomuel · rakanalh · commit 44eebd9dbec3 · 2019-06-05T13:56:39.000+02:00
diff --git a/.unittest-coveragerc b/.unittest-coveragerc
@@ -5,6 +5,8 @@ exclude_lines =
 	if TYPE_CHECKING:
 	def __repr__
 	raise NotImplementedError
+	assert not isinstance
+	typecheck
 
 [run]
 branch = True
diff --git a/raiden/api/python.py b/raiden/api/python.py
@@ -130,7 +130,7 @@ def get_transfer_from_task(
             transfer = transfer_task.mediator_state.waiting_transfer.transfer
     elif isinstance(transfer_task, TargetTask):
         transfer = transfer_task.target_state.transfer
-    else:
+    else:  # pragma: no unittest
         raise ValueError("get_tranfer_from_task for a non TransferTask argument")
 
     return transfer, role
@@ -160,9 +160,8 @@ def transfer_tasks_view(
     return view
 
 
-class RaidenAPI:
+class RaidenAPI:  # pragma: no unittest
     # pylint: disable=too-many-public-methods
-    # pragma: no unittest
 
     def __init__(self, raiden):
         self.raiden = raiden
@@ -729,7 +728,7 @@ def transfer_async(
         current_state = views.state_from_raiden(self.raiden)
         payment_network_address = self.raiden.default_registry.address
 
-        if not isinstance(amount, int):
+        if not isinstance(amount, int):  # pragma: no unittest
             raise InvalidAmount("Amount not a number")
 
         if amount <= 0:
diff --git a/raiden/encoding/encoders.py b/raiden/encoding/encoders.py
@@ -1,3 +1,5 @@
+from raiden.utils.typing import typecheck
+
 __all__ = ("integer",)
 
 
@@ -10,8 +12,7 @@ def __init__(self, minimum: int, maximum: int):
 
     def validate(self, value: int):
         """ Validates the integer is in the value range. """
-        if not isinstance(value, int):
-            raise ValueError("value is not an integer")
+        typecheck(value, int)
 
         if self.minimum > value or self.maximum < value:
             msg = ("{} is outside the valide range [{},{}]").format(
diff --git a/raiden/messages.py b/raiden/messages.py
@@ -65,6 +65,7 @@
     TokenAmount,
     TokenNetworkAddress,
     Type,
+    typecheck,
 )
 
 __all__ = (
@@ -796,10 +797,7 @@ def __post_init__(self):
     def from_balance_proof_signed_state(
         cls, balance_proof: BalanceProofSignedState
     ) -> "SignedBlindedBalanceProof":
-        if not isinstance(balance_proof, BalanceProofSignedState):
-            raise ValueError(
-                "balance_proof is not an instance of the type BalanceProofSignedState"
-            )
+        typecheck(balance_proof, BalanceProofSignedState)
 
         # pylint: disable=unexpected-keyword-arg
         return cls(
@@ -852,11 +850,7 @@ class RequestMonitoring(SignedMessage):
     non_closing_signature: Optional[Signature] = None
 
     def __post_init__(self):
-        if self.balance_proof is None:
-            raise ValueError("no balance proof given")
-
-        if not isinstance(self.balance_proof, SignedBlindedBalanceProof):
-            raise ValueError("onchain_balance_proof is not a SignedBlindedBalanceProof")
+        typecheck(self.balance_proof, SignedBlindedBalanceProof)
 
     @classmethod
     def from_balance_proof_signed_state(
@@ -865,10 +859,7 @@ def from_balance_proof_signed_state(
         reward_amount: TokenAmount,
         monitoring_service_contract_address: Address,
     ) -> "RequestMonitoring":
-        if not isinstance(balance_proof, BalanceProofSignedState):
-            raise ValueError(
-                "balance_proof is not an instance of the type BalanceProofSignedState"
-            )
+        typecheck(balance_proof, BalanceProofSignedState)
 
         onchain_balance_proof = SignedBlindedBalanceProof.from_balance_proof_signed_state(
             balance_proof=balance_proof
diff --git a/raiden/network/blockchain_service.py b/raiden/network/blockchain_service.py
@@ -23,6 +23,7 @@
     TokenAddress,
     TokenNetworkAddress,
     Tuple,
+    typecheck,
 )
 from raiden_contracts.contract_manager import ContractManager
 
@@ -199,8 +200,7 @@ def payment_channel(self, canonical_identifier: CanonicalIdentifier) -> PaymentC
 
         if not is_binary_address(token_network_address):
             raise ValueError("address must be a valid address")
-        if not isinstance(channel_id, T_ChannelID):
-            raise ValueError("channel identifier must be of type T_ChannelID")
+        typecheck(channel_id, T_ChannelID)
 
         with self._payment_channel_creation_lock:
             dict_key = (token_network_address, channel_id)
diff --git a/raiden/network/proxies/token_network.py b/raiden/network/proxies/token_network.py
@@ -71,6 +71,7 @@
     TokenNetworkAddress,
     Tuple,
     cast,
+    typecheck,
 )
 from raiden_contracts.constants import (
     CONTRACT_TOKEN_NETWORK,
@@ -420,7 +421,7 @@ def _detail_channel(
                 participant2=participant2,
                 block_identifier=block_identifier,
             )
-        elif not isinstance(channel_identifier, T_ChannelID):
+        elif not isinstance(channel_identifier, T_ChannelID):  # pragma: no unittest
             raise InvalidChannelID("channel_identifier must be of type T_ChannelID")
         elif channel_identifier <= 0 or channel_identifier > UINT256_MAX:
             raise InvalidChannelID(
@@ -464,7 +465,7 @@ def detail_participants(
                 participant2=participant2,
                 block_identifier=block_identifier,
             )
-        elif not isinstance(channel_identifier, T_ChannelID):
+        elif not isinstance(channel_identifier, T_ChannelID):  # pragma: no unittest
             raise InvalidChannelID("channel_identifier must be of type T_ChannelID")
         elif channel_identifier <= 0 or channel_identifier > UINT256_MAX:
             raise InvalidChannelID(
@@ -703,8 +704,7 @@ def set_total_deposit(
             RuntimeError: If the token address is empty.
             ValueError: If an argument is of the invalid type.
         """
-        if not isinstance(total_deposit, int):
-            raise ValueError("total_deposit needs to be an integer number.")
+        typecheck(total_deposit, int)
 
         with self.channel_operations_lock[partner], self.deposit_lock:
             previous_total_deposit = self._detail_participant(
@@ -1840,8 +1840,7 @@ def _get_channel_state(
             channel_identifier=channel_identifier,
         )
 
-        if not isinstance(channel_data.state, T_ChannelState):
-            raise ValueError("channel state must be of type ChannelState")
+        typecheck(channel_data.state, T_ChannelState)
 
         return channel_data.state
 
diff --git a/raiden/network/proxies/token_network_registry.py b/raiden/network/proxies/token_network_registry.py
@@ -35,6 +35,7 @@
     T_TargetAddress,
     TokenAddress,
     TokenAmount,
+    typecheck,
 )
 from raiden_contracts.constants import CONTRACT_TOKEN_NETWORK_REGISTRY, EVENT_TOKEN_NETWORK_CREATED
 from raiden_contracts.contract_manager import ContractManager
@@ -82,8 +83,7 @@ def get_token_network(
         """ Return the token network address for the given token or None if
         there is no correspoding address.
         """
-        if not isinstance(token_address, T_TargetAddress):
-            raise ValueError("token_address must be an address")
+        typecheck(token_address, T_TargetAddress)
 
         address = self.proxy.contract.functions.token_to_token_networks(
             to_checksum_address(token_address)
diff --git a/raiden/network/proxies/user_deposit.py b/raiden/network/proxies/user_deposit.py
@@ -21,6 +21,7 @@
     TokenAddress,
     TokenAmount,
     Tuple,
+    typecheck,
 )
 from raiden_contracts.constants import CONTRACT_USER_DEPOSIT, GAS_REQUIRED_FOR_UDC_DEPOSIT
 from raiden_contracts.contract_manager import ContractManager
@@ -158,8 +159,7 @@ def _deposit_preconditions(
         token: Token,
         block_identifier: BlockSpecification,
     ) -> Tuple[TokenAmount, Dict]:
-        if not isinstance(total_deposit, int):
-            raise ValueError("total_deposit needs to be an integer number.")
+        typecheck(total_deposit, int)
 
         previous_total_deposit = self.get_total_deposit(
             address=beneficiary, block_identifier=block_identifier
diff --git a/raiden/tests/utils/transfer.py b/raiden/tests/utils/transfer.py
@@ -44,6 +44,7 @@
     TokenAddress,
     TokenAmount,
     TokenNetworkAddress,
+    typecheck,
 )
 
 
@@ -513,8 +514,7 @@ def make_receive_transfer_mediated(
     chain_id: Optional[ChainID] = None,
 ) -> LockedTransferSignedState:
 
-    if not isinstance(lock, HashTimeLockState):
-        raise ValueError("lock must be of type HashTimeLockState")
+    typecheck(lock, HashTimeLockState)
 
     signer = LocalSigner(privkey)
     address = signer.address
@@ -584,8 +584,7 @@ def make_receive_expired_lock(
     chain_id: ChainID = None,
 ) -> ReceiveLockExpired:
 
-    if not isinstance(lock, HashTimeLockState):
-        raise ValueError("lock must be of type HashTimeLockState")
+    typecheck(lock, HashTimeLockState)
 
     signer = LocalSigner(privkey)
     address = signer.address
diff --git a/raiden/transfer/architecture.py b/raiden/transfer/architecture.py
@@ -34,6 +34,7 @@
     TransactionHash,
     Tuple,
     TypeVar,
+    typecheck,
 )
 
 # Quick overview
@@ -159,8 +160,7 @@ class ContractSendEvent(Event):
     triggered_by_block_hash: BlockHash
 
     def __post_init__(self) -> None:
-        if not isinstance(self.triggered_by_block_hash, T_BlockHash):
-            raise ValueError("triggered_by_block_hash must be of type block_hash")
+        typecheck(self.triggered_by_block_hash, T_BlockHash)
 
 
 @dataclass
@@ -181,10 +181,8 @@ class ContractReceiveStateChange(StateChange):
     block_hash: BlockHash
 
     def __post_init__(self) -> None:
-        if not isinstance(self.block_number, T_BlockNumber):
-            raise ValueError("block_number must be of type block_number")
-        if not isinstance(self.block_hash, T_BlockHash):
-            raise ValueError("block_hash must be of type block_hash")
+        typecheck(self.block_number, T_BlockNumber)
+        typecheck(self.block_hash, T_BlockHash)
 
 
 ST = TypeVar("ST", bound=State)
@@ -208,7 +206,7 @@ def __init__(
             state_transition: function that can apply a StateChange message.
             current_state: current application state.
         """
-        if not callable(state_transition):
+        if not callable(state_transition):  # pragma: no unittest
             raise ValueError("state_transition must be a callable")
 
         self.state_transition = state_transition
@@ -291,17 +289,10 @@ class BalanceProofUnsignedState(State):
     balance_hash: BalanceHash = field(default=EMPTY_BALANCE_HASH)
 
     def __post_init__(self) -> None:
-        if not isinstance(self.nonce, int):
-            raise ValueError("nonce must be int")
-
-        if not isinstance(self.transferred_amount, T_TokenAmount):
-            raise ValueError("transferred_amount must be a token_amount instance")
-
-        if not isinstance(self.locked_amount, T_TokenAmount):
-            raise ValueError("locked_amount must be a token_amount instance")
-
-        if not isinstance(self.locksroot, T_Keccak256):
-            raise ValueError("locksroot must be a keccak256 instance")
+        typecheck(self.nonce, int)
+        typecheck(self.transferred_amount, T_TokenAmount)
+        typecheck(self.locked_amount, T_TokenAmount)
+        typecheck(self.locksroot, T_Keccak256)
 
         if self.nonce <= 0:
             raise ValueError("nonce cannot be zero or negative")
@@ -356,26 +347,13 @@ class BalanceProofSignedState(State):
     balance_hash: BalanceHash = field(default=EMPTY_BALANCE_HASH)
 
     def __post_init__(self) -> None:
-        if not isinstance(self.nonce, int):
-            raise ValueError("nonce must be int")
-
-        if not isinstance(self.transferred_amount, T_TokenAmount):
-            raise ValueError("transferred_amount must be a token_amount instance")
-
-        if not isinstance(self.locked_amount, T_TokenAmount):
-            raise ValueError("locked_amount must be a token_amount instance")
-
-        if not isinstance(self.locksroot, T_Keccak256):
-            raise ValueError("locksroot must be a keccak256 instance")
-
-        if not isinstance(self.message_hash, T_Keccak256):
-            raise ValueError("message_hash must be a keccak256 instance")
-
-        if not isinstance(self.signature, T_Signature):
-            raise ValueError("signature must be a signature instance")
-
-        if not isinstance(self.sender, T_Address):
-            raise ValueError("sender must be an address instance")
+        typecheck(self.nonce, int)
+        typecheck(self.transferred_amount, T_TokenAmount)
+        typecheck(self.locked_amount, T_TokenAmount)
+        typecheck(self.locksroot, T_Keccak256)
+        typecheck(self.message_hash, T_Keccak256)
+        typecheck(self.signature, T_Signature)
+        typecheck(self.sender, T_Address)
 
         if self.nonce <= 0:
             raise ValueError("nonce cannot be zero or negative")
diff --git a/raiden/transfer/identifiers.py b/raiden/transfer/identifiers.py
@@ -9,6 +9,7 @@
     T_ChainID,
     T_ChannelID,
     TokenNetworkAddress,
+    typecheck,
 )
 
 
@@ -19,14 +20,9 @@ class CanonicalIdentifier:
     channel_identifier: ChannelID
 
     def validate(self) -> None:
-        if not isinstance(self.token_network_address, T_Address):
-            raise ValueError("token_network_address must be an address instance")
-
-        if not isinstance(self.channel_identifier, T_ChannelID):
-            raise ValueError("channel_identifier must be an ChannelID instance")
-
-        if not isinstance(self.chain_identifier, T_ChainID):
-            raise ValueError("chain_id must be a ChainID instance")
+        typecheck(self.chain_identifier, T_ChainID)
+        typecheck(self.token_network_address, T_Address)
+        typecheck(self.channel_identifier, T_ChannelID)
 
         if self.channel_identifier < 0 or self.channel_identifier > constants.UINT256_MAX:
             raise ValueError("channel id is invalid")
diff --git a/raiden/transfer/mediated_transfer/events.py b/raiden/transfer/mediated_transfer/events.py
@@ -16,6 +16,7 @@
     SecretHash,
     TokenAddress,
     TokenNetworkAddress,
+    typecheck,
 )
 
 
@@ -44,8 +45,7 @@ class SendLockedTransfer(SendMessageEvent):
 
     def __post_init__(self) -> None:
         super().__post_init__()
-        if not isinstance(self.transfer, LockedTransferUnsignedState):
-            raise ValueError("transfer must be a LockedTransferUnsignedState instance")
+        typecheck(self.transfer, LockedTransferUnsignedState)
 
     @property
     def balance_proof(self) -> BalanceProofUnsignedState:
diff --git a/raiden/transfer/mediated_transfer/state.py b/raiden/transfer/mediated_transfer/state.py
diff --git a/raiden/transfer/mediated_transfer/state_change.py b/raiden/transfer/mediated_transfer/state_change.py
diff --git a/raiden/transfer/secret_registry.py b/raiden/transfer/secret_registry.py
diff --git a/raiden/transfer/state.py b/raiden/transfer/state.py
diff --git a/raiden/transfer/state_change.py b/raiden/transfer/state_change.py
diff --git a/raiden/utils/typing.py b/raiden/utils/typing.py
