cmd_cmd.go

package main

import (
	"crypto/rand"
	"fmt"
	"os"
	"os/exec"
	"strings"
	"time"

	"github.com/spf13/cobra"

	propagation "github.com/honeycombio/beeline-go/propagation"
	libhoney "github.com/honeycombio/libhoney-go"
)

func commandCmd(cfg *libhoney.Config, filename *string, ciProvider *string) *cobra.Command {
	// CMD eg: buildevents cmd $TRAVIS_BUILD_ID $STAGE_SPAN_ID go-test -- go test github.com/honeycombio/hound/...
	execCmd := &cobra.Command{
		Use:   "cmd [flags] BUILD_ID STEP_ID NAME -- [shell command to execute]",
		Short: "Invoke an individual command that is part of the build.",
		Long: `
The cmd mode invokes an individual command that is part of the build, such as
running DB migrations or running a specific test suite. It must be able to be
expressed as a single shell command - either a process like "go test" or a
shell script. The command to run is the final argument to buildevents and
will be launched via "bash -c" using "exec". The shell can be changed with the
-s/--shell flag.`,
		Args: cobra.MatchAll(
			cobra.MinimumNArgs(4),
			func(cmd *cobra.Command, args []string) error {
				if cmd.ArgsLenAtDash() != 3 {
					return fmt.Errorf("use `--` to signify shell command")
				}
				return nil
			},
		),
		DisableFlagsInUseLine: true,
		RunE: func(cmd *cobra.Command, args []string) error {
			// Don't show usage if RunE returns an error. This set in RunE
			// instead of when we instantiate the cmd so we don't suppress usage
			// for errors from Args.
			cmd.SilenceUsage = true

			traceID := strings.TrimSpace(args[0])
			stepID := strings.TrimSpace(args[1])
			name := strings.TrimSpace(args[2])
			quiet, _ := cmd.Flags().GetBool("quiet")
			shell, _ := cmd.Flags().GetString("shell")

			var quoted []string
			for _, s := range args[3:] {
				quoted = append(quoted, fmt.Sprintf("\"%s\"", strings.Replace(s, "\"", "\\\"", -1)))
			}
			subcmd := strings.Join(quoted, " ")

			ev := createEvent(cfg, *ciProvider, traceID)
			defer ev.Send()

			providerInfo(*ciProvider, ev)

			spanBytes := make([]byte, 16)
			rand.Read(spanBytes)

			start := time.Now()

			// copy out the current set of fields to avoid later modification
			localFields := map[string]interface{}{}
			for k, v := range ev.Fields() {
				localFields[k] = v
			}
			var spanID = fmt.Sprintf("%x", spanBytes)
			prop := &propagation.PropagationContext{
				TraceID:      traceID,
				ParentID:     spanID,
				TraceContext: localFields,
			}
			err := runCommand(subcmd, prop, quiet, shell)
			dur := time.Since(start)

			ev.Add(map[string]interface{}{
				"trace.parent_id": stepID,
				"trace.span_id":   spanID,
				"service_name":    ifClassic(cfg.APIKey, "cmd", cfg.Dataset),
				"service.name":    ifClassic(cfg.APIKey, "cmd", cfg.Dataset),
				"command_name":    "cmd",
				"name":            name,
				"duration_ms":     dur / time.Millisecond,
				"cmd":             subcmd,
				"source":          "buildevents",
			})
			ev.Timestamp = start

			// Annotate with arbitrary fields after the command runs
			// this way we can consume a file if the command itself generated one
			arbitraryFields(*filename, ev)

			if err == nil {
				ev.AddField("status", "success")
			} else {
				ev.Add(map[string]interface{}{
					"error":          true,
					"status":         "failure",
					"failure_reason": err.Error(),
				})
			}

			return err
		},
	}
	var quiet bool
	var shell string
	execCmd.Flags().BoolVarP(&quiet, "quiet", "q", false, "silence non-cmd output")
	execCmd.Flags().StringVarP(&shell, "shell", "s", "/bin/bash", "path of shell executable to use for command, must accept -c as an argument")
	return execCmd
}

func runCommand(subcmd string, prop *propagation.PropagationContext, quiet bool, shell string) error {
	if !quiet {
		fmt.Println("running", shell, "-c", subcmd)
	}
	cmd := exec.Command(shell, "-c", subcmd)

	cmd.Env = append(os.Environ(),
		"HONEYCOMB_TRACE="+propagation.MarshalHoneycombTraceContext(prop),
	)

	cmd.Stdout = os.Stdout
	cmd.Stderr = os.Stderr
	cmd.Stdin = os.Stdin

	return cmd.Run()
}