repository

package
v0.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 18, 2025 License: GPL-3.0 Imports: 35 Imported by: 0

Documentation

Overview

Package repository contains helper methods for working with a Git repo.

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrNoConfigEntry       = errors.New("no config entry for the given key")
	ErrMultipleConfigEntry = errors.New("multiple config entry for the given key")
)
View Source 
var (
	// ErrNotARepo is the error returned when the git repo root can't be found
	ErrNotARepo = errors.New("not a git repository")
	// ErrClockNotExist is the error returned when a clock can't be found
	ErrClockNotExist = errors.New("clock doesn't exist")
	// ErrNotFound is the error returned when a git object can't be found
	ErrNotFound = errors.New("ref not found")
)
View Source 
var ErrKeyringKeyNotFound = keyring.ErrKeyNotFound

Functions

func NewMockRepo 

func NewMockRepo() *mockRepo

func NewMockRepoClock 

func NewMockRepoClock() *mockRepoClock

func NewMockRepoCommon 

func NewMockRepoCommon() *mockRepoCommon

func NewMockRepoConfig 

func NewMockRepoConfig() *mockRepoConfig

func NewMockRepoData 

func NewMockRepoData() *mockRepoData

func NewMockRepoKeyring 

func NewMockRepoKeyring() *mockRepoKeyring

func NewMockRepoStorage 

func NewMockRepoStorage() *mockRepoStorage

func NewMockRepoTest 

func NewMockRepoTest() *mockRepoTest

func ParseTimestamp 

func ParseTimestamp(s string) (time.Time, error)

func RepoClockTest 

func RepoClockTest(t *testing.T, repo RepoClock)

helper to test a RepoClock

func RepoConfigTest 

func RepoConfigTest(t *testing.T, repo RepoConfig)

helper to test a RepoConfig

func RepoDataSignatureTest 

func RepoDataSignatureTest(t *testing.T, repo RepoData)

func RepoDataTest 

func RepoDataTest(t *testing.T, repo RepoData)

helper to test a RepoData

func RepoIndexTest 

func RepoIndexTest(t *testing.T, repo RepoIndex)

func RepoStorageTest 

func RepoStorageTest(t *testing.T, repo RepoStorage)

func RepoTest 

func RepoTest(t *testing.T, creator RepoCreator)

Test suite for a Repo implementation

Types

type ClockLoader 

type ClockLoader struct {
	// Clocks hold the name of all the clocks this loader deal with.
	// Those clocks will be checked when the repo load. If not present or broken,
	// Witnesser will be used to create them.
	Clocks []string
	// Witnesser is a function that will initialize the clocks of a repo
	// from scratch
	Witnesser func(repo ClockedRepo) error
}

ClockLoader hold which logical clock need to exist for an entity and how to create them if they don't.

type ClockedRepo 

type ClockedRepo interface {
	Repo
	RepoClock
}

ClockedRepo is a Repo that also has Lamport clocks

type Commit 

type Commit struct {
	Hash       Hash
	Parents    []Hash    // hashes of the parents, if any
	TreeHash   Hash      // hash of the git Tree
	SignedData io.Reader // if signed, reader for the signed data (likely, the serialized commit)
	Signature  io.Reader // if signed, reader for the (non-armored) signature
}

type Config 

type Config interface {
	ConfigRead
	ConfigWrite
}

Config represent the common function interacting with the repository config storage

type ConfigRead 

type ConfigRead interface {
	// ReadAll reads all key/value pair matching the key prefix
	ReadAll(keyPrefix string) (map[string]string, error)

	// ReadBool read a single boolean value from the config
	// Return ErrNoConfigEntry or ErrMultipleConfigEntry if
	// there is zero or more than one entry for this key
	ReadBool(key string) (bool, error)

	// ReadString read a single string value from the config
	// Return ErrNoConfigEntry or ErrMultipleConfigEntry if
	// there is zero or more than one entry for this key
	ReadString(key string) (string, error)

	// ReadTimestamp read a single timestamp value from the config
	// Return ErrNoConfigEntry or ErrMultipleConfigEntry if
	// there is zero or more than one entry for this key
	ReadTimestamp(key string) (time.Time, error)
}

type ConfigWrite 

type ConfigWrite interface {
	// StoreString writes a single string key/value pair in the config
	StoreString(key, value string) error

	// StoreTimestamp writes a key and timestamp value to the config
	StoreTimestamp(key string, value time.Time) error

	// StoreBool writes a key and boolean value to the config
	StoreBool(key string, value bool) error

	// RemoveAll removes all key/value pair matching the key prefix
	RemoveAll(keyPrefix string) error
}

type GoGitRepo 

type GoGitRepo struct {
	// contains filtered or unexported fields
}

func InitBareGoGitRepo 

func InitBareGoGitRepo(path, namespace string) (*GoGitRepo, error)

InitBareGoGitRepo creates a new --bare empty git repo at the given path and with the specified LocalStorage namespace. Given a repository path of "~/myrepo" and a namespace of "git-bug", local storage for the GoGitRepo will be configured at "~/myrepo/.git/git-bug".

func InitGoGitRepo 

func InitGoGitRepo(path, namespace string) (*GoGitRepo, error)

InitGoGitRepo creates a new empty git repo at the given path and with the specified LocalStorage namespace. Given a repository path of "~/myrepo" and a namespace of "git-bug", local storage for the GoGitRepo will be configured at "~/myrepo/.git/git-bug".

func OpenGoGitRepo 

func OpenGoGitRepo(path, namespace string, clockLoaders []ClockLoader) (*GoGitRepo, error)

OpenGoGitRepo opens an already existing repo at the given path and with the specified LocalStorage namespace. Given a repository path of "~/myrepo" and a namespace of "git-bug", local storage for the GoGitRepo will be configured at "~/myrepo/.git/git-bug".

func (*GoGitRepo) AddRemote 

func (repo *GoGitRepo) AddRemote(name string, url string) error

AddRemote add a new remote to the repository Not in the interface because it's only used for testing

func (*GoGitRepo) AllClocks 

func (repo *GoGitRepo) AllClocks() (map[string]lamport.Clock, error)

func (*GoGitRepo) AnyConfig 

func (repo *GoGitRepo) AnyConfig() ConfigRead

AnyConfig give access to a merged local/global configuration

func (*GoGitRepo) Close 

func (repo *GoGitRepo) Close() error

func (*GoGitRepo) CopyRef 

func (repo *GoGitRepo) CopyRef(source string, dest string) error

CopyRef will create a new reference with the same value as another one

func (*GoGitRepo) EraseFromDisk 

func (repo *GoGitRepo) EraseFromDisk() error

EraseFromDisk delete this repository entirely from the disk

func (*GoGitRepo) FetchRefs 

func (repo *GoGitRepo) FetchRefs(remote string, prefixes ...string) (string, error)

FetchRefs fetch git refs matching a directory prefix to a remote Ex: prefix="foo" will fetch any remote refs matching "refs/foo/*" locally. The equivalent git refspec would be "refs/foo/*:refs/remotes/<remote>/foo/*"

func (*GoGitRepo) GetCoreEditor 

func (repo *GoGitRepo) GetCoreEditor() (string, error)

GetCoreEditor returns the name of the editor that the user has used to configure git.

func (*GoGitRepo) GetIndex 

func (repo *GoGitRepo) GetIndex(name string) (Index, error)

func (*GoGitRepo) GetLocalRemote 

func (repo *GoGitRepo) GetLocalRemote() string

GetLocalRemote return the URL to use to add this repo as a local remote

func (*GoGitRepo) GetOrCreateClock 

func (repo *GoGitRepo) GetOrCreateClock(name string) (lamport.Clock, error)

GetOrCreateClock return a Lamport clock stored in the Repo. If the clock doesn't exist, it's created.

func (*GoGitRepo) GetRemotes 

func (repo *GoGitRepo) GetRemotes() (map[string]string, error)

GetRemotes returns the configured remotes repositories.

func (*GoGitRepo) GetUserEmail 

func (repo *GoGitRepo) GetUserEmail() (string, error)

GetUserEmail returns the email address that the user has used to configure git.

func (*GoGitRepo) GetUserName 

func (repo *GoGitRepo) GetUserName() (string, error)

GetUserName returns the name the user has used to configure git

func (*GoGitRepo) GlobalConfig 

func (repo *GoGitRepo) GlobalConfig() Config

GlobalConfig give access to the global scoped configuration

func (*GoGitRepo) Increment 

func (repo *GoGitRepo) Increment(name string) (lamport.Time, error)

Increment is equivalent to c = GetOrCreateClock(name) + c.Increment()

func (*GoGitRepo) Keyring 

func (repo *GoGitRepo) Keyring() Keyring

Keyring give access to a user-wide storage for secrets

func (*GoGitRepo) ListCommits 

func (repo *GoGitRepo) ListCommits(ref string) ([]Hash, error)

ListCommits will return the list of tree hashes of a ref, in chronological order

func (*GoGitRepo) ListRefs 

func (repo *GoGitRepo) ListRefs(refPrefix string) ([]string, error)

ListRefs will return a list of Git ref matching the given refspec

func (*GoGitRepo) LocalConfig 

func (repo *GoGitRepo) LocalConfig() Config

LocalConfig give access to the repository scoped configuration

func (*GoGitRepo) LocalStorage 

func (repo *GoGitRepo) LocalStorage() LocalStorage

LocalStorage returns a billy.Filesystem giving access to $RepoPath/.git/$Namespace.

func (*GoGitRepo) PushRefs 

func (repo *GoGitRepo) PushRefs(remote string, prefixes ...string) (string, error)

PushRefs push git refs matching a directory prefix to a remote Ex: prefix="foo" will push any local refs matching "refs/foo/*" to the remote. The equivalent git refspec would be "refs/foo/*:refs/foo/*"

Additionally, PushRefs will update the local references in refs/remotes/<remote>/foo to match the remote state.

func (*GoGitRepo) ReadCommit 

func (repo *GoGitRepo) ReadCommit(hash Hash) (Commit, error)

func (*GoGitRepo) ReadData 

func (repo *GoGitRepo) ReadData(hash Hash) ([]byte, error)

ReadData will attempt to read arbitrary data from the given hash

func (*GoGitRepo) ReadTree 

func (repo *GoGitRepo) ReadTree(hash Hash) ([]TreeEntry, error)

ReadTree will return the list of entries in a Git tree

func (*GoGitRepo) RefExist 

func (repo *GoGitRepo) RefExist(ref string) (bool, error)

RefExist will check if a reference exist in Git

func (*GoGitRepo) RemoveRef 

func (repo *GoGitRepo) RemoveRef(ref string) error

RemoveRef will remove a Git reference

func (*GoGitRepo) ResolveRef 

func (repo *GoGitRepo) ResolveRef(ref string) (Hash, error)

func (*GoGitRepo) StoreCommit 

func (repo *GoGitRepo) StoreCommit(treeHash Hash, parents ...Hash) (Hash, error)

StoreCommit will store a Git commit with the given Git tree

func (*GoGitRepo) StoreData 

func (repo *GoGitRepo) StoreData(data []byte) (Hash, error)

StoreData will store arbitrary data and return the corresponding hash

func (*GoGitRepo) StoreSignedCommit 

func (repo *GoGitRepo) StoreSignedCommit(treeHash Hash, signKey *openpgp.Entity, parents ...Hash) (Hash, error)

StoreSignedCommit will store a Git commit with the given Git tree. If signKey is not nil, the commit will be signed accordingly.

func (*GoGitRepo) StoreTree 

func (repo *GoGitRepo) StoreTree(mapping []TreeEntry) (Hash, error)

StoreTree will store a mapping key-->Hash as a Git tree

func (*GoGitRepo) UpdateRef 

func (repo *GoGitRepo) UpdateRef(ref string, hash Hash) error

UpdateRef will create or update a Git reference

func (*GoGitRepo) Witness 

func (repo *GoGitRepo) Witness(name string, time lamport.Time) error

Witness is equivalent to c = GetOrCreateClock(name) + c.Witness(time)

type Hash 

type Hash string

Hash is a git hash

func (*Hash) IsValid 

func (h *Hash) IsValid() bool

IsValid tell if the hash is valid

func (Hash) MarshalGQL 

func (h Hash) MarshalGQL(w io.Writer)

MarshalGQL implement the Marshaler interface for gqlgen

func (Hash) String 

func (h Hash) String() string

func (*Hash) UnmarshalGQL 

func (h *Hash) UnmarshalGQL(v interface{}) error

UnmarshalGQL implement the Unmarshaler interface for gqlgen

type Index 

type Index interface {
	// IndexOne indexes one document, for the given ID. If the document already exist,
	// it replaces it.
	IndexOne(id string, texts []string) error

	// IndexBatch start a batch indexing. The returned indexer function is used the same
	// way as IndexOne, and the closer function complete the batch insertion.
	IndexBatch() (indexer func(id string, texts []string) error, closer func() error)

	// Search returns the list of IDs matching the given terms.
	Search(terms []string) (ids []string, err error)

	// DocCount returns the number of document in the index.
	DocCount() (uint64, error)

	// Remove delete one document in the index.
	Remove(id string) error

	// Clear empty the index.
	Clear() error

	// Close closes the index and make sure everything is safely written. After this call
	// the index can't be used anymore.
	Close() error
}

Index is a full-text search index

type Item 

type Item = keyring.Item

type Keyring 

type Keyring interface {
	// Get returns an Item matching the key or ErrKeyringKeyNotFound
	Get(key string) (Item, error)
	// Set stores an Item on the keyring. Set is idempotent.
	Set(item Item) error
	// Remove removes the item with matching key
	Remove(key string) error
	// Keys provides a slice of all keys stored on the keyring
	Keys() ([]string, error)
}

Keyring provides the uniform interface over the underlying backends

type LocalStorage 

type LocalStorage interface {
	billy.Filesystem
	RemoveAll(path string) error
}

type MemConfig 

type MemConfig struct {
	// contains filtered or unexported fields
}

func NewMemConfig 

func NewMemConfig() *MemConfig

func (*MemConfig) ReadAll 

func (mc *MemConfig) ReadAll(keyPrefix string) (map[string]string, error)

func (*MemConfig) ReadBool 

func (mc *MemConfig) ReadBool(key string) (bool, error)

func (*MemConfig) ReadString 

func (mc *MemConfig) ReadString(key string) (string, error)

func (*MemConfig) ReadTimestamp 

func (mc *MemConfig) ReadTimestamp(key string) (time.Time, error)

func (*MemConfig) RemoveAll 

func (mc *MemConfig) RemoveAll(keyPrefix string) error

RemoveAll remove all key/value pair matching the key prefix

func (*MemConfig) StoreBool 

func (mc *MemConfig) StoreBool(key string, value bool) error

func (*MemConfig) StoreString 

func (mc *MemConfig) StoreString(key, value string) error

func (*MemConfig) StoreTimestamp 

func (mc *MemConfig) StoreTimestamp(key string, value time.Time) error

type ObjectType 

type ObjectType int
const (
	Unknown ObjectType = iota
	Blob
	Tree
)

func ParseObjectType 

func ParseObjectType(mode, objType string) (ObjectType, error)

func (ObjectType) Format 

func (ot ObjectType) Format() string

type Repo 

type Repo interface {
	RepoConfig
	RepoKeyring
	RepoCommon
	RepoStorage
	RepoIndex
	RepoData

	Close() error
}

Repo represents a source code repository.

type RepoClock 

type RepoClock interface {
	// AllClocks return all the known clocks
	AllClocks() (map[string]lamport.Clock, error)

	// GetOrCreateClock return a Lamport clock stored in the Repo.
	// If the clock doesn't exist, it's created.
	GetOrCreateClock(name string) (lamport.Clock, error)

	// Increment is equivalent to c = GetOrCreateClock(name) + c.Increment()
	Increment(name string) (lamport.Time, error)

	// Witness is equivalent to c = GetOrCreateClock(name) + c.Witness(time)
	Witness(name string, time lamport.Time) error
}

RepoClock give access to Lamport clocks

type RepoCommon 

type RepoCommon interface {
	// GetUserName returns the name the user has used to configure git
	GetUserName() (string, error)

	// GetUserEmail returns the email address that the user has used to configure git.
	GetUserEmail() (string, error)

	// GetCoreEditor returns the name of the editor that the user has used to configure git.
	GetCoreEditor() (string, error)

	// GetRemotes returns the configured remotes repositories.
	GetRemotes() (map[string]string, error)
}

RepoCommon represent the common function we want all repos to implement

type RepoCommonStorage 

type RepoCommonStorage interface {
	RepoCommon
	RepoStorage
}

type RepoConfig 

type RepoConfig interface {
	// LocalConfig give access to the repository scoped configuration
	LocalConfig() Config

	// GlobalConfig give access to the global scoped configuration
	GlobalConfig() Config

	// AnyConfig give access to a merged local/global configuration
	AnyConfig() ConfigRead
}

RepoConfig access the configuration of a repository

type RepoCreator 

type RepoCreator func(t testing.TB, bare bool) TestedRepo

type RepoData 

type RepoData interface {
	// FetchRefs fetch git refs matching a directory prefix to a remote
	// Ex: prefix="foo" will fetch any remote refs matching "refs/foo/*" locally.
	// The equivalent git refspec would be "refs/foo/*:refs/remotes/<remote>/foo/*"
	FetchRefs(remote string, prefixes ...string) (string, error)

	// PushRefs push git refs matching a directory prefix to a remote
	// Ex: prefix="foo" will push any local refs matching "refs/foo/*" to the remote.
	// The equivalent git refspec would be "refs/foo/*:refs/foo/*"
	//
	// Additionally, PushRefs will update the local references in refs/remotes/<remote>/foo to match
	// the remote state.
	PushRefs(remote string, prefixes ...string) (string, error)

	// StoreData will store arbitrary data and return the corresponding hash
	StoreData(data []byte) (Hash, error)

	// ReadData will attempt to read arbitrary data from the given hash
	// Returns ErrNotFound if not found.
	ReadData(hash Hash) ([]byte, error)

	// StoreTree will store a mapping key-->Hash as a Git tree
	StoreTree(mapping []TreeEntry) (Hash, error)

	// ReadTree will return the list of entries in a Git tree
	// The given hash could be from either a commit or a tree
	// Returns ErrNotFound if not found.
	ReadTree(hash Hash) ([]TreeEntry, error)

	// StoreCommit will store a Git commit with the given Git tree
	StoreCommit(treeHash Hash, parents ...Hash) (Hash, error)

	// StoreSignedCommit will store a Git commit with the given Git tree. If signKey is not nil, the commit
	// will be signed accordingly.
	StoreSignedCommit(treeHash Hash, signKey *openpgp.Entity, parents ...Hash) (Hash, error)

	// ReadCommit read a Git commit and returns some of its characteristic
	// Returns ErrNotFound if not found.
	ReadCommit(hash Hash) (Commit, error)

	// ResolveRef returns the hash of the target commit of the given ref
	// Returns ErrNotFound if not found.
	ResolveRef(ref string) (Hash, error)

	// UpdateRef will create or update a Git reference
	UpdateRef(ref string, hash Hash) error

	// RemoveRef will remove a Git reference
	// RemoveRef is idempotent.
	RemoveRef(ref string) error

	// ListRefs will return a list of Git ref matching the given refspec
	ListRefs(refPrefix string) ([]string, error)

	// RefExist will check if a reference exist in Git
	RefExist(ref string) (bool, error)

	// CopyRef will create a new reference with the same value as another one
	// Returns ErrNotFound if not found.
	CopyRef(source string, dest string) error

	// ListCommits will return the list of tree hashes of a ref, in chronological order
	ListCommits(ref string) ([]Hash, error)
}

RepoData give access to the git data storage

type RepoIndex 

type RepoIndex interface {
	GetIndex(name string) (Index, error)
}

RepoIndex gives access to full-text search indexes

type RepoKeyring 

type RepoKeyring interface {
	// Keyring give access to a user-wide storage for secrets
	Keyring() Keyring
}

RepoKeyring give access to a user-wide storage for secrets

type RepoStorage 

type RepoStorage interface {
	// LocalStorage return a billy.Filesystem giving access to $RepoPath/.git/git-bug
	LocalStorage() LocalStorage
}

RepoStorage give access to the filesystem

type TestedRepo 

type TestedRepo interface {
	ClockedRepo
	// contains filtered or unexported methods
}

TestedRepo is an extended ClockedRepo with function for testing only

func CreateGoGitTestRepo 

func CreateGoGitTestRepo(t testing.TB, bare bool) TestedRepo

func SetupGoGitReposAndRemote 

func SetupGoGitReposAndRemote(t *testing.T) (repoA, repoB, remote TestedRepo)

type TreeEntry 

type TreeEntry struct {
	ObjectType ObjectType
	Hash       Hash
	Name       string
}

func ParseTreeEntry 

func ParseTreeEntry(line string) (TreeEntry, error)

func SearchTreeEntry 

func SearchTreeEntry(entries []TreeEntry, name string) (TreeEntry, bool)

SearchTreeEntry search a TreeEntry by name from an array

func (TreeEntry) Format 

func (entry TreeEntry) Format() string

Format the entry as a git ls-tree compatible line

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.