File: modelinfo_test.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 (502 lines) | stat: -rw-r--r-- 13,633 bytes parent folder | download | duplicates (3)
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
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
// -*- Mode: Go; indent-tabs-mode: t -*-

/*
 * Copyright (C) 2022 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 clientutil_test

import (
	"bytes"
	"fmt"
	"strings"
	"text/tabwriter"
	"time"

	. "gopkg.in/check.v1"

	"github.com/snapcore/snapd/asserts"
	"github.com/snapcore/snapd/asserts/assertstest"
	"github.com/snapcore/snapd/client/clientutil"
	"github.com/snapcore/snapd/strutil"
	"github.com/snapcore/snapd/testutil"
	"github.com/snapcore/snapd/timeutil"
)

const (
	modelExample = "type: model\n" +
		"authority-id: brand-id1\n" +
		"series: 16\n" +
		"brand-id: brand-id1\n" +
		"model: baz-3000\n" +
		"display-name: Baz 3000\n" +
		"architecture: amd64\n" +
		"gadget: brand-gadget\n" +
		"base: core18\n" +
		"kernel: baz-linux\n" +
		"store: brand-store\n" +
		"serial-authority:\n  - generic\n" +
		"system-user-authority: *\n" +
		"required-snaps:\n  - foo\n  - bar\n" +
		"TSLINE" +
		"body-length: 0\n" +
		"sign-key-sha3-384: Jv8_JiHiIzJVcO9M55pPdqSDWUvuhfDIBJUS-3VW7F_idjix7Ffn5qMxB21ZQuij" +
		"\n\n" +
		"AXNpZw=="

	core20ModelExample = `type: model
authority-id: brand-id1
series: 16
brand-id: brand-id1
model: baz-3000
display-name: Baz 3000
architecture: amd64
system-user-authority:
  - partner
  - brand-id1
base: core20
store: brand-store
grade: dangerous
storage-safety: prefer-unencrypted
snaps:
  -
    name: baz-linux
    id: bazlinuxidididididididididididid
    type: kernel
    default-channel: 20
  -
    name: brand-gadget
    id: brandgadgetdidididididididididid
    type: gadget
  -
    name: other-base
    id: otherbasedididididididididididid
    type: base
    modes:
      - run
    presence: required
  -
    name: nm
    id: nmididididididididididididididid
    modes:
      - ephemeral
      - run
    default-channel: 1.0
  -
    name: myapp
    id: myappdididididididididididididid
    type: app
    default-channel: 2.0
  -
    name: myappopt
    id: myappoptidididididididididididid
    type: app
    presence: optional
    grade: secured
    storage-safety: encrypted
` + "TSLINE" +
		"body-length: 0\n" +
		"sign-key-sha3-384: Jv8_JiHiIzJVcO9M55pPdqSDWUvuhfDIBJUS-3VW7F_idjix7Ffn5qMxB21ZQuij" +
		"\n\n" +
		"AXNpZw=="

	serialExample = "type: serial\n" +
		"authority-id: brand-id1\n" +
		"brand-id: brand-id1\n" +
		"model: baz-3000\n" +
		"serial: 2700\n" +
		"device-key:\n    DEVICEKEY\n" +
		"device-key-sha3-384: KEYID\n" +
		"TSLINE" +
		"body-length: 2\n" +
		"sign-key-sha3-384: Jv8_JiHiIzJVcO9M55pPdqSDWUvuhfDIBJUS-3VW7F_idjix7Ffn5qMxB21ZQuij\n\n" +
		"HW" +
		"\n\n" +
		"AXNpZw=="
)

type testFormatter struct {
}

func (tf testFormatter) GetEscapedDash() string {
	return "--"
}

func (tf testFormatter) LongPublisher(storeAccountID string) string {
	return storeAccountID
}

type modelInfoSuite struct {
	testutil.BaseTest
	ts            time.Time
	tsLine        string
	deviceKey     asserts.PrivateKey
	encodedDevKey string
	formatter     testFormatter
}

var testPrivKey2, _ = assertstest.GenerateKey(752)

var _ = Suite(&modelInfoSuite{})

func (s *modelInfoSuite) SetUpTest(c *C) {
	s.BaseTest.SetUpTest(c)
	s.ts = time.Now().Truncate(time.Second).UTC()
	s.tsLine = "timestamp: " + s.ts.Format(time.RFC3339) + "\n"

	s.deviceKey = testPrivKey2
	encodedPubKey, err := asserts.EncodePublicKey(s.deviceKey.PublicKey())
	c.Assert(err, IsNil)
	s.encodedDevKey = string(encodedPubKey)
}

func (s *modelInfoSuite) getModel(c *C, modelText string) asserts.Model {
	encoded := strings.Replace(modelText, "TSLINE", s.tsLine, 1)
	a, err := asserts.Decode([]byte(encoded))
	c.Assert(err, IsNil)
	c.Check(a.Type(), Equals, asserts.ModelType)
	model := a.(*asserts.Model)
	return *model
}

func (s *modelInfoSuite) getDeviceKey(padding string, termWidth int) string {
	var buffer bytes.Buffer
	w := tabwriter.NewWriter(&buffer, 0, 5, 4, ' ', 0)
	key := strings.Join(strings.Split(s.encodedDevKey, "\n"), "")
	strutil.WordWrapPadded(w, []rune(key), padding, termWidth)
	return buffer.String()
}

func (s *modelInfoSuite) getSerial(c *C, serialText string) asserts.Serial {
	encoded := strings.Replace(serialText, "TSLINE", s.tsLine, 1)
	encoded = strings.Replace(encoded, "DEVICEKEY", strings.Replace(s.encodedDevKey, "\n", "\n    ", -1), 1)
	encoded = strings.Replace(encoded, "KEYID", s.deviceKey.PublicKey().ID(), 1)
	a, err := asserts.Decode([]byte(encoded))
	c.Assert(err, IsNil)
	c.Check(a.Type(), Equals, asserts.SerialType)
	serial := a.(*asserts.Serial)
	return *serial
}

func (s *modelInfoSuite) TestPrintModelYAML(c *C) {
	var buffer bytes.Buffer
	w := tabwriter.NewWriter(&buffer, 0, 5, 4, ' ', 0)
	model := s.getModel(c, modelExample)

	options := clientutil.PrintModelAssertionOptions{
		TermWidth: 80,
		Verbose:   false,
		AbsTime:   false,
		Assertion: false,
	}
	err := clientutil.PrintModelAssertion(w, model, nil, s.formatter, options)
	c.Assert(err, IsNil)
	c.Check(buffer.String(), Equals, `brand     brand-id1
model     Baz 3000 (baz-3000)
serial    - (device not registered yet)
`)
}

func (s *modelInfoSuite) TestPrintModelWithSerialYAML(c *C) {
	var buffer bytes.Buffer
	w := tabwriter.NewWriter(&buffer, 0, 5, 4, ' ', 0)
	model := s.getModel(c, modelExample)
	serial := s.getSerial(c, serialExample)

	options := clientutil.PrintModelAssertionOptions{
		TermWidth: 80,
		Verbose:   false,
		AbsTime:   false,
		Assertion: false,
	}
	err := clientutil.PrintModelAssertion(w, model, &serial, s.formatter, options)
	c.Assert(err, IsNil)
	c.Check(buffer.String(), Equals, `brand     brand-id1
model     Baz 3000 (baz-3000)
serial    2700
`)
}

func (s *modelInfoSuite) TestPrintModelYAMLVerbose(c *C) {
	var buffer bytes.Buffer
	w := tabwriter.NewWriter(&buffer, 0, 5, 4, ' ', 0)
	model := s.getModel(c, core20ModelExample)

	options := clientutil.PrintModelAssertionOptions{
		TermWidth: 80,
		Verbose:   true,
		AbsTime:   false,
		Assertion: false,
	}
	err := clientutil.PrintModelAssertion(w, model, nil, s.formatter, options)
	c.Assert(err, IsNil)
	c.Check(buffer.String(), Equals, fmt.Sprintf(`brand-id:                 brand-id1
model:                    baz-3000
grade:                    dangerous
storage-safety:           prefer-unencrypted
serial:                   -- (device not registered yet)
architecture:             amd64
base:                     core20
display-name:             Baz 3000
store:                    brand-store
system-user-authority:    
  - partner
  - brand-id1
timestamp:    %s
snaps:
  - name:               baz-linux
    id:                 bazlinuxidididididididididididid
    type:               kernel
    default-channel:    20
  - name:               brand-gadget
    id:                 brandgadgetdidididididididididid
    type:               gadget
  - name:               other-base
    id:                 otherbasedididididididididididid
    type:               base
    presence:           required
    modes:              [run]
  - name:               nm
    id:                 nmididididididididididididididid
    default-channel:    1.0
    modes:              [ephemeral, run]
  - name:               myapp
    id:                 myappdididididididididididididid
    type:               app
    default-channel:    2.0
  - name:               myappopt
    id:                 myappoptidididididididididididid
    type:               app
    presence:           optional
`, timeutil.Human(s.ts)))
}

func (s *modelInfoSuite) TestPrintModelAssertion(c *C) {
	var buffer bytes.Buffer
	w := tabwriter.NewWriter(&buffer, 0, 5, 4, ' ', 0)
	model := s.getModel(c, modelExample)

	options := clientutil.PrintModelAssertionOptions{
		TermWidth: 80,
		Verbose:   false,
		AbsTime:   false,
		Assertion: true,
	}
	err := clientutil.PrintModelAssertion(w, model, nil, s.formatter, options)
	c.Assert(err, IsNil)
	c.Check(buffer.String(), Equals, fmt.Sprintf(`type: model
authority-id: brand-id1
series: 16
brand-id: brand-id1
model: baz-3000
display-name: Baz 3000
architecture: amd64
gadget: brand-gadget
base: core18
kernel: baz-linux
store: brand-store
serial-authority:
  - generic
system-user-authority: *
required-snaps:
  - foo
  - bar
timestamp: %s
body-length: 0
sign-key-sha3-384: Jv8_JiHiIzJVcO9M55pPdqSDWUvuhfDIBJUS-3VW7F_idjix7Ffn5qMxB21ZQuij

`, s.ts.Format(time.RFC3339)))
}

func (s *modelInfoSuite) TestPrintSerialYAML(c *C) {
	var buffer bytes.Buffer
	w := tabwriter.NewWriter(&buffer, 0, 5, 4, ' ', 0)
	serial := s.getSerial(c, serialExample)

	options := clientutil.PrintModelAssertionOptions{
		TermWidth: 80,
		Verbose:   false,
		AbsTime:   false,
		Assertion: false,
	}
	err := clientutil.PrintSerialAssertionYAML(w, serial, s.formatter, options)
	c.Assert(err, IsNil)
	c.Check(buffer.String(), Equals, `brand-id:    brand-id1
model:       baz-3000
serial:      2700
`)
}

func (s *modelInfoSuite) TestPrintSerialAssertion(c *C) {
	var buffer bytes.Buffer
	w := tabwriter.NewWriter(&buffer, 0, 5, 4, ' ', 0)
	serial := s.getSerial(c, serialExample)

	options := clientutil.PrintModelAssertionOptions{
		TermWidth: 80,
		Verbose:   false,
		AbsTime:   false,
		Assertion: true,
	}
	err := clientutil.PrintSerialAssertionYAML(w, serial, s.formatter, options)
	c.Assert(err, IsNil)
	c.Check(buffer.String(), Equals, fmt.Sprintf(`type: serial
authority-id: brand-id1
brand-id: brand-id1
model: baz-3000
serial: 2700
device-key:
%sdevice-key-sha3-384: %s
timestamp: %s
body-length: 2
sign-key-sha3-384: Jv8_JiHiIzJVcO9M55pPdqSDWUvuhfDIBJUS-3VW7F_idjix7Ffn5qMxB21ZQuij

HW

`, s.getDeviceKey("    ", options.TermWidth), s.deviceKey.PublicKey().ID(), s.ts.Format(time.RFC3339)))
}

func (s *modelInfoSuite) TestPrintSerialVerboseYAML(c *C) {
	var buffer bytes.Buffer
	w := tabwriter.NewWriter(&buffer, 0, 5, 4, ' ', 0)
	serial := s.getSerial(c, serialExample)

	options := clientutil.PrintModelAssertionOptions{
		TermWidth: 80,
		Verbose:   true,
		AbsTime:   false,
		Assertion: false,
	}
	err := clientutil.PrintSerialAssertionYAML(w, serial, s.formatter, options)
	c.Assert(err, IsNil)
	c.Check(buffer.String(), Equals, fmt.Sprintf(`brand-id:     brand-id1
model:        baz-3000
serial:       2700
timestamp:    %s
device-key-sha3-384: |
  %s
device-key: |
%s`, timeutil.Human(s.ts), s.deviceKey.PublicKey().ID(), s.getDeviceKey("  ", options.TermWidth)))
}

func (s *modelInfoSuite) TestPrintModelJSON(c *C) {
	var buffer bytes.Buffer
	w := tabwriter.NewWriter(&buffer, 0, 5, 4, ' ', 0)
	model := s.getModel(c, modelExample)

	// For JSON verbose is always implictly true
	options := clientutil.PrintModelAssertionOptions{
		TermWidth: 80,
		Verbose:   true,
		AbsTime:   false,
		Assertion: false,
	}
	err := clientutil.PrintModelAssertionJSON(w, model, nil, options)
	c.Assert(err, IsNil)
	c.Check(buffer.String(), Equals, fmt.Sprintf(`{
  "architecture": "amd64",
  "base": "core18",
  "brand-id": "brand-id1",
  "display-name": "Baz 3000",
  "gadget": "brand-gadget",
  "kernel": "baz-linux",
  "model": "baz-3000",
  "required-snaps": [
    "foo",
    "bar"
  ],
  "serial": null,
  "store": "brand-store",
  "system-user-authority": "*",
  "timestamp": "%s"
}`, s.ts.Format(time.RFC3339)))
}

func (s *modelInfoSuite) TestPrintModelWithSerialJSON(c *C) {
	var buffer bytes.Buffer
	w := tabwriter.NewWriter(&buffer, 0, 5, 4, ' ', 0)
	model := s.getModel(c, modelExample)
	serial := s.getSerial(c, serialExample)

	// For JSON verbose is always implictly true
	options := clientutil.PrintModelAssertionOptions{
		TermWidth: 80,
		Verbose:   true,
		AbsTime:   false,
		Assertion: false,
	}
	err := clientutil.PrintModelAssertionJSON(w, model, &serial, options)
	c.Assert(err, IsNil)
	c.Check(buffer.String(), Equals, fmt.Sprintf(`{
  "architecture": "amd64",
  "base": "core18",
  "brand-id": "brand-id1",
  "display-name": "Baz 3000",
  "gadget": "brand-gadget",
  "kernel": "baz-linux",
  "model": "baz-3000",
  "required-snaps": [
    "foo",
    "bar"
  ],
  "serial": "2700",
  "store": "brand-store",
  "system-user-authority": "*",
  "timestamp": "%s"
}`, s.ts.Format(time.RFC3339)))
}

func (s *modelInfoSuite) TestPrintModelJSONAssertion(c *C) {
	var buffer bytes.Buffer
	w := tabwriter.NewWriter(&buffer, 0, 5, 4, ' ', 0)
	model := s.getModel(c, modelExample)

	// For JSON verbose is always implictly true
	options := clientutil.PrintModelAssertionOptions{
		TermWidth: 80,
		Verbose:   true,
		AbsTime:   false,
		Assertion: true,
	}
	err := clientutil.PrintModelAssertionJSON(w, model, nil, options)
	c.Assert(err, IsNil)
	c.Check(buffer.String(), Equals, fmt.Sprintf(`{
  "headers": {
    "architecture": "amd64",
    "authority-id": "brand-id1",
    "base": "core18",
    "body-length": "0",
    "brand-id": "brand-id1",
    "display-name": "Baz 3000",
    "gadget": "brand-gadget",
    "kernel": "baz-linux",
    "model": "baz-3000",
    "required-snaps": [
      "foo",
      "bar"
    ],
    "serial-authority": [
      "generic"
    ],
    "series": "16",
    "sign-key-sha3-384": "Jv8_JiHiIzJVcO9M55pPdqSDWUvuhfDIBJUS-3VW7F_idjix7Ffn5qMxB21ZQuij",
    "store": "brand-store",
    "system-user-authority": "*",
    "timestamp": "%s",
    "type": "model"
  }
}`, s.ts.Format(time.RFC3339)))
}