Privex JsonRPC Emulators documentation¶
Welcome to the documentation for Privex’s JsonRPC Emulators - a package designed to emulate common JsonRPC
APIs, such as bitcoind ‘s JsonRPC, allowing for unit/integration testing RPC-reliant code, without needing
the appropriate daemon installed (which could require a lot of configuration, synchronisation etc.).
This documentation is automatically kept up to date by ReadTheDocs, as it is automatically re-built each time a new commit is pushed to the Github Project
Contents
Quickstart¶
Installing with Pipenv (recommended)
pipenv install rpcemulator
Installing with standard pip3
pip3 install rpcemulator
Example Usages¶
Using a JsonRPC emulator in a unit test¶
import unittest
from privex.rpcemulator.bitcoin import BitcoinEmulator
from privex.jsonrpc import BitcoinRPC
class TestMyThing(unittest.TestCase):
emulator: BitcoinEmulator
"""Stores the :class:`.BitcoinEmulator` instance"""
rpc = BitcoinRPC()
"""For this example, we're using our BitcoinRPC class and communicating with the RPC directly"""
@classmethod
def setUpClass(cls) -> None:
"""Launch the Bitcoin RPC emulator in the background on default port 8332"""
cls.emulator = BitcoinEmulator()
@classmethod
def tearDownClass(cls) -> None:
"""Shutdown the Bitcoin RPC emulator process"""
cls.emulator.terminate()
def test_something(self):
"""Run whatever code depends on a Bitcoin RPC"""
self.assertGreater(self.rpc.getbalance(), 0)
Using a JsonRPC emulator in your code, with a Context Manager¶
Use the appropriate emulator class with a with statement so the server is automatically stopped once you’re
done querying it.
This prevents any risk of the web server process being leftover.
from privex.rpcemulator.bitcoin import BitcoinEmulator
from privex.jsonrpc import BitcoinRPC
rpc = BitcoinRPC()
print('Starting BitcoinEmulator')
with BitcoinEmulator():
print('Balance is:', rpc.getbalance())
print('Network info is:', rpc.getnetworkinfo())
print('Stopped BitcoinEmulator')
Python Module Overview¶
Below is a listing of the sub-modules available in rpcemulator with a short description of what each module
contains.
Bitcoin RPC emulator - emulates a limited bitcoind JsonRPC API |
|
All Documentation¶
Installation¶
Download and install from PyPi using pip (recommended)¶
pipenv install rpcemulator # Using pipenv
pip3 install rpcemulator # Using normal pip
(Alternative) Manual install from Git¶
Option 1 - Use pip to install straight from Github
pip3 install git+https://github.com/Privex/rpcemulator
Option 2 - Clone and install manually
# Clone the repository from Github
git clone https://github.com/Privex/rpcemulator
cd rpcemulator
# RECOMMENDED MANUAL INSTALL METHOD
# Use pip to install the source code
pip3 install .
# ALTERNATIVE MANUAL INSTALL METHOD
# If you don't have pip, or have issues with installing using it, then you can use setuptools instead.
python3 setup.py install
Example Usages¶
Using a JsonRPC emulator in a unit test¶
import unittest
from privex.rpcemulator.bitcoin import BitcoinEmulator
from privex.jsonrpc import BitcoinRPC
class TestMyThing(unittest.TestCase):
emulator: BitcoinEmulator
"""Stores the :class:`.BitcoinEmulator` instance"""
rpc = BitcoinRPC()
"""For this example, we're using our BitcoinRPC class and communicating with the RPC directly"""
@classmethod
def setUpClass(cls) -> None:
"""Launch the Bitcoin RPC emulator in the background on default port 8332"""
cls.emulator = BitcoinEmulator()
@classmethod
def tearDownClass(cls) -> None:
"""Shutdown the Bitcoin RPC emulator process"""
cls.emulator.terminate()
def test_something(self):
"""Run whatever code depends on a Bitcoin RPC"""
self.assertGreater(self.rpc.getbalance(), 0)
Using a JsonRPC emulator in your code, with a Context Manager¶
Use the appropriate emulator class with a with statement so the server is automatically stopped once you’re
done querying it.
This prevents any risk of the web server process being leftover.
from privex.rpcemulator.bitcoin import BitcoinEmulator
from privex.jsonrpc import BitcoinRPC
rpc = BitcoinRPC()
print('Starting BitcoinEmulator')
with BitcoinEmulator():
print('Balance is:', rpc.getbalance())
print('Network info is:', rpc.getnetworkinfo())
print('Stopped BitcoinEmulator')
Bitcoin RPC emulator - emulates a limited bitcoind JsonRPC API |
|
How to use the unit tests¶
This module contains test cases for Privex’s JsonRPC Emulators (rpcemulator).
Testing pre-requisites¶
Ensure you have any mandatory requirements installed (see setup.py’s install_requires)
You may wish to install any optional requirements listed in README.md for best results
Python 3.7 is recommended at the time of writing this. See README.md in-case this has changed.
Running via PyTest¶
To run the tests, we strongly recommend using the pytest tool (used by default for our Travis CI):
# Install requirements.txt which should include PyTest
user@host: ~/rpcemulator $ pip3 install -r requirements.txt
# You can add `-v` for more detailed output, just like when running the tests directly.
user@host: ~/rpcemulator $ pytest
===================================== test session starts =====================================
platform darwin -- Python 3.7.0, pytest-5.0.1, py-1.8.0, pluggy-0.12.0
rootdir: /home/user/rpcemulator
collected 4 items
tests/test_bitcoin.py .... [100%]
============================ 4 passed, 1 warnings in 0.17 seconds =============================
Running directly using Python Unittest¶
Alternatively, you can run the tests by hand with python3.7 ( or just python3 )
user@the-matrix ~/rpcemulator $ python3.7 -m tests
....
----------------------------------------------------------------------
Ran 4 tests in 0.001s
OK
For more verbosity, simply add -v to the end of the command:
user@the-matrix ~/rpcemulator $ python3 -m tests -v
test_getblockchaininfo (tests.test_bitcoin.TestBitcoinEmulator)
Test that the ``getblockchaininfo`` JsonRPC call returns data as expected ... ok
test_getnetworkinfo (tests.test_bitcoin.TestBitcoinEmulator)
Test that the ``getnetworkinfo`` JsonRPC call returns data as expected ... ok
test_getnewaddress (tests.test_bitcoin.TestBitcoinEmulator)
Get a new address from the emulator and confirm it seems like a BTC address ... ok
test_send_valid (tests.test_bitcoin.TestBitcoinEmulator)
Test sending coins to external address creates a TX in listtransactions, and reduces the balance ... ok
----------------------------------------------------------------------
Ran 4 tests in 0.242s
OK
Copyright:
Copyright 2019 Privex Inc. ( https://www.privex.io )
License: X11 / MIT Github: https://github.com/Privex/rpcemulator
+===================================================+
| © 2019 Privex Inc. |
| https://www.privex.io |
+===================================================+
| |
| Originally Developed by Privex Inc. |
| |
| Core Developer(s): |
| |
| (+) Chris (@someguy123) [Privex] |
| (+) Kale (@kryogenic) [Privex] |
| |
+===================================================+
Copyright 2019 Privex Inc. ( https://www.privex.io )
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.