Sketch out approach to testing abigen v2 #11
Draft
+709
−141
Conversation
This file contains 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
Co-authored-by: Marius van der Wijden <m.vanderwijden@live.de>
I am using unnamed parameters. It might be slightly more maintainable to use named parameters, but I get an error when trying to use {{.Type}} inside a struct literal.
geoknee
commented
Jul 20, 2023
accounts/abi/bind/bind_test.go
Outdated
Comment on lines
102
to
103
| if b, err := NewToken(common.Address{}, nil); b == nil || err != nil { | ||
| t.Fatalf("binding (%v) nil or error (%v) not nil", b, nil) |
There was a problem hiding this comment.
This is currently failing:
bind_test.go:2204: test 1: failed to generate v2 binding: 77:39: expected ')', found ','
There was a problem hiding this comment.
This is because the output from abigen v2 is
func (_Token *Token) PackConstructor(, initialSupply *big.Int , tokenName string , decimalUnits uint8 , tokenSymbol string ) ([]byte, error) {
return _Token.abi.Pack("" , initialSupply, tokenName, decimalUnits, tokenSymbol)
}and we are trying to format the output.
The existing template prints a leading comma before each entry in the range. This works with the old template because there was a preceding variable printed. Here, we opt for a multilne function definition and use trailing commas.
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.
Includes #10 .
The philosophy here is to mirror the existing test suite, so that the abigen v2 is run against all of the sam inputs, but with a custom set of assertions as to what to expect.
Overall the testing approach is pretty indirect / involved (writing to a temporary directory, building test files by editing raw strings,...). I don't love it, but it matches what is there and isn't too hard to modify.
An alternative I had considered is simply asserting on the output of
Bind. If we find exactly what we want in the output, then probably there aren't any bugs. The existing testing system is better because it will check to see if the resulting package is free of bugs, too.Keen to get feedback before finishing off the test (it still has some notes in the margin / mess from development)