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
|
// -*- Mode: Go; indent-tabs-mode: t -*-
/*
* Copyright (C) 2016 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 builtin_test
import (
"fmt"
. "gopkg.in/check.v1"
"github.com/snapcore/snapd/dirs"
"github.com/snapcore/snapd/interfaces"
"github.com/snapcore/snapd/interfaces/apparmor"
"github.com/snapcore/snapd/interfaces/builtin"
"github.com/snapcore/snapd/interfaces/udev"
"github.com/snapcore/snapd/snap"
"github.com/snapcore/snapd/snap/snaptest"
"github.com/snapcore/snapd/testutil"
)
type I2cInterfaceSuite struct {
testutil.BaseTest
iface interfaces.Interface
// OS Snap
testSlot1Info *snap.SlotInfo
testSlotCleanedInfo *snap.SlotInfo
// Gadget Snap
testUDev1 *interfaces.ConnectedSlot
testUDev1Info *snap.SlotInfo
testUDev2 *interfaces.ConnectedSlot
testUDev2Info *snap.SlotInfo
testUDev3 *interfaces.ConnectedSlot
testUDev3Info *snap.SlotInfo
testSysfsName1 *interfaces.ConnectedSlot
testSysfsName1Info *snap.SlotInfo
testUDevBadValue1 *interfaces.ConnectedSlot
testUDevBadValue1Info *snap.SlotInfo
testUDevBadValue2 *interfaces.ConnectedSlot
testUDevBadValue2Info *snap.SlotInfo
testUDevBadValue3 *interfaces.ConnectedSlot
testUDevBadValue3Info *snap.SlotInfo
testUDevBadValue4 *interfaces.ConnectedSlot
testUDevBadValue4Info *snap.SlotInfo
testUDevBadValue5 *interfaces.ConnectedSlot
testUDevBadValue5Info *snap.SlotInfo
testUDevBadValue6 *interfaces.ConnectedSlot
testUDevBadValue6Info *snap.SlotInfo
testUDevBadValue7 *interfaces.ConnectedSlot
testUDevBadValue7Info *snap.SlotInfo
testUDevBadInterface1Info *snap.SlotInfo
testSysfsNameBadValue1 *interfaces.ConnectedSlot
testSysfsNameBadValue1Info *snap.SlotInfo
testSysfsNameAndPath *interfaces.ConnectedSlot
testSysfsNameAndPathInfo *snap.SlotInfo
testSysfsNameEmpty *interfaces.ConnectedSlot
testSysfsNameEmptyInfo *snap.SlotInfo
// Consuming Snap
testPlugPort1 *interfaces.ConnectedPlug
testPlugPort1Info *snap.PlugInfo
}
var _ = Suite(&I2cInterfaceSuite{
iface: builtin.MustInterface("i2c"),
})
func (s *I2cInterfaceSuite) SetUpTest(c *C) {
// Mock for OS Snap
osSnapInfo := snaptest.MockInfo(c, `
name: ubuntu-core
version: 0
type: os
slots:
test-port-1:
interface: i2c
path: /dev/i2c-0
test-port-unclean:
interface: i2c
path: /dev/i2c-1/./
`, nil)
s.testSlot1Info = osSnapInfo.Slots["test-port-1"]
s.testSlotCleanedInfo = osSnapInfo.Slots["test-port-unclean"]
// Mock for Gadget Snap
gadgetSnapInfo := snaptest.MockInfo(c, `
name: some-device
version: 0
type: gadget
slots:
test-udev-1:
interface: i2c
path: /dev/i2c-1
test-udev-2:
interface: i2c
path: /dev/i2c-2
test-udev-3:
interface: i2c
path: /dev/i2c-0
test-sysfs-name-1:
interface: i2c
sysfs-name: 1-0050
test-udev-bad-value-1:
interface: i2c
path: /dev/i2c
test-udev-bad-value-2:
interface: i2c
path: /dev/i2c-a
test-udev-bad-value-3:
interface: i2c
path: /dev/i2c-2a
test-udev-bad-value-4:
interface: i2c
path: /dev/foo-0
test-udev-bad-value-5:
interface: i2c
path: /dev/i2c-foo
test-udev-bad-value-6:
interface: i2c
path: ""
test-udev-bad-value-7:
interface: i2c
test-udev-bad-interface-1:
interface: other-interface
test-sysfs-name-bad-value-1:
interface: i2c
sysfs-name: /slash/not/allowed
test-sysfs-name-and-path:
interface: i2c
path: /dev/i2c-0
sysfs-name: 1-0050
test-sysfs-name-empty:
interface: i2c
sysfs-name: ""
`, nil)
appSet, err := interfaces.NewSnapAppSet(gadgetSnapInfo, nil)
c.Assert(err, IsNil)
s.testUDev1Info = gadgetSnapInfo.Slots["test-udev-1"]
s.testUDev1 = interfaces.NewConnectedSlot(s.testUDev1Info, appSet, nil, nil)
s.testUDev2Info = gadgetSnapInfo.Slots["test-udev-2"]
s.testUDev2 = interfaces.NewConnectedSlot(s.testUDev2Info, appSet, nil, nil)
s.testUDev3Info = gadgetSnapInfo.Slots["test-udev-3"]
s.testUDev3 = interfaces.NewConnectedSlot(s.testUDev3Info, appSet, nil, nil)
s.testSysfsName1Info = gadgetSnapInfo.Slots["test-sysfs-name-1"]
s.testSysfsName1 = interfaces.NewConnectedSlot(s.testSysfsName1Info, appSet, nil, nil)
s.testUDevBadValue1Info = gadgetSnapInfo.Slots["test-udev-bad-value-1"]
s.testUDevBadValue1 = interfaces.NewConnectedSlot(s.testUDevBadValue1Info, appSet, nil, nil)
s.testUDevBadValue2Info = gadgetSnapInfo.Slots["test-udev-bad-value-2"]
s.testUDevBadValue2 = interfaces.NewConnectedSlot(s.testUDevBadValue2Info, appSet, nil, nil)
s.testUDevBadValue3Info = gadgetSnapInfo.Slots["test-udev-bad-value-3"]
s.testUDevBadValue3 = interfaces.NewConnectedSlot(s.testUDevBadValue3Info, appSet, nil, nil)
s.testUDevBadValue4Info = gadgetSnapInfo.Slots["test-udev-bad-value-4"]
s.testUDevBadValue4 = interfaces.NewConnectedSlot(s.testUDevBadValue4Info, appSet, nil, nil)
s.testUDevBadValue5Info = gadgetSnapInfo.Slots["test-udev-bad-value-5"]
s.testUDevBadValue5 = interfaces.NewConnectedSlot(s.testUDevBadValue5Info, appSet, nil, nil)
s.testUDevBadValue6Info = gadgetSnapInfo.Slots["test-udev-bad-value-6"]
s.testUDevBadValue6 = interfaces.NewConnectedSlot(s.testUDevBadValue6Info, appSet, nil, nil)
s.testUDevBadValue7Info = gadgetSnapInfo.Slots["test-udev-bad-value-7"]
s.testUDevBadValue7 = interfaces.NewConnectedSlot(s.testUDevBadValue7Info, appSet, nil, nil)
s.testUDevBadInterface1Info = gadgetSnapInfo.Slots["test-udev-bad-interface-1"]
s.testSysfsNameBadValue1Info = gadgetSnapInfo.Slots["test-sysfs-name-bad-value-1"]
s.testSysfsNameBadValue1 = interfaces.NewConnectedSlot(s.testSysfsNameBadValue1Info, appSet, nil, nil)
s.testSysfsNameAndPathInfo = gadgetSnapInfo.Slots["test-sysfs-name-and-path"]
s.testSysfsNameAndPath = interfaces.NewConnectedSlot(s.testSysfsNameAndPathInfo, appSet, nil, nil)
s.testSysfsNameEmptyInfo = gadgetSnapInfo.Slots["test-sysfs-name-empty"]
s.testSysfsNameEmpty = interfaces.NewConnectedSlot(s.testSysfsNameEmptyInfo, appSet, nil, nil)
// Snap Consumers
consumingSnapInfo := snaptest.MockInfo(c, `
name: client-snap
version: 0
plugs:
plug-for-port-1:
interface: i2c
apps:
app-accessing-1-port:
command: foo
plugs: [i2c]
`, nil)
appSet, err = interfaces.NewSnapAppSet(consumingSnapInfo, nil)
c.Assert(err, IsNil)
s.testPlugPort1Info = consumingSnapInfo.Plugs["plug-for-port-1"]
s.testPlugPort1 = interfaces.NewConnectedPlug(s.testPlugPort1Info, appSet, nil, nil)
}
func (s *I2cInterfaceSuite) TestName(c *C) {
c.Assert(s.iface.Name(), Equals, "i2c")
}
func (s *I2cInterfaceSuite) TestSanitizeCoreSnapSlot(c *C) {
c.Assert(interfaces.BeforePrepareSlot(s.iface, s.testSlot1Info), IsNil)
// Verify historically filepath.Clean()d paths are still valid
c.Assert(interfaces.BeforePrepareSlot(s.iface, s.testSlotCleanedInfo), IsNil)
}
func (s *I2cInterfaceSuite) TestSanitizeGadgetSnapSlot(c *C) {
c.Assert(interfaces.BeforePrepareSlot(s.iface, s.testUDev1Info), IsNil)
c.Assert(interfaces.BeforePrepareSlot(s.iface, s.testUDev2Info), IsNil)
c.Assert(interfaces.BeforePrepareSlot(s.iface, s.testUDev3Info), IsNil)
c.Assert(interfaces.BeforePrepareSlot(s.iface, s.testSysfsName1Info), IsNil)
}
func (s *I2cInterfaceSuite) TestSanitizeBadGadgetSnapSlot(c *C) {
c.Assert(interfaces.BeforePrepareSlot(s.iface, s.testUDevBadValue1Info), ErrorMatches, "i2c path attribute must be a valid device node")
c.Assert(interfaces.BeforePrepareSlot(s.iface, s.testUDevBadValue2Info), ErrorMatches, "i2c path attribute must be a valid device node")
c.Assert(interfaces.BeforePrepareSlot(s.iface, s.testUDevBadValue3Info), ErrorMatches, "i2c path attribute must be a valid device node")
c.Assert(interfaces.BeforePrepareSlot(s.iface, s.testUDevBadValue4Info), ErrorMatches, "i2c path attribute must be a valid device node")
c.Assert(interfaces.BeforePrepareSlot(s.iface, s.testUDevBadValue5Info), ErrorMatches, "i2c path attribute must be a valid device node")
c.Assert(interfaces.BeforePrepareSlot(s.iface, s.testUDevBadValue6Info), ErrorMatches, "i2c slot must have a path or sysfs-name attribute")
c.Assert(interfaces.BeforePrepareSlot(s.iface, s.testUDevBadValue7Info), ErrorMatches, "i2c slot must have a path or sysfs-name attribute")
c.Assert(interfaces.BeforePrepareSlot(s.iface, s.testSysfsNameBadValue1Info), ErrorMatches, "i2c sysfs-name attribute must be a valid sysfs-name")
c.Assert(interfaces.BeforePrepareSlot(s.iface, s.testSysfsNameAndPathInfo), ErrorMatches, "i2c slot can only use path or sysfs-name")
c.Assert(interfaces.BeforePrepareSlot(s.iface, s.testSysfsNameEmptyInfo), ErrorMatches, "i2c sysfs-name attribute must be a valid sysfs-name")
}
func (s *I2cInterfaceSuite) TestUDevSpec(c *C) {
spec := udev.NewSpecification(s.testPlugPort1.AppSet())
c.Assert(spec.AddConnectedPlug(s.iface, s.testPlugPort1, s.testUDev1), IsNil)
c.Assert(spec.Snippets(), HasLen, 2)
c.Assert(spec.Snippets(), testutil.Contains, `# i2c
KERNEL=="i2c-1", TAG+="snap_client-snap_app-accessing-1-port"`)
c.Assert(spec.Snippets(), testutil.Contains, fmt.Sprintf(`TAG=="snap_client-snap_app-accessing-1-port", SUBSYSTEM!="module", SUBSYSTEM!="subsystem", RUN+="%v/snap-device-helper $env{ACTION} snap_client-snap_app-accessing-1-port $devpath $major:$minor"`, dirs.DistroLibExecDir))
}
func (s *I2cInterfaceSuite) TestUDevSpecSysfsName(c *C) {
spec := udev.NewSpecification(s.testPlugPort1.AppSet())
c.Assert(spec.AddConnectedPlug(s.iface, s.testPlugPort1, s.testSysfsName1), IsNil)
c.Assert(spec.Snippets(), HasLen, 0)
}
func (s *I2cInterfaceSuite) TestAppArmorSpecPath(c *C) {
spec := apparmor.NewSpecification(s.testPlugPort1.AppSet())
c.Assert(spec.AddConnectedPlug(s.iface, s.testPlugPort1, s.testUDev1), IsNil)
c.Assert(spec.SecurityTags(), DeepEquals, []string{"snap.client-snap.app-accessing-1-port"})
c.Assert(spec.SnippetForTag("snap.client-snap.app-accessing-1-port"), testutil.Contains, `/dev/i2c-1 rw,`)
c.Assert(spec.SnippetForTag("snap.client-snap.app-accessing-1-port"), testutil.Contains, `/sys/devices/platform/{*,**.i2c}/i2c-1/** rw, # Add any condensed parametric rules`)
}
func (s *I2cInterfaceSuite) TestAppArmorSpecPathMany(c *C) {
spec := apparmor.NewSpecification(s.testPlugPort1.AppSet())
c.Assert(spec.AddConnectedPlug(s.iface, s.testPlugPort1, s.testUDev1), IsNil)
c.Assert(spec.AddConnectedPlug(s.iface, s.testPlugPort1, s.testUDev2), IsNil)
// NOTE: the snap name is misleading.
c.Assert(spec.SecurityTags(), DeepEquals, []string{"snap.client-snap.app-accessing-1-port"})
c.Assert(spec.SnippetForTag("snap.client-snap.app-accessing-1-port"), testutil.Contains, `/dev/i2c-1 rw,`)
c.Assert(spec.SnippetForTag("snap.client-snap.app-accessing-1-port"), testutil.Contains, `/dev/i2c-2 rw,`)
c.Assert(spec.SnippetForTag("snap.client-snap.app-accessing-1-port"), testutil.Contains, `/sys/devices/platform/{*,**.i2c}/i2c-{1,2}/** rw, # Add any condensed parametric rules`)
}
func (s *I2cInterfaceSuite) TestAppArmorSpecSysfsName(c *C) {
spec := apparmor.NewSpecification(s.testPlugPort1.AppSet())
c.Assert(spec.AddConnectedPlug(s.iface, s.testPlugPort1, s.testSysfsName1), IsNil)
c.Assert(spec.SecurityTags(), DeepEquals, []string{"snap.client-snap.app-accessing-1-port"})
c.Assert(spec.SnippetForTag("snap.client-snap.app-accessing-1-port"), Equals, `
# Description: Can access I2C sysfs name
/sys/bus/i2c/devices/1-0050/** rw,
`)
}
func (s *I2cInterfaceSuite) TestAutoConnect(c *C) {
c.Check(s.iface.AutoConnect(nil, nil), Equals, true)
}
func (s *I2cInterfaceSuite) TestInterfaces(c *C) {
c.Check(builtin.Interfaces(), testutil.DeepContains, s.iface)
}
|
