Deploy flags e2e #2755
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
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,22 @@ | ||
| { | ||
|
Collaborator
There was a problem hiding this comment. I like this cmd tree. probably this can have a default name, like test_table.json |
||
| "globalFlags": { | ||
| "local": true, | ||
| "skip-icm-deploy": true, | ||
| "skip-update-check": true | ||
| }, | ||
| "happyPath": [ | ||
| { | ||
| "name": "local_deploy", | ||
| "flags": {} | ||
| } | ||
| ], | ||
| "notHappyPath": [ | ||
| { | ||
| "name": "invalid_version", | ||
| "flags": { | ||
| "avalanchego-version": "invalid_version" | ||
| }, | ||
| "expectedError": "invalid version string" | ||
| } | ||
| ] | ||
| } | ||
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,73 @@ | ||
| // Copyright (C) 2024, Ava Labs, Inc. All rights reserved. | ||
| // See the file LICENSE for licensing terms. | ||
|
|
||
| package deploy | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/ava-labs/avalanche-cli/tests/e2e/commandse2e" | ||
|
|
||
| "github.com/ava-labs/avalanche-cli/tests/e2e/commands" | ||
| ginkgo "github.com/onsi/ginkgo/v2" | ||
| "github.com/onsi/gomega" | ||
| ) | ||
|
|
||
| const ( | ||
| deployTestJSONPath = "tests/e2e/commandse2e/blockchain/deploy/deploy_tests.json" | ||
| subnetName = "testSubnet" | ||
| ) | ||
|
|
||
| var ( | ||
| config *commandse2e.TestJSONConfig | ||
| err error | ||
| ) | ||
|
|
||
| const ewoqEVMAddress = "0x8db97C7cEcE249c2b98bDC0226Cc4C2A57BF52FC" | ||
|
|
||
| var _ = ginkgo.Describe("[Blockchain Deploy Flags]", ginkgo.Ordered, func() { | ||
| _ = ginkgo.BeforeEach(func() { | ||
| // Create test subnet config | ||
| commands.CreateSubnetEvmConfigSOV(subnetName, ewoqEVMAddress, commands.PoA) | ||
|
Collaborator
There was a problem hiding this comment. maybe this should be added to the json spec (how to setup required env) |
||
|
|
||
| // Read test configuration | ||
| config, err = commandse2e.ReadTestConfig(deployTestJSONPath) | ||
| gomega.Expect(err).Should(gomega.BeNil()) | ||
| }) | ||
|
|
||
| ginkgo.AfterEach(func() { | ||
| commands.CleanNetwork() | ||
| // Cleanup test subnet config | ||
| commands.DeleteSubnetConfig(subnetName) | ||
| }) | ||
| blockchainCmdArgs := []string{subnetName} | ||
|
Collaborator
There was a problem hiding this comment. this should belong to the json test case IMO |
||
| ginkgo.It("should successfully deploy a blockchain", func() { | ||
| // Run each happy path test case | ||
| for _, testCase := range config.HappyPath { | ||
| ginkgo.By(fmt.Sprintf("Running test case: %s", testCase.Name)) | ||
| _, err = commandse2e.TestCommandWithJSONConfig( | ||
| commandse2e.BlockchainCmd, | ||
| "deploy", | ||
|
Collaborator
There was a problem hiding this comment. this should be a constant on cmd/blockchaincmd/ |
||
| blockchainCmdArgs, | ||
| deployTestJSONPath, | ||
| &testCase, | ||
| ) | ||
| gomega.Expect(err).Should(gomega.BeNil()) | ||
| } | ||
| }) | ||
|
|
||
| ginkgo.It("should handle error cases", func() { | ||
| // Run each not happy path test case | ||
| for _, testCase := range config.NotHappyPath { | ||
| ginkgo.By(fmt.Sprintf("Running test case: %s", testCase.Name)) | ||
| _, err = commandse2e.TestCommandWithJSONConfig( | ||
| commandse2e.BlockchainCmd, | ||
| "deploy", | ||
| blockchainCmdArgs, | ||
| deployTestJSONPath, | ||
| &testCase, | ||
| ) | ||
| gomega.Expect(err).Should(gomega.HaveOccurred()) | ||
| } | ||
| }) | ||
| }) | ||
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,111 @@ | ||
| // Copyright (C) 2022, Ava Labs, Inc. All rights reserved. | ||
| // See the file LICENSE for licensing terms. | ||
| package commandse2e | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "errors" | ||
| "fmt" | ||
| "os" | ||
| "os/exec" | ||
|
|
||
| "github.com/ava-labs/avalanche-cli/tests/e2e/utils" | ||
| ) | ||
|
|
||
| // TestCase represents a single test case configuration | ||
| type TestCase struct { | ||
| Name string `json:"name"` | ||
| Flags map[string]string `json:"flags"` | ||
|
||
| ExpectedError string `json:"expectedError,omitempty"` | ||
|
||
| } | ||
|
|
||
| // TestJSONConfig represents the json configuration that contains cli command flag inputs | ||
| type TestJSONConfig struct { | ||
| GlobalFlags map[string]interface{} `json:"globalFlags"` | ||
|
|
||
| HappyPath []TestCase `json:"happyPath"` | ||
| NotHappyPath []TestCase `json:"notHappyPath"` | ||
| } | ||
|
|
||
| // CommandGroup represents the different command groups available in the CLI | ||
| type CommandGroup string | ||
|
|
||
| const ( | ||
| BlockchainCmd CommandGroup = "blockchain" | ||
|
Collaborator
There was a problem hiding this comment. I would rather add this constant on cmd/blockchaincmd/ and import that here |
||
| ) | ||
|
|
||
| var avalancheBinaryPath = "./bin/avalanche" | ||
|
|
||
| // TestCommandWithJSONConfig tests a CLI command with flag inputs from a JSON file | ||
| func TestCommandWithJSONConfig(commandGroup CommandGroup, command string, args []string, configPath string, testCase *TestCase) (string, error) { | ||
|
Collaborator
There was a problem hiding this comment. Nice this is generic
Collaborator
There was a problem hiding this comment. I believe this should not take configPath as string and testCase as TestCase, it should either receive |
||
| // Build command arguments | ||
| cmdArgs := []string{string(commandGroup), command} | ||
|
|
||
| // Read and parse the JSON config file | ||
| configData, err := os.ReadFile(configPath) | ||
| if err != nil { | ||
| return "", fmt.Errorf("failed to read config file: %w", err) | ||
| } | ||
|
|
||
| var config TestJSONConfig | ||
| if err := json.Unmarshal(configData, &config); err != nil { | ||
| return "", fmt.Errorf("failed to parse config file: %w", err) | ||
| } | ||
|
|
||
| // Append any additional arguments | ||
| if len(args) > 0 { | ||
|
Collaborator
There was a problem hiding this comment. this should belong to the test case |
||
| cmdArgs = append(cmdArgs, args...) | ||
| } | ||
|
|
||
| // Create a map to store all flags, starting with global flags | ||
| allFlags := make(map[string]interface{}) | ||
| for flag, value := range config.GlobalFlags { | ||
| allFlags[flag] = value | ||
| } | ||
|
|
||
| // Override with test case specific flags if provided | ||
| if testCase != nil { | ||
| for flag, value := range testCase.Flags { | ||
| allFlags[flag] = value | ||
| } | ||
| } | ||
|
|
||
| // Add all flags to command arguments | ||
| for flag, value := range allFlags { | ||
| cmdArgs = append(cmdArgs, "--"+flag+"="+fmt.Sprintf("%v", value)) | ||
| } | ||
|
|
||
| // Execute the command | ||
| cmd := exec.Command(avalancheBinaryPath, cmdArgs...) | ||
| fmt.Println(cmd) | ||
| output, err := cmd.CombinedOutput() | ||
| if err != nil { | ||
| var ( | ||
| exitErr *exec.ExitError | ||
| stderr string | ||
| ) | ||
| if errors.As(err, &exitErr) { | ||
| stderr = string(exitErr.Stderr) | ||
| } | ||
| fmt.Println(string(output)) | ||
| utils.PrintStdErr(err) | ||
| fmt.Println(stderr) | ||
| return "", err | ||
| } | ||
|
|
||
| return string(output), nil | ||
| } | ||
|
|
||
| // ReadTestConfig reads and parses the test configuration from a JSON file | ||
| func ReadTestConfig(configPath string) (*TestJSONConfig, error) { | ||
| configData, err := os.ReadFile(configPath) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to read config file: %w", err) | ||
| } | ||
|
|
||
| var config TestJSONConfig | ||
| if err := json.Unmarshal(configData, &config); err != nil { | ||
| return nil, fmt.Errorf("failed to parse config file: %w", err) | ||
| } | ||
|
|
||
| return &config, nil | ||
| } | ||
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
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
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
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
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.
not sure we want to start modifying CI at this stage