File: device.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 (138 lines) | stat: -rw-r--r-- 4,031 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
136
137
138
// -*- Mode: Go; indent-tabs-mode: t -*-

/*
 * Copyright (C) 2014-2019 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 boottest

import (
	"strings"

	"github.com/snapcore/snapd/asserts"
	"github.com/snapcore/snapd/snap"
)

type mockDevice struct {
	bootSnap  string
	mode      string
	hasModes  bool
	isClassic bool

	model *asserts.Model
}

// MockDevice implements boot.Device. It wraps a string like
// <boot-snap-name>[@<mode>], no <boot-snap-name> means classic, empty
// <mode> defaults to "run" for UC16/18. If mode is set HasModeenv
// returns true for UC20 and an empty boot snap name panics.
// It returns <boot-snap-name> for Base, Kernel and gadget, for more
// control mock a DeviceContext.
func MockDevice(s string) snap.Device {
	bootsnap, mode, uc20 := snapAndMode(s)
	if uc20 && bootsnap == "" {
		panic("MockDevice with no snap name and @mode is unsupported")
	}
	return &mockDevice{
		bootSnap:  bootsnap,
		mode:      mode,
		hasModes:  uc20,
		isClassic: bootsnap == "",
	}
}

// mockDeviceWithModes implements boot.Device and returns true for
// HasModeenv.  Arguments are mode (empty means "run"), model, and a
// boolean specifying if this is a classic with modes or a UC device.
// If model is nil a default model is used (MakeMockUC20Model or
// MakeMockClassicWithModesModel is called).
func mockDeviceWithModes(mode string, model *asserts.Model, isClassic bool) snap.Device {
	if mode == "" {
		mode = "run"
	}
	if model == nil {
		if isClassic {
			model = MakeMockClassicWithModesModel()
		} else {
			model = MakeMockUC20Model()
		}
	}
	return &mockDevice{
		bootSnap:  model.Kernel(),
		mode:      mode,
		hasModes:  true,
		isClassic: isClassic,
		model:     model,
	}
}

// MockUC20Device mocks a UC with modes device.
// Arguments are mode (empty means "run"), and model.
func MockUC20Device(mode string, model *asserts.Model) snap.Device {
	if model != nil && model.Classic() {
		panic("MockUC20Device called with classic model")
	}
	isClassic := false
	return mockDeviceWithModes(mode, model, isClassic)
}

// MockClassicWithModesDevice mocks a classic with modes device.
// Arguments are mode (empty means "run"), and model.
func MockClassicWithModesDevice(mode string, model *asserts.Model) snap.Device {
	if model != nil && !model.Classic() {
		panic("MockClassicWithModesDevice called with Ubuntu Core model")
	}
	isClassic := true
	return mockDeviceWithModes(mode, model, isClassic)
}

func snapAndMode(str string) (snap, mode string, uc20 bool) {
	parts := strings.SplitN(string(str), "@", 2)
	if len(parts) == 1 || parts[1] == "" {
		return parts[0], "run", false
	}
	return parts[0], parts[1], true
}

func (d *mockDevice) Kernel() string   { return d.bootSnap }
func (d *mockDevice) Classic() bool    { return d.isClassic }
func (d *mockDevice) RunMode() bool    { return d.mode == "run" }
func (d *mockDevice) HasModeenv() bool { return d.hasModes }
func (d *mockDevice) IsCoreBoot() bool {
	if d.model != nil {
		return d.model.Kernel() != ""
	}
	return d.hasModes || !d.isClassic
}
func (d *mockDevice) IsClassicBoot() bool { return !d.IsCoreBoot() }
func (d *mockDevice) Base() string {
	if d.model != nil {
		return d.model.Base()
	}
	return d.bootSnap
}
func (d *mockDevice) Gadget() string {
	if d.model != nil {
		return d.model.Gadget()
	}
	return d.bootSnap
}
func (d *mockDevice) Model() *asserts.Model {
	if d.model == nil {
		panic("Device.Model called but MockUC20Device not used")
	}
	return d.model
}