mirror of
https://github.com/go-gitea/gitea.git
synced 2024-12-18 11:03:04 +01:00
7db2f110ad
* Add API to get issue/pull comments and events (timeline) Adds an API to get both comments and events in one endpoint with all required data. Closes go-gitea/gitea#13250 * Fix swagger * Don't show code comments (use review api instead) * fmt * Fix comment * Time -> TrackedTime * Use var directly * Add logger * Fix lint * Fix test * Add comments * fmt * [test] get issue directly by ID * Update test * Add description for changed refs * Fix build issues + lint * Fix build * Use string enums * Update swagger * Support `page` and `limit` params * fmt + swagger * Use global slices Co-authored-by: zeripath <art27@cantab.net> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
205 lines
8.4 KiB
Go
205 lines
8.4 KiB
Go
// Copyright 2017 The Gitea Authors. All rights reserved.
|
|
// Use of this source code is governed by a MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package integrations
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"net/url"
|
|
"testing"
|
|
|
|
"code.gitea.io/gitea/models"
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
|
"code.gitea.io/gitea/models/unittest"
|
|
user_model "code.gitea.io/gitea/models/user"
|
|
"code.gitea.io/gitea/modules/convert"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestAPIListRepoComments(t *testing.T) {
|
|
defer prepareTestEnv(t)()
|
|
|
|
comment := unittest.AssertExistsAndLoadBean(t, &models.Comment{},
|
|
unittest.Cond("type = ?", models.CommentTypeComment)).(*models.Comment)
|
|
issue := unittest.AssertExistsAndLoadBean(t, &models.Issue{ID: comment.IssueID}).(*models.Issue)
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: issue.RepoID}).(*repo_model.Repository)
|
|
repoOwner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID}).(*user_model.User)
|
|
|
|
session := loginUser(t, repoOwner.Name)
|
|
link, _ := url.Parse(fmt.Sprintf("/api/v1/repos/%s/%s/issues/comments", repoOwner.Name, repo.Name))
|
|
req := NewRequest(t, "GET", link.String())
|
|
resp := session.MakeRequest(t, req, http.StatusOK)
|
|
|
|
var apiComments []*api.Comment
|
|
DecodeJSON(t, resp, &apiComments)
|
|
assert.Len(t, apiComments, 2)
|
|
for _, apiComment := range apiComments {
|
|
c := &models.Comment{ID: apiComment.ID}
|
|
unittest.AssertExistsAndLoadBean(t, c,
|
|
unittest.Cond("type = ?", models.CommentTypeComment))
|
|
unittest.AssertExistsAndLoadBean(t, &models.Issue{ID: c.IssueID, RepoID: repo.ID})
|
|
}
|
|
|
|
//test before and since filters
|
|
query := url.Values{}
|
|
before := "2000-01-01T00:00:11+00:00" //unix: 946684811
|
|
since := "2000-01-01T00:00:12+00:00" //unix: 946684812
|
|
query.Add("before", before)
|
|
link.RawQuery = query.Encode()
|
|
req = NewRequest(t, "GET", link.String())
|
|
resp = session.MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, resp, &apiComments)
|
|
assert.Len(t, apiComments, 1)
|
|
assert.EqualValues(t, 2, apiComments[0].ID)
|
|
|
|
query.Del("before")
|
|
query.Add("since", since)
|
|
link.RawQuery = query.Encode()
|
|
req = NewRequest(t, "GET", link.String())
|
|
resp = session.MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, resp, &apiComments)
|
|
assert.Len(t, apiComments, 1)
|
|
assert.EqualValues(t, 3, apiComments[0].ID)
|
|
}
|
|
|
|
func TestAPIListIssueComments(t *testing.T) {
|
|
defer prepareTestEnv(t)()
|
|
|
|
comment := unittest.AssertExistsAndLoadBean(t, &models.Comment{},
|
|
unittest.Cond("type = ?", models.CommentTypeComment)).(*models.Comment)
|
|
issue := unittest.AssertExistsAndLoadBean(t, &models.Issue{ID: comment.IssueID}).(*models.Issue)
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: issue.RepoID}).(*repo_model.Repository)
|
|
repoOwner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID}).(*user_model.User)
|
|
|
|
session := loginUser(t, repoOwner.Name)
|
|
req := NewRequestf(t, "GET", "/api/v1/repos/%s/%s/issues/%d/comments",
|
|
repoOwner.Name, repo.Name, issue.Index)
|
|
resp := session.MakeRequest(t, req, http.StatusOK)
|
|
|
|
var comments []*api.Comment
|
|
DecodeJSON(t, resp, &comments)
|
|
expectedCount := unittest.GetCount(t, &models.Comment{IssueID: issue.ID},
|
|
unittest.Cond("type = ?", models.CommentTypeComment))
|
|
assert.EqualValues(t, expectedCount, len(comments))
|
|
}
|
|
|
|
func TestAPICreateComment(t *testing.T) {
|
|
defer prepareTestEnv(t)()
|
|
const commentBody = "Comment body"
|
|
|
|
issue := unittest.AssertExistsAndLoadBean(t, &models.Issue{}).(*models.Issue)
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: issue.RepoID}).(*repo_model.Repository)
|
|
repoOwner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID}).(*user_model.User)
|
|
|
|
session := loginUser(t, repoOwner.Name)
|
|
token := getTokenForLoggedInUser(t, session)
|
|
urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/issues/%d/comments?token=%s",
|
|
repoOwner.Name, repo.Name, issue.Index, token)
|
|
req := NewRequestWithValues(t, "POST", urlStr, map[string]string{
|
|
"body": commentBody,
|
|
})
|
|
resp := session.MakeRequest(t, req, http.StatusCreated)
|
|
|
|
var updatedComment api.Comment
|
|
DecodeJSON(t, resp, &updatedComment)
|
|
assert.EqualValues(t, commentBody, updatedComment.Body)
|
|
unittest.AssertExistsAndLoadBean(t, &models.Comment{ID: updatedComment.ID, IssueID: issue.ID, Content: commentBody})
|
|
}
|
|
|
|
func TestAPIGetComment(t *testing.T) {
|
|
defer prepareTestEnv(t)()
|
|
|
|
comment := unittest.AssertExistsAndLoadBean(t, &models.Comment{ID: 2}).(*models.Comment)
|
|
assert.NoError(t, comment.LoadIssue())
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: comment.Issue.RepoID}).(*repo_model.Repository)
|
|
repoOwner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID}).(*user_model.User)
|
|
|
|
session := loginUser(t, repoOwner.Name)
|
|
token := getTokenForLoggedInUser(t, session)
|
|
req := NewRequestf(t, "GET", "/api/v1/repos/%s/%s/issues/comments/%d", repoOwner.Name, repo.Name, comment.ID)
|
|
session.MakeRequest(t, req, http.StatusOK)
|
|
req = NewRequestf(t, "GET", "/api/v1/repos/%s/%s/issues/comments/%d?token=%s", repoOwner.Name, repo.Name, comment.ID, token)
|
|
resp := session.MakeRequest(t, req, http.StatusOK)
|
|
|
|
var apiComment api.Comment
|
|
DecodeJSON(t, resp, &apiComment)
|
|
|
|
assert.NoError(t, comment.LoadPoster())
|
|
expect := convert.ToComment(comment)
|
|
|
|
assert.Equal(t, expect.ID, apiComment.ID)
|
|
assert.Equal(t, expect.Poster.FullName, apiComment.Poster.FullName)
|
|
assert.Equal(t, expect.Body, apiComment.Body)
|
|
assert.Equal(t, expect.Created.Unix(), apiComment.Created.Unix())
|
|
}
|
|
|
|
func TestAPIEditComment(t *testing.T) {
|
|
defer prepareTestEnv(t)()
|
|
const newCommentBody = "This is the new comment body"
|
|
|
|
comment := unittest.AssertExistsAndLoadBean(t, &models.Comment{},
|
|
unittest.Cond("type = ?", models.CommentTypeComment)).(*models.Comment)
|
|
issue := unittest.AssertExistsAndLoadBean(t, &models.Issue{ID: comment.IssueID}).(*models.Issue)
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: issue.RepoID}).(*repo_model.Repository)
|
|
repoOwner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID}).(*user_model.User)
|
|
|
|
session := loginUser(t, repoOwner.Name)
|
|
token := getTokenForLoggedInUser(t, session)
|
|
urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/issues/comments/%d?token=%s",
|
|
repoOwner.Name, repo.Name, comment.ID, token)
|
|
req := NewRequestWithValues(t, "PATCH", urlStr, map[string]string{
|
|
"body": newCommentBody,
|
|
})
|
|
resp := session.MakeRequest(t, req, http.StatusOK)
|
|
|
|
var updatedComment api.Comment
|
|
DecodeJSON(t, resp, &updatedComment)
|
|
assert.EqualValues(t, comment.ID, updatedComment.ID)
|
|
assert.EqualValues(t, newCommentBody, updatedComment.Body)
|
|
unittest.AssertExistsAndLoadBean(t, &models.Comment{ID: comment.ID, IssueID: issue.ID, Content: newCommentBody})
|
|
}
|
|
|
|
func TestAPIDeleteComment(t *testing.T) {
|
|
defer prepareTestEnv(t)()
|
|
|
|
comment := unittest.AssertExistsAndLoadBean(t, &models.Comment{},
|
|
unittest.Cond("type = ?", models.CommentTypeComment)).(*models.Comment)
|
|
issue := unittest.AssertExistsAndLoadBean(t, &models.Issue{ID: comment.IssueID}).(*models.Issue)
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: issue.RepoID}).(*repo_model.Repository)
|
|
repoOwner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID}).(*user_model.User)
|
|
|
|
session := loginUser(t, repoOwner.Name)
|
|
token := getTokenForLoggedInUser(t, session)
|
|
req := NewRequestf(t, "DELETE", "/api/v1/repos/%s/%s/issues/comments/%d?token=%s",
|
|
repoOwner.Name, repo.Name, comment.ID, token)
|
|
session.MakeRequest(t, req, http.StatusNoContent)
|
|
|
|
unittest.AssertNotExistsBean(t, &models.Comment{ID: comment.ID})
|
|
}
|
|
|
|
func TestAPIListIssueTimeline(t *testing.T) {
|
|
defer prepareTestEnv(t)()
|
|
|
|
// load comment
|
|
issue := unittest.AssertExistsAndLoadBean(t, &models.Issue{ID: 1}).(*models.Issue)
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: issue.RepoID}).(*repo_model.Repository)
|
|
repoOwner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID}).(*user_model.User)
|
|
|
|
// make request
|
|
session := loginUser(t, repoOwner.Name)
|
|
req := NewRequestf(t, "GET", "/api/v1/repos/%s/%s/issues/%d/timeline",
|
|
repoOwner.Name, repo.Name, issue.Index)
|
|
resp := session.MakeRequest(t, req, http.StatusOK)
|
|
|
|
// check if lens of list returned by API and
|
|
// lists extracted directly from DB are the same
|
|
var comments []*api.TimelineComment
|
|
DecodeJSON(t, resp, &comments)
|
|
expectedCount := unittest.GetCount(t, &models.Comment{IssueID: issue.ID})
|
|
assert.EqualValues(t, expectedCount, len(comments))
|
|
}
|