/
path_release.go
379 lines (311 loc) · 11 KB
/
path_release.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
package server
import (
"archive/tar"
"context"
"encoding/base64"
"fmt"
"io"
"path"
"strings"
"github.com/Masterminds/semver"
"github.com/djherbis/buffer"
"github.com/djherbis/nio/v3"
"github.com/docker/docker/api/types"
"github.com/docker/docker/client"
git "github.com/go-git/go-git/v5"
"github.com/go-git/go-git/v5/plumbing/transport/http"
"github.com/hashicorp/go-hclog"
"github.com/hashicorp/vault/sdk/framework"
"github.com/hashicorp/vault/sdk/logical"
uuid "github.com/satori/go.uuid"
"github.com/werf/logboek"
"github.com/werf/trdl/server/pkg/config"
"github.com/werf/trdl/server/pkg/docker"
trdlGit "github.com/werf/trdl/server/pkg/git"
"github.com/werf/trdl/server/pkg/pgp"
"github.com/werf/trdl/server/pkg/tasks_manager"
"github.com/werf/trdl/server/pkg/util"
)
const (
fieldNameGitTag = "git_tag"
fieldNameGitUsername = "git_username"
fieldNameGitPassword = "git_password"
)
func releasePath(b *Backend) *framework.Path {
return &framework.Path{
Pattern: `release$`,
Fields: map[string]*framework.FieldSchema{
fieldNameGitTag: {
Type: framework.TypeString,
Description: "Git tag",
Required: true,
},
fieldNameGitUsername: {
Type: framework.TypeString,
Description: "Git username",
},
fieldNameGitPassword: {
Type: framework.TypeString,
Description: "Git password",
},
},
Operations: map[logical.Operation]framework.OperationHandler{
logical.CreateOperation: &framework.PathOperation{
Callback: b.pathRelease,
Summary: pathReleaseHelpSyn,
},
logical.UpdateOperation: &framework.PathOperation{
Callback: b.pathRelease,
Summary: pathReleaseHelpSyn,
},
},
HelpSynopsis: pathReleaseHelpSyn,
HelpDescription: pathReleaseHelpDesc,
}
}
func ValidateReleaseVersion(releaseVersion string) error {
_, err := semver.NewVersion(releaseVersion)
if err != nil {
return fmt.Errorf("expected semver release version got %q: %w", releaseVersion, err)
}
return nil
}
func (b *Backend) pathRelease(ctx context.Context, req *logical.Request, fields *framework.FieldData) (*logical.Response, error) {
if errResp := util.CheckRequiredFields(req, fields); errResp != nil {
return errResp, nil
}
cfg, err := getConfiguration(ctx, req.Storage)
if err != nil {
return nil, fmt.Errorf("unable to get configuration from storage: %w", err)
}
if cfg == nil {
return errorResponseConfigurationNotFound, nil
}
gitCredentialFromStorage, err := trdlGit.GetGitCredential(ctx, req.Storage)
if err != nil {
return nil, fmt.Errorf("unable to get git credential from storage: %w", err)
}
gitTag := fields.Get(fieldNameGitTag).(string)
if err := ValidateReleaseVersion(gitTag); err != nil {
return logical.ErrorResponse("%s validation failed: %s", fieldNameGitTag, err), nil
}
releaseName := strings.TrimPrefix(gitTag, "v")
gitUsername := fields.Get(fieldNameGitUsername).(string)
gitPassword := fields.Get(fieldNameGitPassword).(string)
if gitCredentialFromStorage != nil && gitUsername == "" && gitPassword == "" {
gitUsername = gitCredentialFromStorage.Username
gitPassword = gitCredentialFromStorage.Password
}
opts := cfg.RepositoryOptions()
opts.InitializeTUFKeys = true
opts.InitializePGPSigningKey = true
publisherRepository, err := b.Publisher.GetRepository(ctx, req.Storage, opts)
if err != nil {
return nil, fmt.Errorf("error getting publisher repository: %w", err)
}
taskUUID, err := b.TasksManager.RunTask(context.Background(), req.Storage, func(ctx context.Context, storage logical.Storage) error {
logboek.Context(ctx).Default().LogF("Started task\n")
b.Logger().Debug("Started task")
logboek.Context(ctx).Default().LogF("Cloning git repo\n")
b.Logger().Debug("Cloning git repo")
gitRepo, err := cloneGitRepositoryTag(cfg.GitRepoUrl, gitTag, gitUsername, gitPassword)
if err != nil {
return fmt.Errorf("unable to clone git repository: %w", err)
}
logboek.Context(ctx).Default().LogF("Verifying tag PGP signatures of the git tag %q\n", gitTag)
b.Logger().Debug(fmt.Sprintf("Verifying tag PGP signatures of the git tag %q", gitTag))
trustedPGPPublicKeys, err := pgp.GetTrustedPGPPublicKeys(ctx, req.Storage)
if err != nil {
return fmt.Errorf("unable to get trusted PGP public keys: %w", err)
}
b.Logger().Debug(fmt.Sprintf("[DEBUG-SIGNATURES] trustedPGPPublicKeys >%v<", trustedPGPPublicKeys))
if err := trdlGit.VerifyTagSignatures(gitRepo, gitTag, trustedPGPPublicKeys, cfg.RequiredNumberOfVerifiedSignaturesOnCommit, b.Logger()); err != nil {
return fmt.Errorf("signature verification failed: %w", err)
}
logboek.Context(ctx).Default().LogF("Getting trdl.yaml configuration from the git tag %q\n", gitTag)
b.Logger().Debug(fmt.Sprintf("Getting trdl.yaml configuration from the git tag %q\n", gitTag))
trdlCfg, err := getTrdlConfig(gitRepo, gitTag, cfg.GitTrdlPath)
if err != nil {
return fmt.Errorf("unable to get trdl configuration: %w", err)
}
logboek.Context(ctx).Default().LogF("Starting release artifacts tar archive build\n")
b.Logger().Debug("Starting release artifacts tar archive build")
tarBuf := buffer.New(64 * 1024 * 1024)
tarReader, tarWriter := nio.Pipe(tarBuf)
err, cleanupFunc := buildReleaseArtifacts(ctx, tarWriter, gitRepo, trdlCfg.GetDockerImage(), trdlCfg.Commands, b.Logger())
if err != nil {
return fmt.Errorf("unable to build release artifacts: %w", err)
}
defer func() {
if err := cleanupFunc(); err != nil {
b.Logger().Error(fmt.Sprintf("unable to remove service docker image: %s", err))
}
}()
{
twArtifacts := tar.NewReader(tarReader)
for {
hdr, err := twArtifacts.Next()
if err == io.EOF {
break
}
if err != nil {
return fmt.Errorf("error reading next tar artifact header: %w", err)
}
if hdr.Typeflag != tar.TypeDir {
logboek.Context(ctx).Default().LogF("Publishing %q into the tuf repo ...\n", hdr.Name)
b.Logger().Debug(fmt.Sprintf("Publishing %q into the tuf repo ...", hdr.Name))
if err := b.Publisher.StageReleaseTarget(ctx, publisherRepository, releaseName, hdr.Name, twArtifacts); err != nil {
return fmt.Errorf("unable to publish release target %q: %w", hdr.Name, err)
}
}
}
logboek.Context(ctx).Default().LogF("Committing TUF repository state\n")
b.Logger().Debug("Committing TUF repository state")
if err := publisherRepository.CommitStaged(ctx); err != nil {
return fmt.Errorf("unable to commit new tuf repository state: %w", err)
}
}
logboek.Context(ctx).Default().LogF("Task finished\n")
b.Logger().Debug("Task finished")
return nil
})
if err != nil {
if err == tasks_manager.ErrBusy {
return logical.ErrorResponse("busy"), nil
}
return nil, err
}
return &logical.Response{
Data: map[string]interface{}{
"task_uuid": taskUUID,
},
}, nil
}
func cloneGitRepositoryTag(url, gitTag, username, password string) (*git.Repository, error) {
cloneGitOptions := trdlGit.CloneOptions{
TagName: gitTag,
RecurseSubmodules: git.DefaultSubmoduleRecursionDepth,
}
if username != "" && password != "" {
cloneGitOptions.Auth = &http.BasicAuth{
Username: username,
Password: password,
}
}
gitRepo, err := trdlGit.CloneInMemory(url, cloneGitOptions)
if err != nil {
return nil, err
}
return gitRepo, nil
}
func getTrdlConfig(gitRepo *git.Repository, gitTag, trdlPath string) (*config.Trdl, error) {
if trdlPath == "" {
trdlPath = config.DefaultTrdlPath
}
data, err := trdlGit.ReadWorktreeFile(gitRepo, trdlPath)
if err != nil {
return nil, fmt.Errorf("unable to read worktree file %q: %w", trdlPath, err)
}
values := map[string]interface{}{
"Tag": gitTag,
}
cfg, err := config.ParseTrdl(data, values)
if err != nil {
return nil, fmt.Errorf("error parsing %q configuration file: %w", trdlPath, err)
}
if err := cfg.Validate(); err != nil {
return nil, fmt.Errorf("error validation %q configuration file: %w", trdlPath, err)
}
return cfg, nil
}
func buildReleaseArtifacts(ctx context.Context, tarWriter *nio.PipeWriter, gitRepo *git.Repository, fromImage string, runCommands []string, logger hclog.Logger) (error, func() error) {
cli, err := client.NewClientWithOpts(client.FromEnv, client.WithAPIVersionNegotiation())
if err != nil {
return fmt.Errorf("unable to create docker client: %w", err), nil
}
serviceDirInContext := ".trdl"
serviceDockerfilePathInContext := path.Join(serviceDirInContext, "Dockerfile")
serviceLabels := map[string]string{
"vault-trdl-release-uuid": uuid.NewV4().String(),
}
contextBuf := buffer.New(64 * 1024 * 1024)
contextReader, contextWriter := nio.Pipe(contextBuf)
go func() {
if err := func() error {
tw := tar.NewWriter(contextWriter)
logboek.Context(ctx).Default().LogF("Adding git worktree files to the build context\n")
logger.Debug("Adding git worktree files to the build context")
if err := trdlGit.AddWorktreeFilesToTar(tw, gitRepo); err != nil {
return fmt.Errorf("unable to add git worktree files to tar: %w", err)
}
dockerfileOpts := docker.DockerfileOpts{
WithArtifacts: true,
Labels: serviceLabels,
}
if err := docker.GenerateAndAddDockerfileToTar(tw, serviceDockerfilePathInContext, fromImage, runCommands, dockerfileOpts); err != nil {
return fmt.Errorf("unable to add service dockerfile to tar: %w", err)
}
if err := tw.Close(); err != nil {
return fmt.Errorf("unable to close tar writer: %w", err)
}
return nil
}(); err != nil {
if closeErr := contextWriter.CloseWithError(err); closeErr != nil {
panic(closeErr)
}
return
}
if err := contextWriter.Close(); err != nil {
panic(err)
}
}()
logboek.Context(ctx).Default().LogF("Building docker image with artifacts\n")
logger.Debug("Building docker image with artifacts")
response, err := cli.ImageBuild(ctx, contextReader, types.ImageBuildOptions{
Dockerfile: serviceDockerfilePathInContext,
PullParent: true,
NoCache: true,
Remove: true,
ForceRemove: true,
Version: types.BuilderV1,
})
if err != nil {
return fmt.Errorf("unable to run docker image build: %w", err), nil
}
handleFromImageBuildResponse(ctx, response, tarWriter)
cleanupFunc := func() error {
return docker.RemoveImagesByLabels(ctx, cli, serviceLabels)
}
return nil, cleanupFunc
}
func handleFromImageBuildResponse(ctx context.Context, response types.ImageBuildResponse, tarWriter *nio.PipeWriter) {
buf := buffer.New(64 * 1024 * 1024)
r, w := nio.Pipe(buf)
go func() {
if err := docker.ReadTarFromImageBuildResponse(w, logboek.Context(ctx).OutStream(), response); err != nil {
if closeErr := w.CloseWithError(err); closeErr != nil {
panic(closeErr)
}
return
}
if err := w.Close(); err != nil {
panic(err)
}
}()
go func() {
decoder := base64.NewDecoder(base64.StdEncoding, r)
if _, err := io.Copy(tarWriter, decoder); err != nil {
if closeErr := tarWriter.CloseWithError(err); closeErr != nil {
panic(closeErr)
}
return
}
if err := w.Close(); err != nil {
panic(err)
}
}()
}
const (
pathReleaseHelpSyn = "Perform a release"
pathReleaseHelpDesc = "Perform a release for the specified git tag"
)