go/goreleaser
go/goreleaser
1
0
Fork 0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-03-11 14:39:28 +02:00
Code Issues Releases Activity

feat: add missing Snapcraft app metadata fields (#2955)

Browse Source 
* fix: add missing snapcraft app metadata fields

* docs: add missing snapcraft app metadata fields

* Apply suggestions from code review

Co-authored-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com>
This commit is contained in:
David Stotijn 2022-03-06 03:16:43 +01:00 committed by GitHub
parent c52f904245
commit c4017fca69
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 320 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
internal/pipe/snapcraft/snapcraft.go
View File

@ -52,12 +52,39 @@ type Metadata struct {
}
// 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
Plugs []string `yaml:",omitempty"`
Daemon string `yaml:",omitempty"`
Completer string `yaml:",omitempty"`
RestartCondition string `yaml:"restart-condition,omitempty"`
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 {
@ -287,9 +314,35 @@ func create(ctx *context.Context, snap config.Snapcraft, arch string, binaries [
command,
config.Args,
}, " ")),
Plugs: config.Plugs,
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 != "" {

109
internal/pipe/snapcraft/snapcraft_test.go
View File

@ -165,11 +165,55 @@ func TestRunPipeMetadata(t *testing.T) {
"/etc/testprojectname": {Bind: "$SNAP_DATA/etc"},
},
Apps: map[string]config.SnapcraftAppMetadata{
"before-foo": {
Before: []string{"foo"},
Command: "foo",
Daemon: "notify",
},
"after-foo": {
After: []string{"foo"},
Command: "foo",
Daemon: "notify",
},
"foo": {
Plugs: []string{"home", "network", "personal-files"},
Daemon: "simple",
Args: "--foo --bar",
Args: "--foo --bar",
Adapter: "foo_adapter",
Aliases: []string{"dummy_alias"},
Autostart: "foobar.desktop",
BusName: "foo_busname",
CommandChain: []string{"foo_cmd_chain"},
CommonID: "foo_common_id",
Completer: "", // Separately tested in TestCompleter
Daemon: "simple",
Desktop: "foo_desktop",
Environment: map[string]interface{}{
"foo": "bar",
},
Extensions: []string{"foo_extension"},
InstallMode: "disable",
Passthrough: map[string]interface{}{
"planet": "saturn",
},
Plugs: []string{"home", "network", "network-bind", "personal-files"},
PostStopCommand: "foo",
RefreshMode: "endure",
ReloadCommand: "foo",
RestartCondition: "always",
RestartDelay: "42ms",
Slots: []string{"foo_slot"},
Sockets: map[string]interface{}{
"sock": map[string]interface{}{
"listen-stream": "$SNAP_COMMON/socket",
"socket-group": "socket-group",
"socket-mode": 0o640,
},
},
StartTimeout: "43ms",
StopCommand: "foo",
StopMode: "sigterm",
StopTimeout: "44ms",
Timer: "00:00-24:00/24",
WatchdogTimeout: "45ms",
},
},
Plugs: map[string]interface{}{
@ -191,14 +235,59 @@ func TestRunPipeMetadata(t *testing.T) {
var metadata Metadata
err = yaml.Unmarshal(yamlFile, &metadata)
require.NoError(t, err)
require.Equal(t, []string{"home", "network", "personal-files"}, metadata.Apps["foo"].Plugs)
require.Equal(t, "simple", metadata.Apps["foo"].Daemon)
require.Equal(t, "foo --foo --bar", metadata.Apps["foo"].Command)
require.Equal(t, []string{"home", "network", "personal-files"}, metadata.Apps["foo"].Plugs)
require.Equal(t, "simple", metadata.Apps["foo"].Daemon)
require.Equal(t, "foo --foo --bar", metadata.Apps["foo"].Command)
require.Equal(t, map[string]AppMetadata{
"before-foo": {
Before: []string{"foo"},
Command: "foo",
Daemon: "notify",
},
"after-foo": {
After: []string{"foo"},
Command: "foo",
Daemon: "notify",
},
"foo": {
Adapter: "foo_adapter",
Aliases: []string{"dummy_alias"},
Autostart: "foobar.desktop",
BusName: "foo_busname",
Command: "foo --foo --bar",
CommandChain: []string{"foo_cmd_chain"},
CommonID: "foo_common_id",
Completer: "",
Daemon: "simple",
Desktop: "foo_desktop",
Environment: map[string]interface{}{
"foo": "bar",
},
Extensions: []string{"foo_extension"},
InstallMode: "disable",
Passthrough: map[string]interface{}{
"planet": "saturn",
},
Plugs: []string{"home", "network", "network-bind", "personal-files"},
PostStopCommand: "foo",
RefreshMode: "endure",
ReloadCommand: "foo",
RestartCondition: "always",
RestartDelay: "42ms",
Slots: []string{"foo_slot"},
Sockets: map[string]interface{}{
"sock": map[interface{}]interface{}{
"listen-stream": "$SNAP_COMMON/socket",
"socket-group": "socket-group",
"socket-mode": 0o640,
},
},
StartTimeout: "43ms",
StopCommand: "foo",
StopMode: "sigterm",
StopTimeout: "44ms",
Timer: "00:00-24:00/24",
WatchdogTimeout: "45ms",
},
}, metadata.Apps)
require.Equal(t, map[interface{}]interface{}{"read": []interface{}{"$HOME/test"}}, metadata.Plugs["personal-files"])
require.Equal(t, "always", metadata.Apps["foo"].RestartCondition)
require.Equal(t, "$SNAP_DATA/etc", metadata.Layout["/etc/testprojectname"].Bind)
}

38
pkg/config/config.go
View File

@ -688,12 +688,38 @@ type Sign struct {
// SnapcraftAppMetadata for the binaries that will be in the snap package.
type SnapcraftAppMetadata struct {
Plugs []string
Daemon string
Args string
Completer string `yaml:"completer,omitempty"`
Command string `yaml:"command"`
RestartCondition string `yaml:"restart_condition,omitempty"`
Command string `yaml:"command"`
Args string `yaml:"args,omitempty"`
Adapter string `yaml:"adapter,omitempty"`
After []string `yaml:"after,omitempty"`
Aliases []string `yaml:"aliases,omitempty"`
Autostart string `yaml:"autostart,omitempty"`
Before []string `yaml:"before,omitempty"`
BusName string `yaml:"bus_name,omitempty"`
CommandChain []string `yaml:"command_chain,omitempty"`
CommonID string `yaml:"common_id,omitempty"`
Completer string `yaml:"completer,omitempty"`
Daemon string `yaml:"daemon,omitempty"`
Desktop string `yaml:"desktop,omitempty"`
Environment map[string]interface{} `yaml:"environment,omitempty"`
Extensions []string `yaml:"extensions,omitempty"`
InstallMode string `yaml:"install_mode,omitempty"`
Passthrough map[string]interface{} `yaml:"passthrough,omitempty"`
Plugs []string `yaml:"plugs,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:"slots,omitempty"`
Sockets map[string]interface{} `yaml:"sockets,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:"timer,omitempty"`
WatchdogTimeout string `yaml:"watchdog_timeout,omitempty"`
}
type SnapcraftLayoutMetadata struct {

143
www/docs/customization/snapcraft.md
View File

@ -146,11 +146,95 @@ snapcrafts:
# Each binary built by GoReleaser is an app inside the snap. In this section
# you can declare extra details for those binaries. It is optional.
# See: https://snapcraft.io/docs/snapcraft-app-and-service-metadata
apps:
# The name of the app must be the same name as the binary built or the snapcraft name.
drumroll:
# If you any to pass args to your binary, you can add them with the
# args option.
args: --foo
# The kind of wrapper to generate for the given command.
# Defaults to empty.
adapter: none
# List of applications that are ordered to be started after the current
# one.
# Defaults to empty.
after: ["postdrum"]
# Aliases for the app command.
# Defaults to empty.
# https://snapcraft.io/docs/commands-and-aliases#heading--aliases
aliases: ["droll"]
# Defines the name of the .desktop file used to start an application
# with the desktop session.
# Defaults to empty.
# https://snapcraft.io/docs/snap-format#heading--autostart
autostart: drumroll.desktop
# List of applications that are ordered to be started before the current
# one.
# Defaults to empty.
before: ["predrum"]
# D-Bus name this service is reachable as. Mandatory if daemon=dbus.
# Defaults to empty.
bus_name: drumbus
# A list of commands to be executed in order before the command of this
# app.
# Defaults to empty.
command_chain: ["foo", "bar", "baz"]
# An identifier to a desktop-id within an external appstream file.
# https://snapcraft.io/docs/using-external-metadata
common_id: "com.example.drumroll"
# Bash completion snippet. More information about completion here:
# Defaults to empty.
# https://docs.snapcraft.io/tab-completion-for-snaps.
completer: drumroll-completion.bash
# You can override the command name.
# Default is the app name.
command: bin/drumroll.wrapper
# If you want your app to be autostarted and to always run in the
# background, you can make it a simple daemon.
# Defaults to empty.
daemon: simple
# Location of the .desktop file.
# Defaults to empty.
desktop: usr/share/applications/drumroll.desktop
# A set of key-value pairs specifying environment variables.
# Defaults to empty.
environment:
foo: bar
baz: quo
# A list of Snapcraft extensions this app depends on.
# Defaults to empty.
# https://snapcraft.io/docs/snapcraft-extensions
extensions: ["gnome-3-38"]
# Defines whether a freshly installed daemon is started automatically,
# or whether startup control is deferred to the snap.
# Defaults to empty. Requires `daemon` to be set.
install_mode: "disable"
# A set of key-value attributes passed through to snap.yaml without
# snapcraft validation.
# Defaults to empty.
# https://snapcraft.io/docs/using-in-development-features
passthrough:
foo: bar
# If your app requires extra permissions to work outside of its default
# confined space, declare them here.
# You can read the documentation about the available plugs and the
@ -158,27 +242,60 @@ snapcrafts:
# https://snapcraft.io/docs/reference/interfaces.
plugs: ["home", "network", "personal-files"]
# If you want your app to be autostarted and to always run in the
# background, you can make it a simple daemon.
daemon: simple
# Sets a command to run from inside the snap after a service stops.
# Defaults to empty.
post_stop_command: foo
# If you any to pass args to your binary, you can add them with the
# args option.
args: --foo
# Controls whether the daemon should be restarted during a snap refresh.
# Defaults to empty.
refresh_mode: endure
# Bash completion snippet. More information about completion here:
# https://docs.snapcraft.io/tab-completion-for-snaps.
completer: drumroll-completion.bash
# You can override the command name.
# Defaults is the app name.
command: bin/drumroll.wrapper
# Command to use to ask the service to reload its configuration.
# Defaults to empty. Requires `daemon` to be set.
reload_command: foo
# Restart condition of the snap.
# Defaults to empty.
# https://snapcraft.io/docs/snapcraft-yaml-reference
restart_condition: "always"
# List of slots for interfaces to connect to.
# Defaults to empty.
slots: ["foo", "bar", "baz"]
# Maps a daemon’s sockets to services and activates them.
# Defaults to empty. Requires `plugs` to contain `network-bind`.
sockets:
sock:
listen-stream: $SNAP_COMMON/socket
socket-group: socket-group
socket-mode: 416
# Time to wait for daemon to start.
# Defaults to empty.
start_timeout: 42ms
# Command to use to stop the service.
# Defaults to empty. Requires `daemon` to be set.
stop_command: foo
# Controls how the daemon should be stopped.
# Defaults to empty. Requires `daemon` to be set.
stop_mode: sigterm
# Time to wait for daemon to stop.
# Defaults to empty.
stop_timeout: 42ms
# Schedules when, or how often, to run a service or command.
# Defaults to empty. Requires `daemon` to be set.
# https://snapcraft.io/docs/services-and-daemons
timer: "00:00-24:00/24"
# Declares the service watchdog timeout.
# Defaults to empty. Requires `plugs` to contain `daemon-notify`.
watchdog_timeout: 42ms
# Allows plugs to be configured. Plugs like system-files and personal-files
# require this.
# Default is empty.