Adding localnetwork e2e tests: start\status\clean #2784

Tonix517 · 2025-05-01T18:40:50Z

Why this should be merged

https://ava-labs.atlassian.net/browse/DPTN-1625
https://ava-labs.atlassian.net/browse/DPTN-1626
https://ava-labs.atlassian.net/browse/DPTN-1627

How this works

How this was tested

ran new e2e test cases locally

How is this documented

artemanosov

LGTM but would refactor to use new testing function

artemanosov · 2025-05-01T20:17:50Z

tests/e2e/testcases/network/start/suite.go

+	ginkgo.AfterEach(func() {
+		err := commands.StopNetwork()
+		gomega.Expect(err).Should(gomega.BeNil())
+		_, _ = commands.CleanNetwork()


I believe clean stops network, so we don't need to stop it before cleaning

artemanosov · 2025-05-01T20:22:01Z

tests/e2e/commands/network.go

@@ -53,17 +54,42 @@ func StartNetwork() string {
 	return StartNetworkWithVersion("")
 }

+func StartNetworkWithNodeNumber(numOfNodes uint) string {


We should probably start using Raymond's test function so that we don't create these additional utils functions for every scenario

good reminder

sukantoraymond · 2025-05-02T14:57:49Z

tests/e2e/testcases/network/start/suite.go

+	ginkgo.AfterEach(func() {
+		_, _ = commands.CleanNetwork()
+	})
+


can we add tests for these flags too

cmd.Flags().StringVar( &startFlags.UserProvidedAvagoVersion, "avalanchego-version", constants.DefaultAvalancheGoVersion, "use this version of avalanchego (ex: v1.17.12)", ) cmd.Flags().StringVar(&startFlags.AvagoBinaryPath, "avalanchego-path", "", "use this avalanchego binary path") cmd.Flags().StringVar(&startFlags.RelayerBinaryPath, "relayer-path", "", "use this relayer binary path") cmd.Flags().StringVar(&startFlags.SnapshotName, "snapshot-name", constants.DefaultSnapshotName, "name of snapshot to use to start the network from") cmd.Flags().StringVar( &startFlags.RelayerVersion, "relayer-version", constants.DefaultRelayerVersion, "use this relayer version", )

For relayer related tests, feel free to create issue for it / if you want to pick it up, @felipemadero can give more context

ok i just created a ticket for it: https://ava-labs.atlassian.net/browse/DPTN-1665 - will address it in a follow-up PR

what about the other flags;

cmd.Flags().StringVar( &startFlags.UserProvidedAvagoVersion, "avalanchego-version", constants.DefaultAvalancheGoVersion, "use this version of avalanchego (ex: v1.17.12)", ) cmd.Flags().StringVar(&startFlags.AvagoBinaryPath, "avalanchego-path", "", "use this avalanchego binary path") cmd.Flags().StringVar(&startFlags.SnapshotName, "snapshot-name", constants.DefaultSnapshotName, "name of snapshot to use to start the network from")

sukantoraymond · 2025-05-02T15:16:12Z

tests/e2e/testcases/network/clean/suite.go

+		gomega.Expect(err).Should(gomega.BeNil())
+		gomega.Expect(out).Should(gomega.ContainSubstring("Process terminated"))
+	})
+


can we add test for this flag too

cmd.Flags().BoolVar( &hard, "hard", false, "Also clean downloaded avalanchego and plugin binaries", )

the comments here say plugin bins are also cleaned up, but per https://github.com/ava-labs/avalanche-cli/blob/main/cmd/networkcmd/clean.go#L65 we only clean ava-go bins?

can we follow up with @felipemadero to see if this is a bug? If it is might need to create a PR to fix network clean

most probably this flag should be deprecated

felipemadero · 2025-05-07T15:11:54Z

tests/e2e/utils/command.go

@@ -19,6 +19,7 @@ type CommandGroup string

 const (
 	BlockchainCmd CommandGroup = "blockchain"
+	NetworkCmd    CommandGroup = "network"


can we have a ticket to move this constants into cmd/ and unify?

felipemadero · 2025-05-07T15:13:25Z

tests/e2e/commands/network.go

-	cmd := exec.Command(
-		CLIBinary,
-		NetworkCmd,
+func CleanNetworkHard() (string, error) {


I believe we don't need this command anymore, we can just do it with clean network I believe

felipemadero · 2025-05-07T15:15:39Z

tests/e2e/commands/network.go

+func startNetworkWithParams(paramMap map[string]string) string {
+	cmdArgs := utils.GlobalFlags{}
+
+	for k, v := range paramMap {


why do we need this field remapping? we can just pass in the flags

felipemadero · 2025-05-07T15:19:04Z

tests/e2e/commands/network.go

 }

 /* #nosec G204 */
 func StartNetwork() string {
 	return StartNetworkWithVersion("")
 }

+func StartNetworkWithNodeNumber(numOfNodes uint) string {


I believe the caller can just use startNetworkWithParams. I also would make some changes so the numOfNodes is directly passed as map[string]interface{}

felipemadero · 2025-05-07T15:19:21Z

tests/e2e/commands/network.go

+		"number-of-nodes": strconv.FormatUint(uint64(numOfNodes), 10),
+	})
+}
+
 /* #nosec G204 */
 func StartNetworkWithVersion(version string) string {


I think the called can just use startNetworkWithParams

maybe better called, startNetwork

felipemadero · 2025-05-07T15:27:25Z

tests/e2e/testcases/network/start/suite.go

+		gomega.Expect(out).Should(gomega.ContainSubstring("Network ready to use"))
+
+		// https://github.com/ava-labs/avalanchego/blob/master/tests/fixture/tmpnet/defaults.go#L27
+		defaultNodeCount := 2


the constants lives in CLI constants.LocalNetworkNumNodes we don't use tmpnet default

felipemadero · 2025-05-07T15:29:57Z

tests/e2e/testcases/network/start/suite.go

+		gomega.Expect(err).Should(gomega.BeNil())
+		gomega.Expect(out).Should(gomega.ContainSubstring("Network is Up"))
+	})
+})


you need to add tests for starting from a stopped cluster. most important test
consideration is that the state is preserved. eg:
start with N nodes -> stop -> start with no args-> the same N is obtained

and check that L1s are started, blockchain deploy -> stop -> start -> the L1s are up and running

also check for start with different snapshot names, and see that:

it does not modify or create a default snapshot

stop only restores that state if given that snapshot name
also, clean only affects the default snapshot, no other snapshots
all the snapshots semantic may be well tested in this commands, together with stop

felipemadero · 2025-05-07T15:33:35Z

tests/e2e/testcases/network/status/suite.go

+	})
+
+	ginkgo.It("can get status of started network", func() {
+		out := commands.StartNetwork()


can you check the status is current for different network configurations, and for deployed L1s?

felipemadero · 2025-05-07T15:34:10Z

tests/e2e/testcases/network/status/suite.go

+
+	ginkgo.It("can get status of started network", func() {
+		out := commands.StartNetwork()
+		gomega.Expect(out).Should(gomega.ContainSubstring("Network ready to use"))


can you force in some way an unhealthy status and check it is reported?

felipemadero · 2025-05-07T15:35:07Z

tests/e2e/testcases/network/stop/suite.go

 	ginkgo.AfterEach(func() {
-		commands.CleanNetwork()
+		_, _ = commands.CleanNetwork()


I should add here a test case for stopping a locally deployed L1. it should both stop the network and
the L1s

Tonix517 requested a review from a team as a code owner May 1, 2025 18:40

Tonix517 requested review from learyce, jasonatran, sukantoraymond, artemanosov, meaghanfitzgerald and cwend-ava May 1, 2025 18:40

github-actions bot assigned Tonix517 May 1, 2025

artemanosov reviewed May 1, 2025

View reviewed changes

sukantoraymond reviewed May 2, 2025

View reviewed changes

Tonix517 added 3 commits May 2, 2025 10:53

Adding localnetwork e2e tests: start\status\clean

9129045

Using TestCommand in network e2e commands

760798b

adding network hardclean e2e test

cbaf8a2

Tonix517 force-pushed the tonyz/add_more_local_network_tests branch from 6e94b79 to cbaf8a2 Compare May 2, 2025 18:10

Tonix517 mentioned this pull request May 5, 2025

[DPTN-1653] Adding e2e test for local node start #2792

Open

1 task

felipemadero reviewed May 7, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding localnetwork e2e tests: start\status\clean #2784

Adding localnetwork e2e tests: start\status\clean #2784

Tonix517 commented May 1, 2025

artemanosov left a comment

artemanosov May 1, 2025

Tonix517 May 1, 2025

artemanosov May 1, 2025

Tonix517 May 1, 2025

Tonix517 May 1, 2025

sukantoraymond May 2, 2025 •

edited

Loading

sukantoraymond May 2, 2025

Tonix517 May 2, 2025

sukantoraymond May 5, 2025

sukantoraymond May 2, 2025

Tonix517 May 2, 2025

Tonix517 May 2, 2025

sukantoraymond May 5, 2025 •

edited

Loading

felipemadero May 7, 2025

felipemadero May 7, 2025

felipemadero May 7, 2025

felipemadero May 7, 2025

felipemadero May 7, 2025

felipemadero May 7, 2025

felipemadero May 7, 2025

felipemadero May 7, 2025

felipemadero May 7, 2025

felipemadero May 7, 2025

felipemadero May 7, 2025

felipemadero May 7, 2025

felipemadero May 7, 2025

Adding localnetwork e2e tests: start\status\clean #2784

Are you sure you want to change the base?

Adding localnetwork e2e tests: start\status\clean #2784

Conversation

Tonix517 commented May 1, 2025

Why this should be merged

How this works

How this was tested

How is this documented

artemanosov left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sukantoraymond May 2, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sukantoraymond May 5, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sukantoraymond May 2, 2025 •

edited

Loading

sukantoraymond May 5, 2025 •

edited

Loading