Skip to content

Commit 1090cfc

Browse files
tosettil-polimitosettil-polimi
authored
Feat/go debug (#9)
* Remove .vscode directory from .gitignore to streamline ignored files and improve project cleanliness. * Add custom enclave test configuration section to .vscode/README.md This update introduces a new section detailing how to create and use custom devnet configurations for testing environments. It includes step-by-step instructions and an example configuration for setting up nodes, enabling additional services, and configuring parameters for Assertoor. * Refactor VSCode tasks for Kurtosis Updated task labels and commands in .vscode/tasks.json to improve clarity and functionality. Renamed "kurtosis-cleanup" to "kurtosis-stop" and separated the stop and remove commands into distinct tasks, ensuring that both commands handle errors gracefully with "|| true". This enhances the build process and task management. * Update VSCode launch configuration and README Modified the launch configuration in .vscode/launch.json to specify the main Go program file directly. Additionally, removed obsolete parameters from .vscode/README.md to streamline the documentation and focus on relevant configuration details. * fix(pgsql): add pgx stdlib * Add custom Assertoor configuration section to README This update introduces a comprehensive section on creating and managing custom Assertoor configurations within the devnet setup. It details the configuration process, provides an example YAML file, and outlines common customizations, ensuring users can effectively override or extend default settings for their testing environments. * Update VSCode launch configuration to add a new debug configuration for Go assertoor Renamed the existing debug configuration to "Clean debug Go assertoor" and added a new configuration for debugging the main Go program. This enhances the development experience by providing clearer options for debugging. * feat(tasks): add db cleanup * Update README.md to include installation instructions for Docker, Kurtosis CLI, yq, and PostgreSQL Client. This enhances setup guidance for users by providing detailed platform-specific installation commands. * fix(tasks): update PostgreSQL user in db-cleanup command * chore(vscode): update database configuration and cleanup tasks Modified the database settings in README.md to switch from PostgreSQL to SQLite, reflecting the new default configuration. Updated tasks.json to rename the PostgreSQL cleanup task and added a new SQLite cleanup task, enhancing the development workflow for users working with SQLite databases.
1 parent 2ca3346 commit 1090cfc

File tree

7 files changed

+353
-1
lines changed

7 files changed

+353
-1
lines changed

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
.vscode
21
bin
32
tmp
43
example/config/test.yaml
@@ -7,4 +6,5 @@ test-*.yaml
76

87
.hack/devnet/generated-**
98
.hack/devnet/custom-**
9+
.hack/devnet/sqlite.db**
1010
.qodo

‎.vscode/README.md‎

Lines changed: 223 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,223 @@
1+
# VSCode Debugger Configuration
2+
3+
This document explains how to use the debug configuration for Assertoor in VSCode.
4+
5+
## Requirements
6+
7+
Before using the debugger, make sure you have installed:
8+
9+
- **Go v1.23.0** - Required programming language
10+
- **Docker** - Container platform required by Kurtosis. Install Docker Desktop for your platform from [docker.com](https://www.docker.com/products/docker-desktop/)
11+
- **Kurtosis CLI** - Development environment orchestration tool. Install following the official guide:
12+
13+
**macOS (Homebrew):**
14+
15+
```bash
16+
brew install kurtosis-tech/tap/kurtosis-cli
17+
```
18+
19+
**Ubuntu (APT):**
20+
21+
```bash
22+
echo "deb [trusted=yes] https://apt.fury.io/kurtosis-tech/ /" | sudo tee /etc/apt/sources.list.d/kurtosis.list
23+
sudo apt update
24+
sudo apt install kurtosis-cli
25+
```
26+
27+
**RHEL (YUM):**
28+
29+
```bash
30+
echo '[kurtosis]
31+
name=Kurtosis
32+
baseurl=https://yum.fury.io/kurtosis-tech/
33+
enabled=1
34+
gpgcheck=0' | sudo tee /etc/yum.repos.d/kurtosis.repo
35+
sudo yum install kurtosis-cli
36+
```
37+
38+
**Other platforms:** Download from [releases page](https://github.com/kurtosis-tech/kurtosis-cli-release-artifacts/releases)
39+
40+
- **yq** - Tool for manipulating YAML files:
41+
42+
**macOS:**
43+
44+
```bash
45+
brew install yq
46+
```
47+
48+
**Ubuntu/Debian:**
49+
50+
```bash
51+
sudo apt install yq
52+
```
53+
54+
**Other platforms:** Download from [yq releases](https://github.com/mikefarah/yq/releases)
55+
56+
- **PostgreSQL Client (psql)** - Required for database cleanup operations:
57+
58+
**macOS:**
59+
60+
```bash
61+
brew install postgresql
62+
```
63+
64+
**Ubuntu/Debian:**
65+
66+
```bash
67+
sudo apt install postgresql-client
68+
```
69+
70+
**RHEL/CentOS:**
71+
72+
```bash
73+
sudo yum install postgresql
74+
```
75+
76+
## "Debug Go assertoor" Configuration
77+
78+
The `Debug Go assertoor` configuration in the `launch.json` file allows you to start Assertoor in debug mode directly from VSCode.
79+
80+
### What happens when you launch the configuration
81+
82+
1. **Pre-Launch Task**: The `devnet-setup` task is automatically executed to prepare the development environment
83+
2. **Program Launch**: The Go binary of Assertoor is launched from the workspace root
84+
3. **Configuration**: The program is started with the configuration file `.hack/devnet/generated-assertoor-config.yaml`
85+
4. **Logging**: Logs are displayed in the VSCode debug console (`showLog: true`)
86+
87+
### Configuration Parameters
88+
89+
- **Program**: `${workspaceFolder}` - Executes the main package from the project root
90+
- **Args**: `["--config", ".hack/devnet/generated-assertoor-config.yaml"]` - Specifies the configuration file to use
91+
- **PreLaunchTask**: `devnet-setup` - Task that runs before starting the debug session
92+
- **Mode**: `auto` - VSCode automatically determines whether to debug the binary or source code
93+
94+
### How to use
95+
96+
1. Open the Assertoor project in VSCode
97+
2. Go to the "Run and Debug" panel (Ctrl+Shift+D / Cmd+Shift+D)
98+
3. Select "Debug Go assertoor" from the dropdown
99+
4. Click the play button or press F5
100+
5. The debugger will start automatically after completing the environment setup
101+
102+
## Custom Enclave test configuration
103+
104+
You can create a custom devnet configuration to customize the testing environment according to your needs.
105+
106+
### How to add a custom configuration
107+
108+
1. Create the file `.hack/devnet/custom-kurtosis.devnet.config.yaml` in your workspace
109+
2. Add your desired configuration to this file
110+
3. The devnet setup will automatically use your custom configuration if it exists
111+
112+
## Custom Assertoor Configuration
113+
114+
You can create a personalized Assertoor configuration that overrides or extends the automatically generated settings.
115+
116+
### How the configuration system works
117+
118+
When you run the devnet setup (`.hack/devnet/run.sh`), the following process occurs:
119+
120+
1. **Kurtosis generates a base config** from the ethereum-package, including endpoints and global variables
121+
2. **The script looks for a custom file**:
122+
- First searches for `custom-assertoor.devnet.config.yaml`
123+
- If not found, uses `assertoor.devnet.config.yaml`
124+
3. **Applies environment variables** to the custom file using `envsubst`
125+
4. **Merges the configurations** using `yq eval-all` which combines:
126+
- The config generated by Kurtosis (with endpoints, database, etc.)
127+
- Your custom config that overrides/adds settings
128+
129+
### Creating your custom Assertoor configuration
130+
131+
To create a custom configuration:
132+
133+
1. **Create the file `custom-assertoor.devnet.config.yaml`** in the `.hack/devnet/` directory
134+
2. **Add your custom settings** that will override or extend the generated config
135+
3. **Use environment variables** like `${DEVNET_DIR}` which are automatically substituted
136+
137+
### Example custom configuration
138+
139+
```yaml
140+
# Custom Assertoor configuration
141+
# This file overrides/adds settings to the automatically generated config
142+
143+
web:
144+
server:
145+
host: "0.0.0.0"
146+
port: 8080
147+
frontend:
148+
enabled: true
149+
debug: true
150+
151+
# Custom external tests
152+
externalTests:
153+
- file: https://raw.githubusercontent.com/noku-team/assertoor/master/playbooks/dev/tx-pool-check-short.yaml
154+
155+
# Custom logging configuration
156+
logging:
157+
level: "debug"
158+
colorOutput: true
159+
160+
# Custom database settings (optional, but needed for macos, by default it uses /app folder, that is not writable)
161+
database:
162+
engine: "sqlite"
163+
sqlite:
164+
file: "${DEVNET_DIR}/sqlite.db"
165+
166+
# database:
167+
# engine: "pgsql"
168+
# pgsql:
169+
# host: "localhost"
170+
# port: "5432"
171+
# username: "postgres"
172+
# password: ""
173+
# database: "assertoor"
174+
# max_open_conns: 50
175+
# max_idle_conns: 10
176+
```
177+
178+
### Common customizations
179+
180+
- **Change web port**: Modify `web.server.port`
181+
- **Add custom tests**: Use `externalTests` to include your test playbooks
182+
- **Custom global variables**: Use `globalVars` for test parameters
183+
- **Custom logging**: Configure log level and format
184+
- **Different database**: Switch from PostgreSQL to SQLite or customize connection settings
185+
186+
### Important notes
187+
188+
- The custom config file is **always preserved** between runs
189+
- The generated config is recreated each time you run the devnet setup
190+
- Environment variables in your config (like `${DEVNET_DIR}`) are automatically substituted
191+
- Your custom settings will override any conflicting settings from the generated config
192+
193+
### Example Configuration
194+
195+
Here's an example of a custom configuration:
196+
197+
```yaml
198+
participants:
199+
- el_type: erigon
200+
el_image: test/erigon:current
201+
cl_type: prysm
202+
count: 2
203+
additional_services:
204+
- assertoor
205+
- dora
206+
assertoor_params:
207+
run_stability_check: false
208+
run_block_proposal_check: true
209+
```
210+
211+
This configuration:
212+
213+
- Sets up 2 nodes with Erigon (execution layer) and Prysm (consensus layer)
214+
- Enables additional services (Assertoor and Dora)
215+
- Configures Assertoor with specific parameters and test playbooks
216+
- Uses custom Docker images for testing
217+
218+
### Notes
219+
220+
- Make sure all requirements are installed before launching the debugger
221+
- The `devnet-setup` task may take a few minutes the first time
222+
- You can set breakpoints in the Go code before starting the debug session
223+
- Custom configurations allow you to test different network setups and scenarios

‎.vscode/launch.json‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"version": "0.2.0",
3+
"configurations": [
4+
{
5+
"name": "Clean debug Go assertoor",
6+
"type": "go",
7+
"request": "launch",
8+
"mode": "auto",
9+
"program": "${workspaceFolder}/main.go",
10+
"args": ["--config", ".hack/devnet/generated-assertoor-config.yaml"],
11+
"preLaunchTask": "devnet-setup",
12+
"showLog": true
13+
},
14+
{
15+
"name": "Debug go assertoor",
16+
"type": "go",
17+
"request": "launch",
18+
"mode": "auto",
19+
"program": "${workspaceFolder}/main.go",
20+
"args": ["--config", ".hack/devnet/generated-assertoor-config.yaml"],
21+
"showLog": true
22+
}
23+
]
24+
}

‎.vscode/tasks.json‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
{
2+
"version": "2.0.0",
3+
"tasks": [
4+
{
5+
"label": "kurtosis-stop",
6+
"type": "shell",
7+
"command": "kurtosis enclave stop assertoor || true",
8+
"group": "build",
9+
"presentation": {
10+
"echo": true,
11+
"reveal": "always",
12+
"focus": false,
13+
"panel": "shared",
14+
"showReuseMessage": true,
15+
"clear": false
16+
},
17+
"problemMatcher": []
18+
},
19+
{
20+
"label": "kurtosis-remove",
21+
"type": "shell",
22+
"command": "kurtosis enclave rm assertoor || true",
23+
"group": "build",
24+
"presentation": {
25+
"echo": true,
26+
"reveal": "always",
27+
"focus": false,
28+
"panel": "shared",
29+
"showReuseMessage": true,
30+
"clear": false
31+
},
32+
"problemMatcher": []
33+
},
34+
{
35+
"label": "db-pgsql-cleanup",
36+
"type": "shell",
37+
"command": "PGPASSWORD='' psql -h 127.0.0.1 -p 5432 -U postgres -d assertoor -c 'DROP SCHEMA IF EXISTS public CASCADE; CREATE SCHEMA public;' || true",
38+
"group": "build",
39+
"presentation": {
40+
"echo": true,
41+
"reveal": "always",
42+
"focus": false,
43+
"panel": "shared",
44+
"showReuseMessage": true,
45+
"clear": false
46+
},
47+
"problemMatcher": []
48+
},
49+
{
50+
"label": "db-sqlite-cleanup",
51+
"type": "shell",
52+
"command": "rm -f .hack/devnet/sqlite.db* || true",
53+
"group": "build",
54+
"presentation": {
55+
"echo": true,
56+
"reveal": "always",
57+
"focus": false,
58+
"panel": "shared",
59+
"showReuseMessage": true,
60+
"clear": false
61+
},
62+
"problemMatcher": []
63+
},
64+
{
65+
"label": "devnet-setup",
66+
"dependsOrder": "sequence",
67+
"dependsOn": [
68+
"kurtosis-stop",
69+
"kurtosis-remove",
70+
"db-pgsql-cleanup",
71+
"db-sqlite-cleanup",
72+
"devnet-setup-only"
73+
]
74+
},
75+
{
76+
"label": "devnet-setup-only",
77+
"type": "shell",
78+
"command": ".hack/devnet/run.sh",
79+
"group": "build",
80+
"presentation": {
81+
"echo": true,
82+
"reveal": "always",
83+
"focus": false,
84+
"panel": "shared",
85+
"showReuseMessage": true,
86+
"clear": false
87+
},
88+
"problemMatcher": []
89+
}
90+
]
91+
}

‎go.mod‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ require (
1717
github.com/herumi/bls-eth-go-binary v1.36.4
1818
github.com/holiman/uint256 v1.3.2
1919
github.com/itchyny/gojq v0.12.17
20+
github.com/jackc/pgx/v5 v5.7.4
2021
github.com/jmoiron/sqlx v1.4.0
2122
github.com/juliangruber/go-intersect v1.1.0
2223
github.com/lib/pq v1.10.9
@@ -77,6 +78,9 @@ require (
7778
github.com/huin/goupnp v1.3.0 // indirect
7879
github.com/inconshreveable/mousetrap v1.1.0 // indirect
7980
github.com/itchyny/timefmt-go v0.1.6 // indirect
81+
github.com/jackc/pgpassfile v1.0.0 // indirect
82+
github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect
83+
github.com/jackc/puddle/v2 v2.2.2 // indirect
8084
github.com/jackpal/go-nat-pmp v1.0.2 // indirect
8185
github.com/josharian/intern v1.0.0 // indirect
8286
github.com/kilic/bls12-381 v0.1.0 // indirect
@@ -132,6 +136,7 @@ require (
132136
golang.org/x/net v0.40.0 // indirect
133137
golang.org/x/sync v0.14.0 // indirect
134138
golang.org/x/sys v0.33.0 // indirect
139+
golang.org/x/text v0.25.0 // indirect
135140
golang.org/x/tools v0.33.0 // indirect
136141
golang.org/x/xerrors v0.0.0-20240903120638-7835f813f4da // indirect
137142
google.golang.org/protobuf v1.36.6 // indirect

‎go.sum‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,14 @@ github.com/itchyny/gojq v0.12.17 h1:8av8eGduDb5+rvEdaOO+zQUjA04MS0m3Ps8HiD+fceg=
195195
github.com/itchyny/gojq v0.12.17/go.mod h1:WBrEMkgAfAGO1LUcGOckBl5O726KPp+OlkKug0I/FEY=
196196
github.com/itchyny/timefmt-go v0.1.6 h1:ia3s54iciXDdzWzwaVKXZPbiXzxxnv1SPGFfM/myJ5Q=
197197
github.com/itchyny/timefmt-go v0.1.6/go.mod h1:RRDZYC5s9ErkjQvTvvU7keJjxUYzIISJGxm9/mAERQg=
198+
github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsIM=
199+
github.com/jackc/pgpassfile v1.0.0/go.mod h1:CEx0iS5ambNFdcRtxPj5JhEz+xB6uRky5eyVu/W2HEg=
200+
github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 h1:iCEnooe7UlwOQYpKFhBabPMi4aNAfoODPEFNiAnClxo=
201+
github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761/go.mod h1:5TJZWKEWniPve33vlWYSoGYefn3gLQRzjfDlhSJ9ZKM=
202+
github.com/jackc/pgx/v5 v5.7.4 h1:9wKznZrhWa2QiHL+NjTSPP6yjl3451BX3imWDnokYlg=
203+
github.com/jackc/pgx/v5 v5.7.4/go.mod h1:ncY89UGWxg82EykZUwSpUKEfccBGGYq1xjrOpsbsfGQ=
204+
github.com/jackc/puddle/v2 v2.2.2 h1:PR8nw+E/1w0GLuRFSmiioY6UooMp6KJv0/61nB7icHo=
205+
github.com/jackc/puddle/v2 v2.2.2/go.mod h1:vriiEXHvEE654aYKXXjOvZM39qJ0q+azkZFrfEOc3H4=
198206
github.com/jackpal/go-nat-pmp v1.0.2 h1:KzKSgb7qkJvOUTqYl9/Hg/me3pWgBmERKrTGD7BdWus=
199207
github.com/jackpal/go-nat-pmp v1.0.2/go.mod h1:QPH045xvCAeXUZOxsnwmrtiCoxIr9eob+4orBN1SBKc=
200208
github.com/jmoiron/sqlx v1.4.0 h1:1PLqN7S1UYp5t4SrVVnt4nUVNemrDAtxlulVe+Qgm3o=

0 commit comments

Comments
 (0)