[CLD-1781]: tests(operations-gen): add EVM golden tests #920
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| package evm | ||
|
|
||
| import ( | ||
| "flag" | ||
| "os" | ||
| "path/filepath" | ||
| "testing" | ||
| "text/template" | ||
|
|
||
| "gopkg.in/yaml.v3" | ||
|
|
||
| "github.com/smartcontractkit/chainlink-deployments-framework/tools/operations-gen/internal/core" | ||
| ) | ||
|
|
||
| var update = flag.Bool("update", false, "update golden files") | ||
|
|
||
| // TestGenerateLinkToken is an end-to-end test that runs the generator against the | ||
| // real LinkToken ABI/bytecode and verifies that the generated output matches golden. | ||
| func TestGenerateLinkToken(t *testing.T) { | ||
| t.Parallel() | ||
| runGoldenGenerationTest(t, "operations_gen_config.yaml", "link_token.golden.go") | ||
| } | ||
|
|
||
| // TestGenerateManyChainMultiSig verifies generation against an MCMS-like ABI fixture. | ||
| func TestGenerateManyChainMultiSig(t *testing.T) { | ||
| t.Parallel() | ||
| runGoldenGenerationTest(t, "operations_gen_mcms_config.yaml", "many_chain_multi_sig.golden.go") | ||
| } | ||
|
|
||
| func runGoldenGenerationTest(t *testing.T, configFileName string, goldenFileName string) { | ||
| t.Helper() | ||
|
|
||
| evmTestdataDir, err := filepath.Abs(filepath.Join("..", "..", "..", "testdata", "evm")) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| configData, err := os.ReadFile(filepath.Join(evmTestdataDir, configFileName)) | ||
| if err != nil { | ||
| t.Fatalf("reading config: %v", err) | ||
| } | ||
|
|
||
| var cfg core.Config | ||
| if err = yaml.Unmarshal(configData, &cfg); err != nil { | ||
| t.Fatalf("parsing config: %v", err) | ||
| } | ||
|
|
||
| // Override paths: inputs point to fixture dirs, output to a temp dir. | ||
| cfg.Input = mustYAMLNode(t, evmInputConfig{ | ||
| ABIBasePath: filepath.Join(evmTestdataDir, "abi"), | ||
| BytecodeBasePath: filepath.Join(evmTestdataDir, "bytecode"), | ||
| }) | ||
| tmpDir := t.TempDir() | ||
| cfg.Output = mustYAMLNode(t, evmOutputConfig{BasePath: tmpDir}) | ||
| cfg.ConfigDir = "" | ||
|
|
||
| handler := Handler{} | ||
| tmpl, err := loadTemplateForTest() | ||
| if err != nil { | ||
| t.Fatalf("loadTemplate: %v", err) | ||
| } | ||
|
|
||
| if err = handler.Generate(cfg, tmpl); err != nil { | ||
| t.Fatalf("Generate: %v", err) | ||
| } | ||
|
|
||
| // Derive the output path from the first contract in the config, mirroring extractContractInfo. | ||
| var contractCfgs []evmContractConfig | ||
| if err = cfg.Contracts.Decode(&contractCfgs); err != nil || len(contractCfgs) == 0 { | ||
| t.Fatalf("decoding contract configs: %v", err) | ||
| } | ||
graham-chainlink marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| first := contractCfgs[0] | ||
| pkgName := first.PackageName | ||
| if pkgName == "" { | ||
| pkgName = toSnakeCase(first.Name) | ||
| } | ||
| vPath := core.VersionToPath(first.Version) | ||
| if first.VersionPath != "" { | ||
| vPath = first.VersionPath | ||
| } | ||
| outputPath := core.ContractOutputPath(tmpDir, vPath, pkgName) | ||
|
|
||
| got, err := os.ReadFile(outputPath) | ||
| if err != nil { | ||
| t.Fatalf("reading generated file %s: %v", outputPath, err) | ||
| } | ||
|
|
||
| goldenPath := filepath.Join(evmTestdataDir, goldenFileName) | ||
|
|
||
| if *update { | ||
| if err = os.WriteFile(goldenPath, got, 0o600); err != nil { | ||
| t.Fatalf("writing golden file: %v", err) | ||
| } | ||
|
|
||
| return | ||
| } | ||
|
|
||
| want, err := os.ReadFile(goldenPath) | ||
| if err != nil { | ||
| t.Fatalf("reading golden file %s: %v (run with -update to create it)", goldenPath, err) | ||
| } | ||
|
|
||
| if string(got) != string(want) { | ||
| t.Errorf("generated output does not match golden file %s\n\nrun: go test ./... -run %s -update", goldenPath, t.Name()) | ||
| } | ||
| } | ||
|
|
||
| func mustYAMLNode(t *testing.T, value any) yaml.Node { | ||
| t.Helper() | ||
| b, err := yaml.Marshal(value) | ||
| if err != nil { | ||
| t.Fatalf("marshal yaml node: %v", err) | ||
| } | ||
| var n yaml.Node | ||
| if err = yaml.Unmarshal(b, &n); err != nil { | ||
| t.Fatalf("unmarshal yaml node: %v", err) | ||
| } | ||
|
|
||
| return n | ||
| } | ||
|
|
||
| func loadTemplateForTest() (*template.Template, error) { | ||
| path := filepath.Join("..", "..", "..", "templates", "evm", "operations.tmpl") | ||
| content, err := os.ReadFile(path) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return template.New("operations").Parse(string(content)) | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Introduced some constants too