fixup: Make WaitForHealthy a function instead of an Node interface method

Author: maru-ava

tests/e2e/e2e.go

@@ -139,5 +139,5 @@ func AddEphemeralNode(network testnet.Network, flags testnet.FlagsMap) testnet.N
 func WaitForHealthy(node testnet.Node) {
 	ctx, cancel := context.WithTimeout(context.Background(), DefaultTimeout)
 	defer cancel()
-	require.NoError(ginkgo.GinkgoT(), node.WaitForHealthy(ctx))
+	require.NoError(ginkgo.GinkgoT(), testnet.WaitForHealthy(ctx, node))
 }

tests/e2e/faultinjection/duplicate_node_id.go

@@ -47,7 +47,7 @@ var _ = ginkgo.Describe("Duplicate node handling", func() {
 		ginkgo.By("checking that the second new node fails to become healthy before timeout")
 		ctx, cancel := context.WithTimeout(context.Background(), e2e.DefaultNodeStartTimeout)
 		defer cancel()
-		err := node2.WaitForHealthy(ctx)
+		err := testnet.WaitForHealthy(ctx, node2)
 		require.ErrorIs(err, context.DeadlineExceeded)
 
 		ginkgo.By("stopping the first new node")

tests/fixture/testnet/common.go

@@ -0,0 +1,42 @@
+// Copyright (C) 2019-2023, Ava Labs, Inc. All rights reserved.
+// See the file LICENSE for licensing terms.
+
+package testnet
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"time"
+)
+
+const (
+	DefaultNodeTickerInterval = 50 * time.Millisecond
+)
+
+var ErrNotRunning = errors.New("not running")
+
+// WaitForHealthy blocks until Node.IsHealthy returns true or an error (including context timeout) is observed.
+func WaitForHealthy(ctx context.Context, node Node) error {
+	if _, ok := ctx.Deadline(); !ok {
+		return fmt.Errorf("unable to wait for health for node %q with a context without a deadline", node.GetID())
+	}
+	ticker := time.NewTicker(DefaultNodeTickerInterval)
+	defer ticker.Stop()
+
+	for {
+		healthy, err := node.IsHealthy(ctx)
+		if err != nil && !errors.Is(err, ErrNotRunning) {
+			return fmt.Errorf("failed to wait for health of node %q: %w", node.GetID(), err)
+		}
+		if healthy {
+			return nil
+		}
+
+		select {
+		case <-ctx.Done():
+			return fmt.Errorf("failed to wait for health of node %q before timeout: %w", node.GetID(), ctx.Err())
+		case <-ticker.C:
+		}
+	}
+}

tests/fixture/testnet/interfaces.go

@@ -24,6 +24,5 @@ type Node interface {
 	GetConfig() NodeConfig
 	GetProcessContext() node.NodeProcessContext
 	IsHealthy(ctx context.Context) (bool, error)
-	WaitForHealthy(ctx context.Context) error
 	Stop() error
 }

tests/fixture/testnet/local/config.go

@@ -20,7 +20,6 @@ const (
 	DefaultNetworkStartTimeout = 2 * time.Minute
 	DefaultNodeInitTimeout     = 10 * time.Second
 	DefaultNodeStopTimeout     = 5 * time.Second
-	DefaultNodeTickerInterval  = 50 * time.Millisecond
 )
 
 // A set of flags appropriate for local testing.

tests/fixture/testnet/local/network.go

@@ -385,7 +385,7 @@ func (ln *LocalNetwork) WaitForHealthy(ctx context.Context, w io.Writer) error {
 			}
 
 			healthy, err := node.IsHealthy(ctx)
-			if err != nil && !errors.Is(err, errProcessNotRunning) {
+			if err != nil && !errors.Is(err, testnet.ErrNotRunning) {
 				return err
 			}
 			if !healthy {

tests/fixture/testnet/local/node.go

@@ -27,10 +27,7 @@ import (
 	"github.com/ava-labs/avalanchego/utils/perms"
 )
 
-var (
-	errProcessNotRunning  = errors.New("process not running")
-	errNodeAlreadyRunning = errors.New("failed to start local node: node is already running")
-)
+var errNodeAlreadyRunning = errors.New("failed to start local node: node is already running")
 
 // Defines local-specific node configuration. Supports setting default
 // and node-specific values.
@@ -268,7 +265,7 @@ func (n *LocalNode) Stop() error {
 	}
 
 	// Wait for the node process to stop
-	ticker := time.NewTicker(DefaultNodeTickerInterval)
+	ticker := time.NewTicker(testnet.DefaultNodeTickerInterval)
 	defer ticker.Stop()
 	ctx, cancel := context.WithTimeout(context.Background(), DefaultNodeStopTimeout)
 	defer cancel()
@@ -298,7 +295,7 @@ func (n *LocalNode) IsHealthy(ctx context.Context) (bool, error) {
 		return false, fmt.Errorf("failed to determine process status: %w", err)
 	}
 	if proc == nil {
-		return false, errProcessNotRunning
+		return false, testnet.ErrNotRunning
 	}
 
 	// Check that the node is reporting healthy
@@ -323,33 +320,8 @@ func (n *LocalNode) IsHealthy(ctx context.Context) (bool, error) {
 	return false, fmt.Errorf("failed to query node health: %w", err)
 }
 
-// WaitForHealthy blocks until IsHealthy returns true or an error (including context timeout) is observed.
-func (n *LocalNode) WaitForHealthy(ctx context.Context) error {
-	if _, ok := ctx.Deadline(); !ok {
-		return fmt.Errorf("unable to wait for health for node %q with a context without a deadline", n.NodeID)
-	}
-	ticker := time.NewTicker(DefaultNodeTickerInterval)
-	defer ticker.Stop()
-
-	for {
-		healthy, err := n.IsHealthy(ctx)
-		if err != nil && !errors.Is(err, errProcessNotRunning) {
-			return fmt.Errorf("failed to wait for health of node %q: %w", n.NodeID, err)
-		}
-		if healthy {
-			return nil
-		}
-
-		select {
-		case <-ctx.Done():
-			return fmt.Errorf("failed to wait for health of node %q before timeout: %w", n.NodeID, ctx.Err())
-		case <-ticker.C:
-		}
-	}
-}
-
 func (n *LocalNode) WaitForProcessContext(ctx context.Context) error {
-	ticker := time.NewTicker(DefaultNodeTickerInterval)
+	ticker := time.NewTicker(testnet.DefaultNodeTickerInterval)
 	defer ticker.Stop()
 
 	ctx, cancel := context.WithTimeout(ctx, DefaultNodeInitTimeout)