f90928507a
Git has a cool feature called git notes. It allows adding a text to a commit without changing the commit itself. Forgejo already displays git notes. With this PR you can also now change git notes. <details> <summary>Screenshots</summary>     </details> ## Checklist The [developer guide](https://forgejo.org/docs/next/developer/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org). ### Tests - I added test coverage for Go changes... - [ ] in their respective `*_test.go` for unit tests. - [x] in the `tests/integration` directory if it involves interactions with a live Forgejo server. - I added test coverage for JavaScript changes... - [ ] in `web_src/js/*.test.js` if it can be unit tested. - [ ] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)). ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [x] I did not document these changes and I do not expect someone else to do it. ### Release notes - [ ] I do not want this change to show in the release notes. - [x] I want the title to show in the release notes with a link to this pull request. - [ ] I want the content of the `release-notes/<pull request number>.md` to be be used for the release notes instead of the title. <!--start release-notes-assistant--> ## Release notes <!--URL:https://codeberg.org/forgejo/forgejo--> - Features - [PR](https://codeberg.org/forgejo/forgejo/pulls/4753): <!--number 4753 --><!--line 0 --><!--description QWxsb3cgY2hhbmdpbmcgZ2l0IG5vdGVz-->Allow changing git notes<!--description--> <!--end release-notes-assistant--> Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/4753 Reviewed-by: Gusted <gusted@noreply.codeberg.org> Co-authored-by: JakobDev <jakobdev@gmx.de> Co-committed-by: JakobDev <jakobdev@gmx.de>
106 lines
3.4 KiB
Go
106 lines
3.4 KiB
Go
// Copyright 2019 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package git_test
|
|
|
|
import (
|
|
"context"
|
|
"os"
|
|
"path/filepath"
|
|
"testing"
|
|
|
|
"code.gitea.io/gitea/models/unittest"
|
|
"code.gitea.io/gitea/modules/git"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
const (
|
|
testReposDir = "tests/repos/"
|
|
)
|
|
|
|
// openRepositoryWithDefaultContext opens the repository at the given path with DefaultContext.
|
|
func openRepositoryWithDefaultContext(repoPath string) (*git.Repository, error) {
|
|
return git.OpenRepository(git.DefaultContext, repoPath)
|
|
}
|
|
|
|
func TestGetNotes(t *testing.T) {
|
|
bareRepo1Path := filepath.Join(testReposDir, "repo1_bare")
|
|
bareRepo1, err := openRepositoryWithDefaultContext(bareRepo1Path)
|
|
require.NoError(t, err)
|
|
defer bareRepo1.Close()
|
|
|
|
note := git.Note{}
|
|
err = git.GetNote(context.Background(), bareRepo1, "95bb4d39648ee7e325106df01a621c530863a653", ¬e)
|
|
require.NoError(t, err)
|
|
assert.Equal(t, []byte("Note contents\n"), note.Message)
|
|
assert.Equal(t, "Vladimir Panteleev", note.Commit.Author.Name)
|
|
}
|
|
|
|
func TestGetNestedNotes(t *testing.T) {
|
|
repoPath := filepath.Join(testReposDir, "repo3_notes")
|
|
repo, err := openRepositoryWithDefaultContext(repoPath)
|
|
require.NoError(t, err)
|
|
defer repo.Close()
|
|
|
|
note := git.Note{}
|
|
err = git.GetNote(context.Background(), repo, "3e668dbfac39cbc80a9ff9c61eb565d944453ba4", ¬e)
|
|
require.NoError(t, err)
|
|
assert.Equal(t, []byte("Note 2"), note.Message)
|
|
err = git.GetNote(context.Background(), repo, "ba0a96fa63532d6c5087ecef070b0250ed72fa47", ¬e)
|
|
require.NoError(t, err)
|
|
assert.Equal(t, []byte("Note 1"), note.Message)
|
|
}
|
|
|
|
func TestGetNonExistentNotes(t *testing.T) {
|
|
bareRepo1Path := filepath.Join(testReposDir, "repo1_bare")
|
|
bareRepo1, err := openRepositoryWithDefaultContext(bareRepo1Path)
|
|
require.NoError(t, err)
|
|
defer bareRepo1.Close()
|
|
|
|
note := git.Note{}
|
|
err = git.GetNote(context.Background(), bareRepo1, "non_existent_sha", ¬e)
|
|
require.Error(t, err)
|
|
assert.IsType(t, git.ErrNotExist{}, err)
|
|
}
|
|
|
|
func TestSetNote(t *testing.T) {
|
|
bareRepo1Path := filepath.Join(testReposDir, "repo1_bare")
|
|
|
|
tempDir, err := os.MkdirTemp("", "")
|
|
require.NoError(t, err)
|
|
defer os.RemoveAll(tempDir)
|
|
require.NoError(t, unittest.CopyDir(bareRepo1Path, filepath.Join(tempDir, "repo1")))
|
|
|
|
bareRepo1, err := openRepositoryWithDefaultContext(filepath.Join(tempDir, "repo1"))
|
|
require.NoError(t, err)
|
|
defer bareRepo1.Close()
|
|
|
|
require.NoError(t, git.SetNote(context.Background(), bareRepo1, "95bb4d39648ee7e325106df01a621c530863a653", "This is a new note", "Test", "test@test.com"))
|
|
|
|
note := git.Note{}
|
|
err = git.GetNote(context.Background(), bareRepo1, "95bb4d39648ee7e325106df01a621c530863a653", ¬e)
|
|
require.NoError(t, err)
|
|
assert.Equal(t, []byte("This is a new note\n"), note.Message)
|
|
assert.Equal(t, "Test", note.Commit.Author.Name)
|
|
}
|
|
|
|
func TestRemoveNote(t *testing.T) {
|
|
bareRepo1Path := filepath.Join(testReposDir, "repo1_bare")
|
|
|
|
tempDir := t.TempDir()
|
|
|
|
require.NoError(t, unittest.CopyDir(bareRepo1Path, filepath.Join(tempDir, "repo1")))
|
|
|
|
bareRepo1, err := openRepositoryWithDefaultContext(filepath.Join(tempDir, "repo1"))
|
|
require.NoError(t, err)
|
|
defer bareRepo1.Close()
|
|
|
|
require.NoError(t, git.RemoveNote(context.Background(), bareRepo1, "95bb4d39648ee7e325106df01a621c530863a653"))
|
|
|
|
note := git.Note{}
|
|
err = git.GetNote(context.Background(), bareRepo1, "95bb4d39648ee7e325106df01a621c530863a653", ¬e)
|
|
require.Error(t, err)
|
|
assert.IsType(t, git.ErrNotExist{}, err)
|
|
}
|