forked from runatlantis/atlantis
-
Notifications
You must be signed in to change notification settings - Fork 0
/
project_command_runner.go
297 lines (269 loc) · 10 KB
/
project_command_runner.go
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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
// Copyright 2017 HootSuite Media Inc.
//
// Licensed under the Apache License, Version 2.0 (the License);
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an AS IS BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Modified hereafter by contributors to runatlantis/atlantis.
package events
import (
"fmt"
"os"
"path/filepath"
"strings"
"github.com/pkg/errors"
"github.com/runatlantis/atlantis/server/events/models"
"github.com/runatlantis/atlantis/server/events/runtime"
"github.com/runatlantis/atlantis/server/events/webhooks"
"github.com/runatlantis/atlantis/server/events/yaml/raw"
"github.com/runatlantis/atlantis/server/events/yaml/valid"
"github.com/runatlantis/atlantis/server/logging"
)
// DirNotExistErr is an error caused by the directory not existing.
type DirNotExistErr struct {
RepoRelDir string
}
// Error implements the error interface.
func (d DirNotExistErr) Error() string {
return fmt.Sprintf("dir %q does not exist", d.RepoRelDir)
}
//go:generate pegomock generate -m --use-experimental-model-gen --package mocks -o mocks/mock_lock_url_generator.go LockURLGenerator
// LockURLGenerator generates urls to locks.
type LockURLGenerator interface {
// GenerateLockURL returns the full URL to the lock at lockID.
GenerateLockURL(lockID string) string
}
//go:generate pegomock generate -m --use-experimental-model-gen --package mocks -o mocks/mock_step_runner.go StepRunner
// StepRunner runs steps. Steps are individual pieces of execution like
// `terraform plan`.
type StepRunner interface {
// Run runs the step.
Run(ctx models.ProjectCommandContext, extraArgs []string, path string) (string, error)
}
//go:generate pegomock generate -m --use-experimental-model-gen --package mocks -o mocks/mock_webhooks_sender.go WebhooksSender
// WebhooksSender sends webhook.
type WebhooksSender interface {
// Send sends the webhook.
Send(log *logging.SimpleLogger, res webhooks.ApplyResult) error
}
//go:generate pegomock generate -m --use-experimental-model-gen --package mocks -o mocks/mock_project_command_runner.go ProjectCommandRunner
// ProjectCommandRunner runs project commands. A project command is a command
// for a specific TF project.
type ProjectCommandRunner interface {
// Plan runs terraform plan for the project described by ctx.
Plan(ctx models.ProjectCommandContext) models.ProjectResult
// Apply runs terraform apply for the project described by ctx.
Apply(ctx models.ProjectCommandContext) models.ProjectResult
}
// DefaultProjectCommandRunner implements ProjectCommandRunner.
type DefaultProjectCommandRunner struct {
Locker ProjectLocker
LockURLGenerator LockURLGenerator
InitStepRunner StepRunner
PlanStepRunner StepRunner
ApplyStepRunner StepRunner
RunStepRunner StepRunner
PullApprovedChecker runtime.PullApprovedChecker
WorkingDir WorkingDir
Webhooks WebhooksSender
WorkingDirLocker WorkingDirLocker
RequireApprovalOverride bool
RequireMergeableOverride bool
}
// Plan runs terraform plan for the project described by ctx.
func (p *DefaultProjectCommandRunner) Plan(ctx models.ProjectCommandContext) models.ProjectResult {
planSuccess, failure, err := p.doPlan(ctx)
return models.ProjectResult{
Command: models.PlanCommand,
PlanSuccess: planSuccess,
Error: err,
Failure: failure,
RepoRelDir: ctx.RepoRelDir,
Workspace: ctx.Workspace,
ProjectName: ctx.GetProjectName(),
}
}
// Apply runs terraform apply for the project described by ctx.
func (p *DefaultProjectCommandRunner) Apply(ctx models.ProjectCommandContext) models.ProjectResult {
applyOut, failure, err := p.doApply(ctx)
return models.ProjectResult{
Command: models.ApplyCommand,
Failure: failure,
Error: err,
ApplySuccess: applyOut,
RepoRelDir: ctx.RepoRelDir,
Workspace: ctx.Workspace,
ProjectName: ctx.GetProjectName(),
}
}
func (p *DefaultProjectCommandRunner) doPlan(ctx models.ProjectCommandContext) (*models.PlanSuccess, string, error) {
// Acquire Atlantis lock for this repo/dir/workspace.
lockAttempt, err := p.Locker.TryLock(ctx.Log, ctx.Pull, ctx.User, ctx.Workspace, models.NewProject(ctx.BaseRepo.FullName, ctx.RepoRelDir))
if err != nil {
return nil, "", errors.Wrap(err, "acquiring lock")
}
if !lockAttempt.LockAcquired {
return nil, lockAttempt.LockFailureReason, nil
}
ctx.Log.Debug("acquired lock for project")
// Acquire internal lock for the directory we're going to operate in.
unlockFn, err := p.WorkingDirLocker.TryLock(ctx.BaseRepo.FullName, ctx.Pull.Num, ctx.Workspace)
if err != nil {
return nil, "", err
}
defer unlockFn()
// Clone is idempotent so okay to run even if the repo was already cloned.
repoDir, cloneErr := p.WorkingDir.Clone(ctx.Log, ctx.BaseRepo, ctx.HeadRepo, ctx.Pull, ctx.Workspace)
if cloneErr != nil {
if unlockErr := lockAttempt.UnlockFn(); unlockErr != nil {
ctx.Log.Err("error unlocking state after plan error: %v", unlockErr)
}
return nil, "", cloneErr
}
projAbsPath := filepath.Join(repoDir, ctx.RepoRelDir)
if _, err = os.Stat(projAbsPath); os.IsNotExist(err) {
return nil, "", DirNotExistErr{RepoRelDir: ctx.RepoRelDir}
}
// Use default stage unless another workflow is defined in config
stage := p.defaultPlanStage()
if ctx.ProjectConfig != nil && ctx.ProjectConfig.Workflow != nil {
ctx.Log.Debug("project configured to use workflow %q", *ctx.ProjectConfig.Workflow)
configuredStage := ctx.GlobalConfig.GetPlanStage(*ctx.ProjectConfig.Workflow)
if configuredStage != nil {
ctx.Log.Debug("project will use the configured stage for that workflow")
stage = *configuredStage
}
}
outputs, err := p.runSteps(stage.Steps, ctx, projAbsPath)
if err != nil {
if unlockErr := lockAttempt.UnlockFn(); unlockErr != nil {
ctx.Log.Err("error unlocking state after plan error: %v", unlockErr)
}
return nil, "", fmt.Errorf("%s\n%s", err, strings.Join(outputs, "\n"))
}
return &models.PlanSuccess{
LockURL: p.LockURLGenerator.GenerateLockURL(lockAttempt.LockKey),
TerraformOutput: strings.Join(outputs, "\n"),
RePlanCmd: ctx.RePlanCmd,
ApplyCmd: ctx.ApplyCmd,
}, "", nil
}
func (p *DefaultProjectCommandRunner) runSteps(steps []valid.Step, ctx models.ProjectCommandContext, absPath string) ([]string, error) {
var outputs []string
for _, step := range steps {
var out string
var err error
switch step.StepName {
case "init":
out, err = p.InitStepRunner.Run(ctx, step.ExtraArgs, absPath)
case "plan":
out, err = p.PlanStepRunner.Run(ctx, step.ExtraArgs, absPath)
case "apply":
out, err = p.ApplyStepRunner.Run(ctx, step.ExtraArgs, absPath)
case "run":
out, err = p.RunStepRunner.Run(ctx, step.RunCommand, absPath)
}
if out != "" {
outputs = append(outputs, out)
}
if err != nil {
return outputs, err
}
}
return outputs, nil
}
func (p *DefaultProjectCommandRunner) doApply(ctx models.ProjectCommandContext) (applyOut string, failure string, err error) {
repoDir, err := p.WorkingDir.GetWorkingDir(ctx.BaseRepo, ctx.Pull, ctx.Workspace)
if err != nil {
if os.IsNotExist(err) {
return "", "", errors.New("project has not been cloned–did you run plan?")
}
return "", "", err
}
absPath := filepath.Join(repoDir, ctx.RepoRelDir)
if _, err = os.Stat(absPath); os.IsNotExist(err) {
return "", "", DirNotExistErr{RepoRelDir: ctx.RepoRelDir}
}
// Figure out what our apply requirements are.
var applyRequirements []string
if p.RequireApprovalOverride || p.RequireMergeableOverride {
// If any server flags are set, they override project config.
if p.RequireMergeableOverride {
applyRequirements = append(applyRequirements, raw.MergeableApplyRequirement)
}
if p.RequireApprovalOverride {
applyRequirements = append(applyRequirements, raw.ApprovedApplyRequirement)
}
} else if ctx.ProjectConfig != nil {
// Else we use the project config if it's set.
applyRequirements = ctx.ProjectConfig.ApplyRequirements
}
for _, req := range applyRequirements {
switch req {
case raw.ApprovedApplyRequirement:
approved, err := p.PullApprovedChecker.PullIsApproved(ctx.BaseRepo, ctx.Pull) // nolint: vetshadow
if err != nil {
return "", "", errors.Wrap(err, "checking if pull request was approved")
}
if !approved {
return "", "Pull request must be approved before running apply.", nil
}
case raw.MergeableApplyRequirement:
if !ctx.PullMergeable {
return "", "Pull request must be mergeable before running apply.", nil
}
}
}
// Acquire internal lock for the directory we're going to operate in.
unlockFn, err := p.WorkingDirLocker.TryLock(ctx.BaseRepo.FullName, ctx.Pull.Num, ctx.Workspace)
if err != nil {
return "", "", err
}
defer unlockFn()
// Use default stage unless another workflow is defined in config
stage := p.defaultApplyStage()
if ctx.ProjectConfig != nil && ctx.ProjectConfig.Workflow != nil {
configuredStage := ctx.GlobalConfig.GetApplyStage(*ctx.ProjectConfig.Workflow)
if configuredStage != nil {
stage = *configuredStage
}
}
outputs, err := p.runSteps(stage.Steps, ctx, absPath)
p.Webhooks.Send(ctx.Log, webhooks.ApplyResult{ // nolint: errcheck
Workspace: ctx.Workspace,
User: ctx.User,
Repo: ctx.BaseRepo,
Pull: ctx.Pull,
Success: err == nil,
})
if err != nil {
return "", "", fmt.Errorf("%s\n%s", err, strings.Join(outputs, "\n"))
}
return strings.Join(outputs, "\n"), "", nil
}
func (p DefaultProjectCommandRunner) defaultPlanStage() valid.Stage {
return valid.Stage{
Steps: []valid.Step{
{
StepName: "init",
},
{
StepName: "plan",
},
},
}
}
func (p DefaultProjectCommandRunner) defaultApplyStage() valid.Stage {
return valid.Stage{
Steps: []valid.Step{
{
StepName: "apply",
},
},
}
}