Add option on put to delete previous comments (#120)

* Add option on put to delete previous comments

* Refactor github import in e2e tests

Author: rcoy-v

.gitignore

@@ -3,3 +3,6 @@ build/*
 
 # Taskfile
 .task
+
+# Editor
+.idea/

README.md

@@ -117,6 +117,7 @@ empty commit to the PR*.
 | `target_url`        | No       | `$ATC_DEFAULT_URL/builds/$BUILD_ID` | The target URL for the status, where users are sent when clicking details (defaults to the Concourse build page). |
 | `description`       | No       | `Concourse CI build failed`         | The description status on the specified pull request.                                                             |
 | `description_file`  | No       | `my-output/description.txt`         | Path to file containing the description status to add to the pull request                                         |
+| `delete_previous_comments` | No       | `true`         |  Boolean. Previous comments made on the pull request by this resource will be deleted before making the new comment. Useful for removing outdated information. |
 
 Note that `comment`, `comment_file` and `target_url` will all expand environment variables, so in the examples above `$ATC_DEFAULT_URL` will be replaced by the public URL of the Concourse ATCs.
 See https://concourse-ci.org/implementing-resource-types.html#resource-metadata for more details about metadata that is available via environment variables.

e2e/e2e_test.go

@@ -3,15 +3,19 @@
 package e2e_test
 
 import (
+	"context"
+	"fmt"
+	"github.com/google/go-github/github"
+	"github.com/stretchr/testify/assert"
 	"io/ioutil"
 	"os"
 	"os/exec"
 	"path/filepath"
+	"strconv"
 	"strings"
 	"testing"
 	"time"
 
-	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	resource "github.com/telia-oss/github-pr-resource"
 )
@@ -172,11 +176,11 @@ func TestCheckE2E(t *testing.T) {
 
 	for _, tc := range tests {
 		t.Run(tc.description, func(t *testing.T) {
-			github, err := resource.NewGithubClient(&tc.source)
+			githubClient, err := resource.NewGithubClient(&tc.source)
 			require.NoError(t, err)
 
 			input := resource.CheckRequest{Source: tc.source, Version: tc.version}
-			output, err := resource.Check(input, github)
+			output, err := resource.Check(input, githubClient)
 
 			if assert.NoError(t, err) {
 				assert.Equal(t, tc.expected, output)
@@ -380,15 +384,15 @@ func TestGetAndPutE2E(t *testing.T) {
 			require.NoError(t, err)
 			defer os.RemoveAll(dir)
 
-			github, err := resource.NewGithubClient(&tc.source)
+			githubClient, err := resource.NewGithubClient(&tc.source)
 			require.NoError(t, err)
 
 			git, err := resource.NewGitClient(&tc.source, dir, ioutil.Discard)
 			require.NoError(t, err)
 
 			// Get (output and files)
 			getRequest := resource.GetRequest{Source: tc.source, Version: tc.version, Params: tc.getParameters}
-			getOutput, err := resource.Get(getRequest, github, git, dir)
+			getOutput, err := resource.Get(getRequest, githubClient, git, dir)
 
 			require.NoError(t, err)
 			assert.Equal(t, tc.version, getOutput.Version)
@@ -423,14 +427,139 @@ func TestGetAndPutE2E(t *testing.T) {
 
 			// Put
 			putRequest := resource.PutRequest{Source: tc.source, Params: tc.putParameters}
-			putOutput, err := resource.Put(putRequest, github, dir)
+			putOutput, err := resource.Put(putRequest, githubClient, dir)
 
 			require.NoError(t, err)
 			assert.Equal(t, tc.version, putOutput.Version)
 		})
 	}
 }
 
+func TestPutCommentsE2E(t *testing.T) {
+	owner := "rcoy-v"
+	repo := "github-pr-resource-e2e"
+
+	tests := []struct {
+		description, branch                string
+		source                             resource.Source
+		getParams                          resource.GetParameters
+		putParameters                      resource.PutParameters
+		previousComments, expectedComments []string
+	}{
+		{
+			description: "delete previous comments removes old comments and makes new one",
+			branch:      "delete-previous-comments-remove-old-add-new",
+			source: resource.Source{
+				Repository:  fmt.Sprintf("%s/%s", owner, repo),
+				V3Endpoint:  "https://api.github.com/",
+				V4Endpoint:  "https://api.github.com/graphql",
+				AccessToken: os.Getenv("GITHUB_ACCESS_TOKEN"),
+			},
+			getParams: resource.GetParameters{},
+			putParameters: resource.PutParameters{
+				Comment:                "new comment",
+				DeletePreviousComments: true,
+			},
+			previousComments: []string{"old comment"},
+			expectedComments: []string{
+				"new comment",
+			},
+		},
+		{
+			description: "delete previous comments removes all comments when no new comment",
+			branch:      "delete-previous-comments-remove-old",
+			source: resource.Source{
+				Repository:  fmt.Sprintf("%s/%s", owner, repo),
+				V3Endpoint:  "https://api.github.com/",
+				V4Endpoint:  "https://api.github.com/graphql",
+				AccessToken: os.Getenv("GITHUB_ACCESS_TOKEN"),
+			},
+			getParams: resource.GetParameters{},
+			putParameters: resource.PutParameters{
+				DeletePreviousComments: true,
+			},
+			previousComments: []string{"old comment"},
+			expectedComments: []string{},
+		},
+		{
+			description: "delete previous comments should not delete comments when false",
+			branch:      "delete-previous-comments-false",
+			source: resource.Source{
+				Repository:  fmt.Sprintf("%s/%s", owner, repo),
+				V3Endpoint:  "https://api.github.com/",
+				V4Endpoint:  "https://api.github.com/graphql",
+				AccessToken: os.Getenv("GITHUB_ACCESS_TOKEN"),
+			},
+			getParams: resource.GetParameters{},
+			putParameters: resource.PutParameters{
+				Comment:                "new comment",
+				DeletePreviousComments: false,
+			},
+			previousComments: []string{"should not delete"},
+			expectedComments: []string{
+				"should not delete",
+				"new comment",
+			},
+		},
+	}
+
+	for _, tc := range tests {
+		t.Run(tc.description, func(t *testing.T) {
+			dir, err := ioutil.TempDir("", "github-pr-resource")
+			require.NoError(t, err)
+			defer os.RemoveAll(dir)
+
+			githubClient, err := resource.NewGithubClient(&tc.source)
+			require.NoError(t, err)
+
+			git, err := resource.NewGitClient(&tc.source, dir, ioutil.Discard)
+			require.NoError(t, err)
+
+			pullRequest, _, err := githubClient.V3.PullRequests.Create(context.TODO(), owner, repo, &github.NewPullRequest{
+				Title: github.String(tc.description),
+				Base:  github.String("master"),
+				Head:  github.String(fmt.Sprintf("%s:%s", owner, tc.branch)),
+			})
+			require.NoError(t, err)
+
+			for _, comment := range tc.previousComments {
+				_, _, err = githubClient.V3.Issues.CreateComment(context.TODO(), owner, repo, pullRequest.GetNumber(), &github.IssueComment{
+					Body: github.String(comment),
+				})
+				require.NoError(t, err)
+			}
+
+			getRequest := resource.GetRequest{Source: tc.source, Version: resource.Version{
+				PR:     strconv.Itoa(pullRequest.GetNumber()),
+				Commit: pullRequest.GetHead().GetSHA(),
+			}, Params: tc.getParams}
+			_, err = resource.Get(getRequest, githubClient, git, dir)
+			require.NoError(t, err)
+
+			putRequest := resource.PutRequest{
+				Source: tc.source,
+				Params: tc.putParameters,
+			}
+
+			_, err = resource.Put(putRequest, githubClient, dir)
+			require.NoError(t, err)
+
+			comments, _, err := githubClient.V3.Issues.ListComments(context.TODO(), owner, repo, pullRequest.GetNumber(), nil)
+			require.NoError(t, err)
+
+			require.Len(t, comments, len(tc.expectedComments))
+			for index, comment := range comments {
+				require.Equal(t, tc.expectedComments[index], comment.GetBody())
+			}
+
+			_, _, err = githubClient.V3.PullRequests.Edit(context.TODO(), owner, repo, pullRequest.GetNumber(), &github.PullRequest{
+				State: github.String("closed"),
+			})
+			require.NoError(t, err)
+		})
+	}
+}
+
 func gitHistory(t *testing.T, directory string) map[int]string {
 	cmd := exec.Command("git", "log", "--oneline", "--pretty=format:%s")
 	cmd.Dir = directory

fakes/fake_github.go

@@ -26,6 +26,7 @@ type Github interface {
 	GetPullRequest(string, string) (*PullRequest, error)
 	GetChangedFiles(string, string) ([]ChangedFileObject, error)
 	UpdateCommitStatus(string, string, string, string, string, string) error
+	DeletePreviousComments(string) error
 }
 
 // GithubClient for handling requests to the Github V3 and V4 APIs.
@@ -355,6 +356,56 @@ func (m *GithubClient) UpdateCommitStatus(commitRef, baseContext, statusContext,
 	return err
 }
 
+func (m *GithubClient) DeletePreviousComments(prNumber string) error {
+	pr, err := strconv.Atoi(prNumber)
+	if err != nil {
+		return fmt.Errorf("failed to convert pull request number to int: %s", err)
+	}
+
+	var getComments struct {
+		Viewer struct {
+			Login string
+		}
+		Repository struct {
+			PullRequest struct {
+				Id       string
+				Comments struct {
+					Edges []struct {
+						Node struct {
+							DatabaseId int64
+							Author     struct {
+								Login string
+							}
+						}
+					}
+				} `graphql:"comments(last:$commentsLast)"`
+			} `graphql:"pullRequest(number:$prNumber)"`
+		} `graphql:"repository(owner:$repositoryOwner,name:$repositoryName)"`
+	}
+
+	vars := map[string]interface{}{
+		"repositoryOwner": githubv4.String(m.Owner),
+		"repositoryName":  githubv4.String(m.Repository),
+		"prNumber":        githubv4.Int(pr),
+		"commentsLast":    githubv4.Int(100),
+	}
+
+	if err := m.V4.Query(context.TODO(), &getComments, vars); err != nil {
+		return err
+	}
+
+	for _, e := range getComments.Repository.PullRequest.Comments.Edges {
+		if e.Node.Author.Login == getComments.Viewer.Login {
+			_, err := m.V3.Issues.DeleteComment(context.TODO(), m.Owner, m.Repository, e.Node.DatabaseId)
+			if err != nil {
+				return err
+			}
+		}
+	}
+
+	return nil
+}
+
 func parseRepository(s string) (string, string, error) {
 	parts := strings.Split(s, "/")
 	if len(parts) != 2 {