gittuf/pkg/gitinterface/utils.go
Pat Zielinski f649b141d3
pkg: Move gitinterface to pkg
Signed-off-by: Pat Zielinski <git@patzielinski.com>
2026-01-16 14:03:36 -05:00

100 lines
2.9 KiB
Go

// Copyright The gittuf Authors
// SPDX-License-Identifier: Apache-2.0
package gitinterface
import (
"fmt"
"os"
"os/exec"
"path"
"strings"
"testing"
)
// ResetDueToError reverses a change applied to a ref to the specified target
// ID. It is used to ensure a gittuf operation is atomic: if a gittuf operation
// fails, any changes made to the repository in refs/gittuf can be rolled back.
// Worktrees are not updated.
func (r *Repository) ResetDueToError(cause error, refName string, commitID Hash) error {
if err := r.SetReference(refName, commitID); err != nil {
return fmt.Errorf("unable to reset %s to %s, caused by following error: %w", refName, commitID.String(), cause)
}
return cause
}
func RemoteRef(refName, remoteName string) string {
var remotePath string
switch {
case strings.HasPrefix(refName, BranchRefPrefix):
// refs/heads/<path> -> refs/remotes/<remote>/<path>
rest := strings.TrimPrefix(refName, BranchRefPrefix)
remotePath = path.Join(RemoteRefPrefix, remoteName, rest)
case strings.HasPrefix(refName, TagRefPrefix):
// refs/tags/<path> -> refs/tags/<path>
remotePath = refName
default:
// refs/<path> -> refs/remotes/<remote>/<path>
rest := strings.TrimPrefix(refName, RefPrefix)
remotePath = path.Join(RemoteRefPrefix, remoteName, rest)
}
return remotePath
}
// RestoreWorktree is a test helper to fix the worktree in tests where we need
// to operate in a checked out copy of the repository. This is primarily needed
// for support with older Git versions.
func (r *Repository) RestoreWorktree(t *testing.T) {
t.Helper()
worktree := r.gitDirPath
if !r.IsBare() {
worktree = strings.TrimSuffix(worktree, ".git") // TODO: this doesn't support detached git dir
}
cwd, err := os.Getwd()
if err != nil {
t.Fatal(err)
}
if err := os.Chdir(worktree); err != nil {
t.Fatal(err)
}
defer os.Chdir(cwd) //nolint:errcheck
if _, err := r.executor("restore", "--staged", ".").executeString(); err != nil {
t.Fatal(err)
}
if _, err := r.executor("restore", ".").executeString(); err != nil {
t.Fatal(err)
}
}
// IsNiceGitVersion determines whether the version of git is "nice". Certain Git
// subcommands that gittuf uses were added in newer versions than some common
// client versions. Instead of using a workaround for all clients, we determine
// if we can use the newer features or instead need to use workarounds.
func isNiceGitVersion() (bool, error) {
cmd := exec.Command("git", "--version")
output, err := cmd.Output()
if err != nil {
return false, err
}
versionString := strings.TrimPrefix(strings.TrimSpace(string(output)), "git version ")
var major, minor, patch int
_, err = fmt.Sscanf(versionString, "%d.%d.%d", &major, &minor, &patch)
if err != nil {
return false, err
}
if major >= 2 && minor >= 38 {
return true, nil
}
return false, nil
}
func testNameToRefName(testName string) string {
return BranchReferenceName(strings.ReplaceAll(testName, " ", "__"))
}