This tool generates voting power info from a db-sync instance.
Example usage:
snapshot-tool --db postgres --db-user postgres --db-host localhost --out-file output.json
Building with nix should be straightforward, simply enter a dev environment with nix develop, then run cargo build to build.
To run tests, run cargo test. Note, these tests include database tests, which require a running postgres instance to connect to. If you want to run only non-database tests, run cargo test --no-default-features
Database tests perform predefined queries against a test database. If the results don't match the snapshots, the test fails. This requires having the correct data in your database. The current test data can be found here.
There are also "reference database tests", which populate a mock database with fake data, run queries against them, and check the results. These do not require the preset test data, as the correct data is created in the test.
Once you have this database set up, create a file at <project_root>/test_db.json, which contains credentials to connect to this database, for example:
{
"host": "localhost",
"name": "database_name",
"user": "username",
"password": "password"
}(Note, password is optional).
From there, running cargo test will run database tests as well as regular tests. If tests pass, great!
If not, you need to review the changes. It's possible that you intended to change the result of a query. Use cargo insta review to go through all failed tests and mark them as "intended" or not.