mirror of
				https://gitee.com/gitea/gitea
				synced 2025-11-04 08:30:25 +08:00 
			
		
		
		
	Implement git refs API for listing references (branches, tags and other) (#5354)
* Inital routes to git refs api * Git refs API implementation * Update swagger * Fix copyright * Make swagger happy add basic test * Fix test * Fix test again :)
This commit is contained in:
		
				
					committed by
					
						
						techknowlogick
					
				
			
			
				
	
			
			
			
						parent
						
							294904321c
						
					
				
				
					commit
					08bf443016
				
			
							
								
								
									
										18
									
								
								vendor/code.gitea.io/git/ref.go
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										18
									
								
								vendor/code.gitea.io/git/ref.go
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,18 @@
 | 
			
		||||
// Copyright 2018 The Gitea Authors. All rights reserved.
 | 
			
		||||
// Use of this source code is governed by a MIT-style
 | 
			
		||||
// license that can be found in the LICENSE file.
 | 
			
		||||
 | 
			
		||||
package git
 | 
			
		||||
 | 
			
		||||
// Reference represents a Git ref.
 | 
			
		||||
type Reference struct {
 | 
			
		||||
	Name   string
 | 
			
		||||
	repo   *Repository
 | 
			
		||||
	Object SHA1 // The id of this commit object
 | 
			
		||||
	Type   string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Commit return the commit of the reference
 | 
			
		||||
func (ref *Reference) Commit() (*Commit, error) {
 | 
			
		||||
	return ref.repo.getCommit(ref.Object)
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										21
									
								
								vendor/code.gitea.io/git/repo_branch.go
									
									
									
										generated
									
									
										vendored
									
									
								
							
							
						
						
									
										21
									
								
								vendor/code.gitea.io/git/repo_branch.go
									
									
									
										generated
									
									
										vendored
									
									
								
							@@ -1,4 +1,5 @@
 | 
			
		||||
// Copyright 2015 The Gogs Authors. All rights reserved.
 | 
			
		||||
// Copyright 2018 The Gitea Authors. All rights reserved.
 | 
			
		||||
// Use of this source code is governed by a MIT-style
 | 
			
		||||
// license that can be found in the LICENSE file.
 | 
			
		||||
 | 
			
		||||
@@ -7,6 +8,9 @@ package git
 | 
			
		||||
import (
 | 
			
		||||
	"fmt"
 | 
			
		||||
	"strings"
 | 
			
		||||
 | 
			
		||||
	"gopkg.in/src-d/go-git.v4"
 | 
			
		||||
	"gopkg.in/src-d/go-git.v4/plumbing"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// BranchPrefix base dir of the branch information file store on git
 | 
			
		||||
@@ -60,16 +64,23 @@ func (repo *Repository) SetDefaultBranch(name string) error {
 | 
			
		||||
 | 
			
		||||
// GetBranches returns all branches of the repository.
 | 
			
		||||
func (repo *Repository) GetBranches() ([]string, error) {
 | 
			
		||||
	stdout, err := NewCommand("for-each-ref", "--format=%(refname)", BranchPrefix).RunInDir(repo.Path)
 | 
			
		||||
	r, err := git.PlainOpen(repo.Path)
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		return nil, err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	refs := strings.Split(stdout, "\n")
 | 
			
		||||
	branches := make([]string, len(refs)-1)
 | 
			
		||||
	for i, ref := range refs[:len(refs)-1] {
 | 
			
		||||
		branches[i] = strings.TrimPrefix(ref, BranchPrefix)
 | 
			
		||||
	branchIter, err := r.Branches()
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		return nil, err
 | 
			
		||||
	}
 | 
			
		||||
	branches := make([]string, 0)
 | 
			
		||||
	if err = branchIter.ForEach(func(branch *plumbing.Reference) error {
 | 
			
		||||
		branches = append(branches, branch.Name().Short())
 | 
			
		||||
		return nil
 | 
			
		||||
	}); err != nil {
 | 
			
		||||
		return nil, err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return branches, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										51
									
								
								vendor/code.gitea.io/git/repo_ref.go
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										51
									
								
								vendor/code.gitea.io/git/repo_ref.go
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,51 @@
 | 
			
		||||
// Copyright 2018 The Gitea Authors. All rights reserved.
 | 
			
		||||
// Use of this source code is governed by a MIT-style
 | 
			
		||||
// license that can be found in the LICENSE file.
 | 
			
		||||
 | 
			
		||||
package git
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"strings"
 | 
			
		||||
 | 
			
		||||
	"gopkg.in/src-d/go-git.v4"
 | 
			
		||||
	"gopkg.in/src-d/go-git.v4/plumbing"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// GetRefs returns all references of the repository.
 | 
			
		||||
func (repo *Repository) GetRefs() ([]*Reference, error) {
 | 
			
		||||
	return repo.GetRefsFiltered("")
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// GetRefsFiltered returns all references of the repository that matches patterm exactly or starting with.
 | 
			
		||||
func (repo *Repository) GetRefsFiltered(pattern string) ([]*Reference, error) {
 | 
			
		||||
	r, err := git.PlainOpen(repo.Path)
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		return nil, err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	refsIter, err := r.References()
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		return nil, err
 | 
			
		||||
	}
 | 
			
		||||
	refs := make([]*Reference, 0)
 | 
			
		||||
	if err = refsIter.ForEach(func(ref *plumbing.Reference) error {
 | 
			
		||||
		if ref.Name() != plumbing.HEAD && !ref.Name().IsRemote() &&
 | 
			
		||||
			(pattern == "" || strings.HasPrefix(ref.Name().String(), pattern)) {
 | 
			
		||||
			r := &Reference{
 | 
			
		||||
				Name:   ref.Name().String(),
 | 
			
		||||
				Object: SHA1(ref.Hash()),
 | 
			
		||||
				Type:   string(ObjectCommit),
 | 
			
		||||
				repo:   repo,
 | 
			
		||||
			}
 | 
			
		||||
			if ref.Name().IsTag() {
 | 
			
		||||
				r.Type = string(ObjectTag)
 | 
			
		||||
			}
 | 
			
		||||
			refs = append(refs, r)
 | 
			
		||||
		}
 | 
			
		||||
		return nil
 | 
			
		||||
	}); err != nil {
 | 
			
		||||
		return nil, err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return refs, nil
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										69
									
								
								vendor/code.gitea.io/sdk/gitea/repo_refs.go
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										69
									
								
								vendor/code.gitea.io/sdk/gitea/repo_refs.go
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,69 @@
 | 
			
		||||
// Copyright 2018 The Gitea Authors. All rights reserved.
 | 
			
		||||
// Use of this source code is governed by a MIT-style
 | 
			
		||||
// license that can be found in the LICENSE file.
 | 
			
		||||
 | 
			
		||||
package gitea
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"encoding/json"
 | 
			
		||||
	"errors"
 | 
			
		||||
	"fmt"
 | 
			
		||||
	"strings"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Reference represents a Git reference.
 | 
			
		||||
type Reference struct {
 | 
			
		||||
	Ref    string     `json:"ref"`
 | 
			
		||||
	URL    string     `json:"url"`
 | 
			
		||||
	Object *GitObject `json:"object"`
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// GitObject represents a Git object.
 | 
			
		||||
type GitObject struct {
 | 
			
		||||
	Type string `json:"type"`
 | 
			
		||||
	SHA  string `json:"sha"`
 | 
			
		||||
	URL  string `json:"url"`
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// GetRepoRef get one ref's information of one repository
 | 
			
		||||
func (c *Client) GetRepoRef(user, repo, ref string) (*Reference, error) {
 | 
			
		||||
	ref = strings.TrimPrefix(ref, "refs/")
 | 
			
		||||
	r := new(Reference)
 | 
			
		||||
	err := c.getParsedResponse("GET", fmt.Sprintf("/repos/%s/%s/git/refs/%s", user, repo, ref), nil, nil, &r)
 | 
			
		||||
	if _, ok := err.(*json.UnmarshalTypeError); ok {
 | 
			
		||||
		// Multiple refs
 | 
			
		||||
		return nil, errors.New("no exact match found for this ref")
 | 
			
		||||
	} else if err != nil {
 | 
			
		||||
		return nil, err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return r, nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// GetRepoRefs get list of ref's information of one repository
 | 
			
		||||
func (c *Client) GetRepoRefs(user, repo, ref string) ([]*Reference, error) {
 | 
			
		||||
	ref = strings.TrimPrefix(ref, "refs/")
 | 
			
		||||
	resp, err := c.getResponse("GET", fmt.Sprintf("/repos/%s/%s/git/refs/%s", user, repo, ref), nil, nil)
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		return nil, err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// Attempt to unmarshal single returned ref.
 | 
			
		||||
	r := new(Reference)
 | 
			
		||||
	refErr := json.Unmarshal(resp, r)
 | 
			
		||||
	if refErr == nil {
 | 
			
		||||
		return []*Reference{r}, nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// Attempt to unmarshal multiple refs.
 | 
			
		||||
	var rs []*Reference
 | 
			
		||||
	refsErr := json.Unmarshal(resp, &rs)
 | 
			
		||||
	if refsErr == nil {
 | 
			
		||||
		if len(rs) == 0 {
 | 
			
		||||
			return nil, errors.New("unexpected response: an array of refs with length 0")
 | 
			
		||||
		}
 | 
			
		||||
		return rs, nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return nil, fmt.Errorf("unmarshalling failed for both single and multiple refs: %s and %s", refErr, refsErr)
 | 
			
		||||
}
 | 
			
		||||
		Reference in New Issue
	
	Block a user