Commands to list services and output logs (#257)

Related to #236

Author: canercidam

README.md

@@ -126,6 +126,17 @@ docker logs -f $(docker ps | grep contender | cut -d' ' -f1)
 
 To stop the playground, press `Ctrl+C`.
 
+## Logs
+
+```bash
+$ builder-playground list
+mev-boost-relay
+beacon
+el
+validator
+$ builder-playground logs validator
+```
+
 ## Inspect
 
 Builder-playground supports inspecting the connection of a service to a specific port.

main.go

@@ -105,6 +105,34 @@ var inspectCmd = &cobra.Command{
 	},
 }
 
+var logsCmd = &cobra.Command{
+	Use:   "logs",
+	Short: "Show logs for a service",
+	RunE: func(cmd *cobra.Command, args []string) error {
+		// one argument, the name of the service
+		if len(args) != 1 {
+			return fmt.Errorf("please specify a service name")
+		}
+		serviceName := args[0]
+
+		ctx := mainctx.Get()
+		cmd.SilenceUsage = true
+		if err := playground.Logs(ctx, serviceName); err != nil && !strings.Contains(err.Error(), "signal") {
+			return fmt.Errorf("failed to show logs: %w", err)
+		}
+		return nil
+	},
+}
+
+var listCmd = &cobra.Command{
+	Use:   "list",
+	Short: "List all running services",
+	RunE: func(cmd *cobra.Command, args []string) error {
+		ctx := mainctx.Get()
+		return playground.List(ctx)
+	},
+}
+
 var versionCmd = &cobra.Command{
 	Use:   "version",
 	Short: "Print the version",
@@ -158,6 +186,8 @@ func main() {
 
 	rootCmd.AddCommand(startCmd)
 	rootCmd.AddCommand(inspectCmd)
+	rootCmd.AddCommand(logsCmd)
+	rootCmd.AddCommand(listCmd)
 	rootCmd.AddCommand(versionCmd)
 
 	rootCmd.AddCommand(stopCmd)

playground/cmd_list.go

@@ -0,0 +1,32 @@
+package playground
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/docker/docker/api/types/container"
+)
+
+func List(ctx context.Context) error {
+	client, err := newDockerClient()
+	if err != nil {
+		return fmt.Errorf("failed to create docker client: %w", err)
+	}
+
+	// TODO: Filter by session ID when we introduce multiple sessions soon.
+	containers, err := client.ContainerList(ctx, container.ListOptions{
+		All: true,
+	})
+	if err != nil {
+		return fmt.Errorf("error getting container list: %w", err)
+	}
+
+	for _, container := range containers {
+		if container.Labels["playground"] != "true" {
+			continue
+		}
+		fmt.Println(container.Labels["com.docker.compose.service"])
+	}
+
+	return nil
+}

playground/cmd_logs.go

@@ -0,0 +1,37 @@
+package playground
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"os/exec"
+
+	"github.com/docker/docker/api/types/container"
+)
+
+func Logs(ctx context.Context, serviceName string) error {
+	client, err := newDockerClient()
+	if err != nil {
+		return fmt.Errorf("failed to create docker client: %w", err)
+	}
+
+	// TODO: Filter by session ID when we introduce multiple sessions soon.
+	containers, err := client.ContainerList(ctx, container.ListOptions{
+		All: true,
+	})
+	if err != nil {
+		return fmt.Errorf("error getting container list: %w", err)
+	}
+
+	for _, container := range containers {
+		if container.Labels["playground"] == "true" &&
+			container.Labels["com.docker.compose.service"] == serviceName {
+			cmd := exec.CommandContext(ctx, "docker", "logs", "-f", "--tail", "50", container.ID)
+			cmd.Stdout = os.Stdout
+			cmd.Stderr = os.Stderr
+			return cmd.Run()
+		}
+	}
+
+	return fmt.Errorf("no container found for service %s", serviceName)
+}