simplify configuration of nodeset and components

Author: skudasov

framework/clclient/client.go

@@ -33,15 +33,15 @@ func main() {
 			{
 				Name:    "config",
 				Aliases: []string{"c"},
-				Usage:   "Shapes your test config, removes outputs",
+				Usage:   "Shapes your test config, removes outputs, formatting ,etc",
 				Subcommands: []*cli.Command{
 					{
-						Name:    "cleanup",
-						Aliases: []string{"c"},
-						Usage:   "Clean up the outputs of any test configuration",
+						Name:    "fmt",
+						Aliases: []string{"f"},
+						Usage:   "Formats TOML config",
 						Action: func(c *cli.Context) error {
 							in := c.Args().Get(0)
-							return CleanupToml(in, in)
+							return PrettyPrintTOML(in, in)
 						},
 					},
 				},
@@ -210,8 +210,8 @@ func observabilityDown() error {
 	return nil
 }
 
-// CleanupToml removes any paths in the TOML tree that contain "out" and writes the result to a new file.
-func CleanupToml(inputFile string, outputFile string) error {
+// PrettyPrintTOML pretty prints TOML
+func PrettyPrintTOML(inputFile string, outputFile string) error {
 	tomlData, err := os.ReadFile(inputFile)
 	if err != nil {
 		return fmt.Errorf("error reading file: %v", err)
@@ -221,9 +221,6 @@ func CleanupToml(inputFile string, outputFile string) error {
 		return fmt.Errorf("error parsing TOML: %v", err)
 	}
 
-	// Recursively remove fields/paths that contain "out"
-	removeOutFields(tree)
-
 	// Write the result to a new file
 	dumpData, err := tree.ToTomlString()
 	if err != nil {
@@ -237,43 +234,3 @@ func CleanupToml(inputFile string, outputFile string) error {
 	framework.L.Info().Str("File", outputFile).Msg("File cleaned up and saved")
 	return nil
 }
-
-// removeOutFields recursively removes any table, array of tables, or key path containing "out"
-func removeOutFields(tree *toml.Tree) {
-	keys := tree.Keys()
-
-	for _, key := range keys {
-		value := tree.Get(key)
-
-		// If the key contains framework.OutputFieldNameTOML, delete the whole path
-		if hasOutputField(key) {
-			_ = tree.Delete(key)
-			continue
-		}
-
-		switch v := value.(type) {
-		// Handle regular tables recursively
-		case *toml.Tree:
-			removeOutFields(v)
-			if len(v.Keys()) == 0 {
-				_ = tree.Delete(key)
-			}
-		// Handle arrays of tables
-		case []*toml.Tree:
-			for i := len(v) - 1; i >= 0; i-- {
-				removeOutFields(v[i])
-				if len(v[i].Keys()) == 0 {
-					v = append(v[:i], v[i+1:]...)
-				}
-			}
-			if len(v) == 0 {
-				_ = tree.Delete(key)
-			}
-		}
-	}
-}
-
-func hasOutputField(key string) bool {
-	return len(key) > 0 && (key == framework.OutputFieldNameTOML ||
-		len(key) > 3 && key[len(key)-3:] == framework.OutputFieldNameTOML)
-}

framework/cmd/main.go

@@ -24,7 +24,7 @@ func deployAnvil(in *Input) (*Output, error) {
 
 	req := testcontainers.ContainerRequest{
 		AlwaysPullImage: in.PullImage,
-		Image:           fmt.Sprintf("%s:%s", in.Image, in.Tag),
+		Image:           fmt.Sprintf("%s", in.Image),
 		Labels:          framework.DefaultTCLabels(),
 		Name:            containerName,
 		ExposedPorts:    []string{bindPort},

framework/components/blockchain/anvil.go

@@ -8,10 +8,9 @@ import (
 type Input struct {
 	Type                     string   `toml:"type" validate:"required,oneof=anvil geth" envconfig:"net_type"`
 	Image                    string   `toml:"image" validate:"required"`
-	Tag                      string   `toml:"tag" validate:"required"`
-	PullImage                bool     `toml:"pull_image" default:"true"`
-	Port                     string   `toml:"port" validate:"required" default:"8545"`
-	ChainID                  string   `toml:"chain_id" validate:"required" default:"31337"`
+	PullImage                bool     `toml:"pull_image"`
+	Port                     string   `toml:"port" validate:"required"`
+	ChainID                  string   `toml:"chain_id" validate:"required"`
 	DockerCmdParamsOverrides []string `toml:"docker_cmd_params"`
 	Out                      *Output  `toml:"out"`
 }
@@ -35,7 +34,7 @@ type Node struct {
 // - Anvil
 // - Geth
 func NewBlockchainNetwork(in *Input) (*Output, error) {
-	if in.Out.UseCache {
+	if in.Out != nil && in.Out.UseCache {
 		return in.Out, nil
 	}
 	var out *Output

framework/components/blockchain/blockchain.go

@@ -15,24 +15,28 @@ import (
 	"time"
 )
 
+const (
+	Port    = "6688"
+	P2PPort = "6690"
+)
+
 // Input represents Chainlink node input
 type Input struct {
-	DataProviderURL string          `toml:"data_provider_url" validate:"required" default:"http://host.docker.internal:9111"`
+	DataProviderURL string          `toml:"data_provider_url" validate:"required"`
 	DbInput         *postgres.Input `toml:"db" validate:"required"`
 	Node            *NodeInput      `toml:"node" validate:"required"`
 	Out             *Output         `toml:"out"`
 }
 
 // NodeInput is CL nod container inputs
 type NodeInput struct {
-	Image                   string   `toml:"image" validate:"required"`
-	Tag                     string   `toml:"tag" validate:"required"`
-	Name                    string   `toml:"name"`
-	PullImage               bool     `toml:"pull_image" default:"true"`
-	Port                    string   `toml:"port" validate:"required" default:"6688"`
-	P2PPort                 string   `toml:"p2p_port" validate:"required" default:"6690"`
+	Image     string `toml:"image" validate:"required"`
+	Name      string `toml:"name"`
+	PullImage bool   `toml:"pull_image"`
+	//Port                    string   `toml:"port" validate:"required"`
+	//P2PPort                 string   `toml:"p2p_port" validate:"required"`
 	CapabilitiesBinaryPaths []string `toml:"capabilities"`
-	CapabilityContainerDir  string   `toml:"capabilities_container_dir" default:"/home/capabilities"`
+	CapabilityContainerDir  string   `toml:"capabilities_container_dir"`
 	TestConfigOverrides     string   `toml:"test_config_overrides"`
 	UserConfigOverrides     string   `toml:"user_config_overrides"`
 	TestSecretsOverrides    string   `toml:"test_secrets_overrides"`
@@ -130,8 +134,8 @@ func newNode(in *Input, pgOut *postgres.Output) (*NodeOut, error) {
 		return nil, err
 	}
 
-	httpPort := fmt.Sprintf("%s/tcp", in.Node.Port)
-	p2pPort := fmt.Sprintf("%s/udp", in.Node.P2PPort)
+	httpPort := fmt.Sprintf("%s/tcp", Port)
+	p2pPort := fmt.Sprintf("%s/udp", P2PPort)
 	var containerName string
 	if in.Node.Name != "" {
 		containerName = in.Node.Name
@@ -141,7 +145,7 @@ func newNode(in *Input, pgOut *postgres.Output) (*NodeOut, error) {
 
 	req := tc.ContainerRequest{
 		AlwaysPullImage: in.Node.PullImage,
-		Image:           fmt.Sprintf("%s:%s", in.Node.Image, in.Node.Tag),
+		Image:           fmt.Sprintf("%s", in.Node.Image),
 		Name:            containerName,
 		Labels:          framework.DefaultTCLabels(),
 		Networks:        []string{framework.DefaultNetworkName},
@@ -230,8 +234,8 @@ func newNode(in *Input, pgOut *postgres.Output) (*NodeOut, error) {
 	return &NodeOut{
 		HostURL:      fmt.Sprintf("http://%s:%s", host, mp.Port()),
 		HostP2PURL:   fmt.Sprintf("http://%s:%s", host, mpP2P.Port()),
-		DockerURL:    fmt.Sprintf("http://%s:%s", containerName, in.Node.Port),
-		DockerP2PUrl: fmt.Sprintf("http://%s:%s", containerName, in.Node.P2PPort),
+		DockerURL:    fmt.Sprintf("http://%s:%s", containerName, Port),
+		DockerP2PUrl: fmt.Sprintf("http://%s:%s", containerName, P2PPort),
 	}, nil
 }
 
@@ -242,7 +246,7 @@ type DefaultCLNodeConfig struct {
 
 func generateDefaultConfig(in *Input) (string, error) {
 	config := DefaultCLNodeConfig{
-		HTTPPort:      in.Node.Port,
+		HTTPPort:      Port,
 		SecureCookies: false,
 	}
 	tmpl, err := template.New("toml").Parse(defaultConfigTmpl)

framework/components/clnode/clnode.go

@@ -12,15 +12,17 @@ import (
 	"time"
 )
 
+const (
+	User      = "chainlink"
+	Password  = "thispasswordislongenough"
+	Port      = "5432"
+	Database  = "chainlink"
+	Databases = 20
+)
+
 type Input struct {
-	Image     string  `toml:"image" validate:"required" default:"postgres"`
-	Tag       string  `toml:"tag" validate:"required" default:"15.6"`
-	PullImage bool    `toml:"pull_image" default:"true"`
-	User      string  `toml:"user" validate:"required" default:"chainlink"`
-	Password  string  `toml:"password" validate:"required" default:"thispasswordislongenough"`
-	Database  string  `toml:"database" validate:"required" default:"chainlink"`
-	Databases int     `toml:"databases" validate:"required" default:"20"`
-	Port      string  `toml:"port" validate:"required" default:"5432"`
+	Image     string  `toml:"image" validate:"required"`
+	PullImage bool    `toml:"pull_image"`
 	Out       *Output `toml:"out"`
 }
 
@@ -32,12 +34,12 @@ type Output struct {
 func NewPostgreSQL(in *Input) (*Output, error) {
 	ctx := context.Background()
 
-	bindPort := fmt.Sprintf("%s/tcp", in.Port)
+	bindPort := fmt.Sprintf("%s/tcp", Port)
 
 	containerName := framework.DefaultTCName("postgresql")
 
 	var sqlCommands []string
-	for i := 0; i <= in.Databases; i++ {
+	for i := 0; i <= Databases; i++ {
 		sqlCommands = append(sqlCommands, fmt.Sprintf("CREATE DATABASE db_%d;", i))
 	}
 	sqlCommands = append(sqlCommands, "ALTER USER chainlink WITH SUPERUSER;")
@@ -55,7 +57,7 @@ func NewPostgreSQL(in *Input) (*Output, error) {
 
 	req := testcontainers.ContainerRequest{
 		AlwaysPullImage: in.PullImage,
-		Image:           fmt.Sprintf("%s:%s", in.Image, in.Tag),
+		Image:           fmt.Sprintf("%s", in.Image),
 		Name:            containerName,
 		Labels:          framework.DefaultTCLabels(),
 		ExposedPorts:    []string{bindPort},
@@ -64,12 +66,12 @@ func NewPostgreSQL(in *Input) (*Output, error) {
 			framework.DefaultNetworkName: {containerName},
 		},
 		Env: map[string]string{
-			"POSTGRES_USER":     in.User,
-			"POSTGRES_PASSWORD": in.Password,
-			"POSTGRES_DB":       in.Database,
+			"POSTGRES_USER":     User,
+			"POSTGRES_PASSWORD": Password,
+			"POSTGRES_DB":       Database,
 		},
 		Cmd: []string{
-			"postgres", "-c", fmt.Sprintf("port=%s", in.Port),
+			"postgres", "-c", fmt.Sprintf("port=%s", Port),
 		},
 		Files: []testcontainers.ContainerFile{
 			{
@@ -79,7 +81,7 @@ func NewPostgreSQL(in *Input) (*Output, error) {
 			},
 		},
 		WaitingFor: tcwait.ForExec([]string{"psql", "-h", "127.0.0.1",
-			"-U", in.User, "-p", in.Port, "-c", "select", "1", "-d", in.Database}).
+			"-U", User, "-p", Port, "-c", "select", "1", "-d", Database}).
 			WithStartupTimeout(20 * time.Second),
 	}
 	c, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{
@@ -100,19 +102,19 @@ func NewPostgreSQL(in *Input) (*Output, error) {
 	return &Output{
 		DockerInternalURL: fmt.Sprintf(
 			"postgresql://%s:%s@%s:%s/%s?sslmode=disable",
-			in.User,
-			in.Password,
+			User,
+			Password,
 			containerName,
-			in.Port,
-			in.Database,
+			Port,
+			Database,
 		),
 		Url: fmt.Sprintf(
 			"postgresql://%s:%s@%s:%s/%s?sslmode=disable",
-			in.User,
-			in.Password,
+			User,
+			Password,
 			host,
 			mp.Port(),
-			in.Database,
+			Database,
 		),
 	}, nil
 }