mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2025-08-05 09:55:20 +02:00
feat: improve checking if diffs differ (#8451)
This change is very similar to what was done in forgejo/forgejo#7727. When a PR is updated, `checkIfPRContentChanged` is called to check if the diff changed - this is done on a temporary repository. This change improves this checking by doing this operation on the bare repository. The change is split into several commits. The following changes were made (in this exact order) 1. Update the `getTestPatchCtx` function that was introduced in forgejo/forgejo#7727 so it can be used outside the context of conflict checking. This is a simple change by making the caller determine if it can use a bare repository or not. 2. Do a small refactor of `ValidatePullRequest` to avoid indentation hell in this function, this is purely a refactor but necessary to not blow my brain while working on this function. 3. The first enhancement, introduce `testPatchCtx` in `ValidatePullRequest` to get diverging commits via the bare repository. 4. The main enhancement, do a refactor to move the function to be part of the repository struct and do a rename as this fits as a general purpose function. This refactoring includes it no longer being specific to a temporary repository and works on a bare repository. 5. Add extensive units tests, integration tests are added in forgejo/forgejo#8450 it checks that both calls to `CheckIfDiffDiffers` work. Because it also fixes a bug I sent it as a different PR. 6. Extend the integration test to check for diffs with commits from different repositories, to demonstrate that `getTestPatchCtx` works (specifically the `env` variable). Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/8451 Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org> Co-authored-by: Gusted <postmaster@gusted.xyz> Co-committed-by: Gusted <postmaster@gusted.xyz>
This commit is contained in:
Gusted
Gusted
parent
09c9108a35
commit
772bb20875
6 changed files with 725 additions and 181 deletions
|
|
@ -784,47 +784,66 @@ func TestPullRequestStaleReview(t *testing.T) {
|
|||
)
|
||||
defer f()
|
||||
|
||||
// Clone it.
|
||||
dstPath := t.TempDir()
|
||||
r := fmt.Sprintf("%suser2/%s.git", u.String(), repo.Name)
|
||||
cloneURL, _ := url.Parse(r)
|
||||
cloneURL.User = url.UserPassword("user2", userPassword)
|
||||
require.NoError(t, git.CloneWithArgs(t.Context(), nil, cloneURL.String(), dstPath, git.CloneRepoOptions{}))
|
||||
clone := func(t *testing.T, clone string) string {
|
||||
t.Helper()
|
||||
|
||||
// Create first commit.
|
||||
require.NoError(t, os.WriteFile(path.Join(dstPath, "README.md"), []byte("## test content"), 0o600))
|
||||
require.NoError(t, git.AddChanges(dstPath, true))
|
||||
require.NoError(t, git.CommitChanges(dstPath, git.CommitChangesOptions{
|
||||
Committer: &git.Signature{
|
||||
Email: "user2@example.com",
|
||||
Name: "user2",
|
||||
When: time.Now(),
|
||||
},
|
||||
Author: &git.Signature{
|
||||
Email: "user2@example.com",
|
||||
Name: "user2",
|
||||
When: time.Now(),
|
||||
},
|
||||
Message: "Add README.",
|
||||
}))
|
||||
stdout := &bytes.Buffer{}
|
||||
require.NoError(t, git.NewCommand(t.Context(), "rev-parse", "HEAD").Run(&git.RunOpts{Dir: dstPath, Stdout: stdout}))
|
||||
firstCommitID := strings.TrimSpace(stdout.String())
|
||||
dstPath := t.TempDir()
|
||||
cloneURL, _ := url.Parse(clone)
|
||||
cloneURL.User = url.UserPassword("user2", userPassword)
|
||||
require.NoError(t, git.CloneWithArgs(t.Context(), nil, cloneURL.String(), dstPath, git.CloneRepoOptions{}))
|
||||
|
||||
// Create agit PR.
|
||||
require.NoError(t, git.NewCommand(t.Context(), "push", "origin", "HEAD:refs/for/main", "-o", "topic=agit-pr").Run(&git.RunOpts{Dir: dstPath}))
|
||||
return dstPath
|
||||
}
|
||||
|
||||
pr := unittest.AssertExistsAndLoadBean(t, &issues_model.PullRequest{Index: 1, BaseRepoID: repo.ID})
|
||||
firstCommit := func(t *testing.T, dstPath string) string {
|
||||
t.Helper()
|
||||
|
||||
req := NewRequest(t, "GET", "/"+repo.FullName()+"/pulls/1/files/reviews/new_comment")
|
||||
resp := session.MakeRequest(t, req, http.StatusOK)
|
||||
doc := NewHTMLParser(t, resp.Body)
|
||||
require.NoError(t, os.WriteFile(path.Join(dstPath, "README.md"), []byte("## test content"), 0o600))
|
||||
require.NoError(t, git.AddChanges(dstPath, true))
|
||||
require.NoError(t, git.CommitChanges(dstPath, git.CommitChangesOptions{
|
||||
Committer: &git.Signature{
|
||||
Email: "user2@example.com",
|
||||
Name: "user2",
|
||||
When: time.Now(),
|
||||
},
|
||||
Author: &git.Signature{
|
||||
Email: "user2@example.com",
|
||||
Name: "user2",
|
||||
When: time.Now(),
|
||||
},
|
||||
Message: "Add README.",
|
||||
}))
|
||||
stdout := &bytes.Buffer{}
|
||||
require.NoError(t, git.NewCommand(t.Context(), "rev-parse", "HEAD").Run(&git.RunOpts{Dir: dstPath, Stdout: stdout}))
|
||||
|
||||
t.Run("Mark review as stale", func(t *testing.T) {
|
||||
defer tests.PrintCurrentTest(t)()
|
||||
return strings.TrimSpace(stdout.String())
|
||||
}
|
||||
|
||||
// Create a approved review against against this commit.
|
||||
req = NewRequestWithValues(t, "POST", "/"+repo.FullName()+"/pulls/1/files/reviews/comments", map[string]string{
|
||||
secondCommit := func(t *testing.T, dstPath string) {
|
||||
require.NoError(t, os.WriteFile(path.Join(dstPath, "README.md"), []byte("## I prefer this heading"), 0o600))
|
||||
require.NoError(t, git.AddChanges(dstPath, true))
|
||||
require.NoError(t, git.CommitChanges(dstPath, git.CommitChangesOptions{
|
||||
Committer: &git.Signature{
|
||||
Email: "user2@example.com",
|
||||
Name: "user2",
|
||||
When: time.Now(),
|
||||
},
|
||||
Author: &git.Signature{
|
||||
Email: "user2@example.com",
|
||||
Name: "user2",
|
||||
When: time.Now(),
|
||||
},
|
||||
Message: "Add README.",
|
||||
}))
|
||||
}
|
||||
|
||||
firstReview := func(t *testing.T, firstCommitID string, index int64) {
|
||||
t.Helper()
|
||||
|
||||
resp := session.MakeRequest(t, NewRequest(t, "GET", fmt.Sprintf("/%s/pulls/%d/files/reviews/new_comment", repo.FullName(), index)), http.StatusOK)
|
||||
doc := NewHTMLParser(t, resp.Body)
|
||||
|
||||
req := NewRequestWithValues(t, "POST", fmt.Sprintf("/%s/pulls/%d/files/reviews/comments", repo.FullName(), index), map[string]string{
|
||||
"_csrf": doc.GetCSRF(),
|
||||
"origin": doc.GetInputValueByName("origin"),
|
||||
"latest_commit_id": firstCommitID,
|
||||
|
|
@ -846,77 +865,166 @@ func TestPullRequestStaleReview(t *testing.T) {
|
|||
"type": "comment",
|
||||
})
|
||||
session.MakeRequest(t, req, http.StatusOK)
|
||||
}
|
||||
|
||||
// Review is not stale.
|
||||
review := unittest.AssertExistsAndLoadBean(t, &issues_model.Review{IssueID: pr.IssueID})
|
||||
assert.False(t, review.Stale)
|
||||
|
||||
// Create second commit
|
||||
require.NoError(t, os.WriteFile(path.Join(dstPath, "README.md"), []byte("## I prefer this heading"), 0o600))
|
||||
require.NoError(t, git.AddChanges(dstPath, true))
|
||||
require.NoError(t, git.CommitChanges(dstPath, git.CommitChangesOptions{
|
||||
Committer: &git.Signature{
|
||||
Email: "user2@example.com",
|
||||
Name: "user2",
|
||||
When: time.Now(),
|
||||
},
|
||||
Author: &git.Signature{
|
||||
Email: "user2@example.com",
|
||||
Name: "user2",
|
||||
When: time.Now(),
|
||||
},
|
||||
Message: "Add README.",
|
||||
}))
|
||||
|
||||
// Push to agit PR.
|
||||
require.NoError(t, git.NewCommand(t.Context(), "push", "origin", "HEAD:refs/for/main", "-o", "topic=agit-pr").Run(&git.RunOpts{Dir: dstPath}))
|
||||
|
||||
// Review is stale.
|
||||
review = unittest.AssertExistsAndLoadBean(t, &issues_model.Review{IssueID: pr.IssueID})
|
||||
assert.True(t, review.Stale)
|
||||
})
|
||||
|
||||
t.Run("Create stale review", func(t *testing.T) {
|
||||
defer tests.PrintCurrentTest(t)()
|
||||
|
||||
staleReview := func(t *testing.T, firstCommitID string, index int64) {
|
||||
// Review based on the first commit, which is a stale review because the
|
||||
// PR's head is at the seconnd commit.
|
||||
req := NewRequestWithValues(t, "POST", "/"+repo.FullName()+"/pulls/1/files/reviews/submit", map[string]string{
|
||||
"_csrf": doc.GetCSRF(),
|
||||
req := NewRequestWithValues(t, "POST", fmt.Sprintf("/%s/pulls/%d/files/reviews/submit", repo.FullName(), index), map[string]string{
|
||||
"_csrf": GetCSRF(t, session, fmt.Sprintf("/%s/pulls/%d/files/reviews/new_comment", repo.FullName(), index)),
|
||||
"commit_id": firstCommitID,
|
||||
"content": "looks good",
|
||||
"type": "approve",
|
||||
})
|
||||
session.MakeRequest(t, req, http.StatusOK)
|
||||
}
|
||||
|
||||
// There does not exist a review that is not stale, because all reviews
|
||||
// are based on the first commit and the PR's head is at the second commit.
|
||||
unittest.AssertExistsIf(t, false, &issues_model.Review{IssueID: pr.IssueID}, "stale = false")
|
||||
t.Run("Across repositories", func(t *testing.T) {
|
||||
testRepoFork(t, session, "user2", repo.Name, "org3", "forked-repo")
|
||||
|
||||
// Clone it.
|
||||
dstPath := clone(t, fmt.Sprintf("%sorg3/forked-repo.git", u.String()))
|
||||
|
||||
// Create first commit.
|
||||
firstCommitID := firstCommit(t, dstPath)
|
||||
|
||||
// Create PR across repositories.
|
||||
require.NoError(t, git.NewCommand(t.Context(), "push", "origin", "main").Run(&git.RunOpts{Dir: dstPath}))
|
||||
session.MakeRequest(t, NewRequestWithValues(t, "POST", repo.FullName()+"/compare/main...org3/forked-repo:main", map[string]string{
|
||||
"_csrf": GetCSRF(t, session, repo.FullName()+"/compare/main...org3/forked-repo:main"),
|
||||
"title": "pull request",
|
||||
}), http.StatusOK)
|
||||
pr := unittest.AssertExistsAndLoadBean(t, &issues_model.PullRequest{Index: 1, BaseRepoID: repo.ID})
|
||||
|
||||
t.Run("Mark review as stale", func(t *testing.T) {
|
||||
defer tests.PrintCurrentTest(t)()
|
||||
|
||||
// Create first review
|
||||
firstReview(t, firstCommitID, pr.Index)
|
||||
|
||||
// Review is not stale.
|
||||
review := unittest.AssertExistsAndLoadBean(t, &issues_model.Review{IssueID: pr.IssueID})
|
||||
assert.False(t, review.Stale)
|
||||
|
||||
// Create second commit
|
||||
secondCommit(t, dstPath)
|
||||
|
||||
// Push to PR.
|
||||
require.NoError(t, git.NewCommand(t.Context(), "push", "origin", "main").Run(&git.RunOpts{Dir: dstPath}))
|
||||
|
||||
// Review is stale.
|
||||
assert.Eventually(t, func() bool {
|
||||
return unittest.AssertExistsAndLoadBean(t, &issues_model.Review{IssueID: pr.IssueID}).Stale == true
|
||||
}, time.Second*10, time.Microsecond*100)
|
||||
})
|
||||
|
||||
t.Run("Create stale review", func(t *testing.T) {
|
||||
defer tests.PrintCurrentTest(t)()
|
||||
|
||||
// Review based on the first commit, which is a stale review because the
|
||||
// PR's head is at the seconnd commit.
|
||||
staleReview(t, firstCommitID, pr.Index)
|
||||
|
||||
// There does not exist a review that is not stale, because all reviews
|
||||
// are based on the first commit and the PR's head is at the second commit.
|
||||
unittest.AssertExistsIf(t, false, &issues_model.Review{IssueID: pr.IssueID}, "stale = false")
|
||||
})
|
||||
|
||||
t.Run("Mark unstale", func(t *testing.T) {
|
||||
defer tests.PrintCurrentTest(t)()
|
||||
|
||||
// Force push the PR to the first commit.
|
||||
require.NoError(t, git.NewCommand(t.Context(), "reset", "--hard", "HEAD~1").Run(&git.RunOpts{Dir: dstPath}))
|
||||
require.NoError(t, git.NewCommand(t.Context(), "push", "--force-with-lease", "origin", "main").Run(&git.RunOpts{Dir: dstPath}))
|
||||
|
||||
// There does not exist a review that is stale, because all reviews
|
||||
// are based on the first commit and thus all reviews are no longer marked
|
||||
// as stale.
|
||||
assert.Eventually(t, func() bool {
|
||||
return !unittest.BeanExists(t, &issues_model.Review{IssueID: pr.IssueID}, "stale = true")
|
||||
}, time.Second*10, time.Microsecond*100)
|
||||
})
|
||||
|
||||
t.Run("Diff did not change", func(t *testing.T) {
|
||||
defer tests.PrintCurrentTest(t)()
|
||||
|
||||
// Create a empty commit and push it to the PR.
|
||||
require.NoError(t, git.NewCommand(t.Context(), "commit", "--allow-empty", "-m", "Empty commit").Run(&git.RunOpts{Dir: dstPath}))
|
||||
require.NoError(t, git.NewCommand(t.Context(), "push", "origin", "main").Run(&git.RunOpts{Dir: dstPath}))
|
||||
|
||||
// There does not exist a review that is stale, because the diff did not
|
||||
// change.
|
||||
unittest.AssertExistsIf(t, false, &issues_model.Review{IssueID: pr.IssueID}, "stale = true")
|
||||
})
|
||||
})
|
||||
|
||||
t.Run("Mark unstale", func(t *testing.T) {
|
||||
defer tests.PrintCurrentTest(t)()
|
||||
t.Run("AGit", func(t *testing.T) {
|
||||
dstPath := clone(t, fmt.Sprintf("%suser2/%s.git", u.String(), repo.Name))
|
||||
|
||||
// Force push the PR to the first commit.
|
||||
require.NoError(t, git.NewCommand(t.Context(), "reset", "--hard", "HEAD~1").Run(&git.RunOpts{Dir: dstPath}))
|
||||
require.NoError(t, git.NewCommand(t.Context(), "push", "origin", "HEAD:refs/for/main", "-o", "topic=agit-pr", "-o", "force-push").Run(&git.RunOpts{Dir: dstPath}))
|
||||
// Create first commit.
|
||||
firstCommitID := firstCommit(t, dstPath)
|
||||
|
||||
// There does not exist a review that is stale, because all reviews
|
||||
// are based on the first commit and thus all reviews are no longer marked
|
||||
// as stale.
|
||||
unittest.AssertExistsIf(t, false, &issues_model.Review{IssueID: pr.IssueID}, "stale = true")
|
||||
})
|
||||
|
||||
t.Run("Diff did not change", func(t *testing.T) {
|
||||
defer tests.PrintCurrentTest(t)()
|
||||
|
||||
// Create a empty commit and push it to the PR.
|
||||
require.NoError(t, git.NewCommand(t.Context(), "commit", "--allow-empty", "-m", "Empty commit").Run(&git.RunOpts{Dir: dstPath}))
|
||||
// Create agit PR.
|
||||
require.NoError(t, git.NewCommand(t.Context(), "push", "origin", "HEAD:refs/for/main", "-o", "topic=agit-pr").Run(&git.RunOpts{Dir: dstPath}))
|
||||
|
||||
// There does not exist a review that is stale, because the diff did not
|
||||
// change.
|
||||
unittest.AssertExistsIf(t, false, &issues_model.Review{IssueID: pr.IssueID}, "stale = true")
|
||||
pr := unittest.AssertExistsAndLoadBean(t, &issues_model.PullRequest{Index: 2, BaseRepoID: repo.ID})
|
||||
|
||||
t.Run("Mark review as stale", func(t *testing.T) {
|
||||
defer tests.PrintCurrentTest(t)()
|
||||
|
||||
firstReview(t, firstCommitID, pr.Index)
|
||||
|
||||
// Review is not stale.
|
||||
review := unittest.AssertExistsAndLoadBean(t, &issues_model.Review{IssueID: pr.IssueID})
|
||||
assert.False(t, review.Stale)
|
||||
|
||||
// Create second commit
|
||||
secondCommit(t, dstPath)
|
||||
|
||||
// Push to agit PR.
|
||||
require.NoError(t, git.NewCommand(t.Context(), "push", "origin", "HEAD:refs/for/main", "-o", "topic=agit-pr").Run(&git.RunOpts{Dir: dstPath}))
|
||||
|
||||
// Review is stale.
|
||||
review = unittest.AssertExistsAndLoadBean(t, &issues_model.Review{IssueID: pr.IssueID})
|
||||
assert.True(t, review.Stale)
|
||||
})
|
||||
|
||||
t.Run("Create stale review", func(t *testing.T) {
|
||||
defer tests.PrintCurrentTest(t)()
|
||||
|
||||
// Review based on the first commit, which is a stale review because the
|
||||
// PR's head is at the seconnd commit.
|
||||
staleReview(t, firstCommitID, pr.Index)
|
||||
|
||||
// There does not exist a review that is not stale, because all reviews
|
||||
// are based on the first commit and the PR's head is at the second commit.
|
||||
unittest.AssertExistsIf(t, false, &issues_model.Review{IssueID: pr.IssueID}, "stale = false")
|
||||
})
|
||||
|
||||
t.Run("Mark unstale", func(t *testing.T) {
|
||||
defer tests.PrintCurrentTest(t)()
|
||||
|
||||
// Force push the PR to the first commit.
|
||||
require.NoError(t, git.NewCommand(t.Context(), "reset", "--hard", "HEAD~1").Run(&git.RunOpts{Dir: dstPath}))
|
||||
require.NoError(t, git.NewCommand(t.Context(), "push", "origin", "HEAD:refs/for/main", "-o", "topic=agit-pr", "-o", "force-push").Run(&git.RunOpts{Dir: dstPath}))
|
||||
|
||||
// There does not exist a review that is stale, because all reviews
|
||||
// are based on the first commit and thus all reviews are no longer marked
|
||||
// as stale.
|
||||
unittest.AssertExistsIf(t, false, &issues_model.Review{IssueID: pr.IssueID}, "stale = true")
|
||||
})
|
||||
|
||||
t.Run("Diff did not change", func(t *testing.T) {
|
||||
defer tests.PrintCurrentTest(t)()
|
||||
|
||||
// Create a empty commit and push it to the PR.
|
||||
require.NoError(t, git.NewCommand(t.Context(), "commit", "--allow-empty", "-m", "Empty commit").Run(&git.RunOpts{Dir: dstPath}))
|
||||
require.NoError(t, git.NewCommand(t.Context(), "push", "origin", "HEAD:refs/for/main", "-o", "topic=agit-pr").Run(&git.RunOpts{Dir: dstPath}))
|
||||
|
||||
// There does not exist a review that is stale, because the diff did not
|
||||
// change.
|
||||
unittest.AssertExistsIf(t, false, &issues_model.Review{IssueID: pr.IssueID}, "stale = true")
|
||||
})
|
||||
})
|
||||
})
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue