Watch workflows after starting them.

Author: chrisgavin

cmd/root.go

@@ -3,10 +3,14 @@ package cmd
 import (
 	"context"
 	"fmt"
+	"os"
+	"os/exec"
+	"strconv"
 
 	"github.com/AlecAivazis/survey/v2"
 	"github.com/chrisgavin/gh-dispatch/internal/dispatcher"
 	"github.com/chrisgavin/gh-dispatch/internal/locator"
+	"github.com/chrisgavin/gh-dispatch/internal/run"
 	"github.com/chrisgavin/gh-dispatch/internal/version"
 	"github.com/cli/go-gh"
 	"github.com/go-git/go-git/v5"
@@ -16,6 +20,7 @@ import (
 )
 
 type rootFlagFields struct {
+	noWatch bool
 }
 
 var rootFlags = rootFlagFields{}
@@ -82,10 +87,37 @@ var rootCmd = &cobra.Command{
 		}
 		reference := head.Name().String()
 
+		log.Info("Dispatching workflow...")
 		err = dispatcher.DispatchWorkflow(currentRepository, reference, workflowName, inputAnswers)
 		if err != nil {
 			return err
 		}
+
+		if !rootFlags.noWatch {
+			log.Info("Waiting for workflow to start...")
+			workflowRun, err := run.LocateRun(currentRepository, reference)
+			if err != nil {
+				return err
+			}
+
+			command := exec.CommandContext(cmd.Context(), "gh", "run", "watch", strconv.FormatInt(workflowRun.ID, 10))
+			command.Stdout = os.Stdout
+			command.Stderr = os.Stderr
+			err = command.Run()
+			if err != nil {
+				return errors.Wrap(err, "Unable to watch workflow progress.")
+			}
+
+			workflowRun, err = run.GetRun(currentRepository, workflowRun.ID)
+			if err != nil {
+				return err
+			}
+			log.Infof("Workflow completed with conclusion %s.", workflowRun.Conclusion)
+			if workflowRun.Conclusion != "success" {
+				os.Exit(1)
+			}
+		}
+
 		return nil
 	},
 }
@@ -102,6 +134,8 @@ func (f *rootFlagFields) Init(cmd *cobra.Command) error {
 }
 
 func Execute(ctx context.Context) error {
+	rootCmd.Flags().BoolVar(&rootFlags.noWatch, "no-watch", false, "Do not wait for the workflow to complete.")
+
 	err := rootFlags.Init(rootCmd)
 	if err != nil {
 		return err

internal/client/client.go

@@ -0,0 +1,15 @@
+package client
+
+import (
+	"github.com/cli/go-gh"
+	"github.com/cli/go-gh/pkg/api"
+	"github.com/pkg/errors"
+)
+
+func NewClient(host string) (api.RESTClient, error) {
+	client, err := gh.RESTClient(&api.ClientOptions{Host: host})
+	if err != nil {
+		return nil, errors.Wrap(err, "Unable to create GitHub client.")
+	}
+	return client, nil
+}

internal/dispatcher/dispatcher.go

@@ -5,16 +5,15 @@ import (
 	"encoding/json"
 	"fmt"
 
-	"github.com/cli/go-gh"
-	"github.com/cli/go-gh/pkg/api"
+	"github.com/chrisgavin/gh-dispatch/internal/client"
 	"github.com/cli/go-gh/pkg/repository"
 	"github.com/pkg/errors"
 )
 
 func DispatchWorkflow(repository repository.Repository, reference string, workflowName string, inputs map[string]interface{}) error {
-	client, err := gh.RESTClient(&api.ClientOptions{Host: repository.Host()})
+	client, err := client.NewClient(repository.Host())
 	if err != nil {
-		return errors.Wrap(err, "Unable to create GitHub client.")
+		return err
 	}
 
 	body := map[string]interface{}{

internal/run/run.go

@@ -0,0 +1,79 @@
+package run
+
+import (
+	"fmt"
+	"net/url"
+	"strings"
+	"time"
+
+	"github.com/chrisgavin/gh-dispatch/internal/client"
+	"github.com/cli/go-gh/pkg/api"
+	"github.com/cli/go-gh/pkg/repository"
+	"github.com/pkg/errors"
+)
+
+type WorkflowRun struct {
+	ID         int64  `json:"id"`
+	Conclusion string `json:"conclusion"`
+}
+
+type WorkflowRuns struct {
+	WorkflowRuns []WorkflowRun `json:"workflow_runs"`
+}
+
+func findRun(client api.RESTClient, repository repository.Repository, reference string, after time.Time, before time.Time) (*WorkflowRun, error) {
+	urlParameters := url.Values{}
+	//urlParameters.Add("actor", "TODO")
+	urlParameters.Add("branch", strings.TrimPrefix(reference, "refs/heads/"))
+	urlParameters.Add("event", "workflow_dispatch")
+	createdRange := fmt.Sprintf("%s..%s", after.Format(time.RFC3339), before.Format(time.RFC3339))
+	urlParameters.Add("created", createdRange)
+
+	workflowRuns := WorkflowRuns{}
+	if err := client.Get(fmt.Sprintf("repos/%s/%s/actions/runs?%s", repository.Owner(), repository.Name(), urlParameters.Encode()), &workflowRuns); err != nil {
+		return nil, errors.Wrap(err, "Unable to get list of recent runs.")
+	}
+
+	for _, run := range workflowRuns.WorkflowRuns {
+		return &run, nil
+	}
+	return nil, nil
+}
+
+func LocateRun(repository repository.Repository, reference string) (*WorkflowRun, error) {
+	client, err := client.NewClient(repository.Host())
+	if err != nil {
+		return nil, err
+	}
+
+	currentTime := time.Now()
+	after := currentTime.Add(-1 * time.Minute)
+	before := currentTime.Add(1 * time.Minute)
+
+	for {
+		run, err := findRun(client, repository, reference, after, before)
+		if err != nil {
+			return nil, err
+		}
+		if run != nil {
+			return run, nil
+		}
+		if time.Now().After(currentTime.Add(1 * time.Minute)) {
+			return nil, errors.New("Workflow did not start within 1 minute.")
+		}
+		time.Sleep(3 * time.Second)
+	}
+}
+
+func GetRun(repository repository.Repository, id int64) (*WorkflowRun, error) {
+	client, err := client.NewClient(repository.Host())
+	if err != nil {
+		return nil, err
+	}
+
+	workflowRun := WorkflowRun{}
+	if err := client.Get(fmt.Sprintf("repos/%s/%s/actions/runs/%d", repository.Owner(), repository.Name(), id), &workflowRun); err != nil {
+		return nil, errors.Wrap(err, "Unable to get workflow run.")
+	}
+	return &workflowRun, nil
+}