|
| 1 | +"""Tests for basic SMASH operations.""" |
| 2 | + |
| 3 | +import logging |
| 4 | +import re |
| 5 | +from http import HTTPStatus |
| 6 | + |
| 7 | +import pytest |
| 8 | +import requests |
| 9 | +from cardano_clusterlib import clusterlib |
| 10 | + |
| 11 | +from cardano_node_tests.utils import configuration |
| 12 | +from cardano_node_tests.utils import dbsync_queries |
| 13 | +from cardano_node_tests.utils import dbsync_types |
| 14 | +from cardano_node_tests.utils import dbsync_utils |
| 15 | +from cardano_node_tests.utils import helpers |
| 16 | +from cardano_node_tests.utils import logfiles |
| 17 | +from cardano_node_tests.utils import smash_utils |
| 18 | + |
| 19 | +LOGGER = logging.getLogger(__name__) |
| 20 | + |
| 21 | + |
| 22 | +@pytest.fixture(autouse=True) |
| 23 | +def check_smash_availability() -> None: |
| 24 | + """Fixture to check SMASH availability before each test.""" |
| 25 | + if not configuration.HAS_SMASH: |
| 26 | + pytest.skip("Skipping test because SMASH service is not available.") |
| 27 | + |
| 28 | + |
| 29 | +def check_request_error( |
| 30 | + err: requests.exceptions.RequestException, |
| 31 | + expected_status: HTTPStatus, |
| 32 | + expected_code: str | None, |
| 33 | + expected_description: str, |
| 34 | +) -> None: |
| 35 | + """Assert expected HTTP errors in requests, handling both JSON and text responses.""" |
| 36 | + response = err.response |
| 37 | + if response is None: |
| 38 | + err_msg = "No error response" |
| 39 | + raise AssertionError(err_msg) |
| 40 | + assert response.status_code == expected_status |
| 41 | + |
| 42 | + try: |
| 43 | + error_data = response.json() |
| 44 | + actual_code = error_data.get("code") |
| 45 | + actual_description = error_data.get("description") |
| 46 | + except ValueError: |
| 47 | + # If not JSON, treat the entire response as text |
| 48 | + actual_code = None |
| 49 | + actual_description = response.text.strip() |
| 50 | + |
| 51 | + if expected_code: |
| 52 | + assert actual_code == expected_code |
| 53 | + |
| 54 | + assert actual_description == expected_description |
| 55 | + |
| 56 | + |
| 57 | +class TestBasicSmash: |
| 58 | + """Basic tests for SMASH service.""" |
| 59 | + |
| 60 | + @pytest.fixture() |
| 61 | + def locked_pool( |
| 62 | + self, |
| 63 | + cluster_lock_pool: tuple[clusterlib.ClusterLib, str], |
| 64 | + ) -> dbsync_types.PoolDataRecord: |
| 65 | + """Get id of locked pool from cluster_lock_pool fixture.""" |
| 66 | + cluster_obj, pool_name = cluster_lock_pool |
| 67 | + pools_ids = cluster_obj.g_query.get_stake_pools() |
| 68 | + locked_pool_number = pool_name.replace("node-pool", "") |
| 69 | + pattern = re.compile(r"pool" + re.escape(locked_pool_number) + r"(\D|$)") |
| 70 | + pools = [next(dbsync_queries.query_pool_data(p)) for p in pools_ids] |
| 71 | + if len(pools) is not 1: |
| 72 | + err_msg = f"There has to be one pool: {pool_name}" |
| 73 | + raise ValueError(err_msg) |
| 74 | + locked_pool = next((p for p in pools if pattern.search(p.metadata_url)), None) |
| 75 | + locked_pool_data = dbsync_utils.get_pool_data(locked_pool.view) |
| 76 | + if locked_pool_data is None: |
| 77 | + err_msg = f"Locked pool data not found for pool: {pool_name}" |
| 78 | + raise ValueError(err_msg) |
| 79 | + return locked_pool_data |
| 80 | + |
| 81 | + @pytest.fixture(scope="session") |
| 82 | + def smash( |
| 83 | + self, |
| 84 | + ) -> None | smash_utils.SmashClient: |
| 85 | + """Create SMASH client.""" |
| 86 | + smash = smash_utils.get_client() |
| 87 | + return smash |
| 88 | + |
| 89 | + def test_fetch_pool_metadata( |
| 90 | + self, locked_pool: dbsync_types.PoolDataRecord, smash: smash_utils.SmashClient |
| 91 | + ): |
| 92 | + pool_id = locked_pool.hash |
| 93 | + |
| 94 | + # Offchain metadata is inserted into database few minutes after start of a cluster |
| 95 | + def _query_func(): |
| 96 | + pool_metadata = next( |
| 97 | + iter(dbsync_queries.query_off_chain_pool_data(locked_pool.view)), None |
| 98 | + ) |
| 99 | + assert pool_metadata is not None, dbsync_utils.NO_RESPONSE_STR |
| 100 | + return pool_metadata |
| 101 | + |
| 102 | + metadata_dbsync = dbsync_utils.retry_query(query_func=_query_func, timeout=360) |
| 103 | + |
| 104 | + expected_metadata = smash_utils.PoolMetadata( |
| 105 | + name=metadata_dbsync.json["name"], |
| 106 | + description=metadata_dbsync.json["description"], |
| 107 | + ticker=metadata_dbsync.ticker_name, |
| 108 | + homepage=metadata_dbsync.json["homepage"], |
| 109 | + ) |
| 110 | + actual_metadata = smash.get_pool_metadata(pool_id, metadata_dbsync.hash.hex()) |
| 111 | + assert expected_metadata == actual_metadata |
| 112 | + |
| 113 | + def test_delist_pool( |
| 114 | + self, |
| 115 | + locked_pool: dbsync_types.PoolDataRecord, |
| 116 | + smash: smash_utils.SmashClient, |
| 117 | + request: pytest.FixtureRequest, |
| 118 | + worker_id: str, |
| 119 | + ): |
| 120 | + pool_id = locked_pool.hash |
| 121 | + |
| 122 | + # Define and register function that ensures pool is re-enlisted after test completion |
| 123 | + def pool_cleanup(): |
| 124 | + smash.enlist_pool(pool_id) |
| 125 | + |
| 126 | + request.addfinalizer(pool_cleanup) |
| 127 | + |
| 128 | + # Delist the pool |
| 129 | + expected_delisted_pool = smash_utils.PoolData(pool_id=pool_id) |
| 130 | + actual_delisted_pool = smash.delist_pool(pool_id) |
| 131 | + assert expected_delisted_pool == actual_delisted_pool |
| 132 | + |
| 133 | + # Check if fetching metadata for a delisted pool returns an error |
| 134 | + try: |
| 135 | + smash.get_pool_metadata(pool_id, locked_pool.metadata_hash) |
| 136 | + except requests.exceptions.RequestException as err: |
| 137 | + check_request_error(err, HTTPStatus.FORBIDDEN, None, f"Pool {pool_id} is delisted") |
| 138 | + |
| 139 | + # Ignore expected errors in logs that would fail test in teardown phase |
| 140 | + err_msg = "Delisted pool already exists!" |
| 141 | + expected_err_regexes = [err_msg] |
| 142 | + logfiles.add_ignore_rule( |
| 143 | + files_glob="smash.stdout", |
| 144 | + regex="|".join(expected_err_regexes), |
| 145 | + ignore_file_id=worker_id, |
| 146 | + ) |
| 147 | + # Ensure re-delisting an already delisted pool returns an error |
| 148 | + try: |
| 149 | + smash.delist_pool(pool_id) |
| 150 | + except requests.exceptions.RequestException as err: |
| 151 | + check_request_error(err, HTTPStatus.BAD_REQUEST, "DbInsertError", err_msg) |
| 152 | + |
| 153 | + def test_enlist_pool( |
| 154 | + self, |
| 155 | + locked_pool: dbsync_types.PoolDataRecord, |
| 156 | + smash: smash_utils.SmashClient, |
| 157 | + ): |
| 158 | + pool_id = locked_pool.hash |
| 159 | + |
| 160 | + # Ensure enlisting an already enlisted pool returns an error |
| 161 | + try: |
| 162 | + smash.enlist_pool(pool_id) |
| 163 | + except requests.exceptions.RequestException as err: |
| 164 | + check_request_error( |
| 165 | + err, |
| 166 | + HTTPStatus.NOT_FOUND, |
| 167 | + "RecordDoesNotExist", |
| 168 | + "The requested record does not exist.", |
| 169 | + ) |
| 170 | + |
| 171 | + # Delist the pool |
| 172 | + smash.delist_pool(pool_id) |
| 173 | + try: |
| 174 | + smash.get_pool_metadata(pool_id, locked_pool.metadata_hash) |
| 175 | + except requests.exceptions.RequestException as err: |
| 176 | + check_request_error(err, HTTPStatus.FORBIDDEN, None, f"Pool {pool_id} is delisted") |
| 177 | + |
| 178 | + # Enlist the pool |
| 179 | + actual_res_enlist = smash.enlist_pool(pool_id) |
| 180 | + expected_res_enlist = smash_utils.PoolData(pool_id=pool_id) |
| 181 | + assert expected_res_enlist == actual_res_enlist |
| 182 | + |
| 183 | + def test_reserve_ticker( |
| 184 | + self, |
| 185 | + locked_pool: dbsync_types.PoolDataRecord, |
| 186 | + smash: smash_utils.SmashClient, |
| 187 | + request: pytest.FixtureRequest, |
| 188 | + ): |
| 189 | + pool_id = locked_pool.hash |
| 190 | + |
| 191 | + # Register cleanup function that removes ticker from database after test completion |
| 192 | + request.addfinalizer(dbsync_queries.delete_reserved_pool_tickers) |
| 193 | + |
| 194 | + # Reserve ticker |
| 195 | + ticker = helpers.get_rand_str(length=3) |
| 196 | + actual_response = smash.reserve_ticker(ticker_name=ticker, pool_hash=pool_id) |
| 197 | + expected_response = smash_utils.PoolTicker(name=f"{ticker}") |
| 198 | + assert expected_response == actual_response |
| 199 | + |
| 200 | + # Reserve already taken ticker |
| 201 | + try: |
| 202 | + smash.reserve_ticker(ticker_name=ticker, pool_hash=pool_id) |
| 203 | + except requests.exceptions.RequestException as err: |
| 204 | + check_request_error( |
| 205 | + err, |
| 206 | + HTTPStatus.BAD_REQUEST, |
| 207 | + "TickerAlreadyReserved", |
| 208 | + f'Ticker name "{ticker}" is already reserved', |
| 209 | + ) |
0 commit comments