/
snapcraft.go
481 lines (431 loc) · 14.4 KB
/
snapcraft.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
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
// Package snapcraft implements the Pipe interface providing Snapcraft bindings.
//
// nolint:tagliatelle
package snapcraft
import (
"errors"
"fmt"
"os"
"os/exec"
"path/filepath"
"strings"
"github.com/caarlos0/log"
"github.com/goreleaser/goreleaser/internal/artifact"
"github.com/goreleaser/goreleaser/internal/gio"
"github.com/goreleaser/goreleaser/internal/ids"
"github.com/goreleaser/goreleaser/internal/pipe"
"github.com/goreleaser/goreleaser/internal/semerrgroup"
"github.com/goreleaser/goreleaser/internal/tmpl"
"github.com/goreleaser/goreleaser/internal/yaml"
"github.com/goreleaser/goreleaser/pkg/config"
"github.com/goreleaser/goreleaser/pkg/context"
)
const releasesExtra = "releases"
// ErrNoSnapcraft is shown when snapcraft cannot be found in $PATH.
var ErrNoSnapcraft = errors.New("snapcraft not present in $PATH")
// ErrNoDescription is shown when no description provided.
var ErrNoDescription = errors.New("no description provided for snapcraft")
// ErrNoSummary is shown when no summary provided.
var ErrNoSummary = errors.New("no summary provided for snapcraft")
// Metadata to generate the snap package.
type Metadata struct {
Name string
Version string
Summary string
Description string
Base string `yaml:",omitempty"`
License string `yaml:",omitempty"`
Grade string `yaml:",omitempty"`
Confinement string `yaml:",omitempty"`
Architectures []string
Layout map[string]LayoutMetadata `yaml:",omitempty"`
Apps map[string]AppMetadata
Plugs map[string]interface{} `yaml:",omitempty"`
}
// AppMetadata for the binaries that will be in the snap package.
// See: https://snapcraft.io/docs/snapcraft-app-and-service-metadata
type AppMetadata struct {
Command string
Adapter string `yaml:",omitempty"`
After []string `yaml:",omitempty"`
Aliases []string `yaml:",omitempty"`
Autostart string `yaml:",omitempty"`
Before []string `yaml:",omitempty"`
BusName string `yaml:"bus-name,omitempty"`
CommandChain []string `yaml:"command-chain,omitempty"`
CommonID string `yaml:"common-id,omitempty"`
Completer string `yaml:",omitempty"`
Daemon string `yaml:",omitempty"`
Desktop string `yaml:",omitempty"`
Environment map[string]interface{} `yaml:",omitempty"`
Extensions []string `yaml:",omitempty"`
InstallMode string `yaml:"install-mode,omitempty"`
Passthrough map[string]interface{} `yaml:",omitempty"`
Plugs []string `yaml:",omitempty"`
PostStopCommand string `yaml:"post-stop-command,omitempty"`
RefreshMode string `yaml:"refresh-mode,omitempty"`
ReloadCommand string `yaml:"reload-command,omitempty"`
RestartCondition string `yaml:"restart-condition,omitempty"`
RestartDelay string `yaml:"restart-delay,omitempty"`
Slots []string `yaml:",omitempty"`
Sockets map[string]interface{} `yaml:",omitempty"`
StartTimeout string `yaml:"start-timeout,omitempty"`
StopCommand string `yaml:"stop-command,omitempty"`
StopMode string `yaml:"stop-mode,omitempty"`
StopTimeout string `yaml:"stop-timeout,omitempty"`
Timer string `yaml:",omitempty"`
WatchdogTimeout string `yaml:"watchdog-timeout,omitempty"`
}
type LayoutMetadata struct {
Symlink string `yaml:",omitempty"`
Bind string `yaml:",omitempty"`
BindFile string `yaml:"bind-file,omitempty"`
Type string `yaml:",omitempty"`
}
const defaultNameTemplate = `{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}{{ with .Arm }}v{{ . }}{{ end }}{{ with .Mips }}_{{ . }}{{ end }}{{ if not (eq .Amd64 "v1") }}{{ .Amd64 }}{{ end }}`
// Pipe for snapcraft packaging.
type Pipe struct{}
func (Pipe) String() string { return "snapcraft packages" }
func (Pipe) Skip(ctx *context.Context) bool { return len(ctx.Config.Snapcrafts) == 0 }
// Default sets the pipe defaults.
func (Pipe) Default(ctx *context.Context) error {
ids := ids.New("snapcrafts")
for i := range ctx.Config.Snapcrafts {
snap := &ctx.Config.Snapcrafts[i]
if snap.NameTemplate == "" {
snap.NameTemplate = defaultNameTemplate
}
if len(snap.ChannelTemplates) == 0 {
switch snap.Grade {
case "devel":
snap.ChannelTemplates = []string{"edge", "beta"}
default:
snap.ChannelTemplates = []string{"edge", "beta", "candidate", "stable"}
}
}
if len(snap.Builds) == 0 {
for _, b := range ctx.Config.Builds {
snap.Builds = append(snap.Builds, b.ID)
}
}
ids.Inc(snap.ID)
}
return ids.Validate()
}
// Run the pipe.
func (Pipe) Run(ctx *context.Context) error {
for _, snap := range ctx.Config.Snapcrafts {
// TODO: deal with pipe.skip?
if err := doRun(ctx, snap); err != nil {
return err
}
}
return nil
}
func doRun(ctx *context.Context, snap config.Snapcraft) error {
tpl := tmpl.New(ctx)
summary, err := tpl.Apply(snap.Summary)
if err != nil {
return err
}
description, err := tpl.Apply(snap.Description)
if err != nil {
return err
}
snap.Summary = summary
snap.Description = description
if snap.Summary == "" && snap.Description == "" {
return pipe.Skip("no summary nor description were provided")
}
if snap.Summary == "" {
return ErrNoSummary
}
if snap.Description == "" {
return ErrNoDescription
}
_, err = exec.LookPath("snapcraft")
if err != nil {
return ErrNoSnapcraft
}
g := semerrgroup.New(ctx.Parallelism)
for platform, binaries := range ctx.Artifacts.Filter(
artifact.And(
artifact.ByGoos("linux"),
artifact.ByType(artifact.Binary),
artifact.ByIDs(snap.Builds...),
),
).GroupByPlatform() {
arch := linuxArch(platform)
if !isValidArch(arch) {
log.WithField("arch", arch).Warn("ignored unsupported arch")
continue
}
binaries := binaries
g.Go(func() error {
return create(ctx, snap, arch, binaries)
})
}
return g.Wait()
}
func isValidArch(arch string) bool {
// https://snapcraft.io/docs/architectures
for _, a := range []string{"s390x", "ppc64el", "arm64", "armhf", "i386", "amd64"} {
if arch == a {
return true
}
}
return false
}
// Publish packages.
func (Pipe) Publish(ctx *context.Context) error {
if ctx.SkipPublish {
return pipe.ErrSkipPublishEnabled
}
snaps := ctx.Artifacts.Filter(artifact.ByType(artifact.PublishableSnapcraft)).List()
for _, snap := range snaps {
if err := push(ctx, snap); err != nil {
return err
}
}
return nil
}
func create(ctx *context.Context, snap config.Snapcraft, arch string, binaries []*artifact.Artifact) error {
log := log.WithField("arch", arch)
folder, err := tmpl.New(ctx).
WithArtifact(binaries[0], snap.Replacements).
Apply(snap.NameTemplate)
if err != nil {
return err
}
channels, err := processChannelsTemplates(ctx, snap)
if err != nil {
return err
}
// prime is the directory that then will be compressed to make the .snap package.
folderDir := filepath.Join(ctx.Config.Dist, folder)
primeDir := filepath.Join(folderDir, "prime")
metaDir := filepath.Join(primeDir, "meta")
// #nosec
if err = os.MkdirAll(metaDir, 0o755); err != nil {
return err
}
for _, file := range snap.Files {
if file.Destination == "" {
file.Destination = file.Source
}
if file.Mode == 0 {
file.Mode = 0o644
}
destinationDir := filepath.Join(primeDir, filepath.Dir(file.Destination))
if err := os.MkdirAll(destinationDir, 0o755); err != nil {
return fmt.Errorf("failed to create directory '%s': %w", destinationDir, err)
}
if err := gio.CopyWithMode(file.Source, filepath.Join(primeDir, file.Destination), os.FileMode(file.Mode)); err != nil {
return fmt.Errorf("failed to link extra file '%s': %w", file.Source, err)
}
}
file := filepath.Join(primeDir, "meta", "snap.yaml")
log.WithField("file", file).Debug("creating snap metadata")
metadata := &Metadata{
Version: ctx.Version,
Summary: snap.Summary,
Description: snap.Description,
Grade: snap.Grade,
Confinement: snap.Confinement,
Architectures: []string{arch},
Layout: map[string]LayoutMetadata{},
Apps: map[string]AppMetadata{},
}
if snap.Base != "" {
metadata.Base = snap.Base
}
if snap.License != "" {
metadata.License = snap.License
}
metadata.Name = ctx.Config.ProjectName
if snap.Name != "" {
metadata.Name = snap.Name
}
for targetPath, layout := range snap.Layout {
metadata.Layout[targetPath] = LayoutMetadata{
Symlink: layout.Symlink,
Bind: layout.Bind,
BindFile: layout.BindFile,
Type: layout.Type,
}
}
// if the user didn't specify any apps then
// default to the main binary being the command:
if len(snap.Apps) == 0 {
name := snap.Name
if name == "" {
name = filepath.Base(binaries[0].Name)
}
metadata.Apps[name] = AppMetadata{
Command: filepath.Base(filepath.Base(binaries[0].Name)),
}
}
for _, binary := range binaries {
// build the binaries and link resources
destBinaryPath := filepath.Join(primeDir, filepath.Base(binary.Path))
log.WithField("src", binary.Path).
WithField("dst", destBinaryPath).
Debug("copying")
if err = gio.CopyWithMode(binary.Path, destBinaryPath, 0o555); err != nil {
return fmt.Errorf("failed to copy binary: %w", err)
}
}
// setup the apps: directive for each binary
for name, config := range snap.Apps {
command := name
if config.Command != "" {
command = config.Command
}
// TODO: test that the correct binary is used in Command
// See https://github.com/goreleaser/goreleaser/pull/1449
appMetadata := AppMetadata{
Command: strings.TrimSpace(strings.Join([]string{
command,
config.Args,
}, " ")),
Adapter: config.Adapter,
After: config.After,
Aliases: config.Aliases,
Autostart: config.Autostart,
Before: config.Before,
BusName: config.BusName,
CommandChain: config.CommandChain,
CommonID: config.CommonID,
Completer: config.Completer,
Daemon: config.Daemon,
Desktop: config.Desktop,
Environment: config.Environment,
Extensions: config.Extensions,
InstallMode: config.InstallMode,
Passthrough: config.Passthrough,
Plugs: config.Plugs,
PostStopCommand: config.PostStopCommand,
RefreshMode: config.RefreshMode,
ReloadCommand: config.ReloadCommand,
RestartCondition: config.RestartCondition,
RestartDelay: config.RestartDelay,
Slots: config.Slots,
Sockets: config.Sockets,
StartTimeout: config.StartTimeout,
StopCommand: config.StopCommand,
StopMode: config.StopMode,
StopTimeout: config.StopTimeout,
Timer: config.Timer,
WatchdogTimeout: config.WatchdogTimeout,
}
if config.Completer != "" {
destCompleterPath := filepath.Join(primeDir, config.Completer)
if err := os.MkdirAll(filepath.Dir(destCompleterPath), 0o755); err != nil {
return fmt.Errorf("failed to create folder: %w", err)
}
log.WithField("src", config.Completer).
WithField("dst", destCompleterPath).
Debug("copy")
if err := gio.CopyWithMode(config.Completer, destCompleterPath, 0o644); err != nil {
return fmt.Errorf("failed to copy completer: %w", err)
}
appMetadata.Completer = config.Completer
}
metadata.Apps[name] = appMetadata
metadata.Plugs = snap.Plugs
}
out, err := yaml.Marshal(metadata)
if err != nil {
return err
}
log.WithField("file", file).Debugf("writing metadata file")
if err = os.WriteFile(file, out, 0o644); err != nil { //nolint: gosec
return err
}
snapFile := filepath.Join(ctx.Config.Dist, folder+".snap")
log.WithField("snap", snapFile).Info("creating")
/* #nosec */
cmd := exec.CommandContext(ctx, "snapcraft", "pack", primeDir, "--output", snapFile)
if out, err = cmd.CombinedOutput(); err != nil {
return fmt.Errorf("failed to generate snap package: %w: %s", err, string(out))
}
if !snap.Publish {
return nil
}
ctx.Artifacts.Add(&artifact.Artifact{
Type: artifact.PublishableSnapcraft,
Name: folder + ".snap",
Path: snapFile,
Goos: binaries[0].Goos,
Goarch: binaries[0].Goarch,
Goarm: binaries[0].Goarm,
Goamd64: binaries[0].Goamd64,
Extra: map[string]interface{}{
releasesExtra: channels,
},
})
return nil
}
const (
reviewWaitMsg = `Waiting for previous upload(s) to complete their review process.`
humanReviewMsg = `A human will soon review your snap`
needsReviewMsg = `(NEEDS REVIEW)`
)
func push(ctx *context.Context, snap *artifact.Artifact) error {
log := log.WithField("snap", snap.Name)
releases := artifact.ExtraOr(*snap, releasesExtra, []string{})
/* #nosec */
cmd := exec.CommandContext(ctx, "snapcraft", "upload", "--release="+strings.Join(releases, ","), snap.Path)
log.WithField("args", cmd.Args).Info("pushing snap")
if out, err := cmd.CombinedOutput(); err != nil {
if strings.Contains(string(out), reviewWaitMsg) || strings.Contains(string(out), humanReviewMsg) || strings.Contains(string(out), needsReviewMsg) {
log.Warn(reviewWaitMsg)
} else {
return fmt.Errorf("failed to push %s package: %w: %s", snap.Path, err, string(out))
}
}
snap.Type = artifact.Snapcraft
ctx.Artifacts.Add(snap)
return nil
}
func processChannelsTemplates(ctx *context.Context, snap config.Snapcraft) ([]string, error) {
// nolint:prealloc
var channels []string
for _, channeltemplate := range snap.ChannelTemplates {
channel, err := tmpl.New(ctx).Apply(channeltemplate)
if err != nil {
return nil, fmt.Errorf("failed to execute channel template '%s': %w", err, err)
}
if channel == "" {
continue
}
channels = append(channels, channel)
}
return channels, nil
}
var archToSnap = map[string]string{
"386": "i386",
"arm": "armhf",
"arm6": "armhf",
"arm7": "armhf",
"ppc64le": "ppc64el",
}
// TODO: write tests for this
func linuxArch(key string) string {
// XXX: list of all linux arches: `go tool dist list | grep linux`
arch := strings.TrimPrefix(key, "linux")
for _, suffix := range []string{
"hardfloat",
"softfloat",
"v1",
"v2",
"v3",
"v4",
} {
arch = strings.TrimSuffix(arch, suffix)
}
if got, ok := archToSnap[arch]; ok {
return got
}
return arch
}