File: validate.go

package info (click to toggle)
snapd 2.71-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 79,536 kB
  • sloc: ansic: 16,114; sh: 16,105; python: 9,941; makefile: 1,890; exp: 190; awk: 40; xml: 22
file content (135 lines) | stat: -rw-r--r-- 4,154 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
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
// -*- Mode: Go; indent-tabs-mode: t -*-

/*
 * Copyright (C) 2020 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 client

import (
	"bytes"
	"encoding/json"
	"fmt"
	"net/url"

	"golang.org/x/xerrors"
)

// ValidateApplyOptions carries options for ApplyValidationSet.
type ValidateApplyOptions struct {
	Mode     string
	Sequence int
}

// ValidationSetResult holds information about a single validation set.
type ValidationSetResult struct {
	AccountID string `json:"account-id"`
	Name      string `json:"name"`

	Sequence int `json:"sequence,omitempty"`
	PinnedAt int `json:"pinned-at,omitempty"`

	Mode  string `json:"mode"`
	Valid bool   `json:"valid"`
	// TODO: flags/states for notes column
}

type postValidationSetData struct {
	Action   string `json:"action"`
	Mode     string `json:"mode,omitempty"`
	Sequence int    `json:"sequence,omitempty"`
}

// ForgetValidationSet forgets the given validation set identified by account,
// name and optional sequence (if non-zero).
func (client *Client) ForgetValidationSet(accountID, name string, sequence int) error {
	if accountID == "" || name == "" {
		return xerrors.Errorf("cannot forget validation set without account ID and name")
	}

	data := &postValidationSetData{
		Action:   "forget",
		Sequence: sequence,
	}

	var body bytes.Buffer
	if err := json.NewEncoder(&body).Encode(data); err != nil {
		return err
	}
	path := fmt.Sprintf("/v2/validation-sets/%s/%s", accountID, name)
	if _, err := client.doSync("POST", path, nil, nil, &body, nil); err != nil {
		fmt := "cannot forget validation set: %w"
		return xerrors.Errorf(fmt, err)
	}
	return nil
}

// ApplyValidationSet applies the given validation set identified by account and name and returns
// the new validation set tracking info. For monitoring mode the returned res may indicate invalid
// state.
func (client *Client) ApplyValidationSet(accountID, name string, opts *ValidateApplyOptions) (res *ValidationSetResult, err error) {
	if accountID == "" || name == "" {
		return nil, xerrors.Errorf("cannot apply validation set without account ID and name")
	}

	data := &postValidationSetData{
		Action:   "apply",
		Mode:     opts.Mode,
		Sequence: opts.Sequence,
	}

	var body bytes.Buffer
	if err := json.NewEncoder(&body).Encode(data); err != nil {
		return nil, err
	}
	path := fmt.Sprintf("/v2/validation-sets/%s/%s", accountID, name)

	if _, err := client.doSync("POST", path, nil, nil, &body, &res); err != nil {
		fmt := "cannot apply validation set: %w"
		return nil, xerrors.Errorf(fmt, err)
	}
	return res, nil
}

// ListValidationsSets queries all validation sets.
func (client *Client) ListValidationsSets() ([]*ValidationSetResult, error) {
	var res []*ValidationSetResult
	if _, err := client.doSync("GET", "/v2/validation-sets", nil, nil, nil, &res); err != nil {
		fmt := "cannot list validation sets: %w"
		return nil, xerrors.Errorf(fmt, err)
	}
	return res, nil
}

// ValidationSet queries the given validation set identified by account/name.
func (client *Client) ValidationSet(accountID, name string, sequence int) (*ValidationSetResult, error) {
	if accountID == "" || name == "" {
		return nil, xerrors.Errorf("cannot query validation set without account ID and name")
	}

	q := url.Values{}
	if sequence != 0 {
		q.Set("sequence", fmt.Sprintf("%d", sequence))
	}

	var res *ValidationSetResult
	path := fmt.Sprintf("/v2/validation-sets/%s/%s", accountID, name)
	if _, err := client.doSync("GET", path, q, nil, nil, &res); err != nil {
		fmt := "cannot query validation set: %w"
		return nil, xerrors.Errorf(fmt, err)
	}
	return res, nil
}