feat: Enable event forwarding in CI (#48)

* feat: add CI and APIKey flags to listen command

* feat: Support CI client in listen command

* feat: Add `hookdeck ci` command

* feat: Read HOOKDECK_API_KEY env variable

* feat: Validate api_key in ci command

* feat: Remove CI flag from listen command

* feat: Add CI name flag

* refactor: Improve error handling check

* fix: Remove unused CI & APIKey flag from listen command

* chore: Change "account" to "workspace" to describe CI login command

* docs: Add CI command instruction

Author: alexluong

README.md

@@ -196,6 +196,29 @@ Configure auto-completion for Hookdeck CLI. It is run on install when using Home
 hookdeck completion
 ```
 
+### Running in CI
+
+If you want to use Hookdeck in CI for tests or any other purposes, you can use your HOOKDECK_API_KEY to authenticate and start forwarding events.
+
+```sh-session
+$ hookdeck ci --api-key $HOOKDECK_API_KEY
+Done! The Hookdeck CLI is configured in workspace MyWorkspace
+
+$ hookdeck listen 3000 shopify orders
+
+👉  Inspect and replay webhooks: https://dashboard.hookdeck.com/cli/events
+
+Shopify Source
+🔌 Webhook URL: https://events.hookdeck.com/e/src_DAjaFWyyZXsFdZrTOKpuHnOH
+
+Connections
+Inventory Service forwarding to /webhooks/shopify/inventory
+
+
+⣾ Getting ready...
+
+```
+
 ## Developing
 
 Build from source by running:

pkg/cmd/ci.go

@@ -0,0 +1,41 @@
+package cmd
+
+import (
+	"log"
+	"os"
+
+	"github.com/spf13/cobra"
+
+	"github.com/hookdeck/hookdeck-cli/pkg/login"
+	"github.com/hookdeck/hookdeck-cli/pkg/validators"
+)
+
+type ciCmd struct {
+	cmd    *cobra.Command
+	apiKey string
+	name   string
+}
+
+func newCICmd() *ciCmd {
+	lc := &ciCmd{}
+
+	lc.cmd = &cobra.Command{
+		Use:   "ci",
+		Args:  validators.NoArgs,
+		Short: "Login to your Hookdeck workspace in CI",
+		Long:  `Login to your Hookdeck workspace to forward events in CI`,
+		RunE:  lc.runCICmd,
+	}
+	lc.cmd.Flags().StringVar(&lc.apiKey, "api-key", os.Getenv("HOOKDECK_API_KEY"), "Your API key to use for the command")
+	lc.cmd.Flags().StringVar(&lc.name, "name", "", "Your CI name (ex: $GITHUB_REF)")
+
+	return lc
+}
+
+func (lc *ciCmd) runCICmd(cmd *cobra.Command, args []string) error {
+	err := validators.APIKey(lc.apiKey)
+	if err != nil {
+		log.Fatal(err)
+	}
+	return login.CILogin(&Config, lc.apiKey, lc.name)
+}

pkg/cmd/root.go

@@ -104,6 +104,7 @@ func init() {
 
 	rootCmd.Flags().BoolP("version", "v", false, "Get the version of the Hookdeck CLI")
 
+	rootCmd.AddCommand(newCICmd().cmd)
 	rootCmd.AddCommand(newLoginCmd().cmd)
 	rootCmd.AddCommand(newLogoutCmd().cmd)
 	rootCmd.AddCommand(newListenCmd().cmd)

pkg/hookdeck/ci.go

@@ -0,0 +1,40 @@
+package hookdeck
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"net/http"
+)
+
+type CIClient struct {
+	Claimed  bool   `json:"claimed"`
+	UserID   string `json:"user_id"`
+	UserName string `json:"user_name"`
+	TeamID   string `json:"team_id"`
+	TeamName string `json:"team_name"`
+	TeamMode string `json:"team_mode"`
+	APIKey   string `json:"key"`
+	ClientID string `json:"client_id"`
+}
+
+type CreateCIClientInput struct {
+	DeviceName string `json:"device_name"`
+}
+
+func (c *Client) CreateCIClient(input CreateCIClientInput) (CIClient, error) {
+	input_bytes, err := json.Marshal(input)
+	if err != nil {
+		return CIClient{}, err
+	}
+	res, err := c.Post(context.Background(), "/cli-auth/ci", input_bytes, nil)
+	if err != nil {
+		return CIClient{}, err
+	}
+	if res.StatusCode != http.StatusOK {
+		return CIClient{}, fmt.Errorf("unexpected http status code: %d %s", res.StatusCode, err)
+	}
+	ciClient := CIClient{}
+	postprocessJsonResponse(res, &ciClient)
+	return ciClient, nil
+}

pkg/login/client_login.go

@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"io"
 	"io/ioutil"
+	"log"
 	"net/http"
 	"net/url"
 	"os"
@@ -155,6 +156,49 @@ func GuestLogin(config *config.Config) (string, error) {
 	return guest_user.Url, nil
 }
 
+func CILogin(config *config.Config, apiKey string, name string) error {
+	parsedBaseURL, err := url.Parse(config.APIBaseURL)
+	if err != nil {
+		return err
+	}
+
+	client := &hookdeck.Client{
+		BaseURL: parsedBaseURL,
+		APIKey: apiKey,
+	}
+
+	deviceName := name
+	if deviceName == "" {
+		deviceName = config.Profile.DeviceName
+	}
+	response, err := client.CreateCIClient(hookdeck.CreateCIClientInput{
+		DeviceName: deviceName,
+	})
+	if err != nil {
+		return err
+	}
+
+	if err := validators.APIKey(response.APIKey); err != nil {
+		return err
+	}
+
+	config.Profile.APIKey = response.APIKey
+	config.Profile.ClientID = response.ClientID
+	config.Profile.DisplayName = response.UserName
+	config.Profile.TeamName = response.TeamName
+	config.Profile.TeamMode = response.TeamMode
+	config.Profile.TeamID = response.TeamID
+
+	if err := config.Profile.CreateProfile(); err != nil {
+		return err
+	}
+
+	message := SuccessMessage(response.UserName, response.TeamName, response.TeamMode == "console")
+	log.Println(message)
+
+	return nil
+}
+
 func getLinks(baseURL string, deviceName string) (*Links, error) {
 	parsedBaseURL, err := url.Parse(baseURL)
 	if err != nil {

pkg/login/login_message.go

@@ -16,6 +16,14 @@ func SuccessMessage(displayName string, teamName string, isConsole bool) string
 			"Done! The Hookdeck CLI is configured with your console Sandbox",
 		)
 	}
+
+	if displayName == "" {
+		return fmt.Sprintf(
+			"Done! The Hookdeck CLI is configured in workspace %s\n",
+			color.Bold(teamName),
+		)
+	}
+
 	return fmt.Sprintf(
 		"Done! The Hookdeck CLI is configured for %s in workspace %s\n",
 		color.Bold(displayName),