feat(hooks): add builder hooks api (#69)

Author: Joshua-Anderson

api/builds.go

@@ -18,3 +18,13 @@ type CreateBuildRequest struct {
 	Image    string            `json:"image"`
 	Procfile map[string]string `json:"procfile,omitempty"`
 }
+
+// BuildHookRequest is a hook request to create a new build.
+type BuildHookRequest struct {
+	Sha        string      `json:"sha"`
+	User       string      `json:"receive_user"`
+	App        string      `json:"receive_repo"`
+	Image      string      `json:"image"`
+	Procfile   ProcessType `json:"procfile"`
+	Dockerfile string      `json:"dockerfile"`
+}

api/config.go

@@ -46,6 +46,12 @@ type Config struct {
 	UUID string `json:"uuid,omitempty"`
 }
 
+// ConfigHookRequest defines the request for configuration from the config hook.
+type ConfigHookRequest struct {
+	User string `json:"receive_user"`
+	App  string `json:"receive_repo"`
+}
+
 // Healthcheck is the structure for an application healthcheck.
 // Healthchecks only need to provide information about themselves.
 // All the information is pushed to the server and handled by kubernetes.

api/ps.go

@@ -2,6 +2,12 @@ package api
 
 import "github.com/deis/controller-sdk-go/pkg/time"
 
+// ProcessType represents the key/value mappings of a process type to a process inside
+// a Heroku Procfile.
+//
+// See https://devcenter.heroku.com/articles/procfile
+type ProcessType map[string]string
+
 // Pods defines the structure of a process.
 type Pods struct {
 	Release string    `json:"release"`

api/push.go

@@ -0,0 +1,11 @@
+package api
+
+// PushRequest is used to define the structure of the push hook
+type PushRequest struct {
+	Sha         string `json:"sha"`
+	User        string `json:"receive_user"`
+	App         string `json:"receive_repo"`
+	Fingerprint string `json:"fingerprint"`
+	Connection  string `json:"ssh_connection"`
+	Command     string `json:"ssh_original_command"`
+}

api/users.go

@@ -40,3 +40,9 @@ type Users []User
 func (u Users) Len() int           { return len(u) }
 func (u Users) Swap(i, j int)      { u[i], u[j] = u[j], u[i] }
 func (u Users) Less(i, j int) bool { return u[i].Username < u[j].Username }
+
+// UserApps is a definition of the UserFromKey Hook response.
+type UserApps struct {
+	Username string   `json:"username"`
+	Apps     []string `json:"apps"`
+}

deis.go

@@ -82,6 +82,11 @@ type Client struct {
 
 	// Token is used to authenticate the request against the API.
 	Token string
+
+	// HooksToken is the controller token used with the hooks resource.
+	// The hooks resource isn't intended to be used by users, so it requires
+	// a service token rather than a user token.
+	HooksToken string
 }
 
 // APIVersion is the api version compatible with the SDK.

hooks/hooks.go

@@ -0,0 +1,125 @@
+// Package hooks implements the controller's builder hooks api.
+//
+// This is primarily intended to be consumed by the builder to communicate with the controller.
+package hooks
+
+import (
+	"encoding/json"
+	"fmt"
+	"io"
+	"io/ioutil"
+
+	"github.com/deis/controller-sdk-go"
+	"github.com/deis/controller-sdk-go/api"
+)
+
+// UserFromKey retrives a user from their SSH key fingerprint.
+func UserFromKey(c *deis.Client, fingerprint string) (api.UserApps, error) {
+	res, reqErr := c.Request("GET", fmt.Sprintf("/v2/hooks/key/%s", fingerprint), nil)
+	if reqErr != nil && !deis.IsErrAPIMismatch(reqErr) {
+		return api.UserApps{}, reqErr
+	}
+
+	// Fix json.Decoder bug in <go1.7
+	defer func() {
+		io.Copy(ioutil.Discard, res.Body)
+		res.Body.Close()
+	}()
+
+	resUser := api.UserApps{}
+	if err := json.NewDecoder(res.Body).Decode(&resUser); err != nil {
+		return api.UserApps{}, err
+	}
+
+	return resUser, reqErr
+}
+
+// GetAppConfig retrives an app's configuration from the controller.
+func GetAppConfig(c *deis.Client, username, app string) (api.Config, error) {
+	req := api.ConfigHookRequest{User: username, App: app}
+	b, err := json.Marshal(req)
+	if err != nil {
+		return api.Config{}, err
+	}
+
+	res, reqErr := c.Request("POST", "/v2/hooks/config/", b)
+	if reqErr != nil && !deis.IsErrAPIMismatch(reqErr) {
+		return api.Config{}, reqErr
+	}
+	// Fix json.Decoder bug in <go1.7
+	defer func() {
+		io.Copy(ioutil.Discard, res.Body)
+		res.Body.Close()
+	}()
+
+	config := api.Config{}
+	if err := json.NewDecoder(res.Body).Decode(&config); err != nil {
+		return api.Config{}, err
+	}
+
+	return config, reqErr
+}
+
+// CreateBuild creates a new release of an application. It returns the version of the new release.
+// gitSha should be the first 8 charecters of the git commit sha. Image is either the docker image
+// location for the dockerfile app the absolute url to the tar file for a buldpack app.
+func CreateBuild(c *deis.Client, username, app, image, gitSha string, procfile api.ProcessType,
+	usingDockerifle bool) (int, error) {
+	req := api.BuildHookRequest{
+		Sha:      gitSha,
+		User:     username,
+		App:      app,
+		Image:    image,
+		Procfile: procfile,
+	}
+
+	if usingDockerifle {
+		req.Dockerfile = "true"
+	}
+
+	b, err := json.Marshal(req)
+	if err != nil {
+		return -1, err
+	}
+
+	res, reqErr := c.Request("POST", "/v2/hooks/build/", b)
+	if reqErr != nil && !deis.IsErrAPIMismatch(reqErr) {
+		return -1, reqErr
+	}
+	// Fix json.Decoder bug in <go1.7
+	defer func() {
+		io.Copy(ioutil.Discard, res.Body)
+		res.Body.Close()
+	}()
+
+	resMap := make(map[string]map[string]int)
+	if err := json.NewDecoder(res.Body).Decode(&resMap); err != nil {
+		return -1, err
+	}
+
+	return resMap["release"]["version"], reqErr
+}
+
+// CreatePush creates a new push for an application.
+// gitSha should be the first 8 charecters of the git commit sha.
+func CreatePush(c *deis.Client, username, app, gitSha, fingerprint, conn, cmd string) error {
+	req := api.PushRequest{
+		Sha:         gitSha,
+		User:        username,
+		App:         app,
+		Fingerprint: fingerprint,
+		Connection:  conn,
+		Command:     cmd,
+	}
+
+	b, err := json.Marshal(req)
+	if err != nil {
+		return err
+	}
+
+	res, reqErr := c.Request("POST", "/v2/hooks/push/", b)
+	if reqErr == nil {
+		res.Body.Close()
+	}
+	return reqErr
+}