feat: added feature to pass public ports from cli to package

HugoByte · Jan 11, 2024 · 66eed34 · 66eed34
1 parent 123e881
commit 66eed34
Show file tree

Hide file tree

Showing 9 changed files with 379 additions and 362 deletions.
diff --git a/cli/cmd/chains/kusama/cmd.go b/cli/cmd/chains/kusama/cmd.go
@@ -29,6 +29,10 @@ const (
 	runKusamaGrafana                  = "launch_grafana"
 )
 
+var (
+	kusamaParachains                  = []string{"altair", "bajun", "bifrost", "calamari", "encointer", "khala", "kintsugi-btc", "litmus", "mangata", "moonriver", "robonomics", "subzero", "turing"}
+)
+
 var KusamaCmd = common.NewDiveCommandBuilder().
 	SetUse("kusama").
 	SetShort("Build, initialize and start a Kusama node").

diff --git a/cli/cmd/chains/kusama/run.go b/cli/cmd/chains/kusama/run.go
diff --git a/cli/cmd/chains/polkadot/cmd.go b/cli/cmd/chains/polkadot/cmd.go
@@ -29,6 +29,10 @@ const (
 	runPolkadotGrafana                  = "launch_grafana"
 )
 
+var (
+	polkadotParachains = []string{"acala", "ajuna", "bifrost", "centrifuge", "clover", "frequency", "integritee", "interlay", "karura", "kilt", "kylin", "litentry", "manta", "moonbeam", "moonsama", "nodle", "parallel", "pendulum", "phala", "polkadex", "subsocial", "zeitgeist"}
+)
+
 var PolkadotCmd = common.NewDiveCommandBuilder().
 	SetUse("polkadot").
 	SetShort("Build, initialize and start a Polkadot node").

diff --git a/cli/cmd/chains/polkadot/run.go b/cli/cmd/chains/polkadot/run.go
diff --git a/cli/cmd/chains/utils/types.go b/cli/cmd/chains/utils/types.go
@@ -2,6 +2,8 @@ package utils
 
 import (
 	"encoding/json"
+	"fmt"
+	"slices"
 
 	"github.com/hugobyte/dive-core/cli/common"
 )
@@ -160,8 +162,15 @@ func (sc *HardhatServiceConfig) EncodeToString() (string, error) {
 
 type NodeConfig struct {
 	Name       string `json:"name"`
-	NodeType   string `json:"node-type"`
+	NodeType   string `json:"node_type"`
 	Prometheus bool   `json:"prometheus"`
+	Ports      Ports  `json:"ports"`
+}
+
+type Ports struct {
+	RPCPort        int `json:"rpc_port"`
+	Lib2LibPort    int `json:"lib2lib_port"`
+	PrometheusPort int `json:"prometheus_port,omitempty"`
 }
 
 type RelayChainConfig struct {
@@ -175,14 +184,23 @@ type ParaNodeConfig struct {
 }
 
 type PolkadotServiceConfig struct {
-	ChainType  string           `json:"chain-type"`
+	ChainType  string           `json:"chain_type"`
 	RelayChain RelayChainConfig `json:"relaychain"`
-	Para       []ParaNodeConfig `json:"para"`
+	Para       []ParaNodeConfig `json:"parachains"`
 	Explorer   bool             `json:"explorer"`
 }
 
-func (sc *ParaNodeConfig) EncodeToString() (string, error) {
-	encodedBytes, err := json.Marshal(sc)
+func (pc *ParaNodeConfig) EncodeToString() (string, error) {
+	encodedBytes, err := json.Marshal(pc)
+	if err != nil {
+		return "", common.WrapMessageToError(common.ErrDataMarshall, err.Error())
+	}
+
+	return string(encodedBytes), nil
+}
+
+func (rc *RelayChainConfig) EncodeToString() (string, error) {
+	encodedBytes, err := json.Marshal(rc)
 	if err != nil {
 		return "", common.WrapMessageToError(common.ErrDataMarshall, err.Error())
 	}
@@ -209,6 +227,17 @@ func (sc *PolkadotServiceConfig) LoadConfigFromFile(cliContext *common.Cli, file
 	if err != nil {
 		return common.WrapMessageToError(err, "Failed To Load Configuration")
 	}
+
+	for i := range sc.RelayChain.Nodes {
+		sc.RelayChain.Nodes[i].AssignPorts(sc.RelayChain.Nodes[i].Prometheus)
+	}
+
+	for _, parachain := range sc.Para {
+		for i := range parachain.Nodes {
+			sc.RelayChain.Nodes[i].AssignPorts(sc.RelayChain.Nodes[i].Prometheus)
+		}
+	}
+
 	return nil
 }
 
@@ -217,12 +246,37 @@ func (sc *PolkadotServiceConfig) LoadDefaultConfig() error {
 	sc.Explorer = false
 	sc.RelayChain.Name = "rococo-local"
 	sc.RelayChain.Nodes = []NodeConfig{
-		{Name: "bob", NodeType: "full", Prometheus: false},
+		{Name: "bob", NodeType: "validator", Prometheus: false},
 		{Name: "alice", NodeType: "validator", Prometheus: false},
 	}
 
+	for i := range sc.RelayChain.Nodes {
+		sc.RelayChain.Nodes[i].AssignPorts(sc.RelayChain.Nodes[i].Prometheus)
+	}
+
 	sc.Para = []ParaNodeConfig{}
+	return nil
+}
+
+func (nc *NodeConfig) AssignPorts(prometheus bool) error {
+	var rpcPort, lib2libPort, prometheusPort int
+	var err error
+	rpcPort, err = common.GetAvailablePort()
+	if err != nil {
+		return err
+	}
 
+	lib2libPort, err = common.GetAvailablePort()
+	if err != nil {
+		return err
+	}
+	if prometheus {
+		prometheusPort, err = common.GetAvailablePort()
+		if err != nil {
+			return err
+		}
+	}
+	nc.Ports = Ports{RPCPort: rpcPort, Lib2LibPort: lib2libPort, PrometheusPort: prometheusPort}
 	return nil
 }
 
@@ -291,3 +345,114 @@ func (nc *NodeConfig) IsEmpty() error {
 
 	return nil
 }
+
+func (sc *PolkadotServiceConfig) HasPrometheus() bool {
+	// Check relay chain nodes
+	if sc.RelayChain.Name != "" {
+		for _, node := range sc.RelayChain.Nodes {
+			if node.Prometheus {
+				return true
+			}
+		}
+	}
+
+	// Check para nodes
+	for _, paraNode := range sc.Para {
+		for _, node := range paraNode.Nodes {
+			if node.Prometheus {
+				return true
+			}
+		}
+	}
+
+	return false
+}
+
+func (sc *PolkadotServiceConfig) ValidateConfig() error {
+	var validChainTypes = []string{"local", "testnet", "mainnet"}
+	var validRelayNodeType = []string{"validator", "full"}
+	var validParaNodeType = []string{"collator", "full"}
+
+	if !slices.Contains(validChainTypes, sc.ChainType) {
+		return fmt.Errorf("invalid Chain Type: %s", sc.ChainType)
+	}
+
+	if sc.ChainType == "local" && sc.RelayChain.Name != "rococo-local" {
+		return fmt.Errorf("invalid Chain Name for local: %s", sc.RelayChain.Name)
+	}
+
+	if sc.RelayChain.Name != "" {
+		if sc.ChainType == "testnet" && !(sc.RelayChain.Name == "rococo" || sc.RelayChain.Name == "westend") {
+			return fmt.Errorf("invalid Chain Name for testnet: %s", sc.RelayChain.Name)
+		}
+
+		if sc.ChainType == "mainnet" && !(sc.RelayChain.Name == "kusama" || sc.RelayChain.Name == "polkadot") {
+			return fmt.Errorf("invalid Chain Name for mainnet: %s", sc.RelayChain.Name)
+		}
+	}
+
+	if sc.ChainType == "local" {
+		for _, node := range sc.RelayChain.Nodes {
+			if node.NodeType != "validator" {
+				return fmt.Errorf("invalid Node Type for Relay Chain Local: %s", node.NodeType)
+			}
+		}
+	} else {
+		for _, node := range sc.RelayChain.Nodes {
+			if !slices.Contains(validRelayNodeType, node.NodeType) {
+				return fmt.Errorf("invalid Node Type for Relay Chain: %s", node.NodeType)
+			}
+		}
+	}
+
+	for _, paraChain := range sc.Para {
+		for _, node := range paraChain.Nodes {
+			if !slices.Contains(validParaNodeType, node.NodeType) {
+				return fmt.Errorf("invalid Node Type for Para Chain: %s", node.NodeType)
+			}
+		}
+	}
+
+	return nil
+}
+
+func (sc *PolkadotServiceConfig) GetParamsForRelay() (string, error) {
+	relay_nodes, err := sc.RelayChain.EncodeToString()
+	if err != nil {
+		return "", common.WrapMessageToError(common.ErrDataMarshall, err.Error())
+	}
+
+	if sc.ChainType == "local" {
+		return fmt.Sprintf(`{"relaychain": %s}`, relay_nodes), nil
+	} else {
+		return fmt.Sprintf(`{"chain_type": "%s", "relaychain": %s}`, sc.ChainType, relay_nodes), nil
+	}
+}
+
+func (sc *PolkadotServiceConfig) ConfigureMetrics() {
+	for i := range sc.RelayChain.Nodes {
+		sc.RelayChain.Nodes[i].Prometheus = true
+	}
+	if len(sc.Para) != 0 {
+		for i := range sc.Para[0].Nodes {
+			sc.Para[0].Nodes[i].Prometheus = true
+		}
+	}
+}
+
+func (sc *PolkadotServiceConfig) ConfigureFullNodes(network string) {
+
+	if network == "testnet" {
+		sc.RelayChain.Name = "rococo"
+	} else if network == "mainnet" {
+		sc.RelayChain.Name = "kusama"
+	}
+
+	sc.RelayChain.Nodes = []NodeConfig{}
+
+	sc.RelayChain.Nodes = append(sc.RelayChain.Nodes, NodeConfig{
+		Name:       "alice",
+		NodeType:   "full",
+		Prometheus: false,
+	})
+}
diff --git a/cli/common/constants.go b/cli/common/constants.go
@@ -89,6 +89,7 @@ const (
 	EmptyFieldsError
 	MissingFlagsError
 	InvalidFlagError
+	InvalidConfigError
 )
 
 var DiveLogs bool

diff --git a/cli/common/errors.go b/cli/common/errors.go
@@ -38,6 +38,7 @@ var (
 	ErrEmptyFields             = NewBase(EmptyFieldsError, "Missing Fields In The Config File")
 	ErrMissingFlags            = NewBase(MissingFlagsError, "Missing Flags")
 	ErrInvalidFlag             = NewBase(InvalidFlagError, "Invalid Flag Usage")
+	ErrInvalidConfig           = NewBase(InvalidConfigError, "Invalid Config")
 )
 
 func (c ErrorCode) New(msg string) error {

diff --git a/cli/common/types.go b/cli/common/types.go
@@ -5,21 +5,22 @@ import (
 )
 
 type DiveServiceResponse struct {
-	ServiceName        string `json:"service_name,omitempty"`
-	PublicEndpoint     string `json:"endpoint_public,omitempty"`
-	PrivateEndpoint    string `json:"endpoint,omitempty"`
-	KeyPassword        string `json:"keypassword,omitempty"`
-	KeystorePath       string `json:"keystore_path,omitempty"`
-	Network            string `json:"network,omitempty"`
-	NetworkName        string `json:"network_name,omitempty"`
-	NetworkId          string `json:"nid,omitempty"`
-	ChainId            string `json:"chain_id,omitempty"`
-	ChainKey           string `json:"chain_key,omitempty"`
-	PrometheusEndpoint string `json:"endpoint_prometheus,omitempty"`
-	Prometheus         bool   `json:"prometheus,omitempty"`
-	IpAddress          string `json:"ip_address,omitempty"`
-	Node               string `json:"node-type,omitempty"`
-	PrometheusPort     int    `json:"prometheus_port,omitempty"`
+	ServiceName          string `json:"service_name,omitempty"`
+	PublicEndpoint       string `json:"endpoint_public,omitempty"`
+	PrivateEndpoint      string `json:"endpoint,omitempty"`
+	KeyPassword          string `json:"keypassword,omitempty"`
+	KeystorePath         string `json:"keystore_path,omitempty"`
+	Network              string `json:"network,omitempty"`
+	NetworkName          string `json:"network_name,omitempty"`
+	NetworkId            string `json:"nid,omitempty"`
+	ChainId              string `json:"chain_id,omitempty"`
+	ChainKey             string `json:"chain_key,omitempty"`
+	PrometheusEndpoint   string `json:"endpoint_prometheus,omitempty"`
+	Prometheus           bool   `json:"prometheus,omitempty"`
+	IpAddress            string `json:"ip_address,omitempty"`
+	Node                 string `json:"node-type,omitempty"`
+	PrometheusPort       int    `json:"prometheus_port,omitempty"`
+	PrometheusPublicPort int    `json:"prometheus_public_port,omitempty"`
 }
 
 type DiveMultipleServiceResponse struct {
@@ -68,6 +69,29 @@ func (dive *DiveMultipleServiceResponse) EncodeToString() (string, error) {
 	return string(encodedBytes), nil
 }
 
+func (dive *DiveMultipleServiceResponse) ConcatenateDiveResults(result2 *DiveMultipleServiceResponse) *DiveMultipleServiceResponse {
+	result1 := dive
+	if result1 == nil {
+		return result2
+	} else if result2 == nil {
+		return result1
+	}
+
+	concatenatedResult := &DiveMultipleServiceResponse{
+		Dive: make(map[string]*DiveServiceResponse),
+	}
+
+	for key, value := range result1.Dive {
+		concatenatedResult.Dive[key] = value
+	}
+
+	for key, value := range result2.Dive {
+		concatenatedResult.Dive[key] = value
+	}
+
+	return concatenatedResult
+}
+
 type Services map[string]*DiveServiceResponse
 
 type DiveBridgeResponse map[string]interface{}

diff --git a/cli/go.mod b/cli/go.mod
@@ -6,7 +6,7 @@ require (
 	github.com/briandowns/spinner v1.23.0
 	github.com/fatih/color v1.16.0
 	github.com/google/go-github v17.0.0+incompatible
-	github.com/kurtosis-tech/kurtosis/api/golang v0.85.42
+	github.com/kurtosis-tech/kurtosis/api/golang v0.86.2
 	github.com/kurtosis-tech/stacktrace v0.0.0-20211028211901-1c67a77b5409
 	github.com/natefinch/lumberjack v2.0.0+incompatible
 	github.com/sirupsen/logrus v1.9.3