docs: add weekly smoke test cases and prerequisites#772
docs: add weekly smoke test cases and prerequisites#772thepastaclaw wants to merge 4 commits intodashpay:v1.0-devfrom
Conversation
Closes dashpay#771 - Add docs/test-cases.md with 32 test cases covering all implemented user stories from docs/user-stories.md - Add docs/test-prerequisites.md with SPV testnet setup, .env config, bank wallet concept, and cleanup procedures - Test cases are SPV-only (no RPC mode), testnet-only - Structured with Use Case ID, Test Case ID, Pre-Conditions, Steps, Test Data, Expected Result, and Post-Condition - Recommended execution order provided for dependency chain - Covers: WAL, SND, ALK, IDN, DPN, DPY, TOK, DOC, DEV, NET areas
|
@coderabbitai review |
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughTwo new documentation files have been added to define smoke test scenarios and prerequisites. The test-cases.md file specifies comprehensive test coverage across multiple modules (Wallet Management, Send and Receive, Asset Locks, Identity Operations, DPNS, DashPay, Tokens, Contracts, Developer Tools, and Network Settings) in a standardized format. The test-prerequisites.md file outlines shared setup requirements for SPV testnet testing, including environment configuration, .env setup, and test execution guidelines. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
docs/test-cases.md (1)
427-427: Optional: Consider varying sentence structure for readability.The static analysis tool flagged three consecutive test steps beginning with "Verify" (steps 2-4). While this is acceptable in test documentation and follows standard testing terminology, you could optionally vary the phrasing for slightly improved readability.
✨ Optional rewording suggestion
-| **Test Steps** | 1. Navigate to Platform info screen 2. Verify epoch info is displayed 3. Verify total credits shown 4. Verify validator list visible | +| **Test Steps** | 1. Navigate to Platform info screen 2. Verify epoch info is displayed 3. Check that total credits are shown 4. Confirm validator list is visible |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/test-cases.md` at line 427, The three consecutive test steps in the "Test Steps" table row (steps 2–4) all start with "Verify" which is repetitive; update that table cell so the steps vary phrasing while keeping meaning — e.g. keep step 1 as "Navigate to Platform info screen", change step 2 to "Confirm epoch info is displayed", step 3 to "Check total credits are shown", and step 4 to "Ensure validator list is visible" (or similar synonyms) to improve readability without altering test intent.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/test-prerequisites.md`:
- Around line 66-67: Update the listed config directory paths so the Linux entry
matches the macOS casing and add Windows paths: change the Linux entry string
`~/.config/dash-evo-tool/` to use capital D (`~/.config/Dash-Evo-Tool/`) to
match `Dash-Evo-Tool`, and add one or two Windows entries (e.g.,
`%APPDATA%\Dash-Evo-Tool\` and `C:\Users\<User>\AppData\Roaming\Dash-Evo-Tool\`)
alongside the existing macOS line; ensure you edit the same block that contains
the `**macOS:**` and `**Linux:**` lines so formatting/markdown stays consistent.
- Around line 20-25: Update the docs to clarify that although SPV mode does not
use Core RPC at runtime, the NetworkConfig struct requires core_host,
core_rpc_port, core_rpc_user, core_rpc_password, and insight_api_url to be
present during deserialization; state that core_zmq_endpoint is optional
(Option<String>) and that users should supply placeholder values for the
required Core RPC fields in their .env (or .env.example) when running in SPV
mode and keep the TESTNET_dapi_addresses example as shown.
- Around line 27-35: Update the docs to reflect the correct UI path for setting
Core backend mode: replace "Settings → Core Backend Mode" with instructions to
open the Network Chooser screen, go to "Connection Settings" and select the
"Connection Type" dropdown (visible only when Developer Mode is enabled) and
choose "SPV"; also mention that the selection is stored on the backend in the
Settings struct and persisted to the database as core_backend_mode so readers
know where the value is saved.
---
Nitpick comments:
In `@docs/test-cases.md`:
- Line 427: The three consecutive test steps in the "Test Steps" table row
(steps 2–4) all start with "Verify" which is repetitive; update that table cell
so the steps vary phrasing while keeping meaning — e.g. keep step 1 as "Navigate
to Platform info screen", change step 2 to "Confirm epoch info is displayed",
step 3 to "Check total credits are shown", and step 4 to "Ensure validator list
is visible" (or similar synonyms) to improve readability without altering test
intent.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: e9a3225d-8762-4ca0-9095-6ea1e449bb83
📒 Files selected for processing (2)
docs/test-cases.mddocs/test-prerequisites.md
docs/test-prerequisites.md
Outdated
| ```env | ||
| # Testnet SPV mode — no Core RPC needed | ||
| TESTNET_dapi_addresses=https://34.214.48.68:1443,https://52.12.176.90:1443,https://52.34.144.50:1443,https://44.240.98.102:1443,https://54.201.32.131:1443,https://52.10.229.11:1443,https://52.13.132.146:1443,https://52.40.219.41:1443,https://54.149.33.167:1443,https://35.164.23.245:1443,https://52.33.28.47:1443,https://52.43.13.92:1443,https://52.89.154.48:1443,https://52.24.124.162:1443,https://35.85.21.179:1443,https://54.187.14.232:1443,https://54.68.235.201:1443,https://52.13.250.182:1443 | ||
| ``` | ||
|
|
||
| No `core_host`, `core_rpc_port`, `core_rpc_user`, `core_rpc_password`, or `core_zmq_endpoint` settings are needed for SPV mode. |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify NetworkConfig field requirements and .env.example structure
echo "=== NetworkConfig struct fields ==="
ast-grep --pattern 'pub struct NetworkConfig {
$$$
}'
echo -e "\n=== TESTNET config in .env.example ==="
rg -A 20 'TESTNET_dapi_addresses' .env.exampleRepository: dashpay/dash-evo-tool
Length of output: 2764
🏁 Script executed:
#!/bin/bash
echo "=== Checking for SPV mode handling ==="
rg -i "spv" src/ --type rust -B 2 -A 2
echo -e "\n=== Checking if core_host is actually used in code ==="
rg "core_host" src/ --type rust -B 1 -A 1
echo -e "\n=== Checking for conditional Core RPC logic ==="
rg "core_rpc" src/ --type rust -B 1 -A 1 | head -50Repository: dashpay/dash-evo-tool
Length of output: 50378
Update documentation to clarify that Core RPC config fields are structurally required.
The documentation claims Core RPC fields are "not needed for SPV mode," but the NetworkConfig struct requires core_host, core_rpc_port, core_rpc_user, core_rpc_password, and insight_api_url as non-optional fields. This means .env deserialization will fail if these fields are omitted, regardless of whether SPV mode is active.
Note: core_zmq_endpoint is optional (Option<String>), so only the five fields listed above are structurally required.
The .env.example file correctly includes these fields for TESTNET, confirming they must be present. While SPV mode does provide an alternative backend that doesn't actively use Core RPC at runtime, the configuration structure still mandates their presence.
Fix: Clarify the documentation to state: "While Core RPC settings are required in the configuration struct, they are not actively used when operating in SPV mode. Use placeholder values if needed."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/test-prerequisites.md` around lines 20 - 25, Update the docs to clarify
that although SPV mode does not use Core RPC at runtime, the NetworkConfig
struct requires core_host, core_rpc_port, core_rpc_user, core_rpc_password, and
insight_api_url to be present during deserialization; state that
core_zmq_endpoint is optional (Option<String>) and that users should supply
placeholder values for the required Core RPC fields in their .env (or
.env.example) when running in SPV mode and keep the TESTNET_dapi_addresses
example as shown.
docs/test-prerequisites.md
Outdated
| ### Backend mode | ||
|
|
||
| After launching DET, set the Core backend mode to **SPV**: | ||
|
|
||
| 1. Navigate to Settings → Core Backend Mode | ||
| 2. Select **SPV** | ||
| 3. Wait for SPV peers to connect and sync (status indicator turns green) | ||
|
|
||
| > **Note:** SPV mode is not the default as of v1.0.0-dev. It must be explicitly selected in settings. |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Search for backend mode or SPV mode selection logic
echo "=== Searching for backend mode config ==="
rg -n 'backend.*mode|spv.*mode|core.*backend' --type rust -i
echo -e "\n=== Searching for Settings struct ==="
ast-grep --pattern 'struct Settings {
$$$
}'
echo -e "\n=== SpvProvider references ==="
rg -n 'SpvProvider' --type rust -C 2Repository: dashpay/dash-evo-tool
Length of output: 29532
🏁 Script executed:
# Check NetworkConfig struct definition
rg -n 'struct NetworkConfig' --type rust -A 15
# Search for Settings screen UI definition
rg -n 'Settings.*screen|settings.*screen' --type rust -i | head -20
# Verify if backend mode selection happens in network chooser vs settings
rg -n 'backend_mode' src/ui/network_chooser_screen.rs | head -5Repository: dashpay/dash-evo-tool
Length of output: 2859
🏁 Script executed:
# Look for screen navigation and backend mode UI implementation
rg -n 'Core Backend Mode|backend.*mode' src/ui/network_chooser_screen.rs -B2 -A2 | head -50
# Search for any Settings screen that might contain backend mode
rg -n 'core_backend_mode' src/ui/ --type rust -l
# Check the network chooser screen structure
head -100 src/ui/network_chooser_screen.rsRepository: dashpay/dash-evo-tool
Length of output: 6109
🏁 Script executed:
# Search for Settings screen or panel that might offer backend mode selection
rg -n 'settings.*screen|settings.*panel|Settings' src/ui/ --type rust -i | grep -i 'screen\|panel' | head -20
# Check if there's any reference to backend mode in UI outside network_chooser_screen
rg -n 'core_backend_mode' src/ui/ --type rust | grep -v network_chooser_screen
# Look at the actual navigation/menu structure
rg -n 'struct.*Screen|enum.*Screen' src/ui/ --type rust | head -30Repository: dashpay/dash-evo-tool
Length of output: 4558
🏁 Script executed:
# Look for the actual UI rendering of backend mode selection
sed -n '192,300p' src/ui/network_chooser_screen.rs
# Check what the "Connection Settings Card" shows
rg -n 'Connection Settings|backend.*mode.*button|SPV.*toggle' src/ui/network_chooser_screen.rs -A 5 -B 2Repository: dashpay/dash-evo-tool
Length of output: 6171
The documented navigation path is inaccurate.
Backend mode selection is not in "Settings → Core Backend Mode" as documented. Users will find it in the Network Chooser screen under "Connection Settings" as a dropdown selector labeled "Connection Type" (shown only when Developer Mode is enabled). The field is correctly stored in the Settings struct and persisted to the database as core_backend_mode. Update the documentation to reflect the actual UI location.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/test-prerequisites.md` around lines 27 - 35, Update the docs to reflect
the correct UI path for setting Core backend mode: replace "Settings → Core
Backend Mode" with instructions to open the Network Chooser screen, go to
"Connection Settings" and select the "Connection Type" dropdown (visible only
when Developer Mode is enabled) and choose "SPV"; also mention that the
selection is stored on the backend in the Settings struct and persisted to the
database as core_backend_mode so readers know where the value is saved.
docs/test-prerequisites.md
Outdated
| - **macOS:** `~/Library/Application Support/Dash-Evo-Tool/` | ||
| - **Linux:** `~/.config/dash-evo-tool/` |
There was a problem hiding this comment.
Same path issues: incorrect Linux casing and missing Windows.
The same path casing issue and missing Windows documentation apply here as well. The Linux path should use capital D (Dash-Evo-Tool), and Windows paths should be included.
📝 Proposed fix
- **macOS:** `~/Library/Application Support/Dash-Evo-Tool/`
- - **Linux:** `~/.config/dash-evo-tool/`
+ - **Linux:** `~/.config/Dash-Evo-Tool/`
+ - **Windows:** `C:\Users\{username}\AppData\Roaming\Dash-Evo-Tool\`📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **macOS:** `~/Library/Application Support/Dash-Evo-Tool/` | |
| - **Linux:** `~/.config/dash-evo-tool/` | |
| - **macOS:** `~/Library/Application Support/Dash-Evo-Tool/` | |
| - **Linux:** `~/.config/Dash-Evo-Tool/` | |
| - **Windows:** `C:\Users\{username}\AppData\Roaming\Dash-Evo-Tool\` |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/test-prerequisites.md` around lines 66 - 67, Update the listed config
directory paths so the Linux entry matches the macOS casing and add Windows
paths: change the Linux entry string `~/.config/dash-evo-tool/` to use capital D
(`~/.config/Dash-Evo-Tool/`) to match `Dash-Evo-Tool`, and add one or two
Windows entries (e.g., `%APPDATA%\Dash-Evo-Tool\` and
`C:\Users\<User>\AppData\Roaming\Dash-Evo-Tool\`) alongside the existing macOS
line; ensure you edit the same block that contains the `**macOS:**` and
`**Linux:**` lines so formatting/markdown stays consistent.
- Add exact button labels, field names, screen navigation - Implement per-test mnemonic strategy with placeholder variables - Add password-protected bank wallet requirement - Add setup/cleanup fund transfer procedures - Add secrets file specification for test mnemonics Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Clarify Core RPC config fields are structurally required by NetworkConfig even in SPV mode; add placeholder values to .env example - Fix UI navigation path: SPV backend is selected via Network Chooser screen Connection Type dropdown, not Settings - Rename 'Expert mode' to 'Developer mode' to match actual UI - Fix Linux config path casing to match macOS (Dash-Evo-Tool) - Remove spurious /config/ segment from Windows .env path - Vary verb choices in TC-DEV-005-01 test steps for readability
…ables Per lklimek's feedback: - Change secrets file path from ~/det-qa-secrets.env to ~/.secrets/det-qa-mnemonics.env - Add all 10 test mnemonic variables with word counts (24/21/18/15/12) - Add TC_TOK, TC_DPY, TC_DOC, TC_DEV, TC_NET, TC_ALK mnemonics
thepastaclaw
left a comment
thepastaclaw
left a comment
There was a problem hiding this comment.
Code Review
Docs-only PR with 32 smoke test cases. Well-structured but has naming inconsistencies between documents and a missing required env variable in the sample config.
Reviewed commit: 0b10731
🟡 2 suggestion(s)
🤖 Prompt for all review comments with AI agents
These findings are from an automated code review. Verify each finding against the current code and only fix it if needed.
In `docs/test-cases.md`:
- [SUGGESTION] lines 40-42: UI label mismatch: 'Expert mode' should be 'Developer mode'
test-cases.md still uses 'Expert mode' and 'Core backend mode' labels that were corrected to 'Developer mode' and 'Connection Type' in test-prerequisites.md but not propagated back.
In `docs/test-prerequisites.md`:
- [SUGGESTION] lines 78-92: Sample .env missing TESTNET_show_in_ui required field
NetworkConfig has a required `show_in_ui: bool` field. The sample config omits it, which would cause config loading to fail via envy deserialization.
| ### 2. Import the Bank Wallet | ||
|
|
||
| 1. Click **"Wallets"** in the left sidebar. |
There was a problem hiding this comment.
🟡 Suggestion: UI label mismatch: 'Expert mode' should be 'Developer mode'
test-cases.md still uses 'Expert mode' and 'Core backend mode' labels that were corrected to 'Developer mode' and 'Connection Type' in test-prerequisites.md but not propagated back.
source: ['claude-general']
🤖 Fix this with AI agents
These findings are from an automated code review. Verify each finding against the current code and only fix it if needed.
In `docs/test-cases.md`:
- [SUGGESTION] lines 40-42: UI label mismatch: 'Expert mode' should be 'Developer mode'
test-cases.md still uses 'Expert mode' and 'Core backend mode' labels that were corrected to 'Developer mode' and 'Connection Type' in test-prerequisites.md but not propagated back.
| ```env | ||
| # Testnet SPV mode — DAPI addresses plus placeholder Core RPC fields | ||
| TESTNET_dapi_addresses=https://34.214.48.68:1443,https://52.12.176.90:1443,https://52.34.144.50:1443,https://44.240.98.102:1443,https://54.201.32.131:1443,https://52.10.229.11:1443,https://52.13.132.146:1443,https://52.40.219.41:1443,https://54.149.33.167:1443,https://35.164.23.245:1443,https://52.33.28.47:1443,https://52.43.13.92:1443,https://52.89.154.48:1443,https://52.24.124.162:1443,https://35.85.21.179:1443,https://54.187.14.232:1443,https://54.68.235.201:1443,https://52.13.250.182:1443 | ||
|
|
||
| # Core RPC fields are structurally required by NetworkConfig even in SPV mode, | ||
| # but are not actively used at runtime. Supply placeholder values. | ||
| TESTNET_core_host=127.0.0.1 | ||
| TESTNET_core_rpc_port=19998 | ||
| TESTNET_core_rpc_user=user | ||
| TESTNET_core_rpc_password=password | ||
| TESTNET_insight_api_url=https://insight.testnet.networks.dash.org:3002/insight-api | ||
| # core_zmq_endpoint is optional and can be omitted | ||
| ``` | ||
|
|
||
| > **Note:** While Core RPC settings (`core_host`, `core_rpc_port`, `core_rpc_user`, `core_rpc_password`, `insight_api_url`) are not actively used in SPV mode, the `NetworkConfig` struct requires them to be present during deserialization. Use placeholder values as shown above. The `core_zmq_endpoint` field is optional (`Option<String>`) and may be omitted. |
There was a problem hiding this comment.
🟡 Suggestion: Sample .env missing TESTNET_show_in_ui required field
NetworkConfig has a required show_in_ui: bool field. The sample config omits it, which would cause config loading to fail via envy deserialization.
source: ['codex-general']
🤖 Fix this with AI agents
These findings are from an automated code review. Verify each finding against the current code and only fix it if needed.
In `docs/test-prerequisites.md`:
- [SUGGESTION] lines 78-92: Sample .env missing TESTNET_show_in_ui required field
NetworkConfig has a required `show_in_ui: bool` field. The sample config omits it, which would cause config loading to fail via envy deserialization.
2 participants
Issue
Closes #771
Summary
Adds formalized weekly smoke test specification covering all implemented user stories from
docs/user-stories.md, SPV-only on testnet.New files:
docs/test-cases.md— 32 test cases across all feature areas (WAL, SND, ALK, IDN, DPN, DPY, TOK, DOC, DEV, NET)docs/test-prerequisites.md— Environment setup,.envconfiguration for SPV testnet, bank wallet concept, cleanup proceduresTest case structure:
Each test case includes: Use Case ID, Test Case ID, Short Description, Pre-Conditions, Test Steps, Test Data, Expected Result, and Post-Condition.
Coverage:
Notes:
Summary by CodeRabbit