Initial stub for unit tests

Author: Jeff Schroeder

README.md

@@ -2,3 +2,21 @@ Pyth Client in Python
 =====================
 
 A Python library to retrieve data from Pyth account structures off the Solana blockchain.
+
+
+Developer Setup
+---------------
+
+To install this library in editable mode with test dependencies:
+
+    pip install -e '.[testing]'
+
+To run the unit tests:
+
+    pytest --cov=pythclient
+
+If html based test coverage is more your jam:
+
+    pytest --cov-report=html --cov=pythclient
+
+The coverage webpages will be in the `htmlcov` directory.

setup.py

@@ -1,10 +1,15 @@
 from setuptools import setup
 
+requirements = ['aiodns', 'aiohttp', 'backoff', 'base58', 'loguru']
+
 setup(
     name='pythclient',
-    version='0.0.1',
+    version='0.0.2',
     packages=['pythclient'],
     author='Pyth Developers',
     author_email='contact@pyth.network',
-    install_requires=['aiodns', 'aiohttp', 'backoff', 'base58', 'loguru']
+    install_requires=requirements,
+    extras_require={
+        'testing': requirements + ['pytest', 'pytest-cov'],
+    },
 )

tests/test_price_account_header.py

@@ -0,0 +1,93 @@
+import pytest
+
+from pythclient.pythaccounts import PythAccountType, _parse_header
+
+
+@pytest.fixture
+def valid_binary():
+    """
+    magic=0xA1B2C3D4 version=2, type=price, size=16
+    """
+    return bytes([212, 195, 178, 161, 2, 0, 0, 0, 3, 0, 0, 0, 16, 0, 0, 0])
+
+
+@pytest.fixture
+def valid_expected():
+    return PythAccountType.PRICE, 16, 2
+
+
+@pytest.fixture
+def bad_magic():
+    """
+    magic=0xDEADBEEF, version=2, type=price, size=16
+    """
+    return bytes([239, 190, 173, 222, 2, 0, 0, 0, 3, 0, 0, 0, 16, 0, 0, 0])
+
+
+@pytest.fixture
+def bad_magic_message():
+    return "Invalid Pyth account data header has wrong magic: expected a1b2c3d4, got deadbeef"
+
+
+@pytest.fixture
+def wrong_version():
+    """
+    magic=0xA1B2C3D4 version=42, type=price, size=16
+    """
+    return bytes([212, 195, 178, 161, 42, 0, 0, 0, 3, 0, 0, 0, 16, 0, 0, 0])
+
+
+@pytest.fixture
+def wrong_version_message():
+    return "Invalid Pyth account data has unsupported version 42"
+
+
+@pytest.fixture
+def wrong_size():
+    """
+    magic=0xA1B2C3D4 version=2, type=price, size=32
+    """
+    return bytes([212, 195, 178, 161, 2, 0, 0, 0, 3, 0, 0, 0, 32, 0, 0, 0])
+
+
+@pytest.fixture
+def wrong_size_message():
+    return "Invalid Pyth header says data is 32 bytes, but buffer only has 16 bytes"
+
+
+@pytest.fixture
+def too_short():
+    """
+    Totally bogus messge that is too short
+    """
+    return bytes([1, 2, 3, 4])
+
+
+@pytest.fixture
+def too_short_message():
+    return "Pyth account data too short"
+
+
+@pytest.mark.parametrize(
+        "buffer_fixture_name",
+        ["bad_magic", "wrong_version", "wrong_size", "too_short"],
+)
+def test_header_parsing_errors(buffer_fixture_name, request):
+    buffer = request.getfixturevalue(buffer_fixture_name)
+    exc_message = request.getfixturevalue(f"{buffer_fixture_name}_message")
+
+    with pytest.raises(ValueError, match=exc_message):
+        _parse_header(
+            buffer=buffer,
+            offset=0,
+            key="Invalid",
+        )
+
+
+def test_header_parsing_valid(valid_binary, valid_expected):
+    actual = _parse_header(
+        buffer=valid_binary,
+        offset=0,
+        key="Invalid",
+    )
+    assert actual == valid_expected

tests/test_price_info.py

@@ -0,0 +1,103 @@
+import pytest
+from pythclient.pythaccounts import PythPriceStatus, PythPriceInfo
+
+
+@pytest.fixture
+def price_info_trading():
+    return PythPriceInfo(
+        raw_price=59609162000,
+        raw_confidence_interval=43078500,
+        price_status=PythPriceStatus.TRADING,
+        slot=105367617,
+        exponent=-8,
+    )
+
+
+@pytest.fixture
+def price_info_trading_bytes():
+    return bytes([
+            16, 161, 251, 224, 13, 0, 0, 0, 100, 83, 145, 2, 0, 0,
+            0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 65, 200, 71, 6, 0, 0, 0, 0,
+    ])
+
+
+@pytest.mark.parametrize(
+    "raw_price,raw_confidence_interval,price_status,slot,exponent,price,confidence_interval",
+    [
+        (
+            1234567890,
+            3.0,
+            PythPriceStatus.TRADING,
+            12345,
+            -8,
+            12.345678900000001,
+            3.0000000000000004e-08,
+        ),
+        (0, 0, PythPriceStatus.UNKNOWN, 100001, -9, 0.0, 0.0),
+    ],
+)
+class TestPythPriceInfo:
+    def test_price_info(
+        self,
+        raw_price,
+        raw_confidence_interval,
+        price_status,
+        slot,
+        exponent,
+        price,
+        confidence_interval,
+    ):
+        actual = PythPriceInfo(
+            raw_price=raw_price,
+            raw_confidence_interval=raw_confidence_interval,
+            price_status=price_status,
+            slot=slot,
+            exponent=exponent,
+        )
+        for key, actual_value in dict(actual).items():
+            assert actual_value == locals().get(key), f"'{key}' mismatch"
+
+    def test_price_info_iter(
+        self,
+        raw_price,
+        raw_confidence_interval,
+        price_status,
+        slot,
+        exponent,
+        price,
+        confidence_interval,
+    ):
+        actual = dict(
+            PythPriceInfo(
+                raw_price=raw_price,
+                raw_confidence_interval=raw_confidence_interval,
+                price_status=price_status,
+                slot=slot,
+                exponent=exponent,
+            )
+        )
+        expected = {
+            "raw_price": raw_price,
+            "raw_confidence_interval": raw_confidence_interval,
+            "price_status": price_status,
+            "slot": slot,
+            "exponent": exponent,
+            "price": price,
+            "confidence_interval": confidence_interval,
+        }
+        assert actual == expected
+
+
+def test_price_info_deserialise(price_info_trading, price_info_trading_bytes):
+    actual = PythPriceInfo.deserialise(
+        buffer=price_info_trading_bytes,
+        offset=0,
+        exponent=price_info_trading.exponent,
+    )
+    assert dict(actual) == dict(price_info_trading)
+
+
+def test_price_info_str(price_info_trading):
+    expected = "PythPriceInfo status PythPriceStatus.TRADING price 596.09162"
+    assert str(price_info_trading) == expected
+    assert repr(price_info_trading) == expected