Add nodes validation in farmerbot

farmerbot/cmd/run.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 
 	"github.com/spf13/cobra"
+	substrate "github.com/threefoldtech/tfchain/clients/tfchain-client-go"
 	"github.com/threefoldtech/tfgrid-sdk-go/farmerbot/internal"
 	"github.com/threefoldtech/tfgrid-sdk-go/farmerbot/parser"
 )
@@ -40,6 +41,15 @@ var runCmd = &cobra.Command{
 		if err != nil {
 			return err
 		}
+		sub, err := substrate.NewManager(internal.SubstrateURLs[network]...).Substrate()
+		if err != nil {
+			return err
+		}
+		defer sub.Close()
+		err = parser.ValidateInput(&config, sub)
+		if err != nil {
+			return err
+		}
 
 		config.ContinueOnPoweringOnErr = continueOnPoweringOnErr
 

farmerbot/parser/parser.go

@@ -94,3 +94,41 @@ func ParseEnv(content string) (network string, mnemonicOrSeed string, keyType st
 
 	return
 }
+
+// ValidateInput validates that included, excluded and priority nodes are in the farm
+func ValidateInput(input *internal.Config, sub internal.Substrate) error {
+	nodes, err := sub.GetNodes(input.FarmID)
+	if err != nil {
+		return fmt.Errorf("couldn't retrieve node for %d : %v", input.FarmID, err)
+	}
+	nodesMap := make(map[uint32]bool)
+	for _, node := range nodes {
+		nodesMap[node] = true
+	}
+
+	//validate included nodes
+	for _, includedNode := range input.IncludedNodes {
+		if _, ok := nodesMap[includedNode]; !ok {
+			return fmt.Errorf("included node with id %d doesn't exist in the farm", includedNode)
+		}
+	}
+	//validate excluded nodes
+	for _, excludedNode := range input.ExcludedNodes {
+		if _, ok := nodesMap[excludedNode]; !ok {
+			return fmt.Errorf("excluded node with id %d doesn't exist in the farm", excludedNode)
+		}
+		index := slices.Index(input.IncludedNodes, excludedNode)
+		if index >= 0 {
+			return fmt.Errorf("cannot include and exclude the same node %d", excludedNode)
+		}
+	}
+
+	//validate priority nodes
+	for _, priorityNode := range input.PriorityNodes {
+		index := slices.Index(input.IncludedNodes, priorityNode)
+		if index < 0 {
+			return fmt.Errorf("priority node with id %d doesn't exist included nodes", priorityNode)
+		}
+	}
+	return nil
+}

farmerbot/parser/parser_test.go

@@ -4,8 +4,10 @@ import (
 	"testing"
 	"time"
 
+	"github.com/golang/mock/gomock"
 	"github.com/stretchr/testify/assert"
 	"github.com/threefoldtech/tfgrid-sdk-go/farmerbot/internal"
+	"github.com/threefoldtech/tfgrid-sdk-go/farmerbot/mocks"
 )
 
 func TestFileReader(t *testing.T) {
@@ -148,3 +150,47 @@ MNEMONIC_OR_SEED=//alice`
 		assert.Error(t, err)
 	})
 }
+
+func TestValidateInput(t *testing.T) {
+	config := &internal.Config{FarmID: uint32(25)}
+	ctrl := gomock.NewController(t)
+	mockGetNodes := mocks.NewMockSubstrate(ctrl)
+	mockGetNodes.EXPECT().GetNodes(config.FarmID).Times(6).Return([]uint32{20, 21, 22, 23, 24, 30, 31, 32, 34, 40, 41}, nil)
+	t.Run("test valid include, exclude and priority nodes", func(t *testing.T) {
+		config.IncludedNodes = []uint32{20, 21, 22, 30, 31, 32, 40, 41}
+		config.ExcludedNodes = []uint32{23, 24, 34}
+		config.PriorityNodes = []uint32{20, 21}
+		got := ValidateInput(config, mockGetNodes)
+		assert.NoError(t, got)
+	})
+	t.Run("test invalid include", func(t *testing.T) {
+		config.IncludedNodes = []uint32{26, 27}
+		got := ValidateInput(config, mockGetNodes)
+		assert.Error(t, got)
+	})
+	t.Run("test invalid exclude", func(t *testing.T) {
+		config.ExcludedNodes = []uint32{26, 27}
+		got := ValidateInput(config, mockGetNodes)
+		assert.Error(t, got)
+	})
+	t.Run("test invalid priority", func(t *testing.T) {
+		config.IncludedNodes = []uint32{21}
+		config.PriorityNodes = []uint32{20, 21}
+		got := ValidateInput(config, mockGetNodes)
+		assert.Error(t, got)
+	})
+	t.Run("test overlapping nodes in include and exclude", func(t *testing.T) {
+		config.IncludedNodes = []uint32{21}
+		config.ExcludedNodes = []uint32{20, 21}
+		got := ValidateInput(config, mockGetNodes)
+		assert.Error(t, got)
+	})
+	t.Run("test overlapping nodes in priority and exclude", func(t *testing.T) {
+		config.IncludedNodes = []uint32{21}
+		config.PriorityNodes = []uint32{21}
+		config.ExcludedNodes = []uint32{20, 21}
+		got := ValidateInput(config, mockGetNodes)
+		assert.Error(t, got)
+	})
+
+}