---
type: change
description: |-
Completely refactor naming of everything, in light of new SPEC
Writing the SPEC shed some light on just how weakly a lot of concepts, like
"commit", had been defined, and prompted the delineation of a lot of things
along specific lines (commit vs payload, repo vs project). This commit makes the
code reflect the SPEC much better in quite a few ways:
* Repo is now Project
* Commit is now Payload
* GitCommit is now just Commit
* Hash is now Fingerprint
* A lot of minor fields got renamed
* All the XXXInterface types are now just XXX, and their old XXX type is now
XXXUnion.
More than likely there's still some comments and variable names that have
slipped passed, but overall I feel like I got most of the changes.
fingerprint: AKkDC5BKhKbfXzZQ/F4KquHeMgVvcNxgLmkZFz/nP/tY
credentials:
- type: pgp_signature
pub_key_id: 95C46FA6A41148AC
body: iQIzBAABAgAdFiEEJ6tQKp6olvZKJ0lwlcRvpqQRSKwFAl6l7aYACgkQlcRvpqQRSKxFrA//VQ+f8B6pwGS3ORB4VVBnHvvJTGZvAYTvB0fHuHJx2EreR4FwjhaNakk5ClkwbO7WFMq++2OV4xIkvzwswLdbXZF0IHx3wScQM59v4vIkR4V9Lj5p1aGGhQna52uIKugF2gTqKdU4tqYzmBjDND/c2XDwCN5CwTwwnAHXUSSsHxviiPUYPWV5wzFP7uyRW0ZeK8Isv7QECKRXlsDjcSJa+g+jc091FG/jG9Dkai8fbDbW8YXj7W3ALaXgXWEBJMrgQxZcJJRjgCvLY72FIIrUBquu3FepiyzMtZ0yaIvi4NmGCsYqIv00NcMvMtD7iwhOCZn10Sku4wvaKJ8YBMRduhqC99fnr/ZDW0/HvTNcL7GKx11GjwtmzkJgwsHFPy3zX+kMdF4m3WgtoeI0GwEsBXXZE2C49yAk3Mb/3puegl3a1PPMvOabTzo7Xm6xpWkI6gISChI7My71H3EuKZWhkb+IubPmMvJJXIdVxHnsHPz2dl/BZXLgpfVdEgQa2qWeXtYI4NNm37pLl3gv92V4kka+Kr4gfdoq8mJ7aqvc9was35baJbHg4+fEVJG2Wj+2AQU+ncx3nAFzgYyMxwo9K8VuC4QdfRF4ImyxTnWkuokEn9H6JRrbkBDKIELj6vzdPmsjOUEQ4nsYX66/zSibFD7UvhQmdXFs8Gp8/Qq6g4M=
account: mediocregopher
main
mediocregopher
4 years ago
committed by
Brian Picciano
parent
351048e9aa
commit
b01fe1524a
@ -1,610 +1,222 @@ |
|||||||
package dehub |
package dehub |
||||||
|
|
||||||
import ( |
import ( |
||||||
"bytes" |
"encoding/hex" |
||||||
"encoding/base64" |
|
||||||
"errors" |
"errors" |
||||||
"fmt" |
"fmt" |
||||||
"reflect" |
"path/filepath" |
||||||
"sort" |
|
||||||
"strings" |
"strings" |
||||||
"time" |
|
||||||
|
|
||||||
"dehub.dev/src/dehub.git/accessctl" |
|
||||||
"dehub.dev/src/dehub.git/fs" |
|
||||||
"dehub.dev/src/dehub.git/sigcred" |
|
||||||
"dehub.dev/src/dehub.git/typeobj" |
|
||||||
|
|
||||||
"gopkg.in/src-d/go-git.v4" |
|
||||||
"gopkg.in/src-d/go-git.v4/plumbing" |
"gopkg.in/src-d/go-git.v4/plumbing" |
||||||
"gopkg.in/src-d/go-git.v4/plumbing/object" |
"gopkg.in/src-d/go-git.v4/plumbing/object" |
||||||
yaml "gopkg.in/yaml.v2" |
|
||||||
) |
) |
||||||
|
|
||||||
// CommitInterface describes the methods which must be implemented by the
|
// Commit wraps a single git commit object, and also contains various fields
|
||||||
// different commit types. None of the methods should modify the underlying
|
// which are parsed out of it, including the payload. It is used as a
|
||||||
// object.
|
// convenience type, in place of having to manually retrieve and parse specific
|
||||||
type CommitInterface interface { |
// information out of commit objects.
|
||||||
// MessageHead returns the head of the commit message (i.e. the first line).
|
|
||||||
// The CommitCommon of the outer Commit is passed in for added context, if
|
|
||||||
// necessary.
|
|
||||||
MessageHead(CommitCommon) (string, error) |
|
||||||
|
|
||||||
// ExpectedHash returns the raw hash which Signifiers can sign to accredit
|
|
||||||
// this commit. The ChangedFile objects given describe the file changes
|
|
||||||
// between the parent commit and this commit.
|
|
||||||
ExpectedHash([]ChangedFile) ([]byte, error) |
|
||||||
|
|
||||||
// StoredHash returns the signable Hash embedded in the commit, which should
|
|
||||||
// hopefully correspond to the ExpectedHash.
|
|
||||||
StoredHash() []byte |
|
||||||
} |
|
||||||
|
|
||||||
// CommitCommon describes the fields common to all Commit objects.
|
|
||||||
type CommitCommon struct { |
|
||||||
// Credentials represent all created Credentials for this commit, and can be
|
|
||||||
// set on all Commit objects regardless of other fields being set.
|
|
||||||
Credentials []sigcred.Credential `yaml:"credentials"` |
|
||||||
} |
|
||||||
|
|
||||||
func (cc CommitCommon) credIDs() []string { |
|
||||||
m := map[string]struct{}{} |
|
||||||
for _, cred := range cc.Credentials { |
|
||||||
if cred.AccountID != "" { |
|
||||||
m[cred.AccountID] = struct{}{} |
|
||||||
} else if cred.AnonID != "" { |
|
||||||
m[cred.AnonID] = struct{}{} |
|
||||||
} |
|
||||||
} |
|
||||||
s := make([]string, 0, len(m)) |
|
||||||
for id := range m { |
|
||||||
s = append(s, id) |
|
||||||
} |
|
||||||
sort.Strings(s) |
|
||||||
return s |
|
||||||
} |
|
||||||
|
|
||||||
func abbrevCommitMessage(msg string) string { |
|
||||||
i := strings.Index(msg, "\n") |
|
||||||
if i > 0 { |
|
||||||
msg = msg[:i] |
|
||||||
} |
|
||||||
if len(msg) > 80 { |
|
||||||
msg = msg[:80] + "..." |
|
||||||
} |
|
||||||
return msg |
|
||||||
} |
|
||||||
|
|
||||||
// Commit represents a single Commit which is being added to a branch. Only one
|
|
||||||
// field should be set on a Commit, unless otherwise noted.
|
|
||||||
type Commit struct { |
type Commit struct { |
||||||
Change *CommitChange `type:"change,default"` |
Payload PayloadUnion |
||||||
Credential *CommitCredential `type:"credential"` |
|
||||||
Comment *CommitComment `type:"comment"` |
|
||||||
|
|
||||||
Common CommitCommon `yaml:",inline"` |
|
||||||
} |
|
||||||
|
|
||||||
// MarshalYAML implements the yaml.Marshaler interface.
|
|
||||||
func (c Commit) MarshalYAML() (interface{}, error) { |
|
||||||
return typeobj.MarshalYAML(c) |
|
||||||
} |
|
||||||
|
|
||||||
// UnmarshalYAML implements the yaml.Unmarshaler interface.
|
|
||||||
func (c *Commit) UnmarshalYAML(unmarshal func(interface{}) error) error { |
|
||||||
return typeobj.UnmarshalYAML(c, unmarshal) |
|
||||||
} |
|
||||||
|
|
||||||
// Interface returns the CommitInterface instance encapsulated by this Commit
|
|
||||||
// object.
|
|
||||||
func (c Commit) Interface() (CommitInterface, error) { |
|
||||||
el, _, err := typeobj.Element(c) |
|
||||||
if err != nil { |
|
||||||
return nil, err |
|
||||||
} |
|
||||||
return el.(CommitInterface), nil |
|
||||||
} |
|
||||||
|
|
||||||
// Type returns the Commit's type (as would be used in its YAML "type" field).
|
|
||||||
func (c Commit) Type() (string, error) { |
|
||||||
_, typeStr, err := typeobj.Element(c) |
|
||||||
if err != nil { |
|
||||||
return "", err |
|
||||||
} |
|
||||||
return typeStr, nil |
|
||||||
} |
|
||||||
|
|
||||||
// MarshalText implements the encoding.TextMarshaler interface by returning the
|
|
||||||
// form the Commit object takes in the git commit message.
|
|
||||||
func (c Commit) MarshalText() ([]byte, error) { |
|
||||||
commitInt, err := c.Interface() |
|
||||||
if err != nil { |
|
||||||
return nil, fmt.Errorf("could not cast Commit %+v to interface : %w", c, err) |
|
||||||
} |
|
||||||
|
|
||||||
msgHead, err := commitInt.MessageHead(c.Common) |
|
||||||
if err != nil { |
|
||||||
return nil, fmt.Errorf("error constructing message head: %w", err) |
|
||||||
} |
|
||||||
|
|
||||||
msgBodyB, err := yaml.Marshal(c) |
|
||||||
if err != nil { |
|
||||||
return nil, fmt.Errorf("error marshaling commit %+v as yaml: %w", c, err) |
|
||||||
} |
|
||||||
|
|
||||||
w := new(bytes.Buffer) |
Hash plumbing.Hash |
||||||
w.WriteString(msgHead) |
Object *object.Commit |
||||||
w.WriteString("\n\n---\n") |
TreeObject *object.Tree |
||||||
w.Write(msgBodyB) |
|
||||||
return w.Bytes(), nil |
|
||||||
} |
} |
||||||
|
|
||||||
// UnmarshalText implements the encoding.TextUnmarshaler interface by decoding a
|
// GetCommit retrieves the Commit at the given hash, and all of its sub-data
|
||||||
// Commit object which has been encoded into a git commit message.
|
// which can be pulled out of it.
|
||||||
func (c *Commit) UnmarshalText(msg []byte) error { |
func (proj *Project) GetCommit(h plumbing.Hash) (c Commit, err error) { |
||||||
i := bytes.Index(msg, []byte("\n")) |
if c.Object, err = proj.GitRepo.CommitObject(h); err != nil { |
||||||
if i < 0 { |
return c, fmt.Errorf("getting git commit object: %w", err) |
||||||
return fmt.Errorf("commit message %q is malformed, it has no body", msg) |
} else if c.TreeObject, err = proj.GitRepo.TreeObject(c.Object.TreeHash); err != nil { |
||||||
|
return c, fmt.Errorf("getting git tree object %q: %w", |
||||||
|
c.Object.TreeHash, err) |
||||||
|
} else if c.Payload.UnmarshalText([]byte(c.Object.Message)); err != nil { |
||||||
|
return c, fmt.Errorf("decoding commit message: %w", err) |
||||||
} |
} |
||||||
msgBody := msg[i:] |
c.Hash = c.Object.Hash |
||||||
|
return |
||||||
if err := yaml.Unmarshal(msgBody, c); err != nil { |
|
||||||
return fmt.Errorf("could not unmarshal Commit message from yaml: %w", err) |
|
||||||
|
|
||||||
} else if reflect.DeepEqual(*c, Commit{}) { |
|
||||||
// a basic check, but worthwhile
|
|
||||||
return errors.New("commit message is malformed, could not unmarshal yaml object") |
|
||||||
} |
|
||||||
|
|
||||||
return nil |
|
||||||
} |
} |
||||||
|
|
||||||
// AccreditCommit returns the given Commit with an appended Credential provided
|
// ErrHeadIsZero is used to indicate that HEAD resolves to the zero hash. An
|
||||||
// by the given SignifierInterface.
|
// example of when this can happen is if the project was just initialized and
|
||||||
func (r *Repo) AccreditCommit(commit Commit, sigInt sigcred.SignifierInterface) (Commit, error) { |
// has no commits, or if an orphan branch is checked out.
|
||||||
commitInt, err := commit.Interface() |
var ErrHeadIsZero = errors.New("HEAD resolves to the zero hash") |
||||||
if err != nil { |
|
||||||
return commit, fmt.Errorf("could not cast commit %+v to interface: %w", commit, err) |
|
||||||
} |
|
||||||
|
|
||||||
headFS, err := r.headFS() |
// GetHeadCommit returns the Commit which is currently referenced by HEAD.
|
||||||
|
// This method may return ErrHeadIsZero if HEAD resolves to the zero hash.
|
||||||
|
func (proj *Project) GetHeadCommit() (Commit, error) { |
||||||
|
headHash, err := proj.ReferenceToHash(plumbing.HEAD) |
||||||
if err != nil { |
if err != nil { |
||||||
return commit, fmt.Errorf("could not grab snapshot of HEAD fs: %w", err) |
return Commit{}, fmt.Errorf("resolving HEAD: %w", err) |
||||||
|
} else if headHash == plumbing.ZeroHash { |
||||||
|
return Commit{}, ErrHeadIsZero |
||||||
} |
} |
||||||
|
|
||||||
cred, err := sigInt.Sign(headFS, commitInt.StoredHash()) |
c, err := proj.GetCommit(headHash) |
||||||
if err != nil { |
if err != nil { |
||||||
return commit, fmt.Errorf("could not accredit change commit: %w", err) |
return Commit{}, fmt.Errorf("getting commit %q: %w", headHash, err) |
||||||
} |
} |
||||||
commit.Common.Credentials = append(commit.Common.Credentials, cred) |
return c, nil |
||||||
return commit, nil |
|
||||||
} |
} |
||||||
|
|
||||||
// CommitBareParams are the parameters to the CommitBare method. All are
|
// GetCommitRange returns an ancestry of Commits, with the first being the
|
||||||
// required, unless otherwise noted.
|
// commit immediately following the given starting hash, and the last being the
|
||||||
type CommitBareParams struct { |
// given ending hash.
|
||||||
Commit Commit |
//
|
||||||
Author string |
// If start is plumbing.ZeroHash then the root commit will be the starting hash.
|
||||||
ParentHash plumbing.Hash // can be zero if the commit has no parents (Q_Q)
|
func (proj *Project) GetCommitRange(start, end plumbing.Hash) ([]Commit, error) { |
||||||
GitTree *object.Tree |
curr, err := proj.GetCommit(end) |
||||||
} |
|
||||||
|
|
||||||
// CommitBare constructs a git commit object and and stores it, returning the
|
|
||||||
// resulting GitCommit. This method does not interact with HEAD at all.
|
|
||||||
func (r *Repo) CommitBare(params CommitBareParams) (GitCommit, error) { |
|
||||||
msgB, err := params.Commit.MarshalText() |
|
||||||
if err != nil { |
|
||||||
return GitCommit{}, fmt.Errorf("encoding %T to message string: %w", |
|
||||||
params.Commit, err) |
|
||||||
} |
|
||||||
|
|
||||||
author := object.Signature{ |
|
||||||
Name: params.Author, |
|
||||||
When: time.Now(), |
|
||||||
} |
|
||||||
commit := &object.Commit{ |
|
||||||
Author: author, |
|
||||||
Committer: author, |
|
||||||
Message: string(msgB), |
|
||||||
TreeHash: params.GitTree.Hash, |
|
||||||
} |
|
||||||
if params.ParentHash != plumbing.ZeroHash { |
|
||||||
commit.ParentHashes = []plumbing.Hash{params.ParentHash} |
|
||||||
} |
|
||||||
|
|
||||||
commitObj := r.GitRepo.Storer.NewEncodedObject() |
|
||||||
if err := commit.Encode(commitObj); err != nil { |
|
||||||
return GitCommit{}, fmt.Errorf("encoding commit object: %w", err) |
|
||||||
} |
|
||||||
|
|
||||||
commitHash, err := r.GitRepo.Storer.SetEncodedObject(commitObj) |
|
||||||
if err != nil { |
if err != nil { |
||||||
return GitCommit{}, fmt.Errorf("setting encoded object: %w", err) |
return nil, fmt.Errorf("retrieving commit %q: %w", end, err) |
||||||
} |
} |
||||||
|
|
||||||
return r.GetGitCommit(commitHash) |
var commits []Commit |
||||||
} |
var found bool |
||||||
|
for { |
||||||
// Commit uses the given Commit to create a git commit object and commits it to
|
if found = start != plumbing.ZeroHash && curr.Hash == start; found { |
||||||
// the current HEAD, returning the full GitCommit.
|
break |
||||||
func (r *Repo) Commit(commit Commit) (GitCommit, error) { |
} |
||||||
headRef, err := r.TraverseReferenceChain(plumbing.HEAD, func(ref *plumbing.Reference) bool { |
|
||||||
return ref.Type() == plumbing.HashReference |
|
||||||
}) |
|
||||||
if err != nil { |
|
||||||
return GitCommit{}, fmt.Errorf("resolving HEAD to a hash reference: %w", err) |
|
||||||
} |
|
||||||
headRefName := headRef.Name() |
|
||||||
|
|
||||||
headHash, err := r.ReferenceToHash(headRefName) |
commits = append(commits, curr) |
||||||
if err != nil { |
numParents := curr.Object.NumParents() |
||||||
return GitCommit{}, fmt.Errorf("resolving ref %q (HEAD): %w", headRefName, err) |
if numParents == 0 { |
||||||
} |
break |
||||||
|
} else if numParents > 1 { |
||||||
|
return nil, fmt.Errorf("commit %q has more than one parent: %+v", |
||||||
|
curr.Hash, curr.Object.ParentHashes) |
||||||
|
} |
||||||
|
|
||||||
// TODO this is also used in the same way in NewCommitChange. It might make
|
parentHash := curr.Object.ParentHashes[0] |
||||||
// sense to refactor this logic out, it might not be needed in fs at all.
|
parent, err := proj.GetCommit(parentHash) |
||||||
_, stagedTree, err := fs.FromStagedChangesTree(r.GitRepo) |
if err != nil { |
||||||
if err != nil { |
return nil, fmt.Errorf("retrieving commit %q: %w", parentHash, err) |
||||||
return GitCommit{}, fmt.Errorf("getting staged changes: %w", err) |
} |
||||||
|
curr = parent |
||||||
} |
} |
||||||
|
if !found && start != plumbing.ZeroHash { |
||||||
gitCommit, err := r.CommitBare(CommitBareParams{ |
return nil, fmt.Errorf("unable to find commit %q as an ancestor of %q", |
||||||
Commit: commit, |
start, end) |
||||||
Author: strings.Join(commit.Common.credIDs(), ", "), |
|
||||||
ParentHash: headHash, |
|
||||||
GitTree: stagedTree, |
|
||||||
}) |
|
||||||
if err != nil { |
|
||||||
return GitCommit{}, err |
|
||||||
} |
} |
||||||
|
|
||||||
// now set the branch to this new commit
|
// reverse the commits to be in the expected order
|
||||||
newHeadRef := plumbing.NewHashReference(headRefName, gitCommit.GitCommit.Hash) |
for l, r := 0, len(commits)-1; l < r; l, r = l+1, r-1 { |
||||||
if err := r.GitRepo.Storer.SetReference(newHeadRef); err != nil { |
commits[l], commits[r] = commits[r], commits[l] |
||||||
return GitCommit{}, fmt.Errorf("setting reference %q to new commit hash %q: %w", |
|
||||||
headRefName, gitCommit.GitCommit.Hash, err) |
|
||||||
} |
} |
||||||
|
return commits, nil |
||||||
return gitCommit, nil |
|
||||||
} |
} |
||||||
|
|
||||||
// HasStagedChanges returns true if there are file changes which have been
|
var ( |
||||||
// staged (e.g. via "git add").
|
hashStrLen = len(plumbing.ZeroHash.String()) |
||||||
func (r *Repo) HasStagedChanges() (bool, error) { |
errNotHex = errors.New("not a valid hex string") |
||||||
w, err := r.GitRepo.Worktree() |
) |
||||||
if err != nil { |
|
||||||
return false, fmt.Errorf("error retrieving worktree: %w", err) |
|
||||||
} |
|
||||||
|
|
||||||
status, err := w.Status() |
|
||||||
if err != nil { |
|
||||||
return false, fmt.Errorf("error retrieving worktree status: %w", err) |
|
||||||
} |
|
||||||
|
|
||||||
var any bool |
func (proj *Project) findCommitByShortHash(hashStr string) (plumbing.Hash, error) { |
||||||
for _, fileStatus := range status { |
paddedHashStr := hashStr |
||||||
if fileStatus.Staging != git.Unmodified && |
if len(hashStr)%2 > 0 { |
||||||
fileStatus.Staging != git.Untracked { |
paddedHashStr += "0" |
||||||
any = true |
|
||||||
break |
|
||||||
} |
|
||||||
} |
} |
||||||
return any, nil |
|
||||||
} |
|
||||||
|
|
||||||
// VerifyCommits verifies that the given commits, which are presumably on the
|
if hashB, err := hex.DecodeString(paddedHashStr); err != nil { |
||||||
// given branch, are gucci.
|
return plumbing.ZeroHash, errNotHex |
||||||
func (r *Repo) VerifyCommits(branchName plumbing.ReferenceName, gitCommits []GitCommit) error { |
} else if len(hashStr) == hashStrLen { |
||||||
// this isn't strictly necessary for this method, but it helps discover bugs
|
var hash plumbing.Hash |
||||||
// in other parts of the code.
|
copy(hash[:], hashB) |
||||||
if len(gitCommits) == 0 { |
return hash, nil |
||||||
return errors.New("cannot call VerifyCommits with empty commit slice") |
} else if len(hashStr) < 2 { |
||||||
|
return plumbing.ZeroHash, errors.New("hash string must be 2 characters long or more") |
||||||
} |
} |
||||||
|
|
||||||
// First determine the root of the main branch. All commits need to be an
|
for i := 2; i < hashStrLen; i++ { |
||||||
// ancestor of it. If the main branch has not been created yet then there
|
hashPrefix, hashTail := hashStr[:i], hashStr[i:] |
||||||
// might not be a root commit yet.
|
path := filepath.Join("objects", hashPrefix) |
||||||
var rootCommit *object.Commit |
fileInfos, err := proj.GitDirFS.ReadDir(path) |
||||||
mainGitCommit, err := r.GetGitRevision(plumbing.Revision(MainRefName)) |
if err != nil { |
||||||
if errors.Is(err, plumbing.ErrReferenceNotFound) { |
return plumbing.ZeroHash, fmt.Errorf("listing files in %q: %w", path, err) |
||||||
|
|
||||||
// main branch hasn't been created yet. The commits can only be verified
|
|
||||||
// if they are for the main branch and they include the root commit.
|
|
||||||
if branchName != MainRefName { |
|
||||||
return fmt.Errorf("cannot verify commits in branch %q when no main branch exists", branchName) |
|
||||||
} |
|
||||||
|
|
||||||
for _, gitCommit := range gitCommits { |
|
||||||
if gitCommit.GitCommit.NumParents() == 0 { |
|
||||||
rootCommit = gitCommit.GitCommit |
|
||||||
break |
|
||||||
} |
|
||||||
} |
|
||||||
if rootCommit == nil { |
|
||||||
return errors.New("root commit of main branch cannot be determined") |
|
||||||
} |
} |
||||||
|
|
||||||
} else if err != nil { |
var matchedHash plumbing.Hash |
||||||
return fmt.Errorf("retrieving commit at HEAD of %q: %w", MainRefName.Short(), err) |
for _, fileInfo := range fileInfos { |
||||||
|
objFileName := fileInfo.Name() |
||||||
} else { |
if !strings.HasPrefix(objFileName, hashTail) { |
||||||
rootCommit = mainGitCommit.GitCommit |
continue |
||||||
for { |
|
||||||
if rootCommit.NumParents() == 0 { |
|
||||||
break |
|
||||||
} else if rootCommit.NumParents() > 1 { |
|
||||||
return fmt.Errorf("commit %q in main branch has more than one parent", rootCommit.Hash) |
|
||||||
} else if rootCommit, err = rootCommit.Parent(0); err != nil { |
|
||||||
return fmt.Errorf("retrieving parent commit of %q: %w", rootCommit.Hash, err) |
|
||||||
} |
} |
||||||
} |
|
||||||
} |
|
||||||
|
|
||||||
// We also need the HEAD of the given branch, if it exists.
|
|
||||||
branchGitCommit, err := r.GetGitRevision(plumbing.Revision(branchName)) |
|
||||||
if err != nil && !errors.Is(err, plumbing.ErrReferenceNotFound) { |
|
||||||
return fmt.Errorf("retrieving commit at HEAD of %q: %w", branchName.Short(), err) |
|
||||||
} |
|
||||||
|
|
||||||
for i, gitCommit := range gitCommits { |
|
||||||
// It's not a requirement that the given GitCommits are in ancestral
|
|
||||||
// order, but usually they are; if the previous commit is the parent of
|
|
||||||
// this one we can skip a bunch of work.
|
|
||||||
var parentTree *object.Tree |
|
||||||
var isNonFF bool |
|
||||||
if i > 0 && gitCommits[i-1].GitCommit.Hash == gitCommit.GitCommit.ParentHashes[0] { |
|
||||||
parentTree = gitCommits[i-1].GitTree |
|
||||||
|
|
||||||
} else if gitCommit.GitCommit.Hash == rootCommit.Hash { |
|
||||||
// looking at the root commit, assume it's ok
|
|
||||||
|
|
||||||
} else { |
|
||||||
var err error |
|
||||||
isAncestor := func(older, younger *object.Commit) bool { |
|
||||||
var isAncestor bool |
|
||||||
if err != nil { |
|
||||||
return false |
|
||||||
} else if isAncestor, err = older.IsAncestor(younger); err != nil { |
|
||||||
err = fmt.Errorf("determining if %q is an ancestor of %q: %w", |
|
||||||
younger.Hash, older.Hash, err) |
|
||||||
return false |
|
||||||
|
|
||||||
} |
objHash := plumbing.NewHash(hashPrefix + objFileName) |
||||||
return isAncestor |
obj, err := proj.GitRepo.Storer.EncodedObject(plumbing.AnyObject, objHash) |
||||||
} |
if err != nil { |
||||||
|
return plumbing.ZeroHash, fmt.Errorf("reading object %q off disk: %w", objHash, err) |
||||||
|
} else if obj.Type() != plumbing.CommitObject { |
||||||
|
continue |
||||||
|
|
||||||
ancestorOfRoot := isAncestor(rootCommit, gitCommit.GitCommit) |
} else if matchedHash == plumbing.ZeroHash { |
||||||
if branchGitCommit.GitCommit != nil { |
matchedHash = objHash |
||||||
// if the branch doesn't actually exist then this couldn't
|
continue |
||||||
// possibly be a nonFF
|
|
||||||
isNonFF = !isAncestor(branchGitCommit.GitCommit, gitCommit.GitCommit) |
|
||||||
} |
} |
||||||
|
|
||||||
if err != nil { |
return plumbing.ZeroHash, fmt.Errorf("both %q and %q match", matchedHash, objHash) |
||||||
return err |
|
||||||
} else if !ancestorOfRoot { |
|
||||||
return fmt.Errorf("commit %q must be direct descendant of root commit of %q (%q)", |
|
||||||
gitCommit.GitCommit.Hash, MainRefName.Short(), rootCommit.Hash, |
|
||||||
) |
|
||||||
} |
|
||||||
} |
} |
||||||
|
|
||||||
if err := r.verifyCommit(branchName, gitCommit, parentTree, isNonFF); err != nil { |
if matchedHash != plumbing.ZeroHash { |
||||||
return fmt.Errorf("verifying commit %q: %w", |
return matchedHash, nil |
||||||
gitCommit.GitCommit.Hash, err) |
|
||||||
} |
} |
||||||
} |
} |
||||||
return nil |
|
||||||
} |
|
||||||
|
|
||||||
// parentTree returns the tree of the parent commit of the given commit. If the
|
return plumbing.ZeroHash, errors.New("failed to find a commit object with a matching prefix") |
||||||
// given commit has no parents then a bare tree is returned.
|
|
||||||
func (r *Repo) parentTree(commitObj *object.Commit) (*object.Tree, error) { |
|
||||||
switch commitObj.NumParents() { |
|
||||||
case 0: |
|
||||||
return new(object.Tree), nil |
|
||||||
case 1: |
|
||||||
if parentCommitObj, err := commitObj.Parent(0); err != nil { |
|
||||||
return nil, fmt.Errorf("getting parent commit %q: %w", |
|
||||||
commitObj.ParentHashes[0], err) |
|
||||||
} else if parentTree, err := r.GitRepo.TreeObject(parentCommitObj.TreeHash); err != nil { |
|
||||||
return nil, fmt.Errorf("getting parent tree object %q: %w", |
|
||||||
parentCommitObj.TreeHash, err) |
|
||||||
} else { |
|
||||||
return parentTree, nil |
|
||||||
} |
|
||||||
default: |
|
||||||
return nil, errors.New("commit has multiple parents") |
|
||||||
} |
|
||||||
} |
} |
||||||
|
|
||||||
// if parentTree is nil then it will be inferred.
|
func (proj *Project) resolveRev(rev plumbing.Revision) (plumbing.Hash, error) { |
||||||
func (r *Repo) verifyCommit( |
if rev == plumbing.Revision(plumbing.ZeroHash.String()) { |
||||||
branchName plumbing.ReferenceName, |
return plumbing.ZeroHash, nil |
||||||
gitCommit GitCommit, |
|
||||||
parentTree *object.Tree, |
|
||||||
isNonFF bool, |
|
||||||
) error { |
|
||||||
parentTree, err := r.parentTree(gitCommit.GitCommit) |
|
||||||
if err != nil { |
|
||||||
return fmt.Errorf("retrieving parent tree of commit: %w", err) |
|
||||||
} |
|
||||||
|
|
||||||
var sigFS fs.FS |
|
||||||
if gitCommit.Root() { |
|
||||||
sigFS = fs.FromTree(gitCommit.GitTree) |
|
||||||
} else { |
|
||||||
sigFS = fs.FromTree(parentTree) |
|
||||||
} |
|
||||||
|
|
||||||
cfg, err := r.loadConfig(sigFS) |
|
||||||
if err != nil { |
|
||||||
return fmt.Errorf("loading config of parent %q: %w", |
|
||||||
gitCommit.GitCommit.ParentHashes[0], err) |
|
||||||
} |
|
||||||
|
|
||||||
// assert access controls
|
|
||||||
changedFiles, err := ChangedFilesBetweenTrees(parentTree, gitCommit.GitTree) |
|
||||||
if err != nil { |
|
||||||
return fmt.Errorf("calculating diff from tree %q to tree %q: %w", |
|
||||||
parentTree.Hash, gitCommit.GitTree.Hash, err) |
|
||||||
|
|
||||||
} else if len(changedFiles) > 0 && gitCommit.Commit.Change == nil { |
|
||||||
return errors.New("files changes but commit is not a change commit") |
|
||||||
} |
|
||||||
|
|
||||||
pathsChanged := make([]string, len(changedFiles)) |
|
||||||
for i := range changedFiles { |
|
||||||
pathsChanged[i] = changedFiles[i].Path |
|
||||||
} |
|
||||||
|
|
||||||
commitType, err := gitCommit.Commit.Type() |
|
||||||
if err != nil { |
|
||||||
return fmt.Errorf("determining type of commit %+v: %w", gitCommit.Commit, err) |
|
||||||
} |
|
||||||
|
|
||||||
err = accessctl.AssertCanCommit(cfg.AccessControls, accessctl.CommitRequest{ |
|
||||||
Type: commitType, |
|
||||||
Branch: branchName.Short(), |
|
||||||
Credentials: gitCommit.Commit.Common.Credentials, |
|
||||||
FilesChanged: pathsChanged, |
|
||||||
NonFastForward: isNonFF, |
|
||||||
}) |
|
||||||
if err != nil { |
|
||||||
return fmt.Errorf("asserting access controls: %w", err) |
|
||||||
} |
|
||||||
|
|
||||||
// ensure the hash is what it's expected to be
|
|
||||||
storedCommitHash := gitCommit.Interface.StoredHash() |
|
||||||
expectedCommitHash, err := gitCommit.Interface.ExpectedHash(changedFiles) |
|
||||||
if err != nil { |
|
||||||
return fmt.Errorf("calculating expected commit hash: %w", err) |
|
||||||
} else if !bytes.Equal(storedCommitHash, expectedCommitHash) { |
|
||||||
return fmt.Errorf("unexpected hash in commit body, is %s but should be %s", |
|
||||||
base64.StdEncoding.EncodeToString(storedCommitHash), |
|
||||||
base64.StdEncoding.EncodeToString(expectedCommitHash)) |
|
||||||
} |
} |
||||||
|
|
||||||
// verify all credentials
|
{ |
||||||
for _, cred := range gitCommit.Commit.Common.Credentials { |
// pretend the revision is a short hash until proven otherwise
|
||||||
if cred.AccountID == "" { |
shortHash := string(rev) |
||||||
if err := cred.SelfVerify(expectedCommitHash); err != nil { |
hash, err := proj.findCommitByShortHash(shortHash) |
||||||
return fmt.Errorf("verifying credential %+v: %w", cred, err) |
if errors.Is(err, errNotHex) { |
||||||
} |
// ok, continue
|
||||||
|
} else if err != nil { |
||||||
|
return plumbing.ZeroHash, fmt.Errorf("resolving as short hash: %w", err) |
||||||
} else { |
} else { |
||||||
sig, err := r.signifierForCredential(sigFS, cred) |
// guess it _is_ a short hash, knew it!
|
||||||
if err != nil { |
return hash, nil |
||||||
return fmt.Errorf("finding signifier for credential %+v: %w", cred, err) |
|
||||||
} else if err := sig.Verify(sigFS, expectedCommitHash, cred); err != nil { |
|
||||||
return fmt.Errorf("verifying credential %+v: %w", cred, err) |
|
||||||
} |
|
||||||
} |
} |
||||||
} |
} |
||||||
|
|
||||||
return nil |
h, err := proj.GitRepo.ResolveRevision(rev) |
||||||
} |
|
||||||
|
|
||||||
type changeRangeInfo struct { |
|
||||||
changeCommits []GitCommit |
|
||||||
authors map[string]struct{} |
|
||||||
msg string |
|
||||||
startTree, endTree *object.Tree |
|
||||||
changeHash []byte |
|
||||||
} |
|
||||||
|
|
||||||
// changeRangeInfo returns various pieces of information about a range of
|
|
||||||
// commits' changes.
|
|
||||||
func (r *Repo) changeRangeInfo(commits []GitCommit) (changeRangeInfo, error) { |
|
||||||
info := changeRangeInfo{ |
|
||||||
authors: map[string]struct{}{}, |
|
||||||
} |
|
||||||
|
|
||||||
for _, commit := range commits { |
|
||||||
if _, ok := commit.Interface.(*CommitChange); ok { |
|
||||||
info.changeCommits = append(info.changeCommits, commit) |
|
||||||
for _, cred := range commit.Commit.Common.Credentials { |
|
||||||
info.authors[cred.AccountID] = struct{}{} |
|
||||||
} |
|
||||||
} |
|
||||||
} |
|
||||||
if len(info.changeCommits) == 0 { |
|
||||||
return changeRangeInfo{}, errors.New("no change commits found") |
|
||||||
} |
|
||||||
|
|
||||||
// startTree has to be the tree of the parent of the first commit, which
|
|
||||||
// isn't included in commits. Determine it the hard way.
|
|
||||||
var err error |
|
||||||
if info.startTree, err = r.parentTree(commits[0].GitCommit); err != nil { |
|
||||||
return changeRangeInfo{}, fmt.Errorf("getting tree of parent of %q: %w", |
|
||||||
commits[0].GitCommit.Hash, err) |
|
||||||
} |
|
||||||
|
|
||||||
lastChangeCommit := info.changeCommits[len(info.changeCommits)-1] |
|
||||||
info.msg = lastChangeCommit.Commit.Change.Message |
|
||||||
info.endTree = lastChangeCommit.GitTree |
|
||||||
|
|
||||||
changedFiles, err := ChangedFilesBetweenTrees(info.startTree, info.endTree) |
|
||||||
if err != nil { |
if err != nil { |
||||||
return changeRangeInfo{}, fmt.Errorf("calculating diff of commit trees %q and %q: %w", |
return plumbing.ZeroHash, fmt.Errorf("resolving revision %q: %w", rev, err) |
||||||
info.startTree.Hash, info.endTree.Hash, err) |
|
||||||
} |
} |
||||||
|
return *h, nil |
||||||
info.changeHash = genChangeHash(nil, info.msg, changedFiles) |
|
||||||
return info, nil |
|
||||||
} |
} |
||||||
|
|
||||||
// VerifyCanSetBranchHEADTo is used to verify that a branch's HEAD can be set to
|
// GetCommitByRevision resolves the revision and returns the Commit it references.
|
||||||
// the given hash. It verifies any new commits which are being added, and
|
func (proj *Project) GetCommitByRevision(rev plumbing.Revision) (Commit, error) { |
||||||
// handles verifying non-fast-forward commits as well.
|
hash, err := proj.resolveRev(rev) |
||||||
//
|
|
||||||
// If the given hash matches the current HEAD of the branch then this performs
|
|
||||||
// no further checks and returns nil.
|
|
||||||
func (r *Repo) VerifyCanSetBranchHEADTo(branchName plumbing.ReferenceName, hash plumbing.Hash) error { |
|
||||||
oldCommitRef, err := r.GitRepo.Reference(branchName, true) |
|
||||||
if errors.Is(err, plumbing.ErrReferenceNotFound) { |
|
||||||
// if the branch is being created then just pull all of its commits and
|
|
||||||
// verify them.
|
|
||||||
// TODO optimize this so that it tries to use the merge-base with main,
|
|
||||||
// so we're not re-verifying a ton of commits unecessarily
|
|
||||||
commits, err := r.GetGitCommitRange(plumbing.ZeroHash, hash) |
|
||||||
if err != nil { |
|
||||||
return fmt.Errorf("retrieving %q and all its ancestors: %w", hash, err) |
|
||||||
} |
|
||||||
return r.VerifyCommits(branchName, commits) |
|
||||||
|
|
||||||
} else if err != nil { |
|
||||||
return fmt.Errorf("resolving branch reference to a hash: %w", err) |
|
||||||
|
|
||||||
} else if oldCommitRef.Hash() == hash { |
|
||||||
// if the HEAD is already at the given hash then it must be fine.
|
|
||||||
return nil |
|
||||||
} |
|
||||||
|
|
||||||
oldCommitObj, err := r.GitRepo.CommitObject(oldCommitRef.Hash()) |
|
||||||
if err != nil { |
if err != nil { |
||||||
return fmt.Errorf("retrieving commit object %q: %w", oldCommitRef.Hash(), err) |
return Commit{}, err |
||||||
} |
} |
||||||
|
|
||||||
newCommitObj, err := r.GitRepo.CommitObject(hash) |
c, err := proj.GetCommit(hash) |
||||||
if err != nil { |
if err != nil { |
||||||
return fmt.Errorf("retrieving commit object %q: %w", hash, err) |
return Commit{}, fmt.Errorf("getting commit %q: %w", hash, err) |
||||||
} |
} |
||||||
|
return c, nil |
||||||
|
} |
||||||
|
|
||||||
mbCommits, err := oldCommitObj.MergeBase(newCommitObj) |
// GetCommitRangeByRevision is like GetCommitRange, first resolving the given
|
||||||
|
// revisions into hashes before continuing with GetCommitRange's behavior.
|
||||||
|
func (proj *Project) GetCommitRangeByRevision(startRev, endRev plumbing.Revision) ([]Commit, error) { |
||||||
|
start, err := proj.resolveRev(startRev) |
||||||
if err != nil { |
if err != nil { |
||||||
return fmt.Errorf("determining merge-base between %q and %q: %w", |
return nil, err |
||||||
oldCommitObj.Hash, newCommitObj.Hash, err) |
|
||||||
} else if len(mbCommits) == 0 { |
|
||||||
return fmt.Errorf("%q and %q have no ancestors in common", |
|
||||||
oldCommitObj.Hash, newCommitObj.Hash) |
|
||||||
} else if len(mbCommits) == 2 { |
|
||||||
return fmt.Errorf("%q and %q have more than one ancestor in common", |
|
||||||
oldCommitObj.Hash, newCommitObj.Hash) |
|
||||||
} |
} |
||||||
|
|
||||||
commits, err := r.GetGitCommitRange(mbCommits[0].Hash, hash) |
end, err := proj.resolveRev(endRev) |
||||||
if err != nil { |
if err != nil { |
||||||
return fmt.Errorf("retrieving commits %q to %q: %w", mbCommits[0].Hash, hash, err) |
return nil, err |
||||||
} |
} |
||||||
return r.VerifyCommits(branchName, commits) |
|
||||||
|
return proj.GetCommitRange(start, end) |
||||||
} |
} |
||||||
|
|||||||
@ -1,156 +0,0 @@ |
|||||||
package dehub |
|
||||||
|
|
||||||
import ( |
|
||||||
"bytes" |
|
||||||
"errors" |
|
||||||
"fmt" |
|
||||||
"sort" |
|
||||||
"strings" |
|
||||||
|
|
||||||
"dehub.dev/src/dehub.git/fs" |
|
||||||
"dehub.dev/src/dehub.git/sigcred" |
|
||||||
"dehub.dev/src/dehub.git/yamlutil" |
|
||||||
|
|
||||||
"gopkg.in/src-d/go-git.v4/plumbing" |
|
||||||
"gopkg.in/src-d/go-git.v4/plumbing/object" |
|
||||||
) |
|
||||||
|
|
||||||
// CommitChange describes the structure of a change commit message.
|
|
||||||
type CommitChange struct { |
|
||||||
Message string `yaml:"message"` |
|
||||||
ChangeHash yamlutil.Blob `yaml:"change_hash"` |
|
||||||
} |
|
||||||
|
|
||||||
var _ CommitInterface = CommitChange{} |
|
||||||
|
|
||||||
// NewCommitChange constructs a Commit populated with a CommitChange
|
|
||||||
// encompassing the currently staged file changes. The Credentials of the
|
|
||||||
// returned Commit will _not_ be filled in.
|
|
||||||
func (r *Repo) NewCommitChange(msg string) (Commit, error) { |
|
||||||
headTree := new(object.Tree) |
|
||||||
if head, err := r.GetGitHead(); err != nil && !errors.Is(err, ErrHeadIsZero) { |
|
||||||
return Commit{}, fmt.Errorf("getting HEAD commit: %w", err) |
|
||||||
} else if err == nil { |
|
||||||
headTree = head.GitTree |
|
||||||
} |
|
||||||
|
|
||||||
_, stagedTree, err := fs.FromStagedChangesTree(r.GitRepo) |
|
||||||
if err != nil { |
|
||||||
return Commit{}, err |
|
||||||
} |
|
||||||
|
|
||||||
changedFiles, err := ChangedFilesBetweenTrees(headTree, stagedTree) |
|
||||||
if err != nil { |
|
||||||
return Commit{}, fmt.Errorf("calculating diff between HEAD and staged changes: %w", err) |
|
||||||
} |
|
||||||
|
|
||||||
cc := CommitChange{Message: msg} |
|
||||||
if cc.ChangeHash, err = cc.ExpectedHash(changedFiles); err != nil { |
|
||||||
return Commit{}, err |
|
||||||
} |
|
||||||
|
|
||||||
return Commit{ |
|
||||||
Change: &cc, |
|
||||||
}, nil |
|
||||||
} |
|
||||||
|
|
||||||
// MessageHead implements the method for the CommitInterface interface.
|
|
||||||
func (cc CommitChange) MessageHead(CommitCommon) (string, error) { |
|
||||||
return abbrevCommitMessage(cc.Message), nil |
|
||||||
} |
|
||||||
|
|
||||||
// ExpectedHash implements the method for the CommitInterface interface.
|
|
||||||
func (cc CommitChange) ExpectedHash(changedFiles []ChangedFile) ([]byte, error) { |
|
||||||
return genChangeHash(nil, cc.Message, changedFiles), nil |
|
||||||
} |
|
||||||
|
|
||||||
// StoredHash implements the method for the CommitInterface interface.
|
|
||||||
func (cc CommitChange) StoredHash() []byte { |
|
||||||
return cc.ChangeHash |
|
||||||
} |
|
||||||
|
|
||||||
// CombineCommitChanges takes all changes in the given range and combines them
|
|
||||||
// into a single change Commit. The resulting Commit will have the same message
|
|
||||||
// as the latest change commit in the range, and will contain all Credentials
|
|
||||||
// for the resulting change hash that it finds in the range as well.
|
|
||||||
//
|
|
||||||
// The combined commit is then committed to the repo with the given revision as
|
|
||||||
// its parent. If the diff between start/end and onto/end is different then this
|
|
||||||
// will return an error, as the change hash which has been accredited in
|
|
||||||
// start/end will be different than the one which needs to be accredited in
|
|
||||||
// onto/end.
|
|
||||||
func (r *Repo) CombineCommitChanges(commits []GitCommit, onto plumbing.ReferenceName) (GitCommit, error) { |
|
||||||
info, err := r.changeRangeInfo(commits) |
|
||||||
if err != nil { |
|
||||||
return GitCommit{}, err |
|
||||||
} |
|
||||||
|
|
||||||
authors := make([]string, 0, len(info.authors)) |
|
||||||
for author := range info.authors { |
|
||||||
authors = append(authors, author) |
|
||||||
} |
|
||||||
sort.Strings(authors) |
|
||||||
|
|
||||||
ontoBranchName, err := r.ReferenceToBranchName(onto) |
|
||||||
if err != nil { |
|
||||||
return GitCommit{}, fmt.Errorf("resolving %q into a branch name: %w", onto, err) |
|
||||||
} |
|
||||||
|
|
||||||
// now determine the change hash from onto->end, to ensure that it remains
|
|
||||||
// the same as from start->end
|
|
||||||
ontoCommit, err := r.GetGitRevision(plumbing.Revision(onto)) |
|
||||||
if err != nil { |
|
||||||
return GitCommit{}, fmt.Errorf("resolving revision %q: %w", onto, err) |
|
||||||
} |
|
||||||
|
|
||||||
ontoEndChangedFiles, err := ChangedFilesBetweenTrees(ontoCommit.GitTree, info.endTree) |
|
||||||
if err != nil { |
|
||||||
return GitCommit{}, fmt.Errorf("calculating file changes between %q and %q: %w", |
|
||||||
ontoCommit.GitCommit.Hash, commits[len(commits)-1].GitCommit.Hash, err) |
|
||||||
} |
|
||||||
|
|
||||||
ontoEndChangeHash := genChangeHash(nil, info.msg, ontoEndChangedFiles) |
|
||||||
if !bytes.Equal(ontoEndChangeHash, info.changeHash) { |
|
||||||
// TODO figure out what files to show as being the "problem files" in
|
|
||||||
// the error message
|
|
||||||
return GitCommit{}, fmt.Errorf("combining onto %q would cause the change hash to change, aborting combine", onto.Short()) |
|
||||||
} |
|
||||||
|
|
||||||
var creds []sigcred.Credential |
|
||||||
for _, commit := range commits { |
|
||||||
if bytes.Equal(commit.Interface.StoredHash(), info.changeHash) { |
|
||||||
creds = append(creds, commit.Commit.Common.Credentials...) |
|
||||||
} |
|
||||||
} |
|
||||||
|
|
||||||
// this is mostly to make tests easier
|
|
||||||
sort.Slice(creds, func(i, j int) bool { |
|
||||||
return creds[i].AccountID < creds[j].AccountID |
|
||||||
}) |
|
||||||
|
|
||||||
commit := Commit{ |
|
||||||
Change: &CommitChange{ |
|
||||||
Message: info.msg, |
|
||||||
ChangeHash: info.changeHash, |
|
||||||
}, |
|
||||||
Common: CommitCommon{Credentials: creds}, |
|
||||||
} |
|
||||||
|
|
||||||
gitCommit, err := r.CommitBare(CommitBareParams{ |
|
||||||
Commit: commit, |
|
||||||
Author: strings.Join(authors, ","), |
|
||||||
ParentHash: ontoCommit.GitCommit.Hash, |
|
||||||
GitTree: info.endTree, |
|
||||||
}) |
|
||||||
if err != nil { |
|
||||||
return GitCommit{}, fmt.Errorf("storing commit: %w", err) |
|
||||||
} |
|
||||||
|
|
||||||
// set the onto branch to this new commit
|
|
||||||
newHeadRef := plumbing.NewHashReference(ontoBranchName, gitCommit.GitCommit.Hash) |
|
||||||
if err := r.GitRepo.Storer.SetReference(newHeadRef); err != nil { |
|
||||||
return GitCommit{}, fmt.Errorf("setting reference %q to new commit hash %q: %w", |
|
||||||
ontoBranchName, gitCommit.GitCommit.Hash, err) |
|
||||||
} |
|
||||||
return gitCommit, nil |
|
||||||
} |
|
||||||
@ -1,49 +0,0 @@ |
|||||||
package dehub |
|
||||||
|
|
||||||
import ( |
|
||||||
"errors" |
|
||||||
"fmt" |
|
||||||
"strings" |
|
||||||
|
|
||||||
"dehub.dev/src/dehub.git/yamlutil" |
|
||||||
) |
|
||||||
|
|
||||||
// CommitComment describes the structure of a comment commit message.
|
|
||||||
type CommitComment struct { |
|
||||||
Message string `yaml:"message"` |
|
||||||
MessageHash yamlutil.Blob `yaml:"message_hash"` |
|
||||||
} |
|
||||||
|
|
||||||
var _ CommitInterface = CommitComment{} |
|
||||||
|
|
||||||
// NewCommitComment constructs and returns a Commit populated with a
|
|
||||||
// CommitComment encompassing the given message. The Credentials of the returned
|
|
||||||
// Commit will _not_ be filled in.
|
|
||||||
func (r *Repo) NewCommitComment(msg string) (Commit, error) { |
|
||||||
cc := CommitComment{Message: msg} |
|
||||||
var err error |
|
||||||
if cc.MessageHash, err = cc.ExpectedHash(nil); err != nil { |
|
||||||
return Commit{}, fmt.Errorf("calculating comment hash: %w", err) |
|
||||||
} |
|
||||||
return Commit{Comment: &cc}, nil |
|
||||||
} |
|
||||||
|
|
||||||
// MessageHead implements the method for the CommitInterface interface.
|
|
||||||
func (cc CommitComment) MessageHead(common CommitCommon) (string, error) { |
|
||||||
msgAbbrev := abbrevCommitMessage(cc.Message) |
|
||||||
credIDs := strings.Join(common.credIDs(), ", ") |
|
||||||
return fmt.Sprintf("Comment by %s: %s", credIDs, msgAbbrev), nil |
|
||||||
} |
|
||||||
|
|
||||||
// ExpectedHash implements the method for the CommitInterface.
|
|
||||||
func (cc CommitComment) ExpectedHash(changes []ChangedFile) ([]byte, error) { |
|
||||||
if len(changes) > 0 { |
|
||||||
return nil, errors.New("CommitComment cannot have any changed files") |
|
||||||
} |
|
||||||
return genCommentHash(nil, cc.Message), nil |
|
||||||
} |
|
||||||
|
|
||||||
// StoredHash implements the method for the CommitInterface.
|
|
||||||
func (cc CommitComment) StoredHash() []byte { |
|
||||||
return cc.MessageHash |
|
||||||
} |
|
||||||
@ -1,81 +0,0 @@ |
|||||||
package dehub |
|
||||||
|
|
||||||
import ( |
|
||||||
"encoding/base64" |
|
||||||
"errors" |
|
||||||
"fmt" |
|
||||||
"strings" |
|
||||||
|
|
||||||
"dehub.dev/src/dehub.git/yamlutil" |
|
||||||
) |
|
||||||
|
|
||||||
// CommitCredential describes the structure of a credential commit message.
|
|
||||||
type CommitCredential struct { |
|
||||||
CredentialedHash yamlutil.Blob `yaml:"credentialed_hash"` |
|
||||||
|
|
||||||
// CommitHashes represents the commits which this credential is accrediting.
|
|
||||||
// It is only present for informational purposes, as commits don't not have
|
|
||||||
// any bearing on the CredentialedHash itself.
|
|
||||||
CommitHashes []string `yaml:"commits,omitempty"` |
|
||||||
} |
|
||||||
|
|
||||||
var _ CommitInterface = CommitCredential{} |
|
||||||
|
|
||||||
// NewCommitCredential constructs and returns a Commit populated with a
|
|
||||||
// CommitCredential encompassing the given hash. The Credentials of the returned
|
|
||||||
// Commit will _not_ be filled in.
|
|
||||||
func (r *Repo) NewCommitCredential(hash []byte) (Commit, error) { |
|
||||||
return Commit{ |
|
||||||
Credential: &CommitCredential{ |
|
||||||
CredentialedHash: hash, |
|
||||||
}, |
|
||||||
}, nil |
|
||||||
} |
|
||||||
|
|
||||||
// NewCommitCredentialFromChanges constructs and returns a Commit populated with
|
|
||||||
// a CommitCredential for all changes in the given range of GitCommits. The
|
|
||||||
// message of the last change commit in the range is used when generating the
|
|
||||||
// hash.
|
|
||||||
func (r *Repo) NewCommitCredentialFromChanges(commits []GitCommit) (Commit, error) { |
|
||||||
info, err := r.changeRangeInfo(commits) |
|
||||||
if err != nil { |
|
||||||
return Commit{}, err |
|
||||||
} |
|
||||||
|
|
||||||
commitCred, err := r.NewCommitCredential(info.changeHash) |
|
||||||
if err != nil { |
|
||||||
return Commit{}, err |
|
||||||
} |
|
||||||
|
|
||||||
for _, commit := range info.changeCommits { |
|
||||||
commitCred.Credential.CommitHashes = append( |
|
||||||
commitCred.Credential.CommitHashes, |
|
||||||
commit.GitCommit.Hash.String(), |
|
||||||
) |
|
||||||
} |
|
||||||
return commitCred, nil |
|
||||||
} |
|
||||||
|
|
||||||
// MessageHead implements the method for the CommitInterface interface.
|
|
||||||
func (cc CommitCredential) MessageHead(common CommitCommon) (string, error) { |
|
||||||
hash64 := base64.StdEncoding.EncodeToString(cc.CredentialedHash) |
|
||||||
if len(hash64) > 6 { |
|
||||||
hash64 = hash64[:6] + "..." |
|
||||||
} |
|
||||||
|
|
||||||
credIDs := strings.Join(common.credIDs(), ", ") |
|
||||||
return fmt.Sprintf("Credential of hash %s by %s", hash64, credIDs), nil |
|
||||||
} |
|
||||||
|
|
||||||
// ExpectedHash implements the method for the CommitInterface.
|
|
||||||
func (cc CommitCredential) ExpectedHash(changes []ChangedFile) ([]byte, error) { |
|
||||||
if len(changes) > 0 { |
|
||||||
return nil, errors.New("CommitCredential cannot have any changed files") |
|
||||||
} |
|
||||||
return cc.CredentialedHash, nil |
|
||||||
} |
|
||||||
|
|
||||||
// StoredHash implements the method for the CommitInterface.
|
|
||||||
func (cc CommitCredential) StoredHash() []byte { |
|
||||||
return cc.CredentialedHash |
|
||||||
} |
|
||||||
@ -0,0 +1,604 @@ |
|||||||
|
package dehub |
||||||
|
|
||||||
|
import ( |
||||||
|
"bytes" |
||||||
|
"errors" |
||||||
|
"fmt" |
||||||
|
"reflect" |
||||||
|
"sort" |
||||||
|
"strings" |
||||||
|
"time" |
||||||
|
|
||||||
|
"dehub.dev/src/dehub.git/accessctl" |
||||||
|
"dehub.dev/src/dehub.git/fs" |
||||||
|
"dehub.dev/src/dehub.git/sigcred" |
||||||
|
"dehub.dev/src/dehub.git/typeobj" |
||||||
|
"dehub.dev/src/dehub.git/yamlutil" |
||||||
|
|
||||||
|
"gopkg.in/src-d/go-git.v4" |
||||||
|
"gopkg.in/src-d/go-git.v4/plumbing" |
||||||
|
"gopkg.in/src-d/go-git.v4/plumbing/object" |
||||||
|
yaml "gopkg.in/yaml.v2" |
||||||
|
) |
||||||
|
|
||||||
|
// Payload describes the methods which must be implemented by the different
|
||||||
|
// payload types. None of the methods should modify the underlying object.
|
||||||
|
type Payload interface { |
||||||
|
// MessageHead returns the head of the commit message (i.e. the first line).
|
||||||
|
// The PayloadCommon of the outer PayloadUnion is passed in for added
|
||||||
|
// context, if necessary.
|
||||||
|
MessageHead(PayloadCommon) (string, error) |
||||||
|
|
||||||
|
// Fingerprint returns the raw fingerprint which can be signed when
|
||||||
|
// accrediting this payload. The ChangedFile objects given describe the file
|
||||||
|
// changes between the parent commit and this commit.
|
||||||
|
//
|
||||||
|
// If this method returns nil it means that the payload has no fingerprint
|
||||||
|
// in-and-of-itself.
|
||||||
|
Fingerprint([]ChangedFile) ([]byte, error) |
||||||
|
} |
||||||
|
|
||||||
|
// PayloadCommon describes the fields common to all Payloads.
|
||||||
|
type PayloadCommon struct { |
||||||
|
Fingerprint yamlutil.Blob `yaml:"fingerprint"` |
||||||
|
Credentials []sigcred.CredentialUnion `yaml:"credentials"` |
||||||
|
|
||||||
|
// LegacyChangeHash is no longer used, use Fingerprint instead.
|
||||||
|
LegacyChangeHash yamlutil.Blob `yaml:"change_hash,omitempty"` |
||||||
|
} |
||||||
|
|
||||||
|
func (cc PayloadCommon) credIDs() []string { |
||||||
|
m := map[string]struct{}{} |
||||||
|
for _, cred := range cc.Credentials { |
||||||
|
if cred.AccountID != "" { |
||||||
|
m[cred.AccountID] = struct{}{} |
||||||
|
} else if cred.AnonID != "" { |
||||||
|
m[cred.AnonID] = struct{}{} |
||||||
|
} |
||||||
|
} |
||||||
|
s := make([]string, 0, len(m)) |
||||||
|
for id := range m { |
||||||
|
s = append(s, id) |
||||||
|
} |
||||||
|
sort.Strings(s) |
||||||
|
return s |
||||||
|
} |
||||||
|
|
||||||
|
func abbrevCommitMessage(msg string) string { |
||||||
|
i := strings.Index(msg, "\n") |
||||||
|
if i > 0 { |
||||||
|
msg = msg[:i] |
||||||
|
} |
||||||
|
if len(msg) > 80 { |
||||||
|
msg = msg[:77] + "..." |
||||||
|
} |
||||||
|
return msg |
||||||
|
} |
||||||
|
|
||||||
|
// PayloadUnion represents a single Payload of variable type. Only one field
|
||||||
|
// should be set on a PayloadUnion, unless otherwise noted.
|
||||||
|
type PayloadUnion struct { |
||||||
|
Change *PayloadChange `type:"change,default"` |
||||||
|
Credential *PayloadCredential `type:"credential"` |
||||||
|
Comment *PayloadComment `type:"comment"` |
||||||
|
|
||||||
|
// Common may be set in addition to one of the other fields.
|
||||||
|
Common PayloadCommon `yaml:",inline"` |
||||||
|
} |
||||||
|
|
||||||
|
// MarshalYAML implements the yaml.Marshaler interface.
|
||||||
|
func (p PayloadUnion) MarshalYAML() (interface{}, error) { |
||||||
|
return typeobj.MarshalYAML(p) |
||||||
|
} |
||||||
|
|
||||||
|
// UnmarshalYAML implements the yaml.Unmarshaler interface.
|
||||||
|
func (p *PayloadUnion) UnmarshalYAML(unmarshal func(interface{}) error) error { |
||||||
|
if err := typeobj.UnmarshalYAML(p, unmarshal); err != nil { |
||||||
|
return err |
||||||
|
} else if len(p.Common.LegacyChangeHash) > 0 { |
||||||
|
p.Common.Fingerprint = p.Common.LegacyChangeHash |
||||||
|
p.Common.LegacyChangeHash = nil |
||||||
|
} |
||||||
|
return nil |
||||||
|
} |
||||||
|
|
||||||
|
// Payload returns the Payload instance encapsulated by this PayloadUnion.
|
||||||
|
//
|
||||||
|
// This will panic if a Payload field is not populated.
|
||||||
|
func (p PayloadUnion) Payload() Payload { |
||||||
|
el, _, err := typeobj.Element(p) |
||||||
|
if err != nil { |
||||||
|
panic(err) |
||||||
|
} |
||||||
|
return el.(Payload) |
||||||
|
} |
||||||
|
|
||||||
|
// Type returns the Payload's type (as would be used in its YAML "type" field).
|
||||||
|
//
|
||||||
|
// This will panic if a Payload field is not populated.
|
||||||
|
func (p PayloadUnion) Type() string { |
||||||
|
_, typeStr, err := typeobj.Element(p) |
||||||
|
if err != nil { |
||||||
|
panic(err) |
||||||
|
} |
||||||
|
return typeStr |
||||||
|
} |
||||||
|
|
||||||
|
// MarshalText implements the encoding.TextMarshaler interface by returning the
|
||||||
|
// form the payload in the git commit message.
|
||||||
|
func (p PayloadUnion) MarshalText() ([]byte, error) { |
||||||
|
msgHead, err := p.Payload().MessageHead(p.Common) |
||||||
|
if err != nil { |
||||||
|
return nil, fmt.Errorf("constructing message head: %w", err) |
||||||
|
} |
||||||
|
|
||||||
|
msgBodyB, err := yaml.Marshal(p) |
||||||
|
if err != nil { |
||||||
|
return nil, fmt.Errorf("marshaling payload %+v as yaml: %w", p, err) |
||||||
|
} |
||||||
|
|
||||||
|
w := new(bytes.Buffer) |
||||||
|
w.WriteString(msgHead) |
||||||
|
w.WriteString("\n\n---\n") |
||||||
|
w.Write(msgBodyB) |
||||||
|
return w.Bytes(), nil |
||||||
|
} |
||||||
|
|
||||||
|
// UnmarshalText implements the encoding.TextUnmarshaler interface by decoding a
|
||||||
|
// payload object which has been encoded into a git commit message.
|
||||||
|
func (p *PayloadUnion) UnmarshalText(msg []byte) error { |
||||||
|
i := bytes.Index(msg, []byte("\n")) |
||||||
|
if i < 0 { |
||||||
|
return fmt.Errorf("commit message %q is malformed, it has no body", msg) |
||||||
|
} |
||||||
|
msgBody := msg[i:] |
||||||
|
|
||||||
|
if err := yaml.Unmarshal(msgBody, p); err != nil { |
||||||
|
return fmt.Errorf("unmarshaling commit payload from yaml: %w", err) |
||||||
|
|
||||||
|
} else if reflect.DeepEqual(*p, PayloadUnion{}) { |
||||||
|
// a basic check, but worthwhile
|
||||||
|
return errors.New("commit message is malformed, could not unmarshal yaml object") |
||||||
|
} |
||||||
|
|
||||||
|
return nil |
||||||
|
} |
||||||
|
|
||||||
|
// AccreditPayload returns the given PayloadUnion with an appended Credential
|
||||||
|
// provided by the given SignifierInterface.
|
||||||
|
func (proj *Project) AccreditPayload(payUn PayloadUnion, sig sigcred.Signifier) (PayloadUnion, error) { |
||||||
|
headFS, err := proj.headFS() |
||||||
|
if err != nil { |
||||||
|
return payUn, fmt.Errorf("retrieving HEAD fs: %w", err) |
||||||
|
} |
||||||
|
|
||||||
|
cred, err := sig.Sign(headFS, payUn.Common.Fingerprint) |
||||||
|
if err != nil { |
||||||
|
return payUn, fmt.Errorf("signing fingerprint %q: %w", payUn.Common.Fingerprint, err) |
||||||
|
} |
||||||
|
payUn.Common.Credentials = append(payUn.Common.Credentials, cred) |
||||||
|
return payUn, nil |
||||||
|
} |
||||||
|
|
||||||
|
// CommitDirectParams are the parameters to the CommitDirect method. All are
|
||||||
|
// required, unless otherwise noted.
|
||||||
|
type CommitDirectParams struct { |
||||||
|
PayloadUnion PayloadUnion |
||||||
|
Author string |
||||||
|
ParentHash plumbing.Hash // can be zero if the commit has no parents (Q_Q)
|
||||||
|
GitTree *object.Tree |
||||||
|
} |
||||||
|
|
||||||
|
// CommitDirect constructs a git commit object and and stores it, returning the
|
||||||
|
// resulting Commit. This method does not interact with HEAD at all.
|
||||||
|
func (proj *Project) CommitDirect(params CommitDirectParams) (Commit, error) { |
||||||
|
msgB, err := params.PayloadUnion.MarshalText() |
||||||
|
if err != nil { |
||||||
|
return Commit{}, fmt.Errorf("encoding payload to message string: %w", err) |
||||||
|
} |
||||||
|
|
||||||
|
author := object.Signature{ |
||||||
|
Name: params.Author, |
||||||
|
When: time.Now(), |
||||||
|
} |
||||||
|
commit := &object.Commit{ |
||||||
|
Author: author, |
||||||
|
Committer: author, |
||||||
|
Message: string(msgB), |
||||||
|
TreeHash: params.GitTree.Hash, |
||||||
|
} |
||||||
|
if params.ParentHash != plumbing.ZeroHash { |
||||||
|
commit.ParentHashes = []plumbing.Hash{params.ParentHash} |
||||||
|
} |
||||||
|
|
||||||
|
commitObj := proj.GitRepo.Storer.NewEncodedObject() |
||||||
|
if err := commit.Encode(commitObj); err != nil { |
||||||
|
return Commit{}, fmt.Errorf("encoding commit object: %w", err) |
||||||
|
} |
||||||
|
|
||||||
|
commitHash, err := proj.GitRepo.Storer.SetEncodedObject(commitObj) |
||||||
|
if err != nil { |
||||||
|
return Commit{}, fmt.Errorf("setting encoded object: %w", err) |
||||||
|
} |
||||||
|
|
||||||
|
return proj.GetCommit(commitHash) |
||||||
|
} |
||||||
|
|
||||||
|
// Commit uses the given PayloadUnion to create a git commit object and commits
|
||||||
|
// it to the current HEAD, returning the full Commit.
|
||||||
|
func (proj *Project) Commit(payUn PayloadUnion) (Commit, error) { |
||||||
|
headRef, err := proj.TraverseReferenceChain(plumbing.HEAD, func(ref *plumbing.Reference) bool { |
||||||
|
return ref.Type() == plumbing.HashReference |
||||||
|
}) |
||||||
|
if err != nil { |
||||||
|
return Commit{}, fmt.Errorf("resolving HEAD to a hash reference: %w", err) |
||||||
|
} |
||||||
|
headRefName := headRef.Name() |
||||||
|
|
||||||
|
headHash, err := proj.ReferenceToHash(headRefName) |
||||||
|
if err != nil { |
||||||
|
return Commit{}, fmt.Errorf("resolving ref %q (HEAD): %w", headRefName, err) |
||||||
|
} |
||||||
|
|
||||||
|
// TODO this is also used in the same way in NewCommitChange. It might make
|
||||||
|
// sense to refactor this logic out, it might not be needed in fs at all.
|
||||||
|
_, stagedTree, err := fs.FromStagedChangesTree(proj.GitRepo) |
||||||
|
if err != nil { |
||||||
|
return Commit{}, fmt.Errorf("getting staged changes: %w", err) |
||||||
|
} |
||||||
|
|
||||||
|
commit, err := proj.CommitDirect(CommitDirectParams{ |
||||||
|
PayloadUnion: payUn, |
||||||
|
Author: strings.Join(payUn.Common.credIDs(), ", "), |
||||||
|
ParentHash: headHash, |
||||||
|
GitTree: stagedTree, |
||||||
|
}) |
||||||
|
if err != nil { |
||||||
|
return Commit{}, err |
||||||
|
} |
||||||
|
|
||||||
|
// now set the branch to this new commit
|
||||||
|
newHeadRef := plumbing.NewHashReference(headRefName, commit.Hash) |
||||||
|
if err := proj.GitRepo.Storer.SetReference(newHeadRef); err != nil { |
||||||
|
return Commit{}, fmt.Errorf("setting reference %q to new commit hash %q: %w", |
||||||
|
headRefName, commit.Hash, err) |
||||||
|
} |
||||||
|
|
||||||
|
return commit, nil |
||||||
|
} |
||||||
|
|
||||||
|
// HasStagedChanges returns true if there are file changes which have been
|
||||||
|
// staged (e.g. via "git add").
|
||||||
|
func (proj *Project) HasStagedChanges() (bool, error) { |
||||||
|
w, err := proj.GitRepo.Worktree() |
||||||
|
if err != nil { |
||||||
|
return false, fmt.Errorf("retrieving worktree: %w", err) |
||||||
|
} |
||||||
|
|
||||||
|
status, err := w.Status() |
||||||
|
if err != nil { |
||||||
|
return false, fmt.Errorf("retrieving worktree status: %w", err) |
||||||
|
} |
||||||
|
|
||||||
|
var any bool |
||||||
|
for _, fileStatus := range status { |
||||||
|
if fileStatus.Staging != git.Unmodified && |
||||||
|
fileStatus.Staging != git.Untracked { |
||||||
|
any = true |
||||||
|
break |
||||||
|
} |
||||||
|
} |
||||||
|
return any, nil |
||||||
|
} |
||||||
|
|
||||||
|
// VerifyCommits verifies that the given commits, which are presumably on the
|
||||||
|
// given branch, are gucci.
|
||||||
|
func (proj *Project) VerifyCommits(branchName plumbing.ReferenceName, commits []Commit) error { |
||||||
|
// this isn't strictly necessary for this method, but it helps discover bugs
|
||||||
|
// in other parts of the code.
|
||||||
|
if len(commits) == 0 { |
||||||
|
return errors.New("cannot call VerifyCommits with empty commit slice") |
||||||
|
} |
||||||
|
|
||||||
|
// First determine the root of the main branch. All commits need to be an
|
||||||
|
// ancestor of it. If the main branch has not been created yet then there
|
||||||
|
// might not be a root commit yet.
|
||||||
|
var rootCommitObj *object.Commit |
||||||
|
mainCommit, err := proj.GetCommitByRevision(plumbing.Revision(MainRefName)) |
||||||
|
if errors.Is(err, plumbing.ErrReferenceNotFound) { |
||||||
|
|
||||||
|
// main branch hasn't been created yet. The commits can only be verified
|
||||||
|
// if they are for the main branch and they include the root commit.
|
||||||
|
if branchName != MainRefName { |
||||||
|
return fmt.Errorf("cannot verify commits in branch %q when no main branch exists", branchName) |
||||||
|
} |
||||||
|
|
||||||
|
for _, commit := range commits { |
||||||
|
if commit.Object.NumParents() == 0 { |
||||||
|
rootCommitObj = commit.Object |
||||||
|
break |
||||||
|
} |
||||||
|
} |
||||||
|
if rootCommitObj == nil { |
||||||
|
return errors.New("root commit of main branch cannot be determined") |
||||||
|
} |
||||||
|
|
||||||
|
} else if err != nil { |
||||||
|
return fmt.Errorf("retrieving commit at HEAD of %q: %w", MainRefName.Short(), err) |
||||||
|
|
||||||
|
} else { |
||||||
|
rootCommitObj = mainCommit.Object |
||||||
|
for { |
||||||
|
if rootCommitObj.NumParents() == 0 { |
||||||
|
break |
||||||
|
} else if rootCommitObj.NumParents() > 1 { |
||||||
|
return fmt.Errorf("commit %q in main branch has more than one parent", rootCommitObj.Hash) |
||||||
|
} else if rootCommitObj, err = rootCommitObj.Parent(0); err != nil { |
||||||
|
return fmt.Errorf("retrieving parent commit of %q: %w", rootCommitObj.Hash, err) |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// We also need the HEAD of the given branch, if it exists.
|
||||||
|
branchCommit, err := proj.GetCommitByRevision(plumbing.Revision(branchName)) |
||||||
|
if err != nil && !errors.Is(err, plumbing.ErrReferenceNotFound) { |
||||||
|
return fmt.Errorf("retrieving commit at HEAD of %q: %w", branchName.Short(), err) |
||||||
|
} |
||||||
|
|
||||||
|
for i, commit := range commits { |
||||||
|
// It's not a requirement that the given Commits are in ancestral order,
|
||||||
|
// but usually they are; if the previous commit is the parent of this
|
||||||
|
// one we can skip a bunch of work.
|
||||||
|
var parentTree *object.Tree |
||||||
|
var isNonFF bool |
||||||
|
if i > 0 && commits[i-1].Hash == commit.Object.ParentHashes[0] { |
||||||
|
parentTree = commits[i-1].TreeObject |
||||||
|
|
||||||
|
} else if commit.Hash == rootCommitObj.Hash { |
||||||
|
// looking at the root commit, assume it's ok
|
||||||
|
|
||||||
|
} else { |
||||||
|
var err error |
||||||
|
isAncestor := func(older, younger *object.Commit) bool { |
||||||
|
var isAncestor bool |
||||||
|
if err != nil { |
||||||
|
return false |
||||||
|
} else if isAncestor, err = older.IsAncestor(younger); err != nil { |
||||||
|
err = fmt.Errorf("determining if %q is an ancestor of %q: %w", |
||||||
|
younger.Hash, older.Hash, err) |
||||||
|
return false |
||||||
|
|
||||||
|
} |
||||||
|
return isAncestor |
||||||
|
} |
||||||
|
|
||||||
|
ancestorOfRoot := isAncestor(rootCommitObj, commit.Object) |
||||||
|
if branchCommit.Hash != plumbing.ZeroHash { // checking if the var was set
|
||||||
|
// this could only be a nonFF if the branch actually exists.
|
||||||
|
isNonFF = !isAncestor(branchCommit.Object, commit.Object) |
||||||
|
} |
||||||
|
|
||||||
|
if err != nil { |
||||||
|
return err |
||||||
|
} else if !ancestorOfRoot { |
||||||
|
return fmt.Errorf("commit %q must be direct descendant of root commit of %q (%q)", |
||||||
|
commit.Hash, MainRefName.Short(), rootCommitObj.Hash, |
||||||
|
) |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
if err := proj.verifyCommit(branchName, commit, parentTree, isNonFF); err != nil { |
||||||
|
return fmt.Errorf("verifying commit %q: %w", commit.Hash, err) |
||||||
|
} |
||||||
|
} |
||||||
|
return nil |
||||||
|
} |
||||||
|
|
||||||
|
// parentTree returns the tree of the parent commit of the given commit. If the
|
||||||
|
// given commit has no parents then a bare tree is returned.
|
||||||
|
func (proj *Project) parentTree(commitObj *object.Commit) (*object.Tree, error) { |
||||||
|
switch commitObj.NumParents() { |
||||||
|
case 0: |
||||||
|
return new(object.Tree), nil |
||||||
|
case 1: |
||||||
|
if parentCommitObj, err := commitObj.Parent(0); err != nil { |
||||||
|
return nil, fmt.Errorf("getting parent commit %q: %w", |
||||||
|
commitObj.ParentHashes[0], err) |
||||||
|
} else if parentTree, err := proj.GitRepo.TreeObject(parentCommitObj.TreeHash); err != nil { |
||||||
|
return nil, fmt.Errorf("getting parent tree object %q: %w", |
||||||
|
parentCommitObj.TreeHash, err) |
||||||
|
} else { |
||||||
|
return parentTree, nil |
||||||
|
} |
||||||
|
default: |
||||||
|
return nil, errors.New("commit has multiple parents") |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// if parentTree is nil then it will be inferred.
|
||||||
|
func (proj *Project) verifyCommit( |
||||||
|
branchName plumbing.ReferenceName, |
||||||
|
commit Commit, |
||||||
|
parentTree *object.Tree, |
||||||
|
isNonFF bool, |
||||||
|
) error { |
||||||
|
parentTree, err := proj.parentTree(commit.Object) |
||||||
|
if err != nil { |
||||||
|
return fmt.Errorf("retrieving parent tree of commit: %w", err) |
||||||
|
} |
||||||
|
|
||||||
|
var sigFS fs.FS |
||||||
|
if commit.Object.NumParents() == 0 { |
||||||
|
sigFS = fs.FromTree(commit.TreeObject) |
||||||
|
} else { |
||||||
|
sigFS = fs.FromTree(parentTree) |
||||||
|
} |
||||||
|
|
||||||
|
cfg, err := proj.loadConfig(sigFS) |
||||||
|
if err != nil { |
||||||
|
return fmt.Errorf("loading config of parent %q: %w", commit.Object.ParentHashes[0], err) |
||||||
|
} |
||||||
|
|
||||||
|
// assert access controls
|
||||||
|
changedFiles, err := ChangedFilesBetweenTrees(parentTree, commit.TreeObject) |
||||||
|
if err != nil { |
||||||
|
return fmt.Errorf("calculating diff from tree %q to tree %q: %w", |
||||||
|
parentTree.Hash, commit.TreeObject.Hash, err) |
||||||
|
|
||||||
|
} else if len(changedFiles) > 0 && commit.Payload.Change == nil { |
||||||
|
return errors.New("files changes but commit is not a change commit") |
||||||
|
} |
||||||
|
|
||||||
|
pathsChanged := make([]string, len(changedFiles)) |
||||||
|
for i := range changedFiles { |
||||||
|
pathsChanged[i] = changedFiles[i].Path |
||||||
|
} |
||||||
|
|
||||||
|
commitType := commit.Payload.Type() |
||||||
|
err = accessctl.AssertCanCommit(cfg.AccessControls, accessctl.CommitRequest{ |
||||||
|
Type: commitType, |
||||||
|
Branch: branchName.Short(), |
||||||
|
Credentials: commit.Payload.Common.Credentials, |
||||||
|
FilesChanged: pathsChanged, |
||||||
|
NonFastForward: isNonFF, |
||||||
|
}) |
||||||
|
if err != nil { |
||||||
|
return fmt.Errorf("asserting access controls: %w", err) |
||||||
|
} |
||||||
|
|
||||||
|
// ensure the fingerprint is what it's expected to be
|
||||||
|
storedFingerprint := commit.Payload.Common.Fingerprint |
||||||
|
expectedFingerprint, err := commit.Payload.Payload().Fingerprint(changedFiles) |
||||||
|
if err != nil { |
||||||
|
return fmt.Errorf("calculating expected payload fingerprint: %w", err) |
||||||
|
} else if expectedFingerprint == nil { |
||||||
|
// the payload doesn't have a fingerprint of its own, it's just carrying
|
||||||
|
// one, so no point in checking if it's "correct".
|
||||||
|
} else if !bytes.Equal(storedFingerprint, expectedFingerprint) { |
||||||
|
return fmt.Errorf("unexpected fingerprint in payload, is %q but should be %q", |
||||||
|
storedFingerprint, yamlutil.Blob(expectedFingerprint)) |
||||||
|
} |
||||||
|
|
||||||
|
// verify all credentials
|
||||||
|
for _, cred := range commit.Payload.Common.Credentials { |
||||||
|
if cred.AccountID == "" { |
||||||
|
if err := cred.SelfVerify(storedFingerprint); err != nil { |
||||||
|
return fmt.Errorf("verifying credential %+v: %w", cred, err) |
||||||
|
} |
||||||
|
} else { |
||||||
|
sig, err := proj.signifierForCredential(sigFS, cred) |
||||||
|
if err != nil { |
||||||
|
return fmt.Errorf("finding signifier for credential %+v: %w", cred, err) |
||||||
|
} else if err := sig.Verify(sigFS, storedFingerprint, cred); err != nil { |
||||||
|
return fmt.Errorf("verifying credential %+v: %w", cred, err) |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
return nil |
||||||
|
} |
||||||
|
|
||||||
|
type changeRangeInfo struct { |
||||||
|
changeCommits []Commit |
||||||
|
authors map[string]struct{} |
||||||
|
msg string |
||||||
|
startTree, endTree *object.Tree |
||||||
|
changeFingerprint []byte |
||||||
|
} |
||||||
|
|
||||||
|
// changeRangeInfo returns various pieces of information about a range of
|
||||||
|
// commits' changes.
|
||||||
|
func (proj *Project) changeRangeInfo(commits []Commit) (changeRangeInfo, error) { |
||||||
|
info := changeRangeInfo{ |
||||||
|
authors: map[string]struct{}{}, |
||||||
|
} |
||||||
|
|
||||||
|
for _, commit := range commits { |
||||||
|
if commit.Payload.Change != nil { |
||||||
|
info.changeCommits = append(info.changeCommits, commit) |
||||||
|
for _, cred := range commit.Payload.Common.Credentials { |
||||||
|
info.authors[cred.AccountID] = struct{}{} |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
if len(info.changeCommits) == 0 { |
||||||
|
return changeRangeInfo{}, errors.New("no change commits found in range") |
||||||
|
} |
||||||
|
|
||||||
|
// startTree has to be the tree of the parent of the first commit, which
|
||||||
|
// isn't included in commits. Determine it the hard way.
|
||||||
|
var err error |
||||||
|
if info.startTree, err = proj.parentTree(commits[0].Object); err != nil { |
||||||
|
return changeRangeInfo{}, fmt.Errorf("getting tree of parent of %q: %w", |
||||||
|
commits[0].Hash, err) |
||||||
|
} |
||||||
|
|
||||||
|
lastChangeCommit := info.changeCommits[len(info.changeCommits)-1] |
||||||
|
info.msg = lastChangeCommit.Payload.Change.Description |
||||||
|
info.endTree = lastChangeCommit.TreeObject |
||||||
|
|
||||||
|
changedFiles, err := ChangedFilesBetweenTrees(info.startTree, info.endTree) |
||||||
|
if err != nil { |
||||||
|
return changeRangeInfo{}, fmt.Errorf("calculating diff of commit trees %q and %q: %w", |
||||||
|
info.startTree.Hash, info.endTree.Hash, err) |
||||||
|
} |
||||||
|
|
||||||
|
info.changeFingerprint = genChangeFingerprint(nil, info.msg, changedFiles) |
||||||
|
return info, nil |
||||||
|
} |
||||||
|
|
||||||
|
// VerifyCanSetBranchHEADTo is used to verify that a branch's HEAD can be set to
|
||||||
|
// the given hash. It verifies any new commits which are being added, and
|
||||||
|
// handles verifying non-fast-forward commits as well.
|
||||||
|
//
|
||||||
|
// If the given hash matches the current HEAD of the branch then this performs
|
||||||
|
// no further checks and returns nil.
|
||||||
|
func (proj *Project) VerifyCanSetBranchHEADTo(branchName plumbing.ReferenceName, hash plumbing.Hash) error { |
||||||
|
oldCommitRef, err := proj.GitRepo.Reference(branchName, true) |
||||||
|
if errors.Is(err, plumbing.ErrReferenceNotFound) { |
||||||
|
// if the branch is being created then just pull all of its commits and
|
||||||
|
// verify them.
|
||||||
|
// TODO optimize this so that it tries to use the merge-base with main,
|
||||||
|
// so we're not re-verifying a ton of commits unecessarily
|
||||||
|
commits, err := proj.GetCommitRange(plumbing.ZeroHash, hash) |
||||||
|
if err != nil { |
||||||
|
return fmt.Errorf("retrieving %q and all its ancestors: %w", hash, err) |
||||||
|
} |
||||||
|
return proj.VerifyCommits(branchName, commits) |
||||||
|
|
||||||
|
} else if err != nil { |
||||||
|
return fmt.Errorf("resolving branch reference to a hash: %w", err) |
||||||
|
|
||||||
|
} else if oldCommitRef.Hash() == hash { |
||||||
|
// if the HEAD is already at the given hash then it must be fine.
|
||||||
|
return nil |
||||||
|
} |
||||||
|
|
||||||
|
oldCommitObj, err := proj.GitRepo.CommitObject(oldCommitRef.Hash()) |
||||||
|
if err != nil { |
||||||
|
return fmt.Errorf("retrieving commit object %q: %w", oldCommitRef.Hash(), err) |
||||||
|
} |
||||||
|
|
||||||
|
newCommitObj, err := proj.GitRepo.CommitObject(hash) |
||||||
|
if err != nil { |
||||||
|
return fmt.Errorf("retrieving commit object %q: %w", hash, err) |
||||||
|
} |
||||||
|
|
||||||
|
mbCommits, err := oldCommitObj.MergeBase(newCommitObj) |
||||||
|
if err != nil { |
||||||
|
return fmt.Errorf("determining merge-base between %q and %q: %w", |
||||||
|
oldCommitObj.Hash, newCommitObj.Hash, err) |
||||||
|
} else if len(mbCommits) == 0 { |
||||||
|
return fmt.Errorf("%q and %q have no ancestors in common", |
||||||
|
oldCommitObj.Hash, newCommitObj.Hash) |
||||||
|
} else if len(mbCommits) == 2 { |
||||||
|
return fmt.Errorf("%q and %q have more than one ancestor in common", |
||||||
|
oldCommitObj.Hash, newCommitObj.Hash) |
||||||
|
} |
||||||
|
|
||||||
|
commits, err := proj.GetCommitRange(mbCommits[0].Hash, hash) |
||||||
|
if err != nil { |
||||||
|
return fmt.Errorf("retrieving commits %q to %q: %w", mbCommits[0].Hash, hash, err) |
||||||
|
} |
||||||
|
return proj.VerifyCommits(branchName, commits) |
||||||
|
} |
||||||
@ -0,0 +1,171 @@ |
|||||||
|
package dehub |
||||||
|
|
||||||
|
import ( |
||||||
|
"bytes" |
||||||
|
"errors" |
||||||
|
"fmt" |
||||||
|
"sort" |
||||||
|
"strings" |
||||||
|
|
||||||
|
"dehub.dev/src/dehub.git/fs" |
||||||
|
"dehub.dev/src/dehub.git/sigcred" |
||||||
|
|
||||||
|
"gopkg.in/src-d/go-git.v4/plumbing" |
||||||
|
"gopkg.in/src-d/go-git.v4/plumbing/object" |
||||||
|
) |
||||||
|
|
||||||
|
// PayloadChange describes the structure of a change payload.
|
||||||
|
type PayloadChange struct { |
||||||
|
Description string `yaml:"description"` |
||||||
|
|
||||||
|
// LegacyMessage is no longer used, use Description instead
|
||||||
|
LegacyMessage string `yaml:"message,omitempty"` |
||||||
|
} |
||||||
|
|
||||||
|
var _ Payload = PayloadChange{} |
||||||
|
|
||||||
|
// NewPayloadChange constructs a PayloadUnion populated with a PayloadChange
|
||||||
|
// encompassing the currently staged file changes. The Credentials of the
|
||||||
|
// returned PayloadUnion will _not_ be filled in.
|
||||||
|
func (proj *Project) NewPayloadChange(description string) (PayloadUnion, error) { |
||||||
|
headTree := new(object.Tree) |
||||||
|
if head, err := proj.GetHeadCommit(); err != nil && !errors.Is(err, ErrHeadIsZero) { |
||||||
|
return PayloadUnion{}, fmt.Errorf("getting HEAD commit: %w", err) |
||||||
|
} else if err == nil { |
||||||
|
headTree = head.TreeObject |
||||||
|
} |
||||||
|
|
||||||
|
_, stagedTree, err := fs.FromStagedChangesTree(proj.GitRepo) |
||||||
|
if err != nil { |
||||||
|
return PayloadUnion{}, err |
||||||
|
} |
||||||
|
|
||||||
|
changedFiles, err := ChangedFilesBetweenTrees(headTree, stagedTree) |
||||||
|
if err != nil { |
||||||
|
return PayloadUnion{}, fmt.Errorf("calculating diff between HEAD and staged changes: %w", err) |
||||||
|
} |
||||||
|
|
||||||
|
payCh := PayloadChange{Description: description} |
||||||
|
fingerprint, err := payCh.Fingerprint(changedFiles) |
||||||
|
if err != nil { |
||||||
|
return PayloadUnion{}, err |
||||||
|
} |
||||||
|
|
||||||
|
return PayloadUnion{ |
||||||
|
Change: &payCh, |
||||||
|
Common: PayloadCommon{Fingerprint: fingerprint}, |
||||||
|
}, nil |
||||||
|
} |
||||||
|
|
||||||
|
// MessageHead implements the method for the Payload interface.
|
||||||
|
func (payCh PayloadChange) MessageHead(PayloadCommon) (string, error) { |
||||||
|
return abbrevCommitMessage(payCh.Description), nil |
||||||
|
} |
||||||
|
|
||||||
|
// Fingerprint implements the method for the Payload interface.
|
||||||
|
func (payCh PayloadChange) Fingerprint(changedFiles []ChangedFile) ([]byte, error) { |
||||||
|
return genChangeFingerprint(nil, payCh.Description, changedFiles), nil |
||||||
|
} |
||||||
|
|
||||||
|
// UnmarshalYAML implements the yaml.Unmarshaler interface.
|
||||||
|
func (payCh *PayloadChange) UnmarshalYAML(unmarshal func(interface{}) error) error { |
||||||
|
var wrap struct { |
||||||
|
Inner PayloadChange `yaml:",inline"` |
||||||
|
} |
||||||
|
if err := unmarshal(&wrap); err != nil { |
||||||
|
return err |
||||||
|
} |
||||||
|
*payCh = wrap.Inner |
||||||
|
if payCh.LegacyMessage != "" { |
||||||
|
payCh.Description = payCh.LegacyMessage |
||||||
|
payCh.LegacyMessage = "" |
||||||
|
} |
||||||
|
return nil |
||||||
|
} |
||||||
|
|
||||||
|
// CombinePayloadChanges takes all changes in the given range, combines them
|
||||||
|
// into a single PayloadChange, and commits it. The resulting payload will have
|
||||||
|
// the same message as the latest change payload in the range. If the
|
||||||
|
// fingerprint of the PayloadChange produced by this method has any matching
|
||||||
|
// Credentials in the range, those will be included in the payload as well.
|
||||||
|
//
|
||||||
|
// The combined commit is committed to the project with the given revision as
|
||||||
|
// its parent. If the diff across the given range and the diff from onto to the
|
||||||
|
// end of the range are different then this will return an error.
|
||||||
|
func (proj *Project) CombinePayloadChanges(commits []Commit, onto plumbing.ReferenceName) (Commit, error) { |
||||||
|
info, err := proj.changeRangeInfo(commits) |
||||||
|
if err != nil { |
||||||
|
return Commit{}, err |
||||||
|
} |
||||||
|
|
||||||
|
authors := make([]string, 0, len(info.authors)) |
||||||
|
for author := range info.authors { |
||||||
|
authors = append(authors, author) |
||||||
|
} |
||||||
|
sort.Strings(authors) |
||||||
|
|
||||||
|
ontoBranchName, err := proj.ReferenceToBranchName(onto) |
||||||
|
if err != nil { |
||||||
|
return Commit{}, fmt.Errorf("resolving %q into a branch name: %w", onto, err) |
||||||
|
} |
||||||
|
|
||||||
|
// now determine the change hash from onto->end, to ensure that it remains
|
||||||
|
// the same as from start->end
|
||||||
|
ontoCommit, err := proj.GetCommitByRevision(plumbing.Revision(onto)) |
||||||
|
if err != nil { |
||||||
|
return Commit{}, fmt.Errorf("resolving revision %q: %w", onto, err) |
||||||
|
} |
||||||
|
|
||||||
|
ontoEndChangedFiles, err := ChangedFilesBetweenTrees(ontoCommit.TreeObject, info.endTree) |
||||||
|
if err != nil { |
||||||
|
return Commit{}, fmt.Errorf("calculating file changes between %q and %q: %w", |
||||||
|
ontoCommit.Hash, commits[len(commits)-1].Hash, err) |
||||||
|
} |
||||||
|
|
||||||
|
ontoEndChangeFingerprint := genChangeFingerprint(nil, info.msg, ontoEndChangedFiles) |
||||||
|
if !bytes.Equal(ontoEndChangeFingerprint, info.changeFingerprint) { |
||||||
|
// TODO figure out what files to show as being the "problem files" in
|
||||||
|
// the error message
|
||||||
|
return Commit{}, fmt.Errorf("combining onto %q would produce a different change fingerprint, aborting combine", onto.Short()) |
||||||
|
} |
||||||
|
|
||||||
|
var creds []sigcred.CredentialUnion |
||||||
|
for _, commit := range commits { |
||||||
|
if bytes.Equal(commit.Payload.Common.Fingerprint, info.changeFingerprint) { |
||||||
|
creds = append(creds, commit.Payload.Common.Credentials...) |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// this is mostly to make tests easier
|
||||||
|
sort.Slice(creds, func(i, j int) bool { |
||||||
|
return creds[i].AccountID < creds[j].AccountID |
||||||
|
}) |
||||||
|
|
||||||
|
payUn := PayloadUnion{ |
||||||
|
Change: &PayloadChange{ |
||||||
|
Description: info.msg, |
||||||
|
}, |
||||||
|
Common: PayloadCommon{ |
||||||
|
Fingerprint: info.changeFingerprint, |
||||||
|
Credentials: creds, |
||||||
|
}, |
||||||
|
} |
||||||
|
|
||||||
|
commit, err := proj.CommitDirect(CommitDirectParams{ |
||||||
|
PayloadUnion: payUn, |
||||||
|
Author: strings.Join(authors, ","), |
||||||
|
ParentHash: ontoCommit.Hash, |
||||||
|
GitTree: info.endTree, |
||||||
|
}) |
||||||
|
if err != nil { |
||||||
|
return Commit{}, fmt.Errorf("storing commit: %w", err) |
||||||
|
} |
||||||
|
|
||||||
|
// set the onto branch to this new commit
|
||||||
|
newHeadRef := plumbing.NewHashReference(ontoBranchName, commit.Hash) |
||||||
|
if err := proj.GitRepo.Storer.SetReference(newHeadRef); err != nil { |
||||||
|
return Commit{}, fmt.Errorf("setting reference %q to new commit hash %q: %w", |
||||||
|
ontoBranchName, commit.Hash, err) |
||||||
|
} |
||||||
|
return commit, nil |
||||||
|
} |
||||||
@ -0,0 +1,43 @@ |
|||||||
|
package dehub |
||||||
|
|
||||||
|
import ( |
||||||
|
"errors" |
||||||
|
"fmt" |
||||||
|
"strings" |
||||||
|
) |
||||||
|
|
||||||
|
// PayloadComment describes the structure of a comment payload.
|
||||||
|
type PayloadComment struct { |
||||||
|
Comment string `yaml:"comment"` |
||||||
|
} |
||||||
|
|
||||||
|
var _ Payload = PayloadComment{} |
||||||
|
|
||||||
|
// NewPayloadComment constructs a PayloadUnion populated with a PayloadComment.
|
||||||
|
// The Credentials of the returned PayloadUnion will _not_ be filled in.
|
||||||
|
func (proj *Project) NewPayloadComment(comment string) (PayloadUnion, error) { |
||||||
|
payCom := PayloadComment{Comment: comment} |
||||||
|
fingerprint, err := payCom.Fingerprint(nil) |
||||||
|
if err != nil { |
||||||
|
return PayloadUnion{}, err |
||||||
|
} |
||||||
|
return PayloadUnion{ |
||||||
|
Comment: &payCom, |
||||||
|
Common: PayloadCommon{Fingerprint: fingerprint}, |
||||||
|
}, nil |
||||||
|
} |
||||||
|
|
||||||
|
// MessageHead implements the method for the Payload interface.
|
||||||
|
func (payCom PayloadComment) MessageHead(common PayloadCommon) (string, error) { |
||||||
|
credIDs := strings.Join(common.credIDs(), ", ") |
||||||
|
fullMsgHead := fmt.Sprintf("Comment by %s: %s", credIDs, payCom.Comment) |
||||||
|
return abbrevCommitMessage(fullMsgHead), nil |
||||||
|
} |
||||||
|
|
||||||
|
// Fingerprint implements the method for the Payload interface.
|
||||||
|
func (payCom PayloadComment) Fingerprint(changes []ChangedFile) ([]byte, error) { |
||||||
|
if len(changes) > 0 { |
||||||
|
return nil, errors.New("PayloadComment cannot have any changed files") |
||||||
|
} |
||||||
|
return genCommentFingerprint(nil, payCom.Comment), nil |
||||||
|
} |
||||||
@ -0,0 +1,73 @@ |
|||||||
|
package dehub |
||||||
|
|
||||||
|
import ( |
||||||
|
"errors" |
||||||
|
"fmt" |
||||||
|
"strings" |
||||||
|
) |
||||||
|
|
||||||
|
// PayloadCredential describes the structure of a credential payload.
|
||||||
|
type PayloadCredential struct { |
||||||
|
// CommitHashes represents the commits which this credential is accrediting.
|
||||||
|
// It is only present for informational purposes, as commits don't not have
|
||||||
|
// any bearing on the CredentialedHash itself.
|
||||||
|
CommitHashes []string `yaml:"commits,omitempty"` |
||||||
|
} |
||||||
|
|
||||||
|
var _ Payload = PayloadCredential{} |
||||||
|
|
||||||
|
// NewPayloadCredential constructs and returns a PayloadUnion populated with a
|
||||||
|
// PayloadCredential for the given fingerprint. The Credentials of the returned
|
||||||
|
// PayloadUnion will _not_ be filled in.
|
||||||
|
func (proj *Project) NewPayloadCredential(fingerprint []byte) (PayloadUnion, error) { |
||||||
|
return PayloadUnion{ |
||||||
|
Credential: &PayloadCredential{}, |
||||||
|
Common: PayloadCommon{Fingerprint: fingerprint}, |
||||||
|
}, nil |
||||||
|
} |
||||||
|
|
||||||
|
// NewPayloadCredentialFromChanges constructs and returns a PayloadUnion
|
||||||
|
// populated with a PayloadCredential. The fingerprint of the payload will be a
|
||||||
|
// change fingerprint encompassing all changes in the given range of Commits.
|
||||||
|
// The description of the last change payload in the range is used when
|
||||||
|
// generating the fingerprint.
|
||||||
|
func (proj *Project) NewPayloadCredentialFromChanges(commits []Commit) (PayloadUnion, error) { |
||||||
|
info, err := proj.changeRangeInfo(commits) |
||||||
|
if err != nil { |
||||||
|
return PayloadUnion{}, err |
||||||
|
} |
||||||
|
|
||||||
|
payCred, err := proj.NewPayloadCredential(info.changeFingerprint) |
||||||
|
if err != nil { |
||||||
|
return PayloadUnion{}, err |
||||||
|
} |
||||||
|
|
||||||
|
for _, commit := range info.changeCommits { |
||||||
|
payCred.Credential.CommitHashes = append( |
||||||
|
payCred.Credential.CommitHashes, |
||||||
|
commit.Hash.String(), |
||||||
|
) |
||||||
|
} |
||||||
|
return payCred, nil |
||||||
|
} |
||||||
|
|
||||||
|
// MessageHead implements the method for the Payload interface.
|
||||||
|
func (payCred PayloadCredential) MessageHead(common PayloadCommon) (string, error) { |
||||||
|
fingerprintStr := common.Fingerprint.String() |
||||||
|
if len(fingerprintStr) > 9 { |
||||||
|
fingerprintStr = fingerprintStr[:6] + "..." |
||||||
|
} |
||||||
|
credIDs := strings.Join(common.credIDs(), ", ") |
||||||
|
fullMsgHead := fmt.Sprintf("Credential of hash %s by %s", fingerprintStr, credIDs) |
||||||
|
return abbrevCommitMessage(fullMsgHead), nil |
||||||
|
} |
||||||
|
|
||||||
|
// Fingerprint implements the method for the Payload interface.
|
||||||
|
func (payCred PayloadCredential) Fingerprint(changes []ChangedFile) ([]byte, error) { |
||||||
|
if len(changes) > 0 { |
||||||
|
return nil, errors.New("PayloadCredential cannot have any changed files") |
||||||
|
} |
||||||
|
// a PayloadCredential can't compute its own fingerprint, it's stored in the
|
||||||
|
// common.
|
||||||
|
return nil, nil |
||||||
|
} |
||||||
@ -0,0 +1,326 @@ |
|||||||
|
// Package dehub TODO needs package docs
|
||||||
|
package dehub |
||||||
|
|
||||||
|
import ( |
||||||
|
"bytes" |
||||||
|
"errors" |
||||||
|
"fmt" |
||||||
|
"io" |
||||||
|
"os" |
||||||
|
"path/filepath" |
||||||
|
|
||||||
|
"dehub.dev/src/dehub.git/fs" |
||||||
|
|
||||||
|
"gopkg.in/src-d/go-billy.v4" |
||||||
|
"gopkg.in/src-d/go-billy.v4/memfs" |
||||||
|
"gopkg.in/src-d/go-git.v4" |
||||||
|
"gopkg.in/src-d/go-git.v4/plumbing" |
||||||
|
"gopkg.in/src-d/go-git.v4/plumbing/cache" |
||||||
|
"gopkg.in/src-d/go-git.v4/plumbing/format/config" |
||||||
|
"gopkg.in/src-d/go-git.v4/storage" |
||||||
|
"gopkg.in/src-d/go-git.v4/storage/filesystem" |
||||||
|
) |
||||||
|
|
||||||
|
const ( |
||||||
|
// DehubDir defines the name of the directory where all dehub-related files
|
||||||
|
// are expected to be found within the git repo.
|
||||||
|
DehubDir = ".dehub" |
||||||
|
) |
||||||
|
|
||||||
|
var ( |
||||||
|
// ConfigPath defines the expected path to the Project's configuration file.
|
||||||
|
ConfigPath = filepath.Join(DehubDir, "config.yml") |
||||||
|
|
||||||
|
// Main defines the name of the main branch.
|
||||||
|
Main = "main" |
||||||
|
|
||||||
|
// MainRefName defines the reference name of the main branch.
|
||||||
|
MainRefName = plumbing.NewBranchReferenceName(Main) |
||||||
|
) |
||||||
|
|
||||||
|
type openOpts struct { |
||||||
|
bare bool |
||||||
|
} |
||||||
|
|
||||||
|
// OpenOption is an option which can be passed to the OpenProject function to
|
||||||
|
// affect the Project's behavior.
|
||||||
|
type OpenOption func(*openOpts) |
||||||
|
|
||||||
|
// OpenBareRepo returns an OpenOption which, if true is given, causes the
|
||||||
|
// OpenProject function to expect to open a bare git repo.
|
||||||
|
func OpenBareRepo(bare bool) OpenOption { |
||||||
|
return func(o *openOpts) { |
||||||
|
o.bare = bare |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// Project implements accessing and modifying a local dehub project, as well as
|
||||||
|
// extending the functionality of the underlying git repo in ways which are
|
||||||
|
// specifically useful for dehub projects.
|
||||||
|
type Project struct { |
||||||
|
// GitRepo is the git repository which houses the project.
|
||||||
|
GitRepo *git.Repository |
||||||
|
|
||||||
|
// GitDirFS corresponds to the .git directory (or the entire repo directory
|
||||||
|
// if it's a bare repo)
|
||||||
|
GitDirFS billy.Filesystem |
||||||
|
} |
||||||
|
|
||||||
|
func extractGitDirFS(storer storage.Storer) (billy.Filesystem, error) { |
||||||
|
dotGitFSer, ok := storer.(interface{ Filesystem() billy.Filesystem }) |
||||||
|
if !ok { |
||||||
|
return nil, fmt.Errorf("git storage object of type %T does not expose its underlying filesystem", |
||||||
|
storer) |
||||||
|
} |
||||||
|
return dotGitFSer.Filesystem(), nil |
||||||
|
} |
||||||
|
|
||||||
|
// OpenProject opens the dehub project in the given directory and returns a
|
||||||
|
// Project instance for it.
|
||||||
|
//
|
||||||
|
// The given path is expected to have a git repo already initialized.
|
||||||
|
func OpenProject(path string, options ...OpenOption) (*Project, error) { |
||||||
|
var opts openOpts |
||||||
|
for _, opt := range options { |
||||||
|
opt(&opts) |
||||||
|
} |
||||||
|
|
||||||
|
proj := Project{} |
||||||
|
var err error |
||||||
|
openOpts := &git.PlainOpenOptions{ |
||||||
|
DetectDotGit: !opts.bare, |
||||||
|
} |
||||||
|
if proj.GitRepo, err = git.PlainOpenWithOptions(path, openOpts); err != nil { |
||||||
|
return nil, fmt.Errorf("opening git repo: %w", err) |
||||||
|
|
||||||
|
} else if proj.GitDirFS, err = extractGitDirFS(proj.GitRepo.Storer); err != nil { |
||||||
|
return nil, err |
||||||
|
} |
||||||
|
|
||||||
|
return &proj, nil |
||||||
|
} |
||||||
|
|
||||||
|
type initOpts struct { |
||||||
|
bare bool |
||||||
|
remote bool |
||||||
|
} |
||||||
|
|
||||||
|
// InitOption is an option which can be passed into the Init functions to affect
|
||||||
|
// their behavior.
|
||||||
|
type InitOption func(*initOpts) |
||||||
|
|
||||||
|
// InitBareRepo returns an InitOption which, if true is given, causes the Init
|
||||||
|
// function to initialize the project's git repo without a worktree.
|
||||||
|
func InitBareRepo(bare bool) InitOption { |
||||||
|
return func(o *initOpts) { |
||||||
|
o.bare = bare |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// InitRemoteRepo returns an InitOption which, if true is given, causes the Init
|
||||||
|
// function to initialize the project's git repo with certain git configuration
|
||||||
|
// options set which make the repo able to be used as a remote repo.
|
||||||
|
func InitRemoteRepo(remote bool) InitOption { |
||||||
|
return func(o *initOpts) { |
||||||
|
o.remote = remote |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// InitProject will initialize a new project at the given path. If bare is true
|
||||||
|
// then the project's git repo will not have a worktree.
|
||||||
|
func InitProject(path string, options ...InitOption) (*Project, error) { |
||||||
|
var opts initOpts |
||||||
|
for _, opt := range options { |
||||||
|
opt(&opts) |
||||||
|
} |
||||||
|
|
||||||
|
var proj Project |
||||||
|
var err error |
||||||
|
if proj.GitRepo, err = git.PlainInit(path, opts.bare); err != nil { |
||||||
|
return nil, fmt.Errorf("initializing git repo: %w", err) |
||||||
|
|
||||||
|
} else if proj.GitDirFS, err = extractGitDirFS(proj.GitRepo.Storer); err != nil { |
||||||
|
return nil, err |
||||||
|
|
||||||
|
} else if err = proj.init(opts); err != nil { |
||||||
|
return nil, fmt.Errorf("initializing repo with dehub defaults: %w", err) |
||||||
|
} |
||||||
|
|
||||||
|
return &proj, nil |
||||||
|
} |
||||||
|
|
||||||
|
// InitMemProject initializes an empty project which only exists in memory.
|
||||||
|
func InitMemProject(options ...InitOption) *Project { |
||||||
|
var opts initOpts |
||||||
|
for _, opt := range options { |
||||||
|
opt(&opts) |
||||||
|
} |
||||||
|
|
||||||
|
fs := memfs.New() |
||||||
|
dotGitFS, err := fs.Chroot(git.GitDirName) |
||||||
|
if err != nil { |
||||||
|
panic(err) |
||||||
|
} |
||||||
|
storage := filesystem.NewStorage(dotGitFS, cache.NewObjectLRUDefault()) |
||||||
|
|
||||||
|
var worktree billy.Filesystem |
||||||
|
if !opts.bare { |
||||||
|
worktree = fs |
||||||
|
} |
||||||
|
|
||||||
|
r, err := git.Init(storage, worktree) |
||||||
|
if err != nil { |
||||||
|
panic(err) |
||||||
|
} |
||||||
|
|
||||||
|
proj := &Project{GitRepo: r, GitDirFS: dotGitFS} |
||||||
|
if err := proj.init(opts); err != nil { |
||||||
|
panic(err) |
||||||
|
} |
||||||
|
return proj |
||||||
|
} |
||||||
|
|
||||||
|
func (proj *Project) initRemotePreReceive(bare bool) error { |
||||||
|
if err := proj.GitDirFS.MkdirAll("hooks", 0755); err != nil { |
||||||
|
return fmt.Errorf("creating hooks directory: %w", err) |
||||||
|
} |
||||||
|
|
||||||
|
preRcvFlags := os.O_WRONLY | os.O_CREATE | os.O_TRUNC |
||||||
|
preRcv, err := proj.GitDirFS.OpenFile("hooks/pre-receive", preRcvFlags, 0755) |
||||||
|
if err != nil { |
||||||
|
return fmt.Errorf("opening hooks/pre-receive file: %w", err) |
||||||
|
} |
||||||
|
defer preRcv.Close() |
||||||
|
|
||||||
|
var preRcvBody string |
||||||
|
if bare { |
||||||
|
preRcvBody = "#!/bin/sh\nexec dehub hook -bare -pre-receive\n" |
||||||
|
} else { |
||||||
|
preRcvBody = "#!/bin/sh\nexec dehub hook -pre-receive\n" |
||||||
|
} |
||||||
|
|
||||||
|
if _, err := io.Copy(preRcv, bytes.NewBufferString(preRcvBody)); err != nil { |
||||||
|
return fmt.Errorf("writing to hooks/pre-receive: %w", err) |
||||||
|
} |
||||||
|
return nil |
||||||
|
} |
||||||
|
|
||||||
|
func (proj *Project) init(opts initOpts) error { |
||||||
|
headRef := plumbing.NewSymbolicReference(plumbing.HEAD, MainRefName) |
||||||
|
if err := proj.GitRepo.Storer.SetReference(headRef); err != nil { |
||||||
|
return fmt.Errorf("setting HEAD reference to %q: %w", MainRefName, err) |
||||||
|
} |
||||||
|
|
||||||
|
if opts.remote { |
||||||
|
cfg, err := proj.GitRepo.Config() |
||||||
|
if err != nil { |
||||||
|
return fmt.Errorf("opening git cfg: %w", err) |
||||||
|
} |
||||||
|
|
||||||
|
cfg.Raw = cfg.Raw.AddOption("http", config.NoSubsection, "receivepack", "true") |
||||||
|
if err := proj.GitRepo.Storer.SetConfig(cfg); err != nil { |
||||||
|
return fmt.Errorf("storing modified git config: %w", err) |
||||||
|
} |
||||||
|
|
||||||
|
if err := proj.initRemotePreReceive(opts.bare); err != nil { |
||||||
|
return fmt.Errorf("initializing pre-receive hook for remote-enabled repo: %w", err) |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
return nil |
||||||
|
} |
||||||
|
|
||||||
|
func (proj *Project) billyFilesystem() (billy.Filesystem, error) { |
||||||
|
w, err := proj.GitRepo.Worktree() |
||||||
|
if err != nil { |
||||||
|
return nil, fmt.Errorf("opening git worktree: %w", err) |
||||||
|
} |
||||||
|
return w.Filesystem, nil |
||||||
|
} |
||||||
|
|
||||||
|
var errTraverseRefNoMatch = errors.New("failed to find reference matching given predicate") |
||||||
|
|
||||||
|
// TraverseReferenceChain resolves a chain of references, calling the given
|
||||||
|
// predicate on each one, and returning the first one for which the predicate
|
||||||
|
// returns true. This method will return an error if it reaches the end of the
|
||||||
|
// chain and the predicate still has not returned true.
|
||||||
|
//
|
||||||
|
// If a reference name is encountered which does not actually exist, then it is
|
||||||
|
// assumed to be a hash reference to the zero hash.
|
||||||
|
func (proj *Project) TraverseReferenceChain(refName plumbing.ReferenceName, pred func(*plumbing.Reference) bool) (*plumbing.Reference, error) { |
||||||
|
// TODO infinite loop checking
|
||||||
|
// TODO check that this (and the methods which use it) are actually useful
|
||||||
|
for { |
||||||
|
ref, err := proj.GitRepo.Storer.Reference(refName) |
||||||
|
if errors.Is(err, plumbing.ErrReferenceNotFound) { |
||||||
|
ref = plumbing.NewHashReference(refName, plumbing.ZeroHash) |
||||||
|
} else if err != nil { |
||||||
|
return nil, fmt.Errorf("resolving reference %q: %w", refName, err) |
||||||
|
} |
||||||
|
|
||||||
|
if pred(ref) { |
||||||
|
return ref, nil |
||||||
|
} else if ref.Type() != plumbing.SymbolicReference { |
||||||
|
return nil, errTraverseRefNoMatch |
||||||
|
} |
||||||
|
refName = ref.Target() |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// ErrNoBranchReference is returned from ReferenceToBranchName if no reference
|
||||||
|
// in the reference chain is for a branch.
|
||||||
|
var ErrNoBranchReference = errors.New("no branch reference found") |
||||||
|
|
||||||
|
// ReferenceToBranchName traverses a chain of references looking for the first
|
||||||
|
// branch reference, and returns that name, or returns ErrNoBranchReference if
|
||||||
|
// no branch reference is part of the chain.
|
||||||
|
func (proj *Project) ReferenceToBranchName(refName plumbing.ReferenceName) (plumbing.ReferenceName, error) { |
||||||
|
// first check if the given refName is a branch, if so just return that.
|
||||||
|
if refName.IsBranch() { |
||||||
|
return refName, nil |
||||||
|
} |
||||||
|
|
||||||
|
ref, err := proj.TraverseReferenceChain(refName, func(ref *plumbing.Reference) bool { |
||||||
|
return ref.Target().IsBranch() |
||||||
|
}) |
||||||
|
if errors.Is(err, errTraverseRefNoMatch) { |
||||||
|
return "", ErrNoBranchReference |
||||||
|
} else if err != nil { |
||||||
|
return "", fmt.Errorf("traversing reference chain: %w", err) |
||||||
|
} |
||||||
|
return ref.Target(), nil |
||||||
|
} |
||||||
|
|
||||||
|
// ReferenceToHash fully resolves a reference to a hash. If a reference cannot
|
||||||
|
// be resolved then plumbing.ZeroHash is returned.
|
||||||
|
func (proj *Project) ReferenceToHash(refName plumbing.ReferenceName) (plumbing.Hash, error) { |
||||||
|
ref, err := proj.TraverseReferenceChain(refName, func(ref *plumbing.Reference) bool { |
||||||
|
return ref.Type() == plumbing.HashReference |
||||||
|
}) |
||||||
|
if errors.Is(err, errTraverseRefNoMatch) { |
||||||
|
return plumbing.ZeroHash, errors.New("no hash in reference chain (is this even possible???)") |
||||||
|
} else if errors.Is(err, plumbing.ErrReferenceNotFound) { |
||||||
|
return plumbing.ZeroHash, nil |
||||||
|
} else if err != nil { |
||||||
|
return plumbing.ZeroHash, fmt.Errorf("traversing reference chain: %w", err) |
||||||
|
} |
||||||
|
return ref.Hash(), nil |
||||||
|
} |
||||||
|
|
||||||
|
// headFS returns an FS based on the HEAD commit, or if there is no HEAD commit
|
||||||
|
// (it's an empty repo) an FS based on the raw filesystem.
|
||||||
|
func (proj *Project) headFS() (fs.FS, error) { |
||||||
|
head, err := proj.GetHeadCommit() |
||||||
|
if errors.Is(err, ErrHeadIsZero) { |
||||||
|
bfs, err := proj.billyFilesystem() |
||||||
|
if err != nil { |
||||||
|
return nil, fmt.Errorf("getting underlying filesystem: %w", err) |
||||||
|
} |
||||||
|
return fs.FromBillyFilesystem(bfs), nil |
||||||
|
|
||||||
|
} else if err != nil { |
||||||
|
return nil, fmt.Errorf("could not get HEAD tree: %w", err) |
||||||
|
} |
||||||
|
|
||||||
|
return fs.FromTree(head.TreeObject), nil |
||||||
|
} |
||||||
@ -1,544 +0,0 @@ |
|||||||
// Package dehub TODO needs package docs
|
|
||||||
package dehub |
|
||||||
|
|
||||||
import ( |
|
||||||
"bytes" |
|
||||||
"encoding/hex" |
|
||||||
"errors" |
|
||||||
"fmt" |
|
||||||
"io" |
|
||||||
"os" |
|
||||||
"path/filepath" |
|
||||||
"strings" |
|
||||||
|
|
||||||
"dehub.dev/src/dehub.git/fs" |
|
||||||
|
|
||||||
"gopkg.in/src-d/go-billy.v4" |
|
||||||
"gopkg.in/src-d/go-billy.v4/memfs" |
|
||||||
"gopkg.in/src-d/go-git.v4" |
|
||||||
"gopkg.in/src-d/go-git.v4/plumbing" |
|
||||||
"gopkg.in/src-d/go-git.v4/plumbing/cache" |
|
||||||
"gopkg.in/src-d/go-git.v4/plumbing/format/config" |
|
||||||
"gopkg.in/src-d/go-git.v4/plumbing/object" |
|
||||||
"gopkg.in/src-d/go-git.v4/storage" |
|
||||||
"gopkg.in/src-d/go-git.v4/storage/filesystem" |
|
||||||
) |
|
||||||
|
|
||||||
const ( |
|
||||||
// DehubDir defines the name of the directory where all dehub-related files are
|
|
||||||
// expected to be found.
|
|
||||||
DehubDir = ".dehub" |
|
||||||
) |
|
||||||
|
|
||||||
var ( |
|
||||||
// ConfigPath defines the expected path to the Repo's configuration file.
|
|
||||||
ConfigPath = filepath.Join(DehubDir, "config.yml") |
|
||||||
|
|
||||||
// Main defines the name of the main branch.
|
|
||||||
Main = "main" |
|
||||||
|
|
||||||
// MainRefName defines the reference name of the main branch.
|
|
||||||
MainRefName = plumbing.NewBranchReferenceName(Main) |
|
||||||
) |
|
||||||
|
|
||||||
type openOpts struct { |
|
||||||
bare bool |
|
||||||
} |
|
||||||
|
|
||||||
// OpenOption is an option which can be passed to the OpenRepo function to
|
|
||||||
// affect the Repo's behavior.
|
|
||||||
type OpenOption func(*openOpts) |
|
||||||
|
|
||||||
// OpenBare returns an OpenOption which, if true is given, causes the OpenRepo
|
|
||||||
// function to expect to open a bare repo.
|
|
||||||
func OpenBare(bare bool) OpenOption { |
|
||||||
return func(o *openOpts) { |
|
||||||
o.bare = bare |
|
||||||
} |
|
||||||
} |
|
||||||
|
|
||||||
// Repo is an object which allows accessing and modifying the dehub repo.
|
|
||||||
type Repo struct { |
|
||||||
GitRepo *git.Repository |
|
||||||
|
|
||||||
// GitDirFS corresponds to the .git directory (or the entire repo directory
|
|
||||||
// if it's a bare repo)
|
|
||||||
GitDirFS billy.Filesystem |
|
||||||
} |
|
||||||
|
|
||||||
func extractGitDirFS(storer storage.Storer) (billy.Filesystem, error) { |
|
||||||
dotGitFSer, ok := storer.(interface{ Filesystem() billy.Filesystem }) |
|
||||||
if !ok { |
|
||||||
return nil, fmt.Errorf("git storage object of type %T does not expose its underlying filesystem", |
|
||||||
storer) |
|
||||||
} |
|
||||||
return dotGitFSer.Filesystem(), nil |
|
||||||
} |
|
||||||
|
|
||||||
// OpenRepo opens the dehub repo in the given directory and returns the object
|
|
||||||
// for it.
|
|
||||||
//
|
|
||||||
// The given path is expected to have a git repo and .dehub folder already
|
|
||||||
// initialized.
|
|
||||||
func OpenRepo(path string, options ...OpenOption) (*Repo, error) { |
|
||||||
var opts openOpts |
|
||||||
for _, opt := range options { |
|
||||||
opt(&opts) |
|
||||||
} |
|
||||||
|
|
||||||
r := Repo{} |
|
||||||
var err error |
|
||||||
openOpts := &git.PlainOpenOptions{ |
|
||||||
DetectDotGit: !opts.bare, |
|
||||||
} |
|
||||||
if r.GitRepo, err = git.PlainOpenWithOptions(path, openOpts); err != nil { |
|
||||||
return nil, fmt.Errorf("could not open git repo: %w", err) |
|
||||||
|
|
||||||
} else if r.GitDirFS, err = extractGitDirFS(r.GitRepo.Storer); err != nil { |
|
||||||
return nil, err |
|
||||||
} |
|
||||||
|
|
||||||
return &r, nil |
|
||||||
} |
|
||||||
|
|
||||||
type initOpts struct { |
|
||||||
bare bool |
|
||||||
remote bool |
|
||||||
} |
|
||||||
|
|
||||||
// InitOption is an option which can be passed into the Init functions to affect
|
|
||||||
// their behavior.
|
|
||||||
type InitOption func(*initOpts) |
|
||||||
|
|
||||||
// InitBare returns an InitOption which, if true is given, causes the Init
|
|
||||||
// function to initialize the repo without a worktree.
|
|
||||||
func InitBare(bare bool) InitOption { |
|
||||||
return func(o *initOpts) { |
|
||||||
o.bare = bare |
|
||||||
} |
|
||||||
} |
|
||||||
|
|
||||||
// InitRemote returns an InitOption which, if true is given, causes the Init
|
|
||||||
// function to initialize the repo with certain git configuration options set
|
|
||||||
// which make the repo able to be used as a remote repo.
|
|
||||||
func InitRemote(remote bool) InitOption { |
|
||||||
return func(o *initOpts) { |
|
||||||
o.remote = remote |
|
||||||
} |
|
||||||
} |
|
||||||
|
|
||||||
// InitRepo will initialize a new repository at the given path. If bare is true
|
|
||||||
// then the repository will not have a worktree.
|
|
||||||
func InitRepo(path string, options ...InitOption) (*Repo, error) { |
|
||||||
var opts initOpts |
|
||||||
for _, opt := range options { |
|
||||||
opt(&opts) |
|
||||||
} |
|
||||||
|
|
||||||
var repo Repo |
|
||||||
var err error |
|
||||||
if repo.GitRepo, err = git.PlainInit(path, opts.bare); err != nil { |
|
||||||
return nil, fmt.Errorf("initializing git repo: %w", err) |
|
||||||
|
|
||||||
} else if repo.GitDirFS, err = extractGitDirFS(repo.GitRepo.Storer); err != nil { |
|
||||||
return nil, err |
|
||||||
|
|
||||||
} else if err = repo.init(opts); err != nil { |
|
||||||
return nil, fmt.Errorf("initializing repo with dehub defaults: %w", err) |
|
||||||
} |
|
||||||
|
|
||||||
return &repo, nil |
|
||||||
} |
|
||||||
|
|
||||||
// InitMemRepo initializes an empty repository which only exists in memory.
|
|
||||||
func InitMemRepo(options ...InitOption) *Repo { |
|
||||||
var opts initOpts |
|
||||||
for _, opt := range options { |
|
||||||
opt(&opts) |
|
||||||
} |
|
||||||
|
|
||||||
fs := memfs.New() |
|
||||||
dotGitFS, err := fs.Chroot(git.GitDirName) |
|
||||||
if err != nil { |
|
||||||
panic(err) |
|
||||||
} |
|
||||||
storage := filesystem.NewStorage(dotGitFS, cache.NewObjectLRUDefault()) |
|
||||||
|
|
||||||
var worktree billy.Filesystem |
|
||||||
if !opts.bare { |
|
||||||
worktree = fs |
|
||||||
} |
|
||||||
|
|
||||||
r, err := git.Init(storage, worktree) |
|
||||||
if err != nil { |
|
||||||
panic(err) |
|
||||||
} |
|
||||||
|
|
||||||
repo := &Repo{GitRepo: r, GitDirFS: dotGitFS} |
|
||||||
if err := repo.init(opts); err != nil { |
|
||||||
panic(err) |
|
||||||
} |
|
||||||
return repo |
|
||||||
} |
|
||||||
|
|
||||||
func (r *Repo) initRemotePreReceive(bare bool) error { |
|
||||||
if err := r.GitDirFS.MkdirAll("hooks", 0755); err != nil { |
|
||||||
return fmt.Errorf("creating hooks directory: %w", err) |
|
||||||
} |
|
||||||
|
|
||||||
preRcvFlags := os.O_WRONLY | os.O_CREATE | os.O_TRUNC |
|
||||||
preRcv, err := r.GitDirFS.OpenFile("hooks/pre-receive", preRcvFlags, 0755) |
|
||||||
if err != nil { |
|
||||||
return fmt.Errorf("opening hooks/pre-receive file: %w", err) |
|
||||||
} |
|
||||||
defer preRcv.Close() |
|
||||||
|
|
||||||
var preRcvBody string |
|
||||||
if bare { |
|
||||||
preRcvBody = "#!/bin/sh\nexec dehub hook -bare -pre-receive\n" |
|
||||||
} else { |
|
||||||
preRcvBody = "#!/bin/sh\nexec dehub hook -pre-receive\n" |
|
||||||
} |
|
||||||
|
|
||||||
if _, err := io.Copy(preRcv, bytes.NewBufferString(preRcvBody)); err != nil { |
|
||||||
return fmt.Errorf("writing to hooks/pre-receive: %w", err) |
|
||||||
} |
|
||||||
return nil |
|
||||||
} |
|
||||||
|
|
||||||
func (r *Repo) init(opts initOpts) error { |
|
||||||
headRef := plumbing.NewSymbolicReference(plumbing.HEAD, MainRefName) |
|
||||||
if err := r.GitRepo.Storer.SetReference(headRef); err != nil { |
|
||||||
return fmt.Errorf("setting HEAD reference to %q: %w", MainRefName, err) |
|
||||||
} |
|
||||||
|
|
||||||
if opts.remote { |
|
||||||
cfg, err := r.GitRepo.Config() |
|
||||||
if err != nil { |
|
||||||
return fmt.Errorf("opening git cfg: %w", err) |
|
||||||
} |
|
||||||
|
|
||||||
cfg.Raw = cfg.Raw.AddOption("http", config.NoSubsection, "receivepack", "true") |
|
||||||
if err := r.GitRepo.Storer.SetConfig(cfg); err != nil { |
|
||||||
return fmt.Errorf("storing modified git config: %w", err) |
|
||||||
} |
|
||||||
|
|
||||||
if err := r.initRemotePreReceive(opts.bare); err != nil { |
|
||||||
return fmt.Errorf("initializing pre-receive hook for remote-enabled repo: %w", err) |
|
||||||
} |
|
||||||
} |
|
||||||
|
|
||||||
return nil |
|
||||||
} |
|
||||||
|
|
||||||
func (r *Repo) billyFilesystem() (billy.Filesystem, error) { |
|
||||||
w, err := r.GitRepo.Worktree() |
|
||||||
if err != nil { |
|
||||||
return nil, fmt.Errorf("opening git worktree: %w", err) |
|
||||||
} |
|
||||||
return w.Filesystem, nil |
|
||||||
} |
|
||||||
|
|
||||||
var errTraverseRefNoMatch = errors.New("failed to find reference matching given predicate") |
|
||||||
|
|
||||||
// TraverseReferenceChain resolves a chain of references, calling the given
|
|
||||||
// predicate on each one, and returning the first one for which the predicate
|
|
||||||
// returns true. This method will return an error if it reaches the end of the
|
|
||||||
// chain and the predicate still has not returned true.
|
|
||||||
//
|
|
||||||
// If a reference name is encountered which does not actually exist, then it is
|
|
||||||
// assumed to be a hash reference to the zero hash.
|
|
||||||
func (r *Repo) TraverseReferenceChain(refName plumbing.ReferenceName, pred func(*plumbing.Reference) bool) (*plumbing.Reference, error) { |
|
||||||
// TODO infinite loop checking
|
|
||||||
for { |
|
||||||
ref, err := r.GitRepo.Storer.Reference(refName) |
|
||||||
if errors.Is(err, plumbing.ErrReferenceNotFound) { |
|
||||||
ref = plumbing.NewHashReference(refName, plumbing.ZeroHash) |
|
||||||
} else if err != nil { |
|
||||||
return nil, fmt.Errorf("resolving reference %q: %w", refName, err) |
|
||||||
} |
|
||||||
|
|
||||||
if pred(ref) { |
|
||||||
return ref, nil |
|
||||||
} else if ref.Type() != plumbing.SymbolicReference { |
|
||||||
return nil, errTraverseRefNoMatch |
|
||||||
} |
|
||||||
refName = ref.Target() |
|
||||||
} |
|
||||||
} |
|
||||||
|
|
||||||
// ErrNoBranchReference is returned from ReferenceToBranchName if no reference
|
|
||||||
// in the reference chain is for a branch.
|
|
||||||
var ErrNoBranchReference = errors.New("no branch reference found") |
|
||||||
|
|
||||||
// ReferenceToBranchName traverses a chain of references looking for the first
|
|
||||||
// branch reference, and returns that name, or returns ErrNoBranchReference if
|
|
||||||
// no branch reference is part of the chain.
|
|
||||||
func (r *Repo) ReferenceToBranchName(refName plumbing.ReferenceName) (plumbing.ReferenceName, error) { |
|
||||||
// first check if the given refName is a branch, if so just return that.
|
|
||||||
if refName.IsBranch() { |
|
||||||
return refName, nil |
|
||||||
} |
|
||||||
|
|
||||||
ref, err := r.TraverseReferenceChain(refName, func(ref *plumbing.Reference) bool { |
|
||||||
return ref.Target().IsBranch() |
|
||||||
}) |
|
||||||
if errors.Is(err, errTraverseRefNoMatch) { |
|
||||||
return "", ErrNoBranchReference |
|
||||||
} else if err != nil { |
|
||||||
return "", fmt.Errorf("traversing reference chain: %w", err) |
|
||||||
} |
|
||||||
return ref.Target(), nil |
|
||||||
} |
|
||||||
|
|
||||||
// ReferenceToHash fully resolves a reference to a hash. If a reference cannot
|
|
||||||
// be resolved then plumbing.ZeroHash is returned.
|
|
||||||
func (r *Repo) ReferenceToHash(refName plumbing.ReferenceName) (plumbing.Hash, error) { |
|
||||||
ref, err := r.TraverseReferenceChain(refName, func(ref *plumbing.Reference) bool { |
|
||||||
return ref.Type() == plumbing.HashReference |
|
||||||
}) |
|
||||||
if errors.Is(err, errTraverseRefNoMatch) { |
|
||||||
return plumbing.ZeroHash, errors.New("no hash in reference chain (is this even possible???)") |
|
||||||
} else if errors.Is(err, plumbing.ErrReferenceNotFound) { |
|
||||||
return plumbing.ZeroHash, nil |
|
||||||
} else if err != nil { |
|
||||||
return plumbing.ZeroHash, fmt.Errorf("traversing reference chain: %w", err) |
|
||||||
} |
|
||||||
return ref.Hash(), nil |
|
||||||
} |
|
||||||
|
|
||||||
// headFS returns an FS based on the HEAD commit, or if there is no HEAD commit
|
|
||||||
// (it's an empty repo) an FS based on the raw filesystem.
|
|
||||||
func (r *Repo) headFS() (fs.FS, error) { |
|
||||||
head, err := r.GetGitHead() |
|
||||||
if errors.Is(err, ErrHeadIsZero) { |
|
||||||
bfs, err := r.billyFilesystem() |
|
||||||
if err != nil { |
|
||||||
return nil, fmt.Errorf("getting underlying filesystem: %w", err) |
|
||||||
} |
|
||||||
return fs.FromBillyFilesystem(bfs), nil |
|
||||||
|
|
||||||
} else if err != nil { |
|
||||||
return nil, fmt.Errorf("could not get HEAD tree: %w", err) |
|
||||||
} |
|
||||||
|
|
||||||
return fs.FromTree(head.GitTree), nil |
|
||||||
} |
|
||||||
|
|
||||||
// GitCommit wraps a single git commit object, and also contains various fields
|
|
||||||
// which are parsed out of it. It is used as a convenience type, in place of
|
|
||||||
// having to manually retrieve and parse specific information out of commit
|
|
||||||
// objects.
|
|
||||||
type GitCommit struct { |
|
||||||
GitCommit *object.Commit |
|
||||||
|
|
||||||
// Fields based on that Commit, which can't be directly gleaned from it.
|
|
||||||
GitTree *object.Tree |
|
||||||
Commit Commit |
|
||||||
Interface CommitInterface |
|
||||||
} |
|
||||||
|
|
||||||
// Root returns true if this commit is the root commit in its branch (i.e. it
|
|
||||||
// has no parents)
|
|
||||||
func (gc GitCommit) Root() bool { |
|
||||||
return gc.GitCommit.NumParents() == 0 |
|
||||||
} |
|
||||||
|
|
||||||
// GetGitCommit retrieves the commit at the given hash, and all of its sub-data
|
|
||||||
// which can be pulled out of it.
|
|
||||||
func (r *Repo) GetGitCommit(h plumbing.Hash) (gc GitCommit, err error) { |
|
||||||
if gc.GitCommit, err = r.GitRepo.CommitObject(h); err != nil { |
|
||||||
return gc, fmt.Errorf("getting git commit object: %w", err) |
|
||||||
} else if gc.GitTree, err = r.GitRepo.TreeObject(gc.GitCommit.TreeHash); err != nil { |
|
||||||
return gc, fmt.Errorf("getting git tree object %q: %w", |
|
||||||
gc.GitCommit.TreeHash, err) |
|
||||||
} else if gc.Commit.UnmarshalText([]byte(gc.GitCommit.Message)); err != nil { |
|
||||||
return gc, fmt.Errorf("decoding commit message: %w", err) |
|
||||||
} else if gc.Interface, err = gc.Commit.Interface(); err != nil { |
|
||||||
return gc, fmt.Errorf("casting %+v to a CommitInterface: %w", gc.Commit, err) |
|
||||||
} |
|
||||||
return |
|
||||||
} |
|
||||||
|
|
||||||
// ErrHeadIsZero is used to indicate that HEAD resolves to the zero hash. An
|
|
||||||
// example of when this can happen is if the repo was just initialized and has
|
|
||||||
// no commits, or if an orphan branch is checked out.
|
|
||||||
var ErrHeadIsZero = errors.New("HEAD resolves to the zero hash") |
|
||||||
|
|
||||||
// GetGitHead returns the GitCommit which is currently referenced by HEAD.
|
|
||||||
// This method may return ErrHeadIsZero if HEAD resolves to the zero hash.
|
|
||||||
func (r *Repo) GetGitHead() (GitCommit, error) { |
|
||||||
headHash, err := r.ReferenceToHash(plumbing.HEAD) |
|
||||||
if err != nil { |
|
||||||
return GitCommit{}, fmt.Errorf("resolving HEAD: %w", err) |
|
||||||
} else if headHash == plumbing.ZeroHash { |
|
||||||
return GitCommit{}, ErrHeadIsZero |
|
||||||
} |
|
||||||
|
|
||||||
gc, err := r.GetGitCommit(headHash) |
|
||||||
if err != nil { |
|
||||||
return GitCommit{}, fmt.Errorf("getting commit %q: %w", headHash, err) |
|
||||||
} |
|
||||||
return gc, nil |
|
||||||
} |
|
||||||
|
|
||||||
// GetGitCommitRange returns an ancestry of GitCommits, with the first being the
|
|
||||||
// commit immediately following the given starting hash, and the last being the
|
|
||||||
// given ending hash.
|
|
||||||
//
|
|
||||||
// If start is plumbing.ZeroHash then the root commit will be the starting one.
|
|
||||||
func (r *Repo) GetGitCommitRange(start, end plumbing.Hash) ([]GitCommit, error) { |
|
||||||
curr, err := r.GetGitCommit(end) |
|
||||||
if err != nil { |
|
||||||
return nil, fmt.Errorf("retrieving commit %q: %w", end, err) |
|
||||||
} |
|
||||||
|
|
||||||
var commits []GitCommit |
|
||||||
var found bool |
|
||||||
for { |
|
||||||
if found = start != plumbing.ZeroHash && curr.GitCommit.Hash == start; found { |
|
||||||
break |
|
||||||
} |
|
||||||
|
|
||||||
commits = append(commits, curr) |
|
||||||
numParents := curr.GitCommit.NumParents() |
|
||||||
if numParents == 0 { |
|
||||||
break |
|
||||||
} else if numParents > 1 { |
|
||||||
return nil, fmt.Errorf("commit %q has more than one parent: %+v", |
|
||||||
curr.GitCommit.Hash, curr.GitCommit.ParentHashes) |
|
||||||
} |
|
||||||
|
|
||||||
parentHash := curr.GitCommit.ParentHashes[0] |
|
||||||
parent, err := r.GetGitCommit(parentHash) |
|
||||||
if err != nil { |
|
||||||
return nil, fmt.Errorf("retrieving commit %q: %w", parentHash, err) |
|
||||||
} |
|
||||||
curr = parent |
|
||||||
} |
|
||||||
if !found && start != plumbing.ZeroHash { |
|
||||||
return nil, fmt.Errorf("unable to find commit %q as an ancestor of %q", |
|
||||||
start, end) |
|
||||||
} |
|
||||||
|
|
||||||
// reverse the commits to be in the expected order
|
|
||||||
for l, r := 0, len(commits)-1; l < r; l, r = l+1, r-1 { |
|
||||||
commits[l], commits[r] = commits[r], commits[l] |
|
||||||
} |
|
||||||
return commits, nil |
|
||||||
} |
|
||||||
|
|
||||||
var ( |
|
||||||
hashStrLen = len(plumbing.ZeroHash.String()) |
|
||||||
errNotHex = errors.New("not a valid hex string") |
|
||||||
) |
|
||||||
|
|
||||||
func (r *Repo) findCommitByShortHash(hashStr string) (plumbing.Hash, error) { |
|
||||||
paddedHashStr := hashStr |
|
||||||
if len(hashStr)%2 > 0 { |
|
||||||
paddedHashStr += "0" |
|
||||||
} |
|
||||||
|
|
||||||
if hashB, err := hex.DecodeString(paddedHashStr); err != nil { |
|
||||||
return plumbing.ZeroHash, errNotHex |
|
||||||
} else if len(hashStr) == hashStrLen { |
|
||||||
var hash plumbing.Hash |
|
||||||
copy(hash[:], hashB) |
|
||||||
return hash, nil |
|
||||||
} else if len(hashStr) < 2 { |
|
||||||
return plumbing.ZeroHash, errors.New("hash string must be 2 characters long or more") |
|
||||||
} |
|
||||||
|
|
||||||
for i := 2; i < hashStrLen; i++ { |
|
||||||
hashPrefix, hashTail := hashStr[:i], hashStr[i:] |
|
||||||
path := filepath.Join("objects", hashPrefix) |
|
||||||
fileInfos, err := r.GitDirFS.ReadDir(path) |
|
||||||
if err != nil { |
|
||||||
return plumbing.ZeroHash, fmt.Errorf("listing files in %q: %w", path, err) |
|
||||||
} |
|
||||||
|
|
||||||
var matchedHash plumbing.Hash |
|
||||||
for _, fileInfo := range fileInfos { |
|
||||||
objFileName := fileInfo.Name() |
|
||||||
if !strings.HasPrefix(objFileName, hashTail) { |
|
||||||
continue |
|
||||||
} |
|
||||||
|
|
||||||
objHash := plumbing.NewHash(hashPrefix + objFileName) |
|
||||||
obj, err := r.GitRepo.Storer.EncodedObject(plumbing.AnyObject, objHash) |
|
||||||
if err != nil { |
|
||||||
return plumbing.ZeroHash, fmt.Errorf("reading object %q off disk: %w", objHash, err) |
|
||||||
} else if obj.Type() != plumbing.CommitObject { |
|
||||||
continue |
|
||||||
|
|
||||||
} else if matchedHash == plumbing.ZeroHash { |
|
||||||
matchedHash = objHash |
|
||||||
continue |
|
||||||
} |
|
||||||
|
|
||||||
return plumbing.ZeroHash, fmt.Errorf("both %q and %q match", matchedHash, objHash) |
|
||||||
} |
|
||||||
|
|
||||||
if matchedHash != plumbing.ZeroHash { |
|
||||||
return matchedHash, nil |
|
||||||
} |
|
||||||
} |
|
||||||
|
|
||||||
return plumbing.ZeroHash, errors.New("failed to find a commit object with a matching prefix") |
|
||||||
} |
|
||||||
|
|
||||||
func (r *Repo) resolveRev(rev plumbing.Revision) (plumbing.Hash, error) { |
|
||||||
if rev == plumbing.Revision(plumbing.ZeroHash.String()) { |
|
||||||
return plumbing.ZeroHash, nil |
|
||||||
} |
|
||||||
|
|
||||||
{ |
|
||||||
// pretend the revision is a short hash until proven otherwise
|
|
||||||
shortHash := string(rev) |
|
||||||
hash, err := r.findCommitByShortHash(shortHash) |
|
||||||
if errors.Is(err, errNotHex) { |
|
||||||
// ok, continue
|
|
||||||
} else if err != nil { |
|
||||||
return plumbing.ZeroHash, fmt.Errorf("resolving as short hash: %w", err) |
|
||||||
} else { |
|
||||||
// guess it _is_ a short hash, knew it!
|
|
||||||
return hash, nil |
|
||||||
} |
|
||||||
} |
|
||||||
|
|
||||||
h, err := r.GitRepo.ResolveRevision(rev) |
|
||||||
if err != nil { |
|
||||||
return plumbing.ZeroHash, fmt.Errorf("resolving revision %q: %w", rev, err) |
|
||||||
} |
|
||||||
return *h, nil |
|
||||||
} |
|
||||||
|
|
||||||
// GetGitRevision resolves the revision and returns the GitCommit it references.
|
|
||||||
func (r *Repo) GetGitRevision(rev plumbing.Revision) (GitCommit, error) { |
|
||||||
hash, err := r.resolveRev(rev) |
|
||||||
if err != nil { |
|
||||||
return GitCommit{}, err |
|
||||||
} |
|
||||||
|
|
||||||
gc, err := r.GetGitCommit(hash) |
|
||||||
if err != nil { |
|
||||||
return GitCommit{}, fmt.Errorf("getting commit %q: %w", hash, err) |
|
||||||
} |
|
||||||
return gc, nil |
|
||||||
} |
|
||||||
|
|
||||||
// GetGitRevisionRange is like GetGitCommitRange, first resolving the given
|
|
||||||
// revisions into hashes before continuing with GetGitCommitRange's behavior.
|
|
||||||
func (r *Repo) GetGitRevisionRange(startRev, endRev plumbing.Revision) ([]GitCommit, error) { |
|
||||||
start, err := r.resolveRev(startRev) |
|
||||||
if err != nil { |
|
||||||
return nil, err |
|
||||||
} |
|
||||||
|
|
||||||
end, err := r.resolveRev(endRev) |
|
||||||
if err != nil { |
|
||||||
return nil, err |
|
||||||
} |
|
||||||
|
|
||||||
return r.GetGitCommitRange(start, end) |
|
||||||
} |
|
||||||
Loading…
Reference in new issue