Repository navigation
docs: functional checks, the behaviour a release exists for - #4
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
docs/testing.mdmapped safe-sim's structural checklist toLatticeTesthelpers but said nothing about the other half of a release's tests: the behaviour the release exists for, driven end to end through the live proxies after the change.Modifications
docs/testing.md: a Functional checks section — what to cover (the changed behaviour, one happy path that must keep working, failure paths the change moved), how to do it on a fork (prank the role holders, write the inputs the flow needs; nothing reaches the chain underlattice testorlattice run), everything fromEnv, when a release may skip it.Result
A release writer knows a
Functional.t.solsuite is expected beside the structural ones, and how to write one that runs unchanged against the sandbox and against mainnet.Note
Low Risk
Documentation-only change to testing guidance; no runtime or contract behavior is modified.
Overview
Adds a Functional checks section to
docs/testing.mdthat sits alongside the existing structural upgrade checklist and describes what release tests must prove about behaviour, not just proxy mechanics.It expects a
Functional.t.solsuite (via averifystep intestmode after live bytecode / post-deploy checks) to cover the changed flow end-to-end through live proxies, at least one regression happy path, and any failure paths the change moved. It documents how to run those tests on a fork—prank role holders, seed inputs, useEnvfor addresses—why unit tests are not a substitute, and when a release may skip the suite.Reviewed by Cursor Bugbot for commit b07d851. Bugbot is set up for automated code reviews on this repo. Configure here.