Add .diff and .patch support to compare #34433
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,10 +9,13 @@ import ( | |
| "net/url" | ||
| "strings" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "code.gitea.io/gitea/models/db" | ||
| "code.gitea.io/gitea/models/unittest" | ||
| user_model "code.gitea.io/gitea/models/user" | ||
| git_module "code.gitea.io/gitea/modules/git" | ||
| "code.gitea.io/gitea/modules/gitrepo" | ||
| "code.gitea.io/gitea/modules/test" | ||
| repo_service "code.gitea.io/gitea/services/repository" | ||
| "code.gitea.io/gitea/tests" | ||
|
|
@@ -158,3 +161,212 @@ func TestCompareCodeExpand(t *testing.T) { | |
| } | ||
| }) | ||
| } | ||
|
|
||
| func TestCompareRawDiffNormal(t *testing.T) { | ||
| onGiteaRun(t, func(t *testing.T, u *url.URL) { | ||
| user1 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 1}) | ||
| repo, err := repo_service.CreateRepositoryDirectly(db.DefaultContext, user1, user1, repo_service.CreateRepoOptions{ | ||
| Name: "test_raw_diff", | ||
| Readme: "Default", | ||
| AutoInit: true, | ||
| DefaultBranch: "main", | ||
| }, true) | ||
| assert.NoError(t, err) | ||
| session := loginUser(t, user1.Name) | ||
|
|
||
| r, _ := gitrepo.OpenRepository(db.DefaultContext, repo) | ||
|
|
||
| oldRef, _ := r.GetBranchCommit(repo.DefaultBranch) | ||
| oldBlobRef, _ := revParse(r, oldRef.ID.String(), "README.md") | ||
|
|
||
| testEditFile(t, session, user1.Name, repo.Name, "main", "README.md", strings.Repeat("a\n", 2)) | ||
|
|
||
| newRef, _ := r.GetBranchCommit(repo.DefaultBranch) | ||
| newBlobRef, _ := revParse(r, newRef.ID.String(), "README.md") | ||
|
|
||
| req := NewRequest(t, "GET", fmt.Sprintf("/user1/test_raw_diff/compare/%s...%s.diff", oldRef.ID.String(), newRef.ID.String())) | ||
| resp := session.MakeRequest(t, req, http.StatusOK) | ||
|
|
||
| expected := fmt.Sprintf(`diff --git a/README.md b/README.md | ||
| index %s..%s 100644 | ||
| --- a/README.md | ||
| +++ b/README.md | ||
| @@ -1,2 +1,2 @@ | ||
| -# test_raw_diff | ||
| - | ||
| +a | ||
| +a | ||
| `, oldBlobRef[:7], newBlobRef[:7]) | ||
| assert.Equal(t, expected, resp.Body.String()) | ||
| }) | ||
| } | ||
|
|
||
| func TestCompareRawDiffPatch(t *testing.T) { | ||
| onGiteaRun(t, func(t *testing.T, u *url.URL) { | ||
| user1 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 1}) | ||
| repo, err := repo_service.CreateRepositoryDirectly(db.DefaultContext, user1, user1, repo_service.CreateRepoOptions{ | ||
| Name: "test_raw_diff", | ||
| Readme: "Default", | ||
| AutoInit: true, | ||
| DefaultBranch: "main", | ||
| }, true) | ||
| assert.NoError(t, err) | ||
| session := loginUser(t, user1.Name) | ||
|
|
||
| r, _ := gitrepo.OpenRepository(db.DefaultContext, repo) | ||
|
|
||
| // Get the old commit and blob reference | ||
| oldRef, _ := r.GetBranchCommit(repo.DefaultBranch) | ||
| oldBlobRef, _ := revParse(r, oldRef.ID.String(), "README.md") | ||
|
|
||
| resp := testEditFile(t, session, user1.Name, repo.Name, "main", "README.md", strings.Repeat("a\n", 2)) | ||
|
|
||
| newRef, _ := r.GetBranchCommit(repo.DefaultBranch) | ||
| newBlobRef, _ := revParse(r, newRef.ID.String(), "README.md") | ||
|
|
||
| // Get the last modified time from the response header | ||
| respTs, _ := time.Parse(time.RFC1123, resp.Result().Header.Get("Last-Modified")) | ||
| respTs = respTs.In(time.Local) | ||
|
|
||
| // Format the timestamp to match the expected format in the patch | ||
| customFormat := "Mon, 02 Jan 2006 15:04:05 -0700" | ||
| respTsStr := respTs.Format(customFormat) | ||
|
|
||
| req := NewRequest(t, "GET", fmt.Sprintf("/user1/test_raw_diff/compare/%s...%s.patch", oldRef.ID.String(), newRef.ID.String())) | ||
| resp = session.MakeRequest(t, req, http.StatusOK) | ||
|
|
||
| expected := fmt.Sprintf(`From %s Mon Sep 17 00:00:00 2001 | ||
| From: User One <[email protected]> | ||
| Date: %s | ||
| Subject: [PATCH] Update README.md | ||
|
|
||
| --- | ||
| README.md | 4 ++-- | ||
| 1 file changed, 2 insertions(+), 2 deletions(-) | ||
|
|
||
| diff --git a/README.md b/README.md | ||
| index %s..%s 100644 | ||
| --- a/README.md | ||
| +++ b/README.md | ||
| @@ -1,2 +1,2 @@ | ||
| -# test_raw_diff | ||
| - | ||
| +a | ||
| +a | ||
| `, newRef.ID.String(), respTsStr, oldBlobRef[:7], newBlobRef[:7]) | ||
| assert.Equal(t, expected, resp.Body.String()) | ||
| }) | ||
| } | ||
|
|
||
| func TestCompareRawDiffNormalSameOwnerDifferentRepo(t *testing.T) { | ||
| onGiteaRun(t, func(t *testing.T, u *url.URL) { | ||
| user1 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 1}) | ||
| repo, err := repo_service.CreateRepositoryDirectly(db.DefaultContext, user1, user1, repo_service.CreateRepoOptions{ | ||
| Name: "test_raw_diff", | ||
| Readme: "Default", | ||
| AutoInit: true, | ||
| DefaultBranch: "main", | ||
| }, true) | ||
| assert.NoError(t, err) | ||
| session := loginUser(t, user1.Name) | ||
|
|
||
| headRepo, err := repo_service.CreateRepositoryDirectly(db.DefaultContext, user1, user1, repo_service.CreateRepoOptions{ | ||
| Name: "test_raw_diff_head", | ||
| Readme: "Default", | ||
| AutoInit: true, | ||
| DefaultBranch: "main", | ||
| }, true) | ||
| assert.NoError(t, err) | ||
|
|
||
| r, _ := gitrepo.OpenRepository(db.DefaultContext, repo) | ||
| hr, _ := gitrepo.OpenRepository(db.DefaultContext, headRepo) | ||
|
|
||
| oldRef, _ := r.GetBranchCommit(repo.DefaultBranch) | ||
| oldBlobRef, _ := revParse(r, oldRef.ID.String(), "README.md") | ||
|
|
||
| testEditFile(t, session, user1.Name, headRepo.Name, "main", "README.md", strings.Repeat("a\n", 2)) | ||
|
|
||
| newRef, _ := hr.GetBranchCommit(headRepo.DefaultBranch) | ||
| newBlobRef, _ := revParse(hr, newRef.ID.String(), "README.md") | ||
|
|
||
| req := NewRequest(t, "GET", fmt.Sprintf("/user1/test_raw_diff/compare/%s...%s/%s:%s.diff", oldRef.ID.String(), user1.LowerName, headRepo.LowerName, newRef.ID.String())) | ||
| resp := session.MakeRequest(t, req, http.StatusOK) | ||
|
|
||
| expected := fmt.Sprintf(`diff --git a/README.md b/README.md | ||
| index %s..%s 100644 | ||
| --- a/README.md | ||
| +++ b/README.md | ||
| @@ -1,2 +1,2 @@ | ||
| -# test_raw_diff | ||
| - | ||
| +a | ||
| +a | ||
| `, oldBlobRef[:7], newBlobRef[:7]) | ||
| assert.Equal(t, expected, resp.Body.String()) | ||
| }) | ||
| } | ||
|
|
||
| func TestCompareRawDiffNormalAcrossForks(t *testing.T) { | ||
| onGiteaRun(t, func(t *testing.T, u *url.URL) { | ||
| user1 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 1}) | ||
| user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2}) | ||
|
|
||
| repo, err := repo_service.CreateRepositoryDirectly(db.DefaultContext, user1, user1, repo_service.CreateRepoOptions{ | ||
| Name: "test_raw_diff", | ||
| Readme: "Default", | ||
| AutoInit: true, | ||
| DefaultBranch: "main", | ||
| }, true) | ||
| assert.NoError(t, err) | ||
|
|
||
| headRepo, err := repo_service.ForkRepository(db.DefaultContext, user2, user2, repo_service.ForkRepoOptions{ | ||
| BaseRepo: repo, | ||
| Name: repo.Name, | ||
| Description: repo.Description, | ||
| SingleBranch: "", | ||
| }) | ||
| assert.NoError(t, err) | ||
|
|
||
| session := loginUser(t, user2.Name) | ||
|
|
||
| r, _ := gitrepo.OpenRepository(db.DefaultContext, repo) | ||
| hr, _ := gitrepo.OpenRepository(db.DefaultContext, headRepo) | ||
|
|
||
| oldRef, _ := r.GetBranchCommit(repo.DefaultBranch) | ||
| oldBlobRef, _ := revParse(r, oldRef.ID.String(), "README.md") | ||
|
|
||
| testEditFile(t, session, user2.Name, headRepo.Name, "main", "README.md", strings.Repeat("a\n", 2)) | ||
|
|
||
| newRef, _ := hr.GetBranchCommit(headRepo.DefaultBranch) | ||
| newBlobRef, _ := revParse(hr, newRef.ID.String(), "README.md") | ||
|
|
||
| session = loginUser(t, user1.Name) | ||
|
|
||
| req := NewRequest(t, "GET", fmt.Sprintf("/user1/test_raw_diff/compare/%s...%s:%s.diff", oldRef.ID.String(), user2.LowerName, newRef.ID.String())) | ||
| resp := session.MakeRequest(t, req, http.StatusOK) | ||
|
|
||
| expected := fmt.Sprintf(`diff --git a/README.md b/README.md | ||
| index %s..%s 100644 | ||
| --- a/README.md | ||
| +++ b/README.md | ||
| @@ -1,2 +1,2 @@ | ||
| -# test_raw_diff | ||
| - | ||
| +a | ||
| +a | ||
| `, oldBlobRef[:7], newBlobRef[:7]) | ||
| assert.Equal(t, expected, resp.Body.String()) | ||
| }) | ||
| } | ||
|
|
||
| // helper function to use rev-parse | ||
| // revParse resolves a revision reference to other git-related objects | ||
| func revParse(repo *git_module.Repository, ref, file string) (string, error) { | ||
| stdout, _, err := git_module.NewCommand("rev-parse"). | ||
| AddDynamicArguments(ref+":"+file). | ||
| RunStdString(repo.Ctx, &git_module.RunOpts{Dir: repo.Path}) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| return strings.TrimSpace(stdout), nil | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When trying to understand the logic, I find something strange, so I left a FIXME here.
Do you have ideas?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ps: if it is too complex and we don't really need to support these cases, we can also skip the diff/patch support for these cases and leave some comments.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll address that, I prefer to support all use cases