git-bug: github.com/MichaelMure/git-bug/repository Index | Files

package repository

import "github.com/MichaelMure/git-bug/repository"

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

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

Index

Package Files

config.go config_mem.go config_testing.go git.go git_config.go git_testing.go hash.go mock_repo.go repo.go repo_testing.go tree_entry.go

Variables

var (
    ErrNoConfigEntry       = errors.New("no config entry for the given key")
    ErrMultipleConfigEntry = errors.New("multiple config entry for the given key")
    // ErrNotARepo is the error returned when the git repo root wan'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")
)

func CleanupTestRepos Uses

func CleanupTestRepos(repos ...Repo)

func NewMockRepoForTest Uses

func NewMockRepoForTest() *mockRepoForTest

func ParseTimestamp Uses

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

func RepoTest Uses

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

Test suite for a Repo implementation

type ClockLoader Uses

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 Uses

type ClockedRepo interface {
    Repo

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

ClockedRepo is a Repo that also has Lamport clocks

type Config Uses

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

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

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

    // 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)

    // ReadBool 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)

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

Config represent the common function interacting with the repository config storage

type GitRepo Uses

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

GitRepo represents an instance of a (local) git repository.

func InitBareGitRepo Uses

func InitBareGitRepo(path string) (*GitRepo, error)

InitBareGitRepo create a new --bare empty git repo at the given path

func InitGitRepo Uses

func InitGitRepo(path string) (*GitRepo, error)

InitGitRepo create a new empty git repo at the given path

func NewGitRepo Uses

func NewGitRepo(path string, clockLoaders []ClockLoader) (*GitRepo, error)

NewGitRepo determines if the given working directory is inside of a git repository, and returns the corresponding GitRepo instance if it is.

func (*GitRepo) AddRemote Uses

func (repo *GitRepo) 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 (*GitRepo) CopyRef Uses

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

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

func (*GitRepo) FetchRefs Uses

func (repo *GitRepo) FetchRefs(remote, refSpec string) (string, error)

FetchRefs fetch git refs from a remote

func (*GitRepo) FindCommonAncestor Uses

func (repo *GitRepo) FindCommonAncestor(hash1 Hash, hash2 Hash) (Hash, error)

FindCommonAncestor will return the last common ancestor of two chain of commit

func (*GitRepo) GetCoreEditor Uses

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

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

func (*GitRepo) GetOrCreateClock Uses

func (repo *GitRepo) 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 (*GitRepo) GetPath Uses

func (repo *GitRepo) GetPath() string

GetPath returns the path to the repo.

func (*GitRepo) GetRemotes Uses

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

GetRemotes returns the configured remotes repositories.

func (*GitRepo) GetTreeHash Uses

func (repo *GitRepo) GetTreeHash(commit Hash) (Hash, error)

GetTreeHash return the git tree hash referenced in a commit

func (*GitRepo) GetUserEmail Uses

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

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

func (*GitRepo) GetUserName Uses

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

GetUserName returns the name the the user has used to configure git

func (*GitRepo) GlobalConfig Uses

func (repo *GitRepo) GlobalConfig() Config

GlobalConfig give access to the git global configuration

func (*GitRepo) ListCommits Uses

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

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

func (*GitRepo) ListRefs Uses

func (repo *GitRepo) ListRefs(refspec string) ([]string, error)

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

func (*GitRepo) LocalConfig Uses

func (repo *GitRepo) LocalConfig() Config

LocalConfig give access to the repository scoped configuration

func (*GitRepo) PushRefs Uses

func (repo *GitRepo) PushRefs(remote string, refSpec string) (string, error)

PushRefs push git refs to a remote

func (*GitRepo) ReadData Uses

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

ReadData will attempt to read arbitrary data from the given hash

func (*GitRepo) ReadTree Uses

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

ReadTree will return the list of entries in a Git tree

func (*GitRepo) RefExist Uses

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

RefExist will check if a reference exist in Git

func (*GitRepo) RemoveRef Uses

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

RemoveRef will remove a Git reference

func (*GitRepo) StoreCommit Uses

func (repo *GitRepo) StoreCommit(treeHash Hash) (Hash, error)

StoreCommit will store a Git commit with the given Git tree

func (*GitRepo) StoreCommitWithParent Uses

func (repo *GitRepo) StoreCommitWithParent(treeHash Hash, parent Hash) (Hash, error)

StoreCommitWithParent will store a Git commit with the given Git tree

func (*GitRepo) StoreData Uses

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

StoreData will store arbitrary data and return the corresponding hash

func (*GitRepo) StoreTree Uses

func (repo *GitRepo) StoreTree(entries []TreeEntry) (Hash, error)

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

func (*GitRepo) UpdateRef Uses

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

UpdateRef will create or update a Git reference

type Hash Uses

type Hash string

Hash is a git hash

func (*Hash) IsValid Uses

func (h *Hash) IsValid() bool

IsValid tell if the hash is valid

func (Hash) MarshalGQL Uses

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

MarshalGQL implement the Marshaler interface for gqlgen

func (Hash) String Uses

func (h Hash) String() string

func (*Hash) UnmarshalGQL Uses

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

UnmarshalGQL implement the Unmarshaler interface for gqlgen

type MemConfig Uses

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

func NewMemConfig Uses

func NewMemConfig() *MemConfig

func (*MemConfig) ReadAll Uses

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

func (*MemConfig) ReadBool Uses

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

func (*MemConfig) ReadString Uses

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

func (*MemConfig) ReadTimestamp Uses

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

func (*MemConfig) RemoveAll Uses

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

RmConfigs remove all key/value pair matching the key prefix

func (*MemConfig) StoreBool Uses

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

func (*MemConfig) StoreString Uses

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

func (*MemConfig) StoreTimestamp Uses

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

type ObjectType Uses

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

func ParseObjectType Uses

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

func (ObjectType) Format Uses

func (ot ObjectType) Format() string

type Repo Uses

type Repo interface {
    RepoConfig
    RepoCommon

    // FetchRefs fetch git refs from a remote
    FetchRefs(remote string, refSpec string) (string, error)

    // PushRefs push git refs to a remote
    PushRefs(remote string, refSpec 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
    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
    ReadTree(hash Hash) ([]TreeEntry, error)

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

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

    // GetTreeHash return the git tree hash referenced in a commit
    GetTreeHash(commit Hash) (Hash, error)

    // FindCommonAncestor will return the last common ancestor of two chain of commit
    FindCommonAncestor(commit1 Hash, commit2 Hash) (Hash, error)

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

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

    // ListRefs will return a list of Git ref matching the given refspec
    ListRefs(refspec 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
    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)
}

Repo represents a source code repository.

type RepoCleaner Uses

type RepoCleaner func(repos ...Repo)

type RepoCommon Uses

type RepoCommon interface {
    // GetPath returns the path to the repo.
    GetPath() string

    // GetUserName returns the name the 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 the we want all the repo to implement

type RepoConfig Uses

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

    // GlobalConfig give access to the git global configuration
    GlobalConfig() Config
}

RepoConfig access the configuration of a repository

type RepoCreator Uses

type RepoCreator func(bare bool) TestedRepo

type TestedRepo Uses

type TestedRepo interface {
    ClockedRepo

    // AddRemote add a new remote to the repository
    AddRemote(name string, url string) error
}

TestedRepo is an extended ClockedRepo with function for testing only

func CreateTestRepo Uses

func CreateTestRepo(bare bool) TestedRepo

func SetupReposAndRemote Uses

func SetupReposAndRemote() (repoA, repoB, remote TestedRepo)

type TreeEntry Uses

type TreeEntry struct {
    ObjectType ObjectType
    Hash       Hash
    Name       string
}

func ParseTreeEntry Uses

func ParseTreeEntry(line string) (TreeEntry, error)

func (TreeEntry) Format Uses

func (entry TreeEntry) Format() string

Format the entry as a git ls-tree compatible line

Package repository imports 22 packages (graph) and is imported by 14 packages. Updated 2020-07-14. Refresh now. Tools for package owners.