This repository has been archived by the owner on Feb 15, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
azuredevops.go
388 lines (339 loc) · 12.7 KB
/
azuredevops.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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
package operator
import (
"context"
"fmt"
"github.com/containrrr/shoutrrr"
"github.com/microsoft/azure-devops-go-api/azuredevops"
"github.com/microsoft/azure-devops-go-api/azuredevops/core"
"github.com/microsoft/azure-devops-go-api/azuredevops/release"
"github.com/prometheus/client_golang/prometheus"
cron "github.com/robfig/cron/v3"
log "github.com/sirupsen/logrus"
"github.com/webdevops/azuredevops-deployment-operator/config"
"strings"
"time"
)
var (
releaseTriggerCancelComment = "deployment canceled webdevops/azuredevops-deployment-operator"
releaseTriggerNewComment = "deployment triggered by webdevops/azuredevops-deployment-operator"
releaseAutoApprovalComment = "auto-approval by webdevops/azuredevops-deployment-operator"
timeWaitDeploy = 5 * time.Second
)
type (
AzureDevopsOperator struct {
Opts config.OptsAzureDevops
Notification config.OptsNotification
Config config.Config
ctx context.Context
connection *azuredevops.Connection
cron *cron.Cron
coreClient core.Client
releaseClient release.Client
prometheus struct {
deploymentCounter *prometheus.CounterVec
deploymentStatus *prometheus.GaugeVec
deploymentTime *prometheus.GaugeVec
}
}
)
func (o *AzureDevopsOperator) Init() {
o.ctx = context.Background()
o.initAzureDevops()
o.initCron()
o.initMetrics()
}
func (o *AzureDevopsOperator) initAzureDevops() {
o.connection = azuredevops.NewPatConnection(o.Opts.OrganizationUrl, o.Opts.AccessToken)
// core client (projects,...)
coreClient, err := core.NewClient(o.ctx, o.connection)
if err != nil {
log.Error(err)
}
o.coreClient = coreClient
// release clients (releases, environments, definitions,...)
releaseClient, err := release.NewClient(o.ctx, o.connection)
if err != nil {
log.Error(err)
}
o.releaseClient = releaseClient
}
func (o *AzureDevopsOperator) initCron() {
o.cron = cron.New()
}
func (o *AzureDevopsOperator) initMetrics() {
o.prometheus.deploymentCounter = prometheus.NewCounterVec(
prometheus.CounterOpts{
Name: "azuredevops_deployment_operator_deployment_counter",
Help: "AzureDevOps deployment operator: last deployment counter",
},
[]string{"projectId", "projectName", "releaseDefinitionName", "environmentName"},
)
prometheus.MustRegister(o.prometheus.deploymentCounter)
o.prometheus.deploymentStatus = prometheus.NewGaugeVec(
prometheus.GaugeOpts{
Name: "azuredevops_deployment_operator_deployment_status",
Help: "AzureDevOps deployment operator: last deployment status",
},
[]string{"projectId", "projectName", "releaseDefinitionName", "environmentName"},
)
prometheus.MustRegister(o.prometheus.deploymentStatus)
o.prometheus.deploymentTime = prometheus.NewGaugeVec(
prometheus.GaugeOpts{
Name: "azuredevops_deployment_operator_deployment_time",
Help: "AzureDevOps deployment operator: last deployment time",
},
[]string{"projectId", "projectName", "releaseDefinitionName", "environmentName"},
)
prometheus.MustRegister(o.prometheus.deploymentTime)
}
func (o *AzureDevopsOperator) RunSingleshot() {
for _, configRow := range o.Config.Releases {
contextLogger := log.WithFields(log.Fields{
"type": "release",
"project": *configRow.Project,
})
o.triggerReleaseDefinitions(contextLogger, configRow)
}
}
func (o *AzureDevopsOperator) RunCron() {
for _, row := range o.Config.Releases {
configRow := row
_, err := o.cron.AddFunc(configRow.Crontab, func() {
contextLogger := log.WithFields(log.Fields{
"type": "release",
"project": *configRow.Project,
"crontab": configRow.Crontab,
})
o.triggerReleaseDefinitions(contextLogger, configRow)
})
if err != nil {
log.Panic(err)
}
}
o.cron.Start()
}
func (o *AzureDevopsOperator) triggerReleaseDefinitions(contextLogger *log.Entry, config config.ConfigRelease) {
projArgs := core.GetProjectArgs{
ProjectId: config.Project,
}
project, err := o.coreClient.GetProject(o.ctx, projArgs)
if err != nil {
contextLogger.Error(err)
}
expand := release.ReleaseDefinitionExpands(
strings.Join([]string{
string(release.ReleaseDefinitionExpandsValues.Environments),
string(release.ReleaseDefinitionExpandsValues.LastRelease),
}, ","),
)
args := release.GetReleaseDefinitionsArgs{
Project: config.Project,
SearchText: config.ReleaseDefinitions.SearchText,
ArtifactType: config.ReleaseDefinitions.ArtifactType,
ArtifactSourceId: config.ReleaseDefinitions.ArtifactSourceId,
Path: config.ReleaseDefinitions.Path,
IsExactNameMatch: config.ReleaseDefinitions.IsExactNameMatch,
TagFilter: config.ReleaseDefinitions.TagFilter,
DefinitionIdFilter: config.ReleaseDefinitions.DefinitionIdFilter,
SearchTextContainsFolderName: config.ReleaseDefinitions.SearchTextContainsFolderName,
Expand: &expand,
}
releaseDefinitionList, err := o.releaseClient.GetReleaseDefinitions(o.ctx, args)
if err != nil {
contextLogger.Error(err)
}
for _, releaseDefinition := range releaseDefinitionList.Value {
// inject project (it's empty when fetching from the api)
releaseDefinition.ProjectReference = &release.ProjectReference{
Id: project.Id,
Name: project.Name,
}
err := o.triggerReleaseDefinitionDeploy(contextLogger, config, &releaseDefinition)
if err != nil {
contextLogger.Error(err)
}
}
}
func (o *AzureDevopsOperator) triggerReleaseDefinitionDeploy(contextLogger *log.Entry, config config.ConfigRelease, releaseDefinition *release.ReleaseDefinition) error {
contextLogger = contextLogger.WithField("releaseDefinition", o.buildReleaseDefinitionName(releaseDefinition))
contextLogger.Infof("starting deployment")
// check if there are environments defined
if releaseDefinition.Environments == nil {
return nil
}
// reset metrics
for _, environment := range config.Environments {
promLabels := prometheus.Labels{
"projectId": releaseDefinition.ProjectReference.Id.String(),
"projectName": *releaseDefinition.ProjectReference.Name,
"releaseDefinitionName": o.buildReleaseDefinitionName(releaseDefinition),
"environmentName": environment,
}
o.prometheus.deploymentStatus.With(promLabels).Set(0)
}
for _, environment := range *releaseDefinition.Environments {
// only check selected environments
if stringArrayContains(config.Environments, *environment.Name) {
environmentLogger := contextLogger.WithField("environment", *environment.Name)
switch config.Trigger {
// deploy latest version
case "latest":
if releaseDefinition.LastRelease != nil && releaseDefinition.LastRelease.Id != nil {
environmentLogger.Info("trigger latest release")
err := o.triggerExistingReleaseDeployment(
environmentLogger,
releaseDefinition,
*releaseDefinition.LastRelease.Id,
*environment.Name,
config.AutoApprove,
)
if err != nil {
environmentLogger.Error(err)
}
} else {
environmentLogger.Warn("unable to find latest release")
}
// redeploy current version
case "current":
if environment.CurrentRelease != nil && environment.CurrentRelease.Id != nil && *environment.CurrentRelease.Id != 0 {
environmentLogger.Info("trigger current release")
err := o.triggerExistingReleaseDeployment(
environmentLogger,
releaseDefinition,
*environment.CurrentRelease.Id,
*environment.Name,
config.AutoApprove,
)
if err != nil {
environmentLogger.Error(err)
}
} else {
environmentLogger.Warn("unable to find current release")
}
}
}
}
return nil
}
func (o *AzureDevopsOperator) triggerExistingReleaseDeployment(contextLogger *log.Entry, releaseDefinition *release.ReleaseDefinition, releaseId int, environmentName string, autoapprove bool) error {
project := releaseDefinition.ProjectReference.Id.String()
getArgs := release.GetReleaseArgs{
Project: &project,
ReleaseId: &releaseId,
}
releaseRes, err := o.releaseClient.GetRelease(o.ctx, getArgs)
if err != nil {
return err
}
for _, environment := range *releaseRes.Environments {
if *environment.Name == environmentName {
if *environment.Status == release.EnvironmentStatusValues.Queued || *environment.Status == release.EnvironmentStatusValues.InProgress {
_, err := o.updateReleaseEnvironment(contextLogger, releaseDefinition, environment, releaseTriggerCancelComment, release.EnvironmentStatusValues.Canceled, false)
if err != nil {
return err
}
}
time.Sleep(timeWaitDeploy)
_, err := o.updateReleaseEnvironment(contextLogger, releaseDefinition, environment, releaseTriggerNewComment, release.EnvironmentStatusValues.InProgress, autoapprove)
if err != nil {
return err
}
}
}
return nil
}
func (o *AzureDevopsOperator) updateReleaseEnvironment(contextLogger *log.Entry, releaseDefinition *release.ReleaseDefinition, releaseEnvironment release.ReleaseEnvironment, comment string, status release.EnvironmentStatus, autoapprove bool) (*release.ReleaseEnvironment, error) {
project := releaseDefinition.ProjectReference.Id.String()
contextLogger.Infof("update release environment deployment of [%s]%s :: %s -> %s: status -> %s", *releaseDefinition.ProjectReference.Name, o.buildReleaseDefinitionName(releaseDefinition), *releaseEnvironment.Release.Name, *releaseEnvironment.Name, status)
updateArgs := release.UpdateReleaseEnvironmentArgs{
Project: &project,
ReleaseId: releaseEnvironment.ReleaseId,
EnvironmentId: releaseEnvironment.Id,
EnvironmentUpdateData: &release.ReleaseEnvironmentUpdateMetadata{
Comment: &comment,
ScheduledDeploymentTime: nil,
Status: &status,
},
}
releaseRes, err := o.releaseClient.UpdateReleaseEnvironment(o.ctx, updateArgs)
if err != nil {
return releaseRes, err
}
// send notification if (re)deployment is triggered
if status == release.EnvironmentStatusValues.InProgress {
promLabels := prometheus.Labels{
"projectId": releaseDefinition.ProjectReference.Id.String(),
"projectName": *releaseDefinition.ProjectReference.Name,
"releaseDefinitionName": o.buildReleaseDefinitionName(releaseDefinition),
"environmentName": *releaseEnvironment.Name,
}
o.prometheus.deploymentCounter.With(promLabels).Inc()
o.prometheus.deploymentTime.With(promLabels).SetToCurrentTime()
o.prometheus.deploymentStatus.With(promLabels).Set(1)
msg := fmt.Sprintf(
"starting deployment of [%s]%s :: %s -> %s",
*releaseDefinition.ProjectReference.Name,
o.buildReleaseDefinitionName(releaseDefinition),
*releaseEnvironment.Release.Name,
*releaseEnvironment.Name,
)
o.sendNotification(msg)
}
// check for approval
if autoapprove {
// wait to settle update, then get the new release to check if approval is needed
time.Sleep(timeWaitDeploy)
getArgs := release.GetReleaseEnvironmentArgs{
Project: &project,
ReleaseId: releaseEnvironment.ReleaseId,
EnvironmentId: releaseEnvironment.Id,
}
releaseRes, err = o.releaseClient.GetReleaseEnvironment(o.ctx, getArgs)
if err != nil {
return releaseRes, err
}
// check if there are any predeployment approvals needed
if releaseRes.PreDeployApprovals != nil {
for _, approval := range *releaseRes.PreDeployApprovals {
// check if approval is pending
if approval.Status != nil && *approval.Status == release.ApprovalStatusValues.Pending {
// approve the approval
contextLogger.Infof("auto-approve release environment deployment of %s/%s", *releaseEnvironment.Release.Name, *releaseEnvironment.Name)
approvalArgs := release.UpdateReleaseApprovalArgs{
Project: &project,
ApprovalId: approval.Id,
Approval: &release.ReleaseApproval{
Status: &release.ApprovalStatusValues.Approved,
Comments: &releaseAutoApprovalComment,
},
}
_, err := o.releaseClient.UpdateReleaseApproval(o.ctx, approvalArgs)
if err != nil {
return releaseRes, err
}
}
}
}
}
return releaseRes, nil
}
func (o *AzureDevopsOperator) buildReleaseDefinitionName(releaseDefinition *release.ReleaseDefinition) (name string) {
// make releasename human readable
name = *releaseDefinition.Name
if releaseDefinition.Path != nil && *releaseDefinition.Path != "" {
releasePath := *releaseDefinition.Path
releasePath = strings.ReplaceAll(releasePath, "\\", "/")
releasePath = strings.TrimRight(releasePath, "/")
name = fmt.Sprintf("%s/%s", releasePath, name)
}
return
}
func (o *AzureDevopsOperator) sendNotification(message string, args ...interface{}) {
message = fmt.Sprintf(message, args...)
message = fmt.Sprintf(o.Notification.Template, message)
for _, url := range o.Notification.Urls {
if err := shoutrrr.Send(url, message); err != nil {
log.Errorf("unable to send shoutrrr notification: %v", err)
}
}
}