nucypher/tests/unit/test_web3_clients.py

333 lines
9.8 KiB
Python

"""
This file is part of nucypher.
nucypher is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
nucypher is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with nucypher. If not, see <https://www.gnu.org/licenses/>.
"""
import datetime
import pytest
from web3 import HTTPProvider, IPCProvider, WebsocketProvider
from nucypher.blockchain.eth.clients import (EthereumClient, GanacheClient, GethClient, InfuraClient, PUBLIC_CHAINS,
ParityClient)
from nucypher.blockchain.eth.interfaces import BlockchainInterface
#
# Mock Providers
#
class MockGethProvider:
endpoint_uri = 'file:///ipc.geth'
clientVersion = 'Geth/v1.4.11-stable-fed692f6/darwin/go1.7'
class MockParityProvider:
endpoint_uri = 'file:///ipc.parity'
clientVersion = 'Parity-Ethereum/v2.5.1-beta-e0141f8-20190510/x86_64-linux-gnu/rustc1.34.1'
class MockGanacheProvider:
endpoint_uri = 'http://ganache:8445'
clientVersion = 'EthereumJS TestRPC/v2.1.5/ethereum-js'
class MockInfuraProvider:
endpoint_uri = 'wss://:@goerli.infura.io/ws/v3/1234567890987654321abcdef'
clientVersion = 'Geth/v1.8.23-omnibus-2ad89aaa/linux-amd64/go1.11.1'
class MockWebSocketProvider:
endpoint_uri = 'ws://127.0.0.1:8546'
clientVersion = 'Geth/v1.8.23-omnibus-2ad89aaa/linux-amd64/go1.11.1'
class SyncedMockW3Eth:
# Support older and newer versions of web3 py in-test
version = 5
chainId = hex(5)
blockNumber = 5
def getBlock(self, blockNumber):
return {
'timestamp': datetime.datetime.timestamp(datetime.datetime.now() - datetime.timedelta(seconds=25))
}
class SyncingMockW3Eth(SyncedMockW3Eth):
_sync_test_limit = 10
def __init__(self, *args, **kwargs):
self._syncing_counter = 0
super().__init__(*args, **kwargs)
@property
def syncing(self):
if self._syncing_counter < self._sync_test_limit:
self._syncing_counter += 1
return {
'currentBlock': self._syncing_counter,
'highestBlock': self._sync_test_limit,
}
return False
def getBlock(self, blockNumber):
return {
'timestamp': datetime.datetime.timestamp(datetime.datetime.now() - datetime.timedelta(seconds=500))
}
class MockedW3GethWithPeers:
@property
def admin(self):
class GethAdmin:
def peers(self):
return [1, 2, 3]
return GethAdmin()
class MockedW3GethWithNoPeers:
@property
def admin(self):
class GethAdmin:
def peers(self):
return []
return GethAdmin()
#
# Mock Web3
#
class SyncedMockWeb3:
net = SyncedMockW3Eth()
eth = SyncedMockW3Eth()
geth = MockedW3GethWithPeers()
def __init__(self, provider):
self.provider = provider
@property
def clientVersion(self):
return self.provider.clientVersion
@property
def isConnected(self):
return lambda: True
class SyncingMockWeb3(SyncedMockWeb3):
net = SyncingMockW3Eth()
eth = SyncingMockW3Eth()
class SyncingMockWeb3NoPeers(SyncingMockWeb3):
geth = MockedW3GethWithNoPeers()
# Mock Blockchain
#
class BlockchainInterfaceTestBase(BlockchainInterface):
Web3 = SyncedMockWeb3
def _configure_registry(self, *args, **kwargs):
pass
def _setup_solidity(self, *args, **kwargs):
pass
def attach_middleware(self):
pass
class ProviderTypeTestClient(BlockchainInterfaceTestBase):
def __init__(self,
expected_provider_class,
actual_provider_to_attach,
*args,
**kwargs):
super().__init__(*args, **kwargs)
self.expected_provider_class = expected_provider_class
self.test_provider_to_attach = actual_provider_to_attach
def _attach_provider(self, *args, **kwargs) -> None:
super()._attach_provider(*args, **kwargs)
# check type
assert isinstance(self.provider, self.expected_provider_class)
super()._attach_provider(provider=self.test_provider_to_attach)
class InfuraTestClient(BlockchainInterfaceTestBase):
def _attach_provider(self, *args, **kwargs) -> None:
super()._attach_provider(provider=MockInfuraProvider())
class GethClientTestBlockchain(BlockchainInterfaceTestBase):
def _attach_provider(self, *args, **kwargs) -> None:
super()._attach_provider(provider=MockGethProvider())
@property
def is_local(self):
return int(self.w3.net.version) not in PUBLIC_CHAINS
class ParityClientTestInterface(BlockchainInterfaceTestBase):
def _attach_provider(self, *args, **kwargs) -> None:
super()._attach_provider(provider=MockParityProvider())
class GanacheClientTestInterface(BlockchainInterfaceTestBase):
def _attach_provider(self, *args, **kwargs) -> None:
super()._attach_provider(provider=MockGanacheProvider())
def test_client_no_provider():
with pytest.raises(BlockchainInterface.NoProvider) as e:
interface = BlockchainInterfaceTestBase()
interface.connect()
def test_geth_web3_client():
interface = GethClientTestBlockchain(provider_uri='file:///ipc.geth')
interface.connect()
assert isinstance(interface.client, GethClient)
assert interface.client.node_technology == 'Geth'
assert interface.client.node_version == 'v1.4.11-stable-fed692f6'
assert interface.client.platform == 'darwin'
assert interface.client.backend == 'go1.7'
assert interface.client.is_local is False
assert interface.client.chain_id == 5 # Hardcoded above
def test_autodetect_provider_type_file(tempfile_path):
interface = ProviderTypeTestClient(provider_uri=tempfile_path, # existing file for test
expected_provider_class=IPCProvider,
actual_provider_to_attach=MockGethProvider())
interface.connect()
assert isinstance(interface.client, GethClient)
def test_autodetect_provider_type_file_none_existent():
with pytest.raises(BlockchainInterface.UnsupportedProvider) as e:
interface = BlockchainInterfaceTestBase(provider_uri='/none_existent.ipc.geth')
interface.connect()
def test_detect_provider_type_file():
interface = ProviderTypeTestClient(provider_uri='file:///ipc.geth',
expected_provider_class=IPCProvider,
actual_provider_to_attach=MockGethProvider())
interface.connect()
assert isinstance(interface.client, GethClient)
def test_detect_provider_type_ipc():
interface = ProviderTypeTestClient(provider_uri='ipc:///ipc.geth',
expected_provider_class=IPCProvider,
actual_provider_to_attach=MockGethProvider())
interface.connect()
assert isinstance(interface.client, GethClient)
def test_detect_provider_type_http():
interface = ProviderTypeTestClient(provider_uri='http://ganache:8445',
expected_provider_class=HTTPProvider,
actual_provider_to_attach=MockGanacheProvider())
interface.connect()
assert isinstance(interface.client, GanacheClient)
def test_detect_provider_type_https():
interface = ProviderTypeTestClient(provider_uri='https://ganache:8445',
expected_provider_class=HTTPProvider,
actual_provider_to_attach=MockGanacheProvider())
interface.connect()
assert isinstance(interface.client, GanacheClient)
def test_detect_provider_type_ws():
interface = ProviderTypeTestClient(provider_uri='ws://127.0.0.1:8546',
expected_provider_class=WebsocketProvider,
actual_provider_to_attach=MockWebSocketProvider())
interface.connect()
assert isinstance(interface.client, GethClient)
def test_infura_web3_client():
interface = InfuraTestClient(provider_uri='infura://1234567890987654321abcdef')
interface.connect()
assert isinstance(interface.client, InfuraClient)
assert interface.client.node_technology == 'Geth'
assert interface.client.node_version == 'v1.8.23-omnibus-2ad89aaa'
assert interface.client.platform == 'linux-amd64'
assert interface.client.backend == 'go1.11.1'
assert interface.client.is_local is False
assert interface.client.chain_id == 5
assert interface.client.unlock_account('address', 'password') # Returns True on success
def test_parity_web3_client():
interface = ParityClientTestInterface(provider_uri='file:///ipc.parity')
interface.connect()
assert isinstance(interface.client, ParityClient)
assert interface.client.node_technology == 'Parity-Ethereum'
assert interface.client.node_version == 'v2.5.1-beta-e0141f8-20190510'
assert interface.client.platform == 'x86_64-linux-gnu'
assert interface.client.backend == 'rustc1.34.1'
def test_ganache_web3_client():
interface = GanacheClientTestInterface(provider_uri='http://ganache:8445')
interface.connect()
assert isinstance(interface.client, GanacheClient)
assert interface.client.node_technology == 'EthereumJS TestRPC'
assert interface.client.node_version == 'v2.1.5'
assert interface.client.platform is None
assert interface.client.backend == 'ethereum-js'
assert interface.client.is_local