File: fail.go

package info (click to toggle)
snapd 2.72-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 80,412 kB
  • sloc: sh: 16,506; ansic: 16,211; python: 11,213; makefile: 1,919; exp: 190; awk: 58; xml: 22
file content (79 lines) | stat: -rw-r--r-- 2,066 bytes parent folder | download | duplicates (2)
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
// -*- Mode: Go; indent-tabs-mode: t -*-

/*
 * Copyright (C) 2024 Canonical Ltd
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 3 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

package ctlcmd

import (
	"errors"
	"fmt"
	"strings"

	"github.com/snapcore/snapd/i18n"
	"github.com/snapcore/snapd/overlord/confdbstate"
)

type failCommand struct {
	baseCommand

	Positional struct {
		Reason string `positional-args:"true" positional-arg-name:":<rejection-reason>"`
	} `positional-args:"yes" required:"yes"`
}

var shortFailHelp = i18n.G("Fail a confdb change")
var longFailHelp = i18n.G(`
The fail command rejects the confdb changes currently being proposed,
providing a reason for the rejection. It may only be used in a
change-view-<plug> hook.
`)

func init() {
	info := addCommand("fail", shortFailHelp, longFailHelp, func() command {
		return &failCommand{}
	})
	info.hidden = true
}

func (c *failCommand) Execute(args []string) error {
	ctx, err := c.ensureContext()
	if err != nil {
		return err
	}

	if err := validateConfdbsFeatureFlag(ctx.State()); err != nil {
		return err
	}

	ctx.Lock()
	defer ctx.Unlock()

	if ctx.IsEphemeral() || !strings.HasPrefix(ctx.HookName(), "change-view-") {
		return errors.New(i18n.G(`cannot use "snapctl fail" outside of a "change-view" hook`))
	}

	t, _ := ctx.Task()
	tx, _, saveChanges, err := confdbstate.GetStoredTransaction(t)
	if err != nil {
		return fmt.Errorf(i18n.G("internal error: cannot get confdb transaction to fail: %v"), err)
	}

	tx.Abort(ctx.InstanceName(), c.Positional.Reason)
	saveChanges()
	return nil
}