/
main.go
365 lines (335 loc) · 10.4 KB
/
main.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
// Copyright 2020 Google LLC
//
// 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.
package main
import (
"bytes"
"context"
"errors"
"fmt"
"math/big"
"os"
"regexp"
"text/template"
"time"
"cloud.google.com/go/bigquery"
"cloud.google.com/go/civil"
cbpb "cloud.google.com/go/cloudbuild/apiv1/v2/cloudbuildpb"
"github.com/GoogleCloudPlatform/cloud-build-notifiers/lib/notifiers"
log "github.com/golang/glog"
"google.golang.org/protobuf/types/known/timestamppb"
"github.com/google/go-containerregistry/pkg/name"
v1 "github.com/google/go-containerregistry/pkg/v1"
"github.com/google/go-containerregistry/pkg/v1/google"
"github.com/google/go-containerregistry/pkg/v1/remote"
)
var tableResource = regexp.MustCompile(".*/.*/.*/(.*)/.*/(.*)")
var terminalStatusCodes = map[cbpb.Build_Status]bool{
cbpb.Build_SUCCESS: true,
cbpb.Build_FAILURE: true,
cbpb.Build_INTERNAL_ERROR: true,
cbpb.Build_TIMEOUT: true,
cbpb.Build_CANCELLED: true,
cbpb.Build_EXPIRED: true,
}
// TODO(aricz)
const megaByte = int64(1000000)
func main() {
if err := notifiers.Main(&bqNotifier{bqf: &actualBQFactory{}}); err != nil {
log.Fatalf("fatal error: %v", err)
}
}
type bqNotifier struct {
bqf bqFactory
filter notifiers.EventFilter
tmpl *template.Template
client bq
br notifiers.BindingResolver
tmplView *notifiers.TemplateView
}
type bqRow struct {
ProjectID string
ID string
BuildTriggerID string
Status string
Images []*buildImage
Steps []*buildStep
CreateTime civil.DateTime
StartTime civil.DateTime
FinishTime civil.DateTime
Tags []string
Env []string
LogURL string
Substitutions []*substitution
JSON string
}
type substitution struct {
Key string
Value string
}
type buildImage struct {
SHA string
ContainerSizeMB *big.Rat
}
type buildStep struct {
Name string
ID string
Status string
Args []string
StartTime civil.DateTime
EndTime civil.DateTime
}
type actualBQ struct {
client *bigquery.Client
dataset *bigquery.Dataset
table *bigquery.Table
}
type actualBQFactory struct {
}
func (bqf *actualBQFactory) Make(ctx context.Context) (bq, error) {
projectID := os.Getenv("PROJECT_ID")
if projectID == "" {
return nil, errors.New("PROJECT_ID environment variable must be set")
}
bqClient, err := bigquery.NewClient(ctx, projectID)
if err != nil {
return nil, fmt.Errorf("error initializing bigquery client: %v", err)
}
newClient := &actualBQ{client: bqClient}
return newClient, nil
}
func getImageSize(layers []v1.Layer) (*big.Rat, error) {
totalSum := int64(0)
for _, layer := range layers {
layerSize, err := layer.Size()
if err != nil {
return nil, fmt.Errorf("error parsing layer %v: %v", layer, err)
}
totalSum += layerSize
}
return big.NewRat(totalSum, megaByte), nil
}
func imageManifestToBuildImage(image string) (*buildImage, error) {
ref, err := name.ParseReference(image)
if err != nil {
return nil, fmt.Errorf("error parsing image reference: %v", err)
}
img, err := remote.Image(ref, remote.WithAuthFromKeychain(google.Keychain))
if err != nil {
return nil, fmt.Errorf("error obtaining image reference: %v", err)
}
sha, err := img.Digest()
layers, err := img.Layers()
// Calculating the compressed image size
containerSize, err := getImageSize(layers)
if err != nil {
return nil, err
}
return &buildImage{SHA: sha.String(), ContainerSizeMB: containerSize}, nil
}
func (n *bqNotifier) SetUp(ctx context.Context, cfg *notifiers.Config, bigQueryJson string, _ notifiers.SecretGetter, br notifiers.BindingResolver) error {
prd, err := notifiers.MakeCELPredicate(cfg.Spec.Notification.Filter)
if err != nil {
return fmt.Errorf("failed to make a CEL predicate: %v", err)
}
parsed, ok := cfg.Spec.Notification.Delivery["table"].(string)
if !ok {
return fmt.Errorf("expected table string: %v", cfg.Spec.Notification.Delivery)
}
// Initialize client
n.filter = prd
n.client, err = n.bqf.Make(ctx)
if err != nil {
return fmt.Errorf("failed to initialize bigquery client: %v", err)
}
// Extract dataset id and table id from config
rs := tableResource.FindStringSubmatch(parsed)
if len(rs) != 3 {
return fmt.Errorf("failed to parse valid table URI: %v", parsed)
}
if err = n.client.EnsureDataset(ctx, rs[1]); err != nil {
return err
}
if err = n.client.EnsureTable(ctx, rs[2]); err != nil {
return err
}
tmpl, err := template.New("bq_json_template").Parse(bigQueryJson)
n.tmpl = tmpl
n.br = br
return nil
}
func parsePBTime(time *timestamppb.Timestamp) (civil.DateTime, error) {
if time == nil {
return civil.DateTime{}, fmt.Errorf("timestamp is nil")
}
newTime := time.AsTime()
return civil.DateTimeOf(newTime), nil
}
func (n *bqNotifier) SendNotification(ctx context.Context, build *cbpb.Build) error {
if !n.filter.Apply(ctx, build) {
log.V(2).Infof("not doing BQ write for build %v", build.Id)
return nil
}
if build.BuildTriggerId == "" {
log.Warningf("build passes filter but does not have a trigger ID. Build id: %q, status: %v", build.Id, build.GetStatus())
}
if !terminalStatusCodes[build.Status] {
log.Infof("not writing to BigQuery for non-terminal build status %v", build.Status.String())
return nil
}
log.Infof("sending Big Query write for build %q (status: %q)", build.Id, build.Status)
if build.ProjectId == "" {
return fmt.Errorf("build missing project id")
}
buildImages := []*buildImage{}
shaSet := make(map[string]bool)
for _, image := range build.GetImages() {
buildImage, err := imageManifestToBuildImage(image)
if err != nil {
return fmt.Errorf("error parsing image manifest: %v", err)
}
if shaSet[buildImage.SHA] {
continue
}
shaSet[buildImage.SHA] = true
buildImages = append(buildImages, buildImage)
}
buildSteps := []*buildStep{}
createTime, err := parsePBTime(build.CreateTime)
if err != nil {
return fmt.Errorf("error parsing CreateTime: %v", err)
}
startTime, err := parsePBTime(build.StartTime)
if err != nil {
return fmt.Errorf("error parsing StartTime: %v", err)
}
finishTime, err := parsePBTime(build.FinishTime)
if err != nil {
return fmt.Errorf("error parsing FinishTime: %v", err)
}
unixZeroTimestamp := timestamppb.New(time.Unix(0, 0))
for _, step := range build.GetSteps() {
st := step.GetTiming().GetStartTime()
et := step.GetTiming().GetEndTime()
if st == nil {
st = unixZeroTimestamp
}
if et == nil {
et = unixZeroTimestamp
}
startTime, err := parsePBTime(st)
if err != nil {
return fmt.Errorf("error parsing StartTime: %v", err)
}
endTime, err := parsePBTime(et)
if err != nil {
return fmt.Errorf("error parsing EndTime: %v", err)
}
newStep := &buildStep{
Name: step.Name,
ID: step.Id,
Status: step.GetStatus().String(),
Args: step.Args,
StartTime: startTime,
EndTime: endTime,
}
buildSteps = append(buildSteps, newStep)
}
logURL, err := notifiers.AddUTMParams(build.LogUrl, notifiers.StorageMedium)
if err != nil {
return fmt.Errorf("error generating UTM params: %v", err)
}
substitutions := []*substitution{}
for key, value := range build.Substitutions {
substitutions = append(substitutions, &substitution{key, value})
}
var bindings map[string]string
if n.br != nil {
bindings, err = n.br.Resolve(ctx, nil, build)
if err != nil {
return fmt.Errorf("failed to resolve bindings: %w", err)
}
}
n.tmplView = ¬ifiers.TemplateView{
Build: ¬ifiers.BuildView{Build: build},
Params: bindings,
}
var buf bytes.Buffer
if err := n.tmpl.Execute(&buf, n.tmplView); err != nil {
return err
}
newRow := &bqRow{
ProjectID: build.ProjectId,
ID: build.Id,
BuildTriggerID: build.BuildTriggerId,
Status: build.Status.String(),
Images: buildImages,
Steps: buildSteps,
CreateTime: createTime,
StartTime: startTime,
FinishTime: finishTime,
Tags: build.Tags,
Env: build.Options.Env,
LogURL: logURL,
Substitutions: substitutions,
JSON: buf.String(),
}
return n.client.WriteRow(ctx, newRow)
}
func (bq *actualBQ) EnsureDataset(ctx context.Context, datasetName string) error {
// Check for existence of dataset, create if false
bq.dataset = bq.client.Dataset(datasetName)
_, err := bq.client.Dataset(datasetName).Metadata(ctx)
if err != nil {
log.Warningf("error obtaining dataset metadata: %v;Creating new BigQuery dataset: %q", err, datasetName)
if err := bq.dataset.Create(ctx, &bigquery.DatasetMetadata{
Name: datasetName, Description: "BigQuery Notifier Build Data",
}); err != nil {
return fmt.Errorf("error creating dataset: %v", err)
}
}
return nil
}
func (bq *actualBQ) EnsureTable(ctx context.Context, tableName string) error {
// Check for existence of table, create if false
bq.table = bq.dataset.Table(tableName)
schema, err := bigquery.InferSchema(bqRow{})
if err != nil {
return fmt.Errorf("failed to infer schema: %v", err)
}
metadata, err := bq.dataset.Table(tableName).Metadata(ctx)
if err != nil {
log.Warningf("Error obtaining table metadata: %q;Creating new BigQuery table: %q", err, tableName)
// Create table if it does not exist.
if err := bq.table.Create(ctx, &bigquery.TableMetadata{Name: tableName, Description: "BigQuery Notifier Build Data Table", Schema: schema}); err != nil {
return fmt.Errorf("failed to initialize table %v: ", err)
}
} else if len(metadata.Schema) == 0 {
log.Warningf("No schema found for table, writing new schema for table: %v", tableName)
update := bigquery.TableMetadataToUpdate{
Schema: schema,
}
if _, err := bq.table.Update(ctx, update, metadata.ETag); err != nil {
return fmt.Errorf("error: unable to update schema of table: %v", err)
}
}
return nil
}
func (bq *actualBQ) WriteRow(ctx context.Context, row *bqRow) error {
ins := bq.table.Inserter()
log.V(2).Infof("Writing row: %v", row)
if err := ins.Put(ctx, row); err != nil {
return fmt.Errorf("error inserting row into BQ: %v", err)
}
return nil
}