forgejo/modules/git/notes_test.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", &note)
	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", &note)
	require.NoError(t, err)
	assert.Equal(t, []byte("Note 2"), note.Message)
	err = git.GetNote(context.Background(), repo, "ba0a96fa63532d6c5087ecef070b0250ed72fa47", &note)
	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", &note)
	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", &note)
	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", &note)
	require.Error(t, err)
	assert.IsType(t, git.ErrNotExist{}, err)
}