Skip to content

Test Vinter Utils

test_vinter_utils

test_classess 

test_classess()

This function tests the classes in the vinter_validation.py and vinter_url.py files

Source code in tests/test_vinter_utils.py 
 7
 8
 9
10
11
12
13
14
def test_classess():
    """This function tests the classes in the vinter_validation.py and vinter_url.py files"""
    vinter_validation = VinterValidation()
    vinter_url = VinterUrl()
    vinter_error = VinterError()
    assert vinter_error is not None
    assert vinter_validation is not None
    assert vinter_url is not None

test_get_active_url 

test_get_active_url()

The function get_active_url takes an asset type as a string and returns the url for the active assets of that type.

Source code in tests/test_vinter_utils.py 
86
87
88
89
90
91
92
93
def test_get_active_url():
    """> The function `get_active_url` takes an asset type as a string and returns the url for the active
    assets of that type.

    """
    asset_type = "multi_assets"
    url = VinterUrl.get_active_url(asset_type)
    assert url == f"https://www.vinterapi.com/api/v3/active_{asset_type}"

test_get_active_url_invalid_asset_type 

test_get_active_url_invalid_asset_type()

get_active_url returns the active url for the given asset type

Source code in tests/test_vinter_utils.py 
 96
 97
 98
 99
100
def test_get_active_url_invalid_asset_type():
    """`get_active_url` returns the active url for the given asset type"""
    asset_type = "invalid_asset_type"
    with pytest.raises(ValueError):
        VinterUrl.get_active_url(asset_type)

test_get_url 

test_get_url()

The function get_url takes two arguments, asset_type and frequency, and returns a string that is the url for the Vinter API

Source code in tests/test_vinter_utils.py 
103
104
105
106
107
108
109
110
111
def test_get_url():
    """> The function `get_url` takes two arguments, `asset_type` and `frequency`, and returns a string
    that is the url for the Vinter API

    """
    asset_type = "multi_assets"
    frequency = "d"
    url = VinterUrl.get_url(asset_type, frequency)
    assert url == f"https://www.vinterapi.com/api/v3/{asset_type}_daily"

test_get_url_by_symbol 

test_get_url_by_symbol()

Given an asset type and a symbol, return the url for the corresponding API endpoint

Source code in tests/test_vinter_utils.py 
125
126
127
128
129
130
131
def test_get_url_by_symbol():
    """> Given an asset type and a symbol, return the url for the corresponding API endpoint"""
    asset_type = "single_assets"
    symbol = "btc-usd-p-d"

    url = VinterUrl.get_url_by_symbol(asset_type, symbol)
    assert url == "https://www.vinterapi.com/api/v3/single_assets_daily"

test_get_url_invalid_asset_type 

test_get_url_invalid_asset_type()

It tests that the function get_url raises a ValueError when an invalid asset type is passed to it

Source code in tests/test_vinter_utils.py 
114
115
116
117
118
119
120
121
122
def test_get_url_invalid_asset_type():
    """It tests that the function `get_url` raises a `ValueError` when an invalid asset type is passed to
    it

    """
    asset_type = "invalid_asset_type"
    frequency = "d"
    with pytest.raises(ValueError):
        VinterUrl.get_url(asset_type, frequency)

test_get_websocket_url 

test_get_websocket_url()

Given an asset type and a symbol, return the url for the corresponding websocket endpoint

Source code in tests/test_vinter_utils.py 
134
135
136
137
138
139
140
def test_get_websocket_url():
    """> Given an asset type and a symbol, return the url for the corresponding websocket endpoint"""
    asset_type = "single_assets"
    symbol = "btc-usd-p-d"

    url = VinterUrl.websocket_url(asset_type, symbol)
    assert url == f"wss://www.vinterapi.com/ws/singleassets/{symbol}"

test_get_websocket_url_invalid_asset_type 

test_get_websocket_url_invalid_asset_type()

It tests that the function get_websocket_url raises a ValueError when an invalid asset type is passed to it

Source code in tests/test_vinter_utils.py 
143
144
145
146
147
148
149
150
151
def test_get_websocket_url_invalid_asset_type():
    """It tests that the function `get_websocket_url` raises a `ValueError` when an invalid asset type is
    passed to it

    """
    asset_type = "invalid_asset_type"
    symbol = "btc-usd-p-d"
    with pytest.raises(ValueError):
        VinterUrl.websocket_url(asset_type, symbol)

test_get_websocket_url_no_symbol 

test_get_websocket_url_no_symbol()

It tests that the function get_websocket_url raises a ValueError when no symbol is passed to it

Source code in tests/test_vinter_utils.py 
154
155
156
157
158
159
160
161
162
def test_get_websocket_url_no_symbol():
    """It tests that the function `get_websocket_url` raises a `ValueError` when no symbol is passed to
    it

    """
    asset_type = "single_assets"
    symbol = None
    with pytest.raises(ValueError):
        VinterUrl.websocket_url(asset_type, symbol)

test_invalid_asset_type 

test_invalid_asset_type()

test_invalid_asset_type tests that the validate_asset_type function raises a ValueError when an invalid asset type is passed to it

Source code in tests/test_vinter_utils.py 
46
47
48
49
50
51
52
def test_invalid_asset_type():
    """`test_invalid_asset_type` tests that the `validate_asset_type` function raises a `ValueError` when
    an invalid asset type is passed to it

    """
    with pytest.raises(ValueError):
        VinterValidation.validate_asset_type("invalid_asset")

test_invalid_frequency 

test_invalid_frequency()

It raises a ValueError if the frequency is not one of the valid frequencies

Source code in tests/test_vinter_utils.py 
61
62
63
64
def test_invalid_frequency():
    """It raises a ValueError if the frequency is not one of the valid frequencies"""
    with pytest.raises(ValueError):
        VinterValidation.validate_frequency("invalid_frequency")

test_invalid_symbol 

test_invalid_symbol()

It raises a ValueError if the symbol is not a valid symbol

Source code in tests/test_vinter_utils.py 
80
81
82
83
def test_invalid_symbol():
    """It raises a ValueError if the symbol is not a valid symbol"""
    with pytest.raises(ValueError):
        VinterValidation.validate_symbol_frequency("invalid_symbol")

test_symbol_none 

test_symbol_none()

It tests that the function validate_symbol_frequency raises a ValueError when no symbol is passed to it

Source code in tests/test_vinter_utils.py 
165
166
167
168
169
170
171
172
def test_symbol_none():
    """It tests that the function `validate_symbol_frequency` raises a `ValueError` when no symbol is
    passed to it

    """
    symbol = None
    with pytest.raises(ValueError):
        VinterValidation.validate_symbol_frequency(symbol)

test_valid_asset_type 

test_valid_asset_type()

This function checks if the asset type is valid

Source code in tests/test_vinter_utils.py 
40
41
42
43
def test_valid_asset_type():
    """This function checks if the asset type is valid"""
    valid_asset = "multi_assets"
    assert VinterValidation.validate_asset_type(valid_asset) is None

test_valid_frequency 

test_valid_frequency()

This function tests that a valid frequency is accepted

Source code in tests/test_vinter_utils.py 
55
56
57
58
def test_valid_frequency():
    """> This function tests that a valid frequency is accepted"""
    valid_frequency = "d"
    assert VinterValidation.validate_frequency(valid_frequency) is None

test_valid_symbol 

test_valid_symbol()

validate_symbol_frequency takes a string as input and returns a tuple of two strings. The first string is the symbol and the second string is the frequency

Source code in tests/test_vinter_utils.py 
67
68
69
70
71
72
73
74
75
76
77
def test_valid_symbol():
    """`validate_symbol_frequency` takes a string as input and returns a tuple of two strings. The first
    string is the symbol and the second string is the frequency

    """
    valid_symbol = "btc-usd-p-d"
    freq = "d"
    assert VinterValidation.validate_symbol_frequency(valid_symbol) == (
        valid_symbol,
        freq,
    )

test_validate_dates 

test_validate_dates()

It tests that the function validate_dates raises an error when it should, and doesn't raise an error when it shouldn't

Source code in tests/test_vinter_utils.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
def test_validate_dates():
    """It tests that the function `validate_dates` raises an error when it should, and doesn't raise an
    error when it shouldn't

    """
    # Test a list of valid dates
    valid_dates = ["2022-03-18", "2022-03-19", "2022-03-20"]
    VinterValidation.validate_dates(valid_dates)  # Should not raise an error

    # Test a list with an invalid date
    invalid_dates = ["2022-03-18", "2022-03-19", "invalid_date"]
    with pytest.raises(ValueError) as e:
        VinterValidation.validate_dates(invalid_dates)

    assert "The date must be in the format YYYY-MM-DD" in str(
        "".join(e.value.args)
    )

    # Test an empty list
    empty_list = []
    VinterValidation.validate_dates(empty_list)  # Should not raise an error