Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: add workflow for reporting possible state-changing diffs #13774

Merged
merged 2 commits into from
Nov 27, 2022
Merged

ci: add workflow for reporting possible state-changing diffs #13774

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e05613b
ci: add workflow for reporting possible state-changing diffs
elias-orijtech Nov 8, 2022
dd59995
Merge branch 'main' into main
tac0turtle Nov 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/workflows/statediff.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: "Warn about consensus code changes"

on:
pull_request_target:
types:
- opened
- edited
- synchronize

jobs:
main:
permissions:
pull-requests: write # For reading the PR and posting comment
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: orijtech/statediff@main
with:
roots: 'github.com/cosmos/cosmos-sdk/baseapp.BaseApp.DeliverTx,github.com/cosmos/cosmos-sdk/baseapp.BaseApp.BeginBlock,github.com/cosmos/cosmos-sdk/baseapp.BaseApp.EndBlock,github.com/cosmos/cosmos-sdk/baseapp.BaseApp.Commit'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could you explain what this does?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh I read what this does. I don't think this solves the issue described above.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The linked issue says

"State machine relevant code should basically be anything reachable from BeginBlock/DeliverTx/EndBlock/Commit."

This tool implements the basic reachability analysis: function or method calls. With the GitHub and testing machinery in place, the tool can easily be expanded. For example, what makes code such as x/staking/keeper/msg_server.go state code? Called by a root function/method, implementing a certain interface, something else? If you come up with the rule, I can add it to the tool.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ebuchman could you please chime in too? @elias-orijtech implemented checking code reachable from the desired roots. Please chime in with suggestions for the use cases if it doesn't fit what he implemented. Thanks @tac0turtle @alexanderbez for the co-reviews!