support for github deployment API

Author: bradrydzewski

scm/driver/github/github.go

@@ -34,7 +34,7 @@ func New(uri string) (*scm.Client, error) {
 	client.Issues = &issueService{client}
 	client.Organizations = &organizationService{client}
 	client.PullRequests = &pullService{&issueService{client}}
-	client.Repositories = &repositoryService{client}
+	client.Repositories = &RepositoryService{client}
 	client.Reviews = &reviewService{client}
 	client.Users = &userService{client}
 	client.Webhooks = &webhookService{client}

scm/driver/github/repo.go

@@ -49,60 +49,62 @@ type hook struct {
 	} `json:"config"`
 }
 
-type repositoryService struct {
+// RepositoryService implements the repository service for
+// the GitHub driver.
+type RepositoryService struct {
 	client *wrapper
 }
 
 // Find returns the repository by name.
-func (s *repositoryService) Find(ctx context.Context, repo string) (*scm.Repository, *scm.Response, error) {
+func (s *RepositoryService) Find(ctx context.Context, repo string) (*scm.Repository, *scm.Response, error) {
 	path := fmt.Sprintf("repos/%s", repo)
 	out := new(repository)
 	res, err := s.client.do(ctx, "GET", path, nil, out)
 	return convertRepository(out), res, err
 }
 
 // FindHook returns a repository hook.
-func (s *repositoryService) FindHook(ctx context.Context, repo string, id string) (*scm.Hook, *scm.Response, error) {
+func (s *RepositoryService) FindHook(ctx context.Context, repo string, id string) (*scm.Hook, *scm.Response, error) {
 	path := fmt.Sprintf("repos/%s/hooks/%s", repo, id)
 	out := new(hook)
 	res, err := s.client.do(ctx, "GET", path, nil, out)
 	return convertHook(out), res, err
 }
 
 // FindPerms returns the repository permissions.
-func (s *repositoryService) FindPerms(ctx context.Context, repo string) (*scm.Perm, *scm.Response, error) {
+func (s *RepositoryService) FindPerms(ctx context.Context, repo string) (*scm.Perm, *scm.Response, error) {
 	path := fmt.Sprintf("repos/%s", repo)
 	out := new(repository)
 	res, err := s.client.do(ctx, "GET", path, nil, out)
 	return convertRepository(out).Perm, res, err
 }
 
 // List returns the user repository list.
-func (s *repositoryService) List(ctx context.Context, opts scm.ListOptions) ([]*scm.Repository, *scm.Response, error) {
+func (s *RepositoryService) List(ctx context.Context, opts scm.ListOptions) ([]*scm.Repository, *scm.Response, error) {
 	path := fmt.Sprintf("user/repos?%s", encodeListOptions(opts))
 	out := []*repository{}
 	res, err := s.client.do(ctx, "GET", path, nil, &out)
 	return convertRepositoryList(out), res, err
 }
 
 // ListHooks returns a list or repository hooks.
-func (s *repositoryService) ListHooks(ctx context.Context, repo string, opts scm.ListOptions) ([]*scm.Hook, *scm.Response, error) {
+func (s *RepositoryService) ListHooks(ctx context.Context, repo string, opts scm.ListOptions) ([]*scm.Hook, *scm.Response, error) {
 	path := fmt.Sprintf("repos/%s/hooks?%s", repo, encodeListOptions(opts))
 	out := []*hook{}
 	res, err := s.client.do(ctx, "GET", path, nil, &out)
 	return convertHookList(out), res, err
 }
 
 // ListStatus returns a list of commit statuses.
-func (s *repositoryService) ListStatus(ctx context.Context, repo, ref string, opts scm.ListOptions) ([]*scm.Status, *scm.Response, error) {
+func (s *RepositoryService) ListStatus(ctx context.Context, repo, ref string, opts scm.ListOptions) ([]*scm.Status, *scm.Response, error) {
 	path := fmt.Sprintf("repos/%s/statuses/%s?%s", repo, ref, encodeListOptions(opts))
 	out := []*status{}
 	res, err := s.client.do(ctx, "GET", path, nil, &out)
 	return convertStatusList(out), res, err
 }
 
 // CreateHook creates a new repository webhook.
-func (s *repositoryService) CreateHook(ctx context.Context, repo string, input *scm.HookInput) (*scm.Hook, *scm.Response, error) {
+func (s *RepositoryService) CreateHook(ctx context.Context, repo string, input *scm.HookInput) (*scm.Hook, *scm.Response, error) {
 	path := fmt.Sprintf("repos/%s/hooks", repo)
 	in := new(hook)
 	in.Active = true
@@ -120,7 +122,7 @@ func (s *repositoryService) CreateHook(ctx context.Context, repo string, input *
 }
 
 // CreateStatus creates a new commit status.
-func (s *repositoryService) CreateStatus(ctx context.Context, repo, ref string, input *scm.StatusInput) (*scm.Status, *scm.Response, error) {
+func (s *RepositoryService) CreateStatus(ctx context.Context, repo, ref string, input *scm.StatusInput) (*scm.Status, *scm.Response, error) {
 	path := fmt.Sprintf("repos/%s/statuses/%s", repo, ref)
 	in := &status{
 		State:       convertFromState(input.State),
@@ -133,8 +135,23 @@ func (s *repositoryService) CreateStatus(ctx context.Context, repo, ref string,
 	return convertStatus(out), res, err
 }
 
+// CreateDeployStatus creates a new deployment status.
+func (s *RepositoryService) CreateDeployStatus(ctx context.Context, repo string, input *scm.DeployStatus) (*scm.DeployStatus, *scm.Response, error) {
+	path := fmt.Sprintf("repos/%s/deployments/%d/statuses", repo, input.Number)
+	in := &deployStatus{
+		State:          convertFromState(input.State),
+		Environment:    input.Environment,
+		EnvironmentURL: input.EnvironmentURL,
+		Description:    input.Desc,
+		TargetURL:      input.Target,
+	}
+	out := new(deployStatus)
+	res, err := s.client.do(ctx, "POST", path, in, out)
+	return convertDeployStatus(out), res, err
+}
+
 // DeleteHook deletes a repository webhook.
-func (s *repositoryService) DeleteHook(ctx context.Context, repo string, id string) (*scm.Response, error) {
+func (s *RepositoryService) DeleteHook(ctx context.Context, repo string, id string) (*scm.Response, error) {
 	path := fmt.Sprintf("repos/%s/hooks/%s", repo, id)
 	return s.client.do(ctx, "DELETE", path, nil, nil)
 }
@@ -224,6 +241,15 @@ type status struct {
 	Context     string    `json:"context"`
 }
 
+type deployStatus struct {
+	ID             int    `json:"id"`
+	Environment    string `json:"environment"`
+	EnvironmentURL string `json:"environment_url"`
+	State          string `json:"state"`
+	TargetURL      string `json:"log_url"`
+	Description    string `json:"description"`
+}
+
 func convertStatusList(from []*status) []*scm.Status {
 	to := []*scm.Status{}
 	for _, v := range from {
@@ -241,6 +267,17 @@ func convertStatus(from *status) *scm.Status {
 	}
 }
 
+func convertDeployStatus(from *deployStatus) *scm.DeployStatus {
+	return &scm.DeployStatus{
+		Number:         from.ID,
+		State:          convertState(from.State),
+		Desc:           from.Description,
+		Target:         from.TargetURL,
+		Environment:    from.Environment,
+		EnvironmentURL: from.EnvironmentURL,
+	}
+}
+
 func convertState(from string) scm.State {
 	switch from {
 	case "error":

scm/driver/github/repo_test.go

@@ -201,6 +201,45 @@ func TestStatusCreate(t *testing.T) {
 	t.Run("Rate", testRate(res))
 }
 
+func TestDeployStatusCreate(t *testing.T) {
+	defer gock.Off()
+
+	gock.New("https://api.github.com").
+		Post("/repos/octocat/hello-world/deployments/1/status").
+		Reply(201).
+		Type("application/json").
+		SetHeaders(mockHeaders).
+		File("testdata/deployment.json")
+
+	in := &scm.DeployStatus{
+		Number:         1,
+		Desc:           "Build has completed successfully",
+		State:          scm.StateSuccess,
+		Target:         "https://ci.example.com/1000/output",
+		Environment:    "production",
+		EnvironmentURL: "https://example.netlify.com",
+	}
+
+	client := NewDefault()
+	got, res, err := client.Repositories.(*RepositoryService).CreateDeployStatus(context.Background(), "octocat/hello-world", in)
+	if err != nil {
+		t.Error(err)
+		return
+	}
+
+	want := new(scm.DeployStatus)
+	raw, _ := ioutil.ReadFile("testdata/deployment.json.golden")
+	json.Unmarshal(raw, want)
+
+	if diff := cmp.Diff(got, want); diff != "" {
+		t.Errorf("Unexpected Results")
+		t.Log(diff)
+	}
+
+	t.Run("Request", testRequest(res))
+	t.Run("Rate", testRate(res))
+}
+
 func TestRepositoryHookFind(t *testing.T) {
 	defer gock.Off()
 

scm/driver/github/testdata/deployment.json

@@ -0,0 +1,35 @@
+{
+    "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1",
+    "id": 1,
+    "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMx",
+    "state": "success",
+    "creator": {
+        "login": "octocat",
+        "id": 1,
+        "node_id": "MDQ6VXNlcjE=",
+        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+        "gravatar_id": "",
+        "url": "https://api.github.com/users/octocat",
+        "html_url": "https://github.com/octocat",
+        "followers_url": "https://api.github.com/users/octocat/followers",
+        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+        "organizations_url": "https://api.github.com/users/octocat/orgs",
+        "repos_url": "https://api.github.com/users/octocat/repos",
+        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+        "received_events_url": "https://api.github.com/users/octocat/received_events",
+        "type": "User",
+        "site_admin": false
+    },
+    "description": "Deployment finished successfully.",
+    "environment": "production",
+    "target_url": "https://example.com/deployment/42/output",
+    "created_at": "2012-07-20T01:19:13Z",
+    "updated_at": "2012-07-20T01:19:13Z",
+    "deployment_url": "https://api.github.com/repos/octocat/example/deployments/42",
+    "repository_url": "https://api.github.com/repos/octocat/example",
+    "environment_url": "",
+    "log_url": "https://example.com/deployment/42/output"
+}

scm/driver/github/testdata/deployment.json.golden

@@ -0,0 +1,8 @@
+{
+    "Number": 1,
+    "State": 3,
+    "Environment": "production",
+    "EnvironmentURL": "",
+    "Desc": "Deployment finished successfully.",
+    "Target": "https://example.com/deployment/42/output"
+}

scm/repo.go

@@ -87,6 +87,16 @@ type (
 		Target string
 	}
 
+	// DeployStatus represents a deployment status.
+	DeployStatus struct {
+		Number         int
+		State          State
+		Desc           string
+		Target         string
+		Environment    string
+		EnvironmentURL string
+	}
+
 	// RepositoryService provides access to repository resources.
 	RepositoryService interface {
 		// Find returns a repository by name.