feature: RunTrigger gRPC endpoint for Waypoint Server

.changelog/2840.txt

@@ -0,0 +1,6 @@
+```release-note:feature
+core: Introduce RunTriggers to Waypoint Server and CLI. Triggers can be configured
+ahead of time to execute lifecycle operations on demand through the Waypoint API.
+Currently, only the gRPC API is supported, but in the future an HTTP endpoint
+will be added to be used within CI.
+```

internal/cli/trigger_apply.go

@@ -3,6 +3,7 @@ package cli
 import (
  "strings"
 
+ "github.com/golang/protobuf/ptypes/empty"
  "github.com/posener/complete"
 
  "github.com/hashicorp/waypoint-plugin-sdk/terminal"
@@ -26,11 +27,11 @@ type TriggerApplyCommand struct {
  flagTriggerNoAuth bool
 
  // Operation options
- flagArtifactSeq int
- flagBuildSeq int
- flagDeploySeq int
- flagReleaseSeq int
- flagDisablePush bool
+ flagBuildSeq  int
+ flagDeploySeq  int
+ flagDisablePush  bool
+ flagStatusReportDeploy bool
+ flagStatusReportRelease bool
 
  // Release options
  flagReleasePrune bool
@@ -39,7 +40,7 @@ type TriggerApplyCommand struct {
 
 // Current supported trigger operation names.
 var triggerOpValues = []string{"build", "push", "deploy", "destroy-workspace",
- "destroy-deployment", "release", "up", "init"}
+ "destroy-deployment", "release", "up", "init", "status-report-deploy", "status-report-release"}
 
 func (c *TriggerApplyCommand) Run(args []string) int {
  // Initialize. If we fail, we just exit since Init handles the UI.
@@ -94,17 +95,22 @@ func (c *TriggerApplyCommand) Run(args []string) int {
  }
 
  // Trigger target
- if diffTrigger.Workspace != nil {
+ if diffTrigger.Workspace != nil && c.flagWorkspace == "" {
  c.flagWorkspace = diffTrigger.Workspace.Workspace
  }
- if diffTrigger.Project != nil {
+ if diffTrigger.Project != nil && c.flagProject == "" {
  c.flagProject = diffTrigger.Project.Project
  }
- if diffTrigger.Application != nil {
+ if diffTrigger.Application != nil && c.flagApp == "" {
  c.flagApp = diffTrigger.Application.Application
  }
  }
 
+ // NOTE(briancain): there's probably a better way to set default workspace now
+ if c.flagWorkspace == "" {
+ c.flagWorkspace = "default"
+ }
+
  createTrigger := &pb.Trigger{
  Name: c.flagTriggerName,
  Description: c.flagTriggerDescription,
@@ -152,27 +158,33 @@ func (c *TriggerApplyCommand) Run(args []string) int {
  },
  }
  case c.flagTriggerOperation == "deploy":
- // TODO/FUTURE NOTE: If no sequence number is specified (i.e. seq 0), the backend should default to using the "latest" artifact instead
+ var artifact *pb.PushedArtifact
+ if c.flagBuildSeq != 0 {
+ artifact = &pb.PushedArtifact{
+ Application: &pb.Ref_Application{
+ Application: c.flagApp,
+ Project: c.flagProject,
+ },
+ Sequence: uint64(c.flagBuildSeq),
+ Workspace: &pb.Ref_Workspace{
+ Workspace: c.flagWorkspace,
+ },
+ }
+ }
 
+ // NOTE: nil artifact means "latest", the server will look up the latest in the DB and set it there
  createTrigger.Operation = &pb.Trigger_Deploy{
  Deploy: &pb.Job_DeployOp{
- Artifact: &pb.PushedArtifact{
- Sequence: uint64(c.flagBuildSeq),
- Workspace: &pb.Ref_Workspace{
- Workspace: c.flagWorkspace,
- },
- Application: &pb.Ref_Application{
- Application: c.flagApp,
- Project: c.flagProject,
- },
- },
+ Artifact: artifact,
  },
  }
  case c.flagTriggerOperation == "destroy-workspace":
  // NOTE(briancain): I don't think this operation actually works, takes no arguments...
  createTrigger.Operation = &pb.Trigger_Destroy{
  Destroy: &pb.Job_DestroyOp{
- Target: &pb.Job_DestroyOp_Workspace{},
+ Target: &pb.Job_DestroyOp_Workspace{
+ Workspace: &empty.Empty{},
+ },
  },
  }
  case c.flagTriggerOperation == "destroy-deployment":
@@ -235,9 +247,44 @@ func (c *TriggerApplyCommand) Run(args []string) int {
  createTrigger.Operation = &pb.Trigger_Init{
  Init: &pb.Job_InitOp{},
  }
+ case c.flagTriggerOperation == "status-report-deploy":
+ createTrigger.Operation = &pb.Trigger_StatusReport{
+ StatusReport: &pb.Job_StatusReportOp{
+ Target: &pb.Job_StatusReportOp_Deployment{
+ Deployment: &pb.Deployment{
+ Sequence: uint64(c.flagDeploySeq),
+ Workspace: &pb.Ref_Workspace{
+ Workspace: c.flagWorkspace,
+ },
+ Application: &pb.Ref_Application{
+ Application: c.flagApp,
+ Project: c.flagProject,
+ },
+ },
+ },
+ },
+ }
+ case c.flagTriggerOperation == "status-report-release":
+ createTrigger.Operation = &pb.Trigger_StatusReport{
+ StatusReport: &pb.Job_StatusReportOp{
+ Target: &pb.Job_StatusReportOp_Release{
+ Release: &pb.Release{
+ Sequence: uint64(c.flagDeploySeq),
+ Workspace: &pb.Ref_Workspace{
+ Workspace: c.flagWorkspace,
+ },
+ Application: &pb.Ref_Application{
+ Application: c.flagApp,
+ Project: c.flagProject,
+ },
+ },
+ },
+ },
+ }
  case c.flagTriggerOperation == "":
  if diffTrigger == nil {
- c.ui.Output("Empty operation type requested. Must be one of the following values:\n%s\n\n%s",
+ c.ui.Output("Empty operation type requested. Operation must be set with "+
+ "'-op' and be one of the following values:\n%s\n\n%s",
  strings.Join(triggerOpValues[:], ", "), c.Help(), terminal.WithErrorStyle())
  return 1
  } else {
@@ -267,7 +314,7 @@ func (c *TriggerApplyCommand) Run(args []string) int {
  c.ui.Output("Trigger %q (%s) has been %s", resp.Trigger.Name, resp.Trigger.Id,
  action, terminal.WithSuccessStyle())
 
- c.ui.Output(" Trigger ID: %s", resp.Trigger.Id, terminal.WithSuccessStyle())
+ c.ui.Output("Trigger ID: %s", resp.Trigger.Id, terminal.WithSuccessStyle())
  // TODO(briancain): update output to show trigger URL with wp server attached once http service is implemented
  //c.ui.Output("Trigger URL: %s", resp.TriggerURL, terminal.WithSuccessStyle())
 
@@ -321,12 +368,6 @@ func (c *TriggerApplyCommand) Flags() *flag.Sets {
 
  // Operation specific flags
  fo := set.NewSet("Operation Options")
- fo.IntVar(&flag.IntVar{
- Name: "artifact-id",
- Target: &c.flagArtifactSeq,
- Usage: "The sequence number (short id) for the artifact to use in an operation.",
- })
-
  fo.BoolVar(&flag.BoolVar{
  Name: "disable-push",
  Target: &c.flagDisablePush,
@@ -337,19 +378,13 @@ func (c *TriggerApplyCommand) Flags() *flag.Sets {
  fo.IntVar(&flag.IntVar{
  Name: "build-id",
  Target: &c.flagBuildSeq,
- Usage: "The sequence number (short id) for the build to use in an operation.",
+ Usage: "The sequence number (short id) for the build to use for a deployment operation.",
  })
 
  fo.IntVar(&flag.IntVar{
  Name: "deployment-id",
  Target: &c.flagDeploySeq,
- Usage: "The sequence number (short id) for the deployment to use in an operation.",
- })
-
- fo.IntVar(&flag.IntVar{
- Name: "release-id",
- Target: &c.flagReleaseSeq,
- Usage: "The sequence number (short id) for the release to use in an operation.",
+ Usage: "The sequence number (short id) for the deployment to use for a deployment operation.",
  })
 
  // Release operation specific flags

internal/cli/trigger_inspect.go

@@ -4,6 +4,7 @@ import (
  "fmt"
  "strings"
 
+ "github.com/dustin/go-humanize"
  "github.com/golang/protobuf/jsonpb"
  "github.com/posener/complete"
  "google.golang.org/grpc/codes"
@@ -33,11 +34,12 @@ func (c *TriggerInspectCommand) Run(args []string) int {
  return 1
  }
 
- if len(c.args) == 0 && c.flagTriggerId == "" {
+ if len(c.args) == 0 {
  c.ui.Output("Trigger ID required.\n\n%s", c.Help(), terminal.WithErrorStyle())
  return 1
+ } else {
+ c.flagTriggerId = c.args[0]
  }
- c.flagTriggerId = c.args[0]
 
  ctx := c.Ctx
 
@@ -48,7 +50,7 @@ func (c *TriggerInspectCommand) Run(args []string) int {
  })
  if err != nil {
  if status.Code(err) == codes.NotFound {
- c.ui.Output("Trigger configuration not found", clierrors.Humanize(err),
+ c.ui.Output("Trigger configuration not found: %s", clierrors.Humanize(err),
  terminal.WithErrorStyle())
  return 1
  }
@@ -86,26 +88,33 @@ func (c *TriggerInspectCommand) Run(args []string) int {
  var opStr string
  switch triggerOpType := trigger.Operation.(type) {
  case *pb.Trigger_Build:
- opStr = "build operation"
+ opStr = "build"
  case *pb.Trigger_Push:
- opStr = "push operation"
+ opStr = "push"
  case *pb.Trigger_Deploy:
- opStr = "deploy operation"
+ opStr = "deploy"
  case *pb.Trigger_Destroy:
  switch triggerOpType.Destroy.Target.(type) {
  case *pb.Job_DestroyOp_Workspace:
- opStr = "destroy workspace operation"
+ opStr = "destroy workspace"
  case *pb.Job_DestroyOp_Deployment:
- opStr = "destroy deployment operation"
+ opStr = "destroy deployment"
  default:
  opStr = "unknown destroy operation target"
  }
  case *pb.Trigger_Release:
- opStr = "release operation"
+ opStr = "release"
  case *pb.Trigger_Up:
- opStr = "up operation"
+ opStr = "up"
  case *pb.Trigger_Init:
- opStr = "init operation"
+ opStr = "init"
+ case *pb.Trigger_StatusReport:
+ switch triggerOpType.StatusReport.Target.(type) {
+ case *pb.Job_StatusReportOp_Deployment:
+ opStr = "status report deployment"
+ case *pb.Job_StatusReportOp_Release:
+ opStr = "status report release"
+ }
  default:
  opStr = fmt.Sprintf("unknown operation: %T", triggerOpType)
  }
@@ -115,6 +124,11 @@ func (c *TriggerInspectCommand) Run(args []string) int {
  tags = strings.Join(trigger.Tags[:], ", ")
  }
 
+ lastActiveTime := "n/a"
+ if trigger.ActiveTime.IsValid() {
+ lastActiveTime = humanize.Time(trigger.ActiveTime.AsTime())
+ }
+
  c.ui.Output("Trigger URL config:", terminal.WithHeaderStyle())
  c.ui.NamedValues([]terminal.NamedValue{
  {
@@ -124,7 +138,7 @@ func (c *TriggerInspectCommand) Run(args []string) int {
  Name: "ID", Value: trigger.Id,
  },
  {
- Name: "Last Time Active", Value: trigger.ActiveTime.String(),
+ Name: "Last Time Active", Value: lastActiveTime,
  },
  {
  Name: "Authenticated", Value: trigger.Authenticated,
@@ -156,12 +170,6 @@ func (c *TriggerInspectCommand) Flags() *flag.Sets {
  return c.flagSet(flagSetOperation, func(set *flag.Sets) {
  f := set.NewSet("Command Options")
 
- f.StringVar(&flag.StringVar{
- Name: "id",
- Target: &c.flagTriggerId,
- Usage: "The id of the trigger URL to inspect.",
- })
-
  f.BoolVar(&flag.BoolVar{
  Name: "json",
  Target: &c.flagJson,