Add a new flag to add custom labels (#128)

* Rename git module

* Add custom labels

* Update README

Author: ferranbt

README.md

@@ -65,6 +65,7 @@ $ builder-playground cook l1 --latest-fork --output ~/my-builder-testnet --genes
 - `--watchdog` (bool): Enable the watchdog service to monitor the specific chain
 - `--dry-run` (bool): Generates the artifacts and manifest but does not deploy anything (also enabled with the `--mise-en-place` flag)
 - `--log-level` (string): Log level to use (debug, info, warn, error, fatal). Defaults to `info`.
+- `--labels` (key=val): Custom labels to apply to your deployment.
 
 To stop the playground, press `Ctrl+C`.
 

internal/local_runner.go

@@ -74,6 +74,9 @@ type LocalRunner struct {
 
 	// networkName is the name of the network to use for the services
 	networkName string
+
+	// labels is the list of labels to apply to each resource being created
+	labels map[string]string
 }
 
 type task struct {
@@ -104,7 +107,7 @@ func newDockerClient() (*client.Client, error) {
 }
 
 // TODO: add a runner config struct
-func NewLocalRunner(out *output, manifest *Manifest, overrides map[string]string, interactive bool, bindHostPortsLocally bool, networkName string) (*LocalRunner, error) {
+func NewLocalRunner(out *output, manifest *Manifest, overrides map[string]string, interactive bool, bindHostPortsLocally bool, networkName string, labels map[string]string) (*LocalRunner, error) {
 	client, err := newDockerClient()
 	if err != nil {
 		return nil, fmt.Errorf("failed to create docker client: %w", err)
@@ -209,6 +212,7 @@ func NewLocalRunner(out *output, manifest *Manifest, overrides map[string]string
 		sessionID:            uuid.New().String(),
 		networkName:          networkName,
 		instances:            instances,
+		labels:               labels,
 	}
 
 	if interactive {
@@ -594,6 +598,11 @@ func (d *LocalRunner) toDockerComposeService(s *Service) (map[string]interface{}
 		"service":            s.Name,
 	}
 
+	// apply the user defined labels
+	for k, v := range d.labels {
+		labels[k] = v
+	}
+
 	// add the local ports exposed by the service as labels
 	// we have to do this for now since we do not store the manifest in JSON yet.
 	// Otherwise, we could use that directly

internal/utils.go

@@ -3,6 +3,7 @@ package internal
 import (
 	"fmt"
 	"strconv"
+	"strings"
 )
 
 type nullableUint64Value struct {
@@ -37,3 +38,33 @@ func (n nullableUint64Value) Type() string {
 func (n nullableUint64Value) GetNoOptDefVal() string {
 	return "0"
 }
+
+type MapStringFlag map[string]string
+
+func (n *MapStringFlag) String() string {
+	parts := []string{}
+	for k, v := range *n {
+		parts = append(parts, k+"="+v)
+	}
+	return "(" + strings.Join(parts, ",") + ")"
+}
+
+func (n *MapStringFlag) Type() string {
+	return "map(string, string)"
+}
+
+func (n *MapStringFlag) Set(s string) error {
+	parts := strings.Split(s, "=")
+	if len(parts) != 2 {
+		return fmt.Errorf("expected k=v for flag")
+	}
+
+	k := parts[0]
+	v := parts[1]
+
+	if *n == nil {
+		(*n) = map[string]string{}
+	}
+	(*n)[k] = v
+	return nil
+}

main.go

@@ -27,6 +27,7 @@ var logLevelFlag string
 var bindExternal bool
 var withPrometheus bool
 var networkName string
+var labels internal.MapStringFlag
 
 var rootCmd = &cobra.Command{
 	Use:   "playground",
@@ -173,7 +174,7 @@ func main() {
 		recipeCmd.Flags().BoolVar(&bindExternal, "bind-external", false, "bind host ports to external interface")
 		recipeCmd.Flags().BoolVar(&withPrometheus, "with-prometheus", false, "whether to gather the Prometheus metrics")
 		recipeCmd.Flags().StringVar(&networkName, "network", "", "network name")
-
+		recipeCmd.Flags().Var(&labels, "labels", "list of labels to apply to the resources")
 		cookCmd.AddCommand(recipeCmd)
 	}
 
@@ -251,7 +252,7 @@ func runIt(recipe internal.Recipe) error {
 		}
 	}
 
-	dockerRunner, err := internal.NewLocalRunner(artifacts.Out, svcManager, overrides, interactive, !bindExternal, networkName)
+	dockerRunner, err := internal.NewLocalRunner(artifacts.Out, svcManager, overrides, interactive, !bindExternal, networkName, labels)
 	if err != nil {
 		return fmt.Errorf("failed to create docker runner: %w", err)
 	}