feat: add `gnoland config` command suite #1605

zivkovicmilos · 2024-01-30T18:08:59Z

Description

Based on discussions in #1593, this PR introduces the CLI suite for manipulating the config.toml. Using this suite, we can build better workflows for power users.

This PR is a series of lego blocks that are required for us to get a normal user chain connection going:

feat: add genesis command suite #1252 - solved genesis.json management and manipulation
feat: add gnoland secrets command suite #1593 - solved node secrets management and manipulation
this PR - solves config.toml management and manipulation

All of these PRs get us to a point where the user can run:

gnoland init
gnoland start

to get up and running with any Gno network. The added middle step is fine-tuning the configuration and genesis, but it's worth noting this step is optional.

New commands:

gnoland config --help             
USAGE
  config <subcommand> [flags]

Gno config manipulation suite, for editing base and module configurations

SUBCOMMANDS
  init  Initializes the Gno node configuration
  set   Edits the Gno node configuration
  get   Shows the Gno node configuration

In short, the gnoland config init command initializes a default config.toml, while other subcommands allow editing
viewing any field in the specific configuration.

Contributors' checklist...

Added new tests, or not needed, or not feasible
Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
Updated the official documentation or not needed
No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
Added references to related issues and PRs
Provided any useful hints for running manual tests
Added new benchmarks to generated graphs, if any. More info here.

codecov · 2024-01-30T18:13:02Z

Codecov Report

Attention: Patch coverage is 77.29730% with 42 lines in your changes are missing coverage. Please review.

Project coverage is 47.50%. Comparing base (45c8f90) to head (62d3951).

Files	Patch %	Lines
gno.land/cmd/gnoland/config.go	63.26%	17 Missing and 1 partial ⚠️
gno.land/cmd/gnoland/config_set.go	79.22%	9 Missing and 7 partials ⚠️
gno.land/cmd/gnoland/config_get.go	81.25%	3 Missing and 3 partials ⚠️
gno.land/cmd/gnoland/config_init.go	91.30%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1605      +/-   ##
==========================================
+ Coverage   47.41%   47.50%   +0.08%     
==========================================
  Files         384      388       +4     
  Lines       61187    61367     +180     
==========================================
+ Hits        29014    29152     +138     
- Misses      29744    29774      +30     
- Partials     2429     2441      +12

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

thehowl

Some comments from the review meeting:

Preferably let's avoid having all of the flags, and instead having a single source of truth. Approaches can be reflect, codegen, or keeping two registries with a test that checks that the config in tm2 and here doesn't fall out of sync.
And a preferable API seems to be gnoland config <key> [<value>] (or some variation).

zivkovicmilos · 2024-02-12T15:13:23Z

Some comments from the review meeting:

Preferably let's avoid having all of the flags, and instead having a single source of truth. Approaches can be reflect, codegen, or keeping two registries with a test that checks that the config in tm2 and here doesn't fall out of sync.

And a preferable API seems to be gnoland config <key> [<value>] (or some variation).

Based on these discussions, if we wanted to adapt gnoland config to use the git config syntax (similar), we'd need to use reflect.

I've drawn up a small snippet that demonstrates how it would look like (note it always uses the fresh struct, so we can't risk falling out of sync in the update command):
https://goplay.tools/snippet/LuahKUZcoig

Let me know your thoughts, if this looks alright, so I can apply it to this PR 🙏

cc @gfanton @ajnavarro @moul

zivkovicmilos · 2024-02-16T21:25:07Z

@thehowl @gfanton @ajnavarro

I've swapped the approach in this PR to utilize reflect, as we've discussed:
714db31 (and with an updated comment here)

Now, you can edit individual fields (however nested) using a similar syntax to git config.
Ex:
gnoland config edit RPC.ListenAddress tcp://0.0.0.0:8080

I've also noticed that my previous version of the PR lacked support for the Mempool configuration, which nobody seemed to point out 🙂
This has been resolved in the commit I've linked, and covered with unit tests

tm2/pkg/bft/config/config.go

gno.land/cmd/gnoland/config.go

gno.land/cmd/gnoland/config_init.go

gno.land/cmd/gnoland/config_edit.go

zivkovicmilos · 2024-02-28T17:30:16Z

@gfanton @ajnavarro
Friendly ping to check the latest changes 🙏

gno.land/cmd/gnoland/config_set.go

thehowl

I'll make a separate comment for the unmarshaler; mostly nitpicky comments as usual :)

gno.land/cmd/gnoland/config.go

gno.land/cmd/gnoland/config_init.go

gno.land/cmd/gnoland/config_get.go

gno.land/cmd/gnoland/config_set_test.go

gno.land/cmd/gnoland/config_get_test.go

gno.land/cmd/gnoland/config_set.go

gfanton

Just a small change needed. I experimented with the command a bit. looks good ! :)

gno.land/cmd/gnoland/config_set.go

## Description Based on discussions in gnolang#1593, this PR introduces the CLI suite for manipulating the `config.toml`. Using this suite, we can build better workflows for power users. This PR is a series of lego blocks that are required for us to get a normal user chain connection going: - gnolang#1252 - solved `genesis.json` management and manipulation - gnolang#1593 - solved node secrets management and manipulation - this PR - solves `config.toml` management and manipulation All of these PRs get us to a point where the user can run: - `gnoland init` - `gnoland start` to get up and running with any Gno network. The added middle step is fine-tuning the configuration and genesis, but it's worth noting this step is optional. New commands: ```shell gnoland config --help USAGE config <subcommand> [flags] Gno config manipulation suite, for editing base and module configurations SUBCOMMANDS init Initializes the Gno node configuration set Edits the Gno node configuration get Shows the Gno node configuration ``` In short, the `gnoland config init` command initializes a default `config.toml`, while other subcommands allow editing viewing any field in the specific configuration. <details><summary>Contributors' checklist...</summary> - [x] Added new tests, or not needed, or not feasible - [x] Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory - [x] Updated the official documentation or not needed - [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message was included in the description - [x] Added references to related issues and PRs - [ ] Provided any useful hints for running manual tests - [ ] Added new benchmarks to [generated graphs](https://gnoland.github.io/benchmarks), if any. More info [here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md). </details>

@zivkovicmilos

…1769) After briefly discussing #1605, me and @zivkovicmilos convened that it would be better if the `config` commands took, for the keys in the configuration, their TOML name rather than the internal Go struct field name. This PR implements that.

zivkovicmilos added 6 commits January 30, 2024 10:30

Add config init

81aafcb

Add config base

21d3deb

Add config rpc

f4a6916

Add config p2p

9839e30

Add config consensus

ac7b4b4

Add config events

92e9b8d

zivkovicmilos added the 📦 ⛰️ gno.land Issues or PRs gno.land package related label Jan 30, 2024

zivkovicmilos self-assigned this Jan 30, 2024

zivkovicmilos requested review from moul, jaekwon and piux2 as code owners January 30, 2024 18:09

zivkovicmilos requested review from gfanton and ajnavarro January 30, 2024 18:09

github-actions bot added the 📦 🌐 tendermint v2 Issues or PRs tm2 related label Jan 30, 2024

zivkovicmilos requested a review from albttx January 30, 2024 18:11

Simplify return

01872f1

thehowl mentioned this pull request Jan 31, 2024

chore: add gnoland init #1050

Closed

7 tasks

zivkovicmilos mentioned this pull request Jan 31, 2024

feat: add gnoland secrets command suite #1593

Merged

7 tasks

thehowl reviewed Feb 8, 2024

View reviewed changes

zivkovicmilos mentioned this pull request Feb 12, 2024

Minutes: Core Staff Weekly Syncs [every Monday] gnolang/meetings#36

Open

michelleellen mentioned this pull request Feb 12, 2024

Minutes: Public Dev Calls [every Wednesday] gnolang/meetings#37

Open

thehowl mentioned this pull request Feb 15, 2024

feat: use 0.0.0.0 as the default listening address for RPC and gnoweb #1657

Closed

7 tasks

zivkovicmilos added 2 commits February 16, 2024 22:22

Switch to a reflect-based approach

714db31

Merge branch 'master' into feat/config

1b3eed8

zivkovicmilos requested a review from thehowl February 16, 2024 21:25

Add additional comment about string slices

fb2b385

thehowl requested changes Feb 21, 2024

View reviewed changes

zivkovicmilos requested a review from thehowl February 28, 2024 17:13

Merge branch 'master' into feat/config

922129c

thehowl reviewed Feb 29, 2024

View reviewed changes

gno.land/cmd/gnoland/config_set.go Outdated Show resolved Hide resolved

thehowl reviewed Feb 29, 2024

View reviewed changes

gno.land/cmd/gnoland/config_set.go Outdated Show resolved Hide resolved

gno.land/cmd/gnoland/config_set.go Outdated Show resolved Hide resolved

thehowl reviewed Feb 29, 2024

View reviewed changes

gno.land/cmd/gnoland/config_set.go Outdated Show resolved Hide resolved

gfanton approved these changes Feb 29, 2024

View reviewed changes

gno.land/cmd/gnoland/config_set.go Outdated Show resolved Hide resolved

thehowl reviewed Feb 29, 2024

View reviewed changes

gno.land/cmd/gnoland/config_set.go Outdated Show resolved Hide resolved

zivkovicmilos added 8 commits March 9, 2024 09:53

Add exported field checking for generating field error

5a3b493

Add additional check to fetching config field

e7be015

Use lowercase for short help

7412856

Use different syntax for buffer initialization

0adf819

Move invalid field generation error

c8aca4a

Simplify print format

ae3a4ae

Remove redundant check

38c1be5

Simplify value saving

c09b7ec

zivkovicmilos requested a review from thehowl March 9, 2024 10:05

zivkovicmilos added 2 commits March 9, 2024 11:06

Merge branch 'master' into feat/config

ecd6b3b

Fix faulty tests after WALPath field update

62d3951

thehowl approved these changes Mar 12, 2024

View reviewed changes

thehowl merged commit bc77c2b into gnolang:master Mar 12, 2024
184 of 185 checks passed

leohhhn deleted the feat/config branch March 12, 2024 12:00

thehowl mentioned this pull request Mar 13, 2024

feat(gnoland): in config, refer to fields using toml struct tags #1769

Merged

zivkovicmilos mentioned this pull request Mar 25, 2024

[chain] Chain Creation Flow Improvement #1836

Closed

zivkovicmilos mentioned this pull request Apr 3, 2024

[chain] Standardize node directory structure #1882

Closed

r3v4s mentioned this pull request Apr 12, 2024

[chain] Add a get-node-id flag to gnoland secrets // multi-node related #1922

Closed

moul mentioned this pull request Apr 26, 2024

feat: overhaul lazy init in gnoland start #1985

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add `gnoland config` command suite #1605

feat: add `gnoland config` command suite #1605

zivkovicmilos commented Jan 30, 2024 •

edited

Loading

codecov bot commented Jan 30, 2024 •

edited

Loading

thehowl left a comment

zivkovicmilos commented Feb 12, 2024

zivkovicmilos commented Feb 16, 2024 •

edited

Loading

zivkovicmilos commented Feb 28, 2024

thehowl left a comment

gfanton left a comment

feat: add gnoland config command suite #1605

feat: add gnoland config command suite #1605

Conversation

zivkovicmilos commented Jan 30, 2024 • edited Loading

Description

codecov bot commented Jan 30, 2024 • edited Loading

Codecov Report

thehowl left a comment

Choose a reason for hiding this comment

zivkovicmilos commented Feb 12, 2024

zivkovicmilos commented Feb 16, 2024 • edited Loading

zivkovicmilos commented Feb 28, 2024

thehowl left a comment

Choose a reason for hiding this comment

gfanton left a comment

Choose a reason for hiding this comment

feat: add `gnoland config` command suite #1605

feat: add `gnoland config` command suite #1605

zivkovicmilos commented Jan 30, 2024 •

edited

Loading

codecov bot commented Jan 30, 2024 •

edited

Loading

zivkovicmilos commented Feb 16, 2024 •

edited

Loading