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
|
// -*- Mode: Go; indent-tabs-mode: t -*-
/*
* Copyright (C) 2025 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 asserts_test
import (
"strings"
"time"
. "gopkg.in/check.v1"
"github.com/snapcore/snapd/asserts"
)
type clusterSuite struct {
ts time.Time
tsLine string
}
var _ = Suite(&clusterSuite{})
func (cs *clusterSuite) SetUpSuite(c *C) {
cs.ts = time.Now().Truncate(time.Second).UTC()
cs.tsLine = "timestamp: " + cs.ts.Format(time.RFC3339) + "\n"
}
const (
clusterExample = `type: cluster
authority-id: authority-id
cluster-id: bf3675f5-cffa-40f4-a119-7492ccc08e04
sequence: 3
devices:
-
id: 1
device: 9cc45ad6-d01b-4efd-9f76-db55b76c076b.ubuntu-core-24-amd64.canonical
addresses:
- 192.168.1.10
- 10.0.0.10
-
id: 2
device: bc3c0a19-cdad-4cfc-a6f0-85e917bc6280.ubuntu-core-24-amd64.canonical
addresses:
- 192.168.1.20
subclusters:
-
name: default
devices:
- 1
- 2
snaps:
-
state: clustered
instance: clustered-snap
channel: stable
-
state: evacuated
instance: evacuated-snap
channel: edge
-
name: additional-cluster
devices:
- 2
snaps:
-
state: removed
instance: removed-snap
channel: 24/stable
TSLINE` +
"body-length: 0\n" +
"sign-key-sha3-384: Jv8_JiHiIzJVcO9M55pPdqSDWUvuhfDIBJUS-3VW7F_idjix7Ffn5qMxB21ZQuij" +
"\n\n" +
"AXNpZw=="
)
func (cs *clusterSuite) TestDecodeOK(c *C) {
encoded := strings.Replace(clusterExample, "TSLINE", cs.tsLine, 1)
a, err := asserts.Decode([]byte(encoded))
c.Assert(err, IsNil)
c.Check(a.Type(), Equals, asserts.ClusterType)
cluster := a.(*asserts.Cluster)
c.Check(cluster.AuthorityID(), Equals, "authority-id")
c.Check(cluster.ClusterID(), Equals, "bf3675f5-cffa-40f4-a119-7492ccc08e04")
c.Check(cluster.Sequence(), Equals, 3)
devices := cluster.Devices()
c.Assert(devices, HasLen, 2)
c.Check(devices[0].ID, Equals, 1)
c.Check(devices[0].BrandID, Equals, "canonical")
c.Check(devices[0].Model, Equals, "ubuntu-core-24-amd64")
c.Check(devices[0].Serial, Equals, "9cc45ad6-d01b-4efd-9f76-db55b76c076b")
c.Check(devices[0].Addresses, DeepEquals, []string{"192.168.1.10", "10.0.0.10"})
c.Check(devices[1].ID, Equals, 2)
c.Check(devices[1].BrandID, Equals, "canonical")
c.Check(devices[1].Model, Equals, "ubuntu-core-24-amd64")
c.Check(devices[1].Serial, Equals, "bc3c0a19-cdad-4cfc-a6f0-85e917bc6280")
c.Check(devices[1].Addresses, DeepEquals, []string{"192.168.1.20"})
subclusters := cluster.Subclusters()
c.Assert(subclusters, HasLen, 2)
c.Check(subclusters[0].Name, Equals, "default")
c.Check(subclusters[0].Devices, DeepEquals, []int{1, 2})
c.Assert(subclusters[0].Snaps, HasLen, 2)
c.Check(subclusters[0].Snaps[0].State, Equals, asserts.ClusterSnapStateClustered)
c.Check(subclusters[0].Snaps[0].Instance, Equals, "clustered-snap")
c.Check(subclusters[0].Snaps[0].Channel, Equals, "stable")
c.Check(subclusters[0].Snaps[1].State, Equals, asserts.ClusterSnapStateEvacuated)
c.Check(subclusters[0].Snaps[1].Instance, Equals, "evacuated-snap")
c.Check(subclusters[0].Snaps[1].Channel, Equals, "edge")
c.Check(subclusters[1].Name, Equals, "additional-cluster")
c.Check(subclusters[1].Devices, DeepEquals, []int{2})
c.Assert(subclusters[1].Snaps, HasLen, 1)
c.Check(subclusters[1].Snaps[0].State, Equals, asserts.ClusterSnapStateRemoved)
c.Check(subclusters[1].Snaps[0].Instance, Equals, "removed-snap")
c.Check(subclusters[1].Snaps[0].Channel, Equals, "24/stable")
}
func (cs *clusterSuite) TestDecodeInvalidTopLevel(c *C) {
encoded := strings.Replace(clusterExample, "TSLINE", cs.tsLine, 1)
invalidTests := []struct{ original, invalid, expectedErr string }{
{"cluster-id: bf3675f5-cffa-40f4-a119-7492ccc08e04\n", "", `"cluster-id" header is mandatory`},
{"cluster-id: bf3675f5-cffa-40f4-a119-7492ccc08e04\n", "cluster-id: \n", `"cluster-id" header should not be empty`},
{"sequence: 3\n", "sequence: 0\n", `"sequence" must be >=1: 0`},
{"devices:\n -\n id: 1\n device: 9cc45ad6-d01b-4efd-9f76-db55b76c076b.ubuntu-core-24-amd64.canonical\n addresses:\n - 192.168.1.10\n - 10.0.0.10\n -\n id: 2\n device: bc3c0a19-cdad-4cfc-a6f0-85e917bc6280.ubuntu-core-24-amd64.canonical\n addresses:\n - 192.168.1.20\n", "devices: not-a-list\n", `"devices" header must be a list`},
{"subclusters:\n -\n name: default\n devices:\n - 1\n - 2\n snaps:\n -\n state: clustered\n instance: clustered-snap\n channel: stable\n -\n state: evacuated\n instance: evacuated-snap\n channel: edge\n -\n name: additional-cluster\n devices:\n - 2\n snaps:\n -\n state: removed\n instance: removed-snap\n channel: 24/stable\n", "subclusters: not-a-list\n", `"subclusters" header must be a list`},
}
for _, test := range invalidTests {
invalid := strings.Replace(encoded, test.original, test.invalid, 1)
_, err := asserts.Decode([]byte(invalid))
c.Check(err, ErrorMatches, ".*"+test.expectedErr)
}
}
func (cs *clusterSuite) TestDecodeInvalidDevices(c *C) {
encoded := strings.Replace(clusterExample, "TSLINE", cs.tsLine, 1)
invalidTests := []struct{ original, invalid, expectedErr string }{
{" id: 1\n", " id: not-an-integer\n", `"id" header is not an integer: not-an-integer`},
{" id: 1\n", " id: 0\n", `"id" header must be >=1: 0`},
{" id: 1\n", " id: -1\n", `"id" header must be >=1: -1`},
{" device: 9cc45ad6-d01b-4efd-9f76-db55b76c076b.ubuntu-core-24-amd64.canonical\n", "", `"device" header is mandatory`},
{" device: 9cc45ad6-d01b-4efd-9f76-db55b76c076b.ubuntu-core-24-amd64.canonical\n", " device: \n", `"device" header should not be empty`},
{" device: 9cc45ad6-d01b-4efd-9f76-db55b76c076b.ubuntu-core-24-amd64.canonical\n", " device: invalid\n", `invalid device id format: expected 3 parts separated by '.', got 1: invalid`},
{" device: 9cc45ad6-d01b-4efd-9f76-db55b76c076b.ubuntu-core-24-amd64.canonical\n", " device: 9cc45ad6-d01b-4efd-9f76-db55b76c076b.ubuntu-core-24-amd64.Canonical\n", `invalid brand-id "Canonical" in device id "9cc45ad6-d01b-4efd-9f76-db55b76c076b.ubuntu-core-24-amd64.Canonical"`},
{" addresses:\n - 192.168.1.10\n - 10.0.0.10\n", " addresses: not-a-list\n", `"addresses" header must be a list of strings`},
{" -\n id: 1\n device: 9cc45ad6-d01b-4efd-9f76-db55b76c076b.ubuntu-core-24-amd64.canonical\n addresses:\n - 192.168.1.10\n - 10.0.0.10\n", " - device-string\n", `"devices" field must be a list of maps`},
{" id: 2\n", " id: 1\n", `"devices" field contains duplicate device id 1`},
}
for _, test := range invalidTests {
invalid := strings.Replace(encoded, test.original, test.invalid, 1)
_, err := asserts.Decode([]byte(invalid))
c.Check(err, ErrorMatches, ".*"+test.expectedErr)
}
}
func (cs *clusterSuite) TestDecodeInvalidSubclusters(c *C) {
encoded := strings.Replace(clusterExample, "TSLINE", cs.tsLine, 1)
invalidTests := []struct{ original, invalid, expectedErr string }{
{" state: clustered\n", " state: invalid-state\n", `snap state must be one of: "clustered", "evacuated", "removed"`},
{" - 1\n", " - not-a-number\n", `device id "not-a-number" is not an integer: not-a-number`},
{" - 1\n", " - 0\n", `device id must be >=1: 0`},
{" - 1\n", " - -1\n", `device id must be >=1: -1`},
{" name: default\n", "", `"name" header is mandatory`},
{" state: clustered\n", "", `"state" header is mandatory`},
{" instance: clustered-snap\n", "", `"instance" header is mandatory`},
{" instance: clustered-snap\n", " instance: invalid instance\n", `invalid snap instance name: invalid snap name: "invalid instance"`},
{" channel: stable\n", "", `"channel" header is mandatory`},
{" channel: stable\n", " channel: invalid//channel\n", `invalid channel name "invalid//channel": invalid risk in channel name: invalid//channel`},
{" -\n state: clustered\n instance: clustered-snap\n channel: stable\n", " - snap-string\n", `"snaps" field must be a list of maps`},
{" -\n name: default\n devices:\n - 1\n - 2\n snaps:\n -\n state: clustered\n instance: clustered-snap\n channel: stable\n -\n state: evacuated\n instance: evacuated-snap\n channel: edge\n", " - subcluster-string\n", `"subclusters" field must be a list of maps`},
{" name: additional-cluster\n", " name: default\n", `"subclusters" field contains duplicate subcluster name "default"`},
{" devices:\n - 1\n - 2\n", " devices: not-a-list\n", `"devices" header must be a list of strings`},
{" snaps:\n -\n state: clustered\n instance: clustered-snap\n channel: stable\n -\n state: evacuated\n instance: evacuated-snap\n channel: edge\n", " snaps: not-a-list\n", `"snaps" header must be a list`},
{" - 2\n snaps:", " - 999\n snaps:", `"subclusters" references unknown device id 999`},
}
for _, test := range invalidTests {
invalid := strings.Replace(encoded, test.original, test.invalid, 1)
_, err := asserts.Decode([]byte(invalid))
c.Check(err, ErrorMatches, ".*"+test.expectedErr)
}
}
|
