Skip to content

Commit 2390095

Browse files
Add SMASH service support for testing
1 parent 8b0442e commit 2390095

File tree

11 files changed

+473
-3
lines changed

11 files changed

+473
-3
lines changed
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
#!/usr/bin/env bash
2+
3+
set -uo pipefail
4+
5+
SOCKET_PATH="$(readlink -m "$CARDANO_NODE_SOCKET_PATH")"
6+
STATE_CLUSTER="${SOCKET_PATH%/*}"
7+
STATE_CLUSTER_NAME="${STATE_CLUSTER##*/}"
8+
9+
export PGPASSFILE="$STATE_CLUSTER/pgpass"
10+
export SMASH_ADMIN="${SMASH_ADMIN:-admin}"
11+
export SMASH_PASSWORD="${SMASH_PASSWORD:-password}"
12+
export SMASH_ADMINS_FILE="$STATE_CLUSTER/admins.txt"
13+
14+
echo "${SMASH_ADMIN}, ${SMASH_PASSWORD}" > "$SMASH_ADMINS_FILE"
15+
16+
exec "$DBSYNC_REPO/smash-server/bin/cardano-smash-server" --config "./$STATE_CLUSTER_NAME/dbsync-config.yaml" --port %%SMASH_PORT%% --admins "$SMASH_ADMINS_FILE"

cardano_node_tests/cluster_scripts/conway_fast/start-cluster

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
# controlling environment variables:
44
# DBSYNC_REPO - will start and configure db-sync if the value is path to db-sync repository
5+
# SMASH - if set, will start and configure smash
56
# ENABLE_LEGACY - if set, local cluster will use legacy networking
67
# MIXED_P2P - if set, local cluster will use P2P for some nodes and legacy topology for others
78
# UTXO_BACKEND - 'mem' or 'disk', default is 'mem' (or legacy) if unset
@@ -206,6 +207,23 @@ startsecs=5
206207
EoF
207208
fi
208209

210+
# enable smash service
211+
if [ -n "${DBSYNC_REPO:-""}" ] && [ -n "${SMASH:-""}" ]; then
212+
[ -e "${DBSYNC_REPO}/smash-server/bin/cardano-smash-server" ] || \
213+
{ echo "The \`${DBSYNC_REPO}/smash-server/bin/cardano-smash-server\` not found, line $LINENO" >&2; exit 1; } # assert
214+
215+
cat >> "${STATE_CLUSTER}/supervisor.conf" <<EoF
216+
217+
[program:smash]
218+
command=${SCRIPT_DIR}/run-cardano-smash
219+
stderr_logfile=./${STATE_CLUSTER_NAME}/smash.stderr
220+
stdout_logfile=./${STATE_CLUSTER_NAME}/smash.stdout
221+
autostart=false
222+
autorestart=false
223+
startsecs=5
224+
EoF
225+
fi
226+
209227
# enable cardano-submit-api service
210228
if [ "$ENABLE_SUBMIT_API" -eq 1 ]; then
211229
cat >> "${STATE_CLUSTER}/supervisor.conf" <<EoF
@@ -625,6 +643,12 @@ if [ -n "${DBSYNC_REPO:-""}" ]; then
625643
supervisorctl -s "unix:///${SUPERVISORD_SOCKET_PATH}" start dbsync
626644
fi
627645

646+
# start smash
647+
if [ -n "${DBSYNC_REPO:-""}" ] && [ -n "${SMASH:-""}" ]; then
648+
echo "Starting smash"
649+
supervisorctl -s "unix:///${SUPERVISORD_SOCKET_PATH}" start smash
650+
fi
651+
628652
echo "Sleeping for initial Tx submission delay of $TX_SUBMISSION_DELAY seconds"
629653
sleep "$TX_SUBMISSION_DELAY"
630654

cardano_node_tests/tests/conftest.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,13 @@ def pytest_configure(config: tp.Any) -> None:
119119
config.stash[metadata_key]["db-sync ghc"] = VERSIONS.dbsync_ghc
120120
config.stash[metadata_key]["db-sync exe"] = str(configuration.DBSYNC_BIN)
121121

122+
config.stash[metadata_key]["HAS_SMASH"] = str(configuration.HAS_SMASH)
123+
if configuration.HAS_SMASH:
124+
config.stash[metadata_key]["smash"] = str(VERSIONS.smash)
125+
config.stash[metadata_key]["smash rev"] = VERSIONS.smash_git_rev
126+
config.stash[metadata_key]["smash ghc"] = VERSIONS.smash_ghc
127+
config.stash[metadata_key]["smash exe"] = str(configuration.SMASH_BIN)
128+
122129
if "nix/store" not in config.stash[metadata_key]["cardano-cli exe"]:
123130
LOGGER.warning(" WARNING: Using `cardano-cli` from custom path!")
124131
if "nix/store" not in config.stash[metadata_key]["cardano-node exe"]:

cardano_node_tests/tests/test_pools.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
from cardano_node_tests.utils import clusterlib_utils
2727
from cardano_node_tests.utils import configuration
2828
from cardano_node_tests.utils import dbsync_utils
29+
from cardano_node_tests.utils import smash_utils
2930
from cardano_node_tests.utils import helpers
3031
from cardano_node_tests.utils import locking
3132
from cardano_node_tests.utils import temptools
@@ -696,6 +697,7 @@ def _query_func():
696697
@pytest.mark.testnets
697698
@pytest.mark.smoke
698699
@pytest.mark.dbsync
700+
@pytest.mark.smash
699701
def test_stake_pool_not_avail_metadata(
700702
self,
701703
cluster_manager: cluster_management.ClusterManager,
@@ -720,14 +722,15 @@ def test_stake_pool_not_avail_metadata(
720722
out_file=f"{pool_name}_registration_metadata.json", content=pool_metadata
721723
)
722724
pool_metadata_url = "https://www.where_metadata_file_is_located.com"
725+
pool_metadata_hash = cluster.g_stake_pool.gen_pool_metadata_hash(pool_metadata_file)
723726

724727
pool_data = clusterlib.PoolData(
725728
pool_name=pool_name,
726729
pool_pledge=1_000,
727730
pool_cost=cluster.g_query.get_protocol_params().get("minPoolCost", 500),
728731
pool_margin=0.2,
729732
pool_metadata_url=pool_metadata_url,
730-
pool_metadata_hash=cluster.g_stake_pool.gen_pool_metadata_hash(pool_metadata_file),
733+
pool_metadata_hash=pool_metadata_hash,
731734
)
732735

733736
# Create pool owners
@@ -766,6 +769,7 @@ def _query_func():
766769
)
767770

768771
dbsync_utils.retry_query(query_func=_query_func, timeout=360)
772+
smash_utils.check_smash_pool_errors(pool_creation_out.stake_pool_id, pool_metadata_hash)
769773

770774
@allure.link(helpers.get_vcs_link())
771775
@common.PARAM_USE_BUILD_CMD
@@ -820,6 +824,7 @@ def test_create_stake_pool(
820824
@common.PARAM_USE_BUILD_CMD
821825
@pytest.mark.testnets
822826
@pytest.mark.dbsync
827+
@pytest.mark.smash
823828
def test_deregister_stake_pool(
824829
self,
825830
cluster_manager: cluster_management.ClusterManager,
@@ -944,6 +949,7 @@ def test_deregister_stake_pool(
944949
dbsync_utils.check_pool_deregistration(
945950
pool_id=pool_creation_out.stake_pool_id, retiring_epoch=depoch
946951
)
952+
smash_utils.check_smash_pool_retired(pool_id=pool_creation_out.stake_pool_id)
947953

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

cardano_node_tests/utils/cluster_scripts.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ class InstancePorts:
5151
webserver: int
5252
metrics_submit_api: int
5353
submit_api: int
54+
smash: int
5455
supervisor: int
5556
relay1: int
5657
ekg_relay1: int
@@ -189,6 +190,7 @@ def _get_node_ports(num: int) -> NodePorts:
189190
webserver=last_port,
190191
metrics_submit_api=last_port - 1,
191192
submit_api=last_port - 2,
193+
smash=last_port - 3,
192194
supervisor=12001 + instance_num,
193195
# Relay1
194196
relay1=0,
@@ -266,6 +268,8 @@ def _replace_instance_files(
266268
new_content = new_content.replace(
267269
"%%METRICS_SUBMIT_API_PORT%%", str(instance_ports.metrics_submit_api)
268270
)
271+
# Reconfigure smash port
272+
new_content = new_content.replace("%%SMASH_PORT%%", str(instance_ports.smash))
269273
# Reconfigure webserver port
270274
new_content = new_content.replace("%%WEBSERVER_PORT%%", str(instance_ports.webserver))
271275
return new_content
@@ -615,6 +619,8 @@ def _reconfigure_testnet(
615619
new_content = new_content.replace(
616620
"%%METRICS_SUBMIT_API_PORT%%", str(instance_ports.metrics_submit_api)
617621
)
622+
# Reconfigure smash port
623+
new_content = new_content.replace("%%SMASH_PORT%%", str(instance_ports.smash))
618624
# Reconfigure EKG metrics port
619625
new_content = new_content.replace("%%EKG_PORT_RELAY1%%", str(instance_ports.ekg_relay1))
620626
# Reconfigure prometheus metrics port

cardano_node_tests/utils/configuration.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ def _check_cardano_node_socket_path() -> None:
3535
# See `cat /proc/sys/net/ipv4/ip_local_port_range`.
3636
PORTS_BASE = int(os.environ.get("PORTS_BASE") or 23000)
3737

38+
SMASH_ADMIN = os.environ.get("SMASH_ADMIN", "admin")
39+
SMASH_PASSWORD = os.environ.get("SMASH_PASSWORD", "password")
40+
3841
# Used also in startup scripts as `if [ -n "$VAR" ]...`
3942
ENABLE_LEGACY = (os.environ.get("ENABLE_LEGACY") or "") != ""
4043
# Used also in startup scripts as `if [ -n "$VAR" ]...`
@@ -100,6 +103,14 @@ def _check_cardano_node_socket_path() -> None:
100103
else:
101104
DBSYNC_BIN = pl.Path("/nonexistent")
102105

106+
HAS_SMASH = HAS_DBSYNC and bool(os.environ.get("SMASH"))
107+
if HAS_SMASH:
108+
SMASH_BIN = (
109+
pl.Path(os.environ["DBSYNC_REPO"]).expanduser() / "smash-server" / "bin" / "cardano-smash-server"
110+
).resolve()
111+
else:
112+
SMASH_BIN = pl.Path("/nonexistent")
113+
103114
DONT_OVERWRITE_OUTFILES = bool(os.environ.get("DONT_OVERWRITE_OUTFILES"))
104115

105116
# Cluster instances are kept running after tests finish

cardano_node_tests/utils/dbsync_queries.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1539,3 +1539,14 @@ def query_drep_distr(
15391539
with execute(query=query, vars=(drep_hash, epoch_no)) as cur:
15401540
while (result := cur.fetchone()) is not None:
15411541
yield DrepDistributionDBRow(*result)
1542+
1543+
1544+
def delete_reserved_pool_tickers() -> int:
1545+
"""Delete all records from reserved_pool_ticker and return the number of affected rows."""
1546+
query = "DELETE FROM reserved_pool_ticker"
1547+
1548+
with execute(query=query) as cur:
1549+
cur.execute(query)
1550+
affected_rows = cur.rowcount
1551+
dbsync_conn.conn().commit() # Commit the changes to the database
1552+
return affected_rows

0 commit comments

Comments
 (0)