1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
|
package funcs
import (
"fmt"
"io"
"io/ioutil"
"os/exec"
"time"
"github.com/go-git/go-git/v5"
"github.com/zclconf/go-cty/cty"
"github.com/zclconf/go-cty/cty/function"
)
func VCSGitFuncs(path string) map[string]function.Function {
state := &VCSGit{Path: path}
return map[string]function.Function{
"gitrefpretty": state.RefPrettyFunc(),
"gitrefhash": state.RefHashFunc(),
"gitreftag": state.RefTagFunc(),
"gitremoteurl": state.RemoteUrlFunc(),
}
}
type VCSGit struct {
// Path of the git repository. Parent directories will be searched for
// a ".git" folder automatically.
Path string
initErr error
repo *git.Repository
}
// RefPrettyFunc returns a string format of the current Git ref. This function
// takes some liberties to humanize the output: it will use a tag if the
// ref matches a tag, it will append "+CHANGES" to the commit if there are
// uncommitted changed files, etc.
//
// You may use direct functions such as `gitrefhash` if you want the direct
// hash. Or `gitreftag` to get the current tag.
//
// vagrant:gitrefpretty
func (s *VCSGit) RefPrettyFunc() function.Function {
return function.New(&function.Spec{
Params: []function.Parameter{},
Type: function.StaticReturnType(cty.String),
Impl: s.refPrettyFunc,
})
}
func (s *VCSGit) refPrettyFunc(args []cty.Value, retType cty.Type) (cty.Value, error) {
if err := s.init(); err != nil {
return cty.UnknownVal(cty.String), err
}
ref, err := s.repo.Head()
if err != nil {
return cty.UnknownVal(cty.String), err
}
result := ref.Hash().String()
// Get the tags
iter, err := s.repo.Tags()
if err != nil {
return cty.UnknownVal(cty.String), err
}
defer iter.Close()
for {
tagRef, err := iter.Next()
if err == io.EOF {
break
}
if err != nil {
return cty.UnknownVal(cty.String), err
}
if tagRef.Hash() == ref.Hash() {
result = tagRef.Name().Short()
break
}
}
// To determine if there are changes we subprocess because go-git's Status
// function is really, really slow sadly. On the vagrant repo at the time
// of this commit, go-git took 12s on my machine vs. 50ms for `git`.
cmd := exec.Command("git", "diff", "--quiet")
cmd.Stdout = ioutil.Discard
cmd.Stderr = ioutil.Discard
if err := cmd.Run(); err != nil {
exitError, ok := err.(*exec.ExitError)
if !ok {
return cty.UnknownVal(cty.String), fmt.Errorf("error executing git: %s", err)
}
if exitError.ExitCode() != 0 {
result += fmt.Sprintf("_CHANGES_%d", time.Now().Unix())
}
}
return cty.StringVal(result), nil
}
// RefHashFunc returns the full hash of the HEAD ref.
//
// vagrant:gitrefhash
func (s *VCSGit) RefHashFunc() function.Function {
return function.New(&function.Spec{
Params: []function.Parameter{},
Type: function.StaticReturnType(cty.String),
Impl: s.refHashFunc,
})
}
func (s *VCSGit) refHashFunc(args []cty.Value, retType cty.Type) (cty.Value, error) {
if err := s.init(); err != nil {
return cty.UnknownVal(cty.String), err
}
ref, err := s.repo.Head()
if err != nil {
return cty.UnknownVal(cty.String), err
}
return cty.StringVal(ref.Hash().String()), nil
}
// RefTagFunc returns the tag of the HEAD ref or empty if not tag is found.
//
// vagrant:gitreftag
func (s *VCSGit) RefTagFunc() function.Function {
return function.New(&function.Spec{
Params: []function.Parameter{},
Type: function.StaticReturnType(cty.String),
Impl: s.refTagFunc,
})
}
func (s *VCSGit) refTagFunc(args []cty.Value, retType cty.Type) (cty.Value, error) {
if err := s.init(); err != nil {
return cty.UnknownVal(cty.String), err
}
ref, err := s.repo.Head()
if err != nil {
return cty.UnknownVal(cty.String), err
}
// Get the tags
iter, err := s.repo.Tags()
if err != nil {
return cty.UnknownVal(cty.String), err
}
defer iter.Close()
for {
tagRef, err := iter.Next()
if err == io.EOF {
break
}
if err != nil {
return cty.UnknownVal(cty.String), err
}
if tagRef.Hash() == ref.Hash() {
return cty.StringVal(tagRef.Name().Short()), nil
}
}
return cty.StringVal(""), nil
}
// RemoteUrlFunc returns the URL for the matching remote or unknown
// if it can't be found.
//
// vagrant:gitremoteurl
func (s *VCSGit) RemoteUrlFunc() function.Function {
return function.New(&function.Spec{
Params: []function.Parameter{
{
Name: "name",
Type: cty.String,
},
},
Type: function.StaticReturnType(cty.String),
Impl: s.remoteUrlFunc,
})
}
func (s *VCSGit) remoteUrlFunc(args []cty.Value, retType cty.Type) (cty.Value, error) {
if err := s.init(); err != nil {
return cty.UnknownVal(cty.String), err
}
name := args[0].AsString()
remote, err := s.repo.Remote(name)
if err != nil {
if err == git.ErrRemoteNotFound {
err = nil
}
return cty.UnknownVal(cty.String), err
}
urls := remote.Config().URLs
if len(urls) == 0 {
return cty.UnknownVal(cty.String), nil
}
return cty.StringVal(urls[0]), nil
}
func (s *VCSGit) init() error {
// If we initialized already return
if s.initErr != nil {
return s.initErr
}
if s.repo != nil {
return nil
}
// Check if `git` is installed. We'll use this sometimes.
if _, err := exec.LookPath("git"); err != nil {
s.initErr = fmt.Errorf("git was not found on the system and is required")
return s.initErr
}
// Open the repo
repo, err := git.PlainOpenWithOptions(s.Path, &git.PlainOpenOptions{
DetectDotGit: true,
})
if err != nil {
s.initErr = err
return err
}
s.repo = repo
return nil
}
|