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
|
package git
import (
"fmt"
"os/exec"
"strconv"
"strings"
"github.com/argoproj-labs/argocd-image-updater/pkg/log"
)
// CommitOptions holds options for a git commit operation
type CommitOptions struct {
// CommitMessageText holds a short commit message (-m option)
CommitMessageText string
// CommitMessagePath holds the path to a file to be used for the commit message (-F option)
CommitMessagePath string
// SigningKey holds a GnuPG key ID or path to a Private SSH Key used to sign the commit with (-S option)
SigningKey string
// SigningMethod holds the signing method used to sign commits. (git -c gpg.format=ssh option)
SigningMethod string
// SignOff specifies whether to sign-off a commit (-s option)
SignOff bool
}
// Commit perfoms a git commit for the given pathSpec to the currently checked
// out branch. If pathSpec is empty, or the special value "*", all pending
// changes will be committed. If message is not the empty string, it will be
// used as the commit message, otherwise a default commit message will be used.
// If signingKey is not the empty string, commit will be signed with the given
// GPG or SSH key.
func (m *nativeGitClient) Commit(pathSpec string, opts *CommitOptions) error {
defaultCommitMsg := "Update parameters"
// Git configuration
config := "gpg.format=" + opts.SigningMethod
args := []string{}
// -c is a global option and needs to be passed before the actual git sub
// command (commit).
if opts.SigningMethod != "" {
args = append(args, "-c", config)
}
args = append(args, "commit")
if pathSpec == "" || pathSpec == "*" {
args = append(args, "-a")
}
// Commit fails with a space between -S flag and path to SSH key
// -S/user/test/.ssh/signingKey or -SAAAAAAAA...
if opts.SigningKey != "" {
args = append(args, fmt.Sprintf("-S%s", opts.SigningKey))
}
if opts.SignOff {
args = append(args, "-s")
}
if opts.CommitMessageText != "" {
args = append(args, "-m", opts.CommitMessageText)
} else if opts.CommitMessagePath != "" {
args = append(args, "-F", opts.CommitMessagePath)
} else {
args = append(args, "-m", defaultCommitMsg)
}
out, err := m.runCmd(args...)
if err != nil {
log.Errorf(out)
return err
}
return nil
}
// Branch creates a new target branch from a given source branch
func (m *nativeGitClient) Branch(sourceBranch string, targetBranch string) error {
if sourceBranch != "" {
_, err := m.runCmd("checkout", sourceBranch)
if err != nil {
return fmt.Errorf("could not checkout source branch: %v", err)
}
}
_, err := m.runCmd("branch", targetBranch)
if err != nil {
return fmt.Errorf("could not create new branch: %v", err)
}
return nil
}
// Push pushes local changes to the remote branch. If force is true, will force
// the remote to accept the push.
func (m *nativeGitClient) Push(remote string, branch string, force bool) error {
args := []string{"push"}
if force {
args = append(args, "-f")
}
args = append(args, remote, branch)
err := m.runCredentialedCmd(args...)
if err != nil {
return fmt.Errorf("could not push %s to %s: %v", branch, remote, err)
}
return nil
}
// Add adds a path spec to the repository
func (m *nativeGitClient) Add(path string) error {
return m.runCredentialedCmd("add", path)
}
// SymRefToBranch retrieves the branch name a symbolic ref points to
func (m *nativeGitClient) SymRefToBranch(symRef string) (string, error) {
output, err := m.runCredentialedCmdWithOutput("remote", "show", "origin")
if err != nil {
return "", fmt.Errorf("error running git: %v", err)
}
for _, l := range strings.Split(output, "\n") {
l = strings.TrimSpace(l)
if strings.HasPrefix(l, "HEAD branch:") {
b := strings.SplitN(l, ":", 2)
if len(b) == 2 {
return strings.TrimSpace(b[1]), nil
}
}
}
return "", fmt.Errorf("no default branch found in remote")
}
// Config configures username and email address for the repository
func (m *nativeGitClient) Config(username string, email string) error {
_, err := m.runCmd("config", "user.name", username)
if err != nil {
return fmt.Errorf("could not set git username: %v", err)
}
_, err = m.runCmd("config", "user.email", email)
if err != nil {
return fmt.Errorf("could not set git email: %v", err)
}
return nil
}
// runCredentialedCmdWithOutput is a convenience function to run a git command
// with username/password credentials while supplying command output to the
// caller.
// nolint:unparam
func (m *nativeGitClient) runCredentialedCmdWithOutput(args ...string) (string, error) {
closer, environ, err := m.creds.Environ()
if err != nil {
return "", err
}
defer func() { _ = closer.Close() }()
// If a basic auth header is explicitly set, tell Git to send it to the
// server to force use of basic auth instead of negotiating the auth scheme
for _, e := range environ {
if strings.HasPrefix(e, fmt.Sprintf("%s=", forceBasicAuthHeaderEnv)) {
args = append([]string{"--config-env", fmt.Sprintf("http.extraHeader=%s", forceBasicAuthHeaderEnv)}, args...)
}
}
cmd := exec.Command("git", args...)
cmd.Env = append(cmd.Env, environ...)
return m.runCmdOutput(cmd, runOpts{})
}
func (m *nativeGitClient) shallowFetch(revision string, depth int) error {
var err error
if revision != "" {
err = m.runCredentialedCmd("fetch", "origin", revision, "--force", "--prune", "--depth", strconv.Itoa(depth))
} else {
err = m.runCredentialedCmd("fetch", "origin", "--force", "--prune", "--depth", strconv.Itoa(depth))
}
return err
}
// Fetch fetches latest updates from origin
func (m *nativeGitClient) ShallowFetch(revision string, depth int) error {
if m.OnFetch != nil {
done := m.OnFetch(m.repoURL)
defer done()
}
err := m.shallowFetch(revision, depth)
// When we have LFS support enabled, check for large files and fetch them too.
// No shallow fetch is possible here
if err == nil && m.IsLFSEnabled() {
largeFiles, err := m.LsLargeFiles()
if err == nil && len(largeFiles) > 0 {
err = m.runCredentialedCmd("lfs", "fetch", "--all")
if err != nil {
return err
}
}
}
return err
}
|
