github.com/rigado/snapd@v2.42.5-go-mod+incompatible/interfaces/builtin/spi_test.go (about) 1 // -*- Mode: Go; indent-tabs-mode: t -*- 2 3 /* 4 * Copyright (C) 2017 Canonical Ltd 5 * 6 * This program is free software: you can redistribute it and/or modify 7 * it under the terms of the GNU General Public License version 3 as 8 * published by the Free Software Foundation. 9 * 10 * This program is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * GNU General Public License for more details. 14 * 15 * You should have received a copy of the GNU General Public License 16 * along with this program. If not, see <http://www.gnu.org/licenses/>. 17 * 18 */ 19 20 package builtin_test 21 22 import ( 23 . "gopkg.in/check.v1" 24 25 "github.com/snapcore/snapd/interfaces" 26 "github.com/snapcore/snapd/interfaces/apparmor" 27 "github.com/snapcore/snapd/interfaces/builtin" 28 "github.com/snapcore/snapd/interfaces/udev" 29 "github.com/snapcore/snapd/snap" 30 "github.com/snapcore/snapd/snap/snaptest" 31 "github.com/snapcore/snapd/testutil" 32 ) 33 34 type spiInterfaceSuite struct { 35 testutil.BaseTest 36 iface interfaces.Interface 37 38 slotOs1Info *snap.SlotInfo 39 slotOs1 *interfaces.ConnectedSlot 40 slotOs2Info *snap.SlotInfo 41 slotOs2 *interfaces.ConnectedSlot 42 slotOs3Info *snap.SlotInfo 43 slotOs3 *interfaces.ConnectedSlot 44 45 slotGadget1Info *snap.SlotInfo 46 slotGadget1 *interfaces.ConnectedSlot 47 slotGadget2Info *snap.SlotInfo 48 slotGadget2 *interfaces.ConnectedSlot 49 slotGadget3Info *snap.SlotInfo 50 slotGadget3 *interfaces.ConnectedSlot 51 slotGadgetBad1Info *snap.SlotInfo 52 slotGadgetBad1 *interfaces.ConnectedSlot 53 slotGadgetBad2Info *snap.SlotInfo 54 slotGadgetBad2 *interfaces.ConnectedSlot 55 slotGadgetBad3Info *snap.SlotInfo 56 slotGadgetBad3 *interfaces.ConnectedSlot 57 slotGadgetBad4Info *snap.SlotInfo 58 slotGadgetBad4 *interfaces.ConnectedSlot 59 slotGadgetBad5Info *snap.SlotInfo 60 slotGadgetBad5 *interfaces.ConnectedSlot 61 slotGadgetBad6Info *snap.SlotInfo 62 slotGadgetBad6 *interfaces.ConnectedSlot 63 64 plug1Info *snap.PlugInfo 65 plug1 *interfaces.ConnectedPlug 66 plug2Info *snap.PlugInfo 67 plug2 *interfaces.ConnectedPlug 68 plug3Info *snap.PlugInfo 69 plug3 *interfaces.ConnectedPlug 70 } 71 72 var _ = Suite(&spiInterfaceSuite{ 73 iface: builtin.MustInterface("spi"), 74 }) 75 76 func (s *spiInterfaceSuite) SetUpTest(c *C) { 77 info := snaptest.MockInfo(c, ` 78 name: core 79 version: 0 80 type: os 81 slots: 82 spi-1: 83 interface: spi 84 path: /dev/spidev0.0 85 spi-2: 86 interface: spi 87 path: /dev/spidev0.1 88 spi-3: 89 interface: spi 90 path: /dev/spidev33566.0 91 `, nil) 92 s.slotOs1Info = info.Slots["spi-1"] 93 s.slotOs1 = interfaces.NewConnectedSlot(s.slotOs1Info, nil, nil) 94 s.slotOs2Info = info.Slots["spi-2"] 95 s.slotOs2 = interfaces.NewConnectedSlot(s.slotOs2Info, nil, nil) 96 s.slotOs3Info = info.Slots["spi-3"] 97 s.slotOs3 = interfaces.NewConnectedSlot(s.slotOs3Info, nil, nil) 98 99 info = snaptest.MockInfo(c, ` 100 name: gadget 101 version: 0 102 type: gadget 103 slots: 104 spi-1: 105 interface: spi 106 path: /dev/spidev0.0 107 spi-2: 108 interface: spi 109 path: /dev/spidev0.1 110 spi-3: 111 interface: spi 112 path: /dev/spidev33566.0 113 bad-spi-1: 114 interface: spi 115 path: /dev/spev0.0 116 bad-spi-2: 117 interface: spi 118 path: /dev/sidv0.0 119 bad-spi-3: 120 interface: spi 121 path: /dev/slpiv0.3 122 bad-spi-4: 123 interface: spi 124 path: /dev/sdev-00 125 bad-spi-5: 126 interface: spi 127 path: /dev/spi-foo 128 bad-spi-6: 129 interface: spi 130 `, nil) 131 s.slotGadget1Info = info.Slots["spi-1"] 132 s.slotGadget1 = interfaces.NewConnectedSlot(s.slotGadget1Info, nil, nil) 133 s.slotGadget2Info = info.Slots["spi-2"] 134 s.slotGadget2 = interfaces.NewConnectedSlot(s.slotGadget2Info, nil, nil) 135 s.slotGadget3Info = info.Slots["spi-3"] 136 s.slotGadget3 = interfaces.NewConnectedSlot(s.slotGadget3Info, nil, nil) 137 s.slotGadgetBad1Info = info.Slots["bad-spi-1"] 138 s.slotGadgetBad1 = interfaces.NewConnectedSlot(s.slotGadgetBad1Info, nil, nil) 139 s.slotGadgetBad2Info = info.Slots["bad-spi-2"] 140 s.slotGadgetBad2 = interfaces.NewConnectedSlot(s.slotGadgetBad2Info, nil, nil) 141 s.slotGadgetBad3Info = info.Slots["bad-spi-3"] 142 s.slotGadgetBad3 = interfaces.NewConnectedSlot(s.slotGadgetBad3Info, nil, nil) 143 s.slotGadgetBad4Info = info.Slots["bad-spi-4"] 144 s.slotGadgetBad4 = interfaces.NewConnectedSlot(s.slotGadgetBad4Info, nil, nil) 145 s.slotGadgetBad5Info = info.Slots["bad-spi-5"] 146 s.slotGadgetBad5 = interfaces.NewConnectedSlot(s.slotGadgetBad5Info, nil, nil) 147 s.slotGadgetBad6Info = info.Slots["bad-spi-6"] 148 s.slotGadgetBad6 = interfaces.NewConnectedSlot(s.slotGadgetBad6Info, nil, nil) 149 150 info = snaptest.MockInfo(c, ` 151 name: consumer 152 version: 0 153 plugs: 154 spi-1: 155 interface: spi 156 path: /dev/spidev.0.0 157 spi-2: 158 interface: spi 159 path: /dev/spidev0.1 160 spi-3: 161 interface: spi 162 path: /dev/spidev33566.0 163 apps: 164 app: 165 command: foo 166 plugs: [spi-1] 167 `, nil) 168 s.plug1Info = info.Plugs["spi-1"] 169 s.plug1 = interfaces.NewConnectedPlug(s.plug1Info, nil, nil) 170 s.plug2Info = info.Plugs["spi-2"] 171 s.plug2 = interfaces.NewConnectedPlug(s.plug2Info, nil, nil) 172 s.plug3Info = info.Plugs["spi-3"] 173 s.plug3 = interfaces.NewConnectedPlug(s.plug3Info, nil, nil) 174 } 175 176 func (s *spiInterfaceSuite) TestName(c *C) { 177 c.Assert(s.iface.Name(), Equals, "spi") 178 } 179 180 func (s *spiInterfaceSuite) TestSanitizeSlot(c *C) { 181 c.Assert(interfaces.BeforePrepareSlot(s.iface, s.slotOs1Info), IsNil) 182 c.Assert(interfaces.BeforePrepareSlot(s.iface, s.slotOs2Info), IsNil) 183 c.Assert(interfaces.BeforePrepareSlot(s.iface, s.slotOs3Info), IsNil) 184 c.Assert(interfaces.BeforePrepareSlot(s.iface, s.slotGadget1Info), IsNil) 185 c.Assert(interfaces.BeforePrepareSlot(s.iface, s.slotGadget2Info), IsNil) 186 c.Assert(interfaces.BeforePrepareSlot(s.iface, s.slotGadget3Info), IsNil) 187 err := interfaces.BeforePrepareSlot(s.iface, s.slotGadgetBad1Info) 188 c.Assert(err, ErrorMatches, `"/dev/spev0.0" is not a valid SPI device`) 189 err = interfaces.BeforePrepareSlot(s.iface, s.slotGadgetBad2Info) 190 c.Assert(err, ErrorMatches, `"/dev/sidv0.0" is not a valid SPI device`) 191 err = interfaces.BeforePrepareSlot(s.iface, s.slotGadgetBad3Info) 192 c.Assert(err, ErrorMatches, `"/dev/slpiv0.3" is not a valid SPI device`) 193 err = interfaces.BeforePrepareSlot(s.iface, s.slotGadgetBad4Info) 194 c.Assert(err, ErrorMatches, `"/dev/sdev-00" is not a valid SPI device`) 195 err = interfaces.BeforePrepareSlot(s.iface, s.slotGadgetBad5Info) 196 c.Assert(err, ErrorMatches, `"/dev/spi-foo" is not a valid SPI device`) 197 err = interfaces.BeforePrepareSlot(s.iface, s.slotGadgetBad6Info) 198 c.Assert(err, ErrorMatches, `slot "gadget:bad-spi-6" must have a path attribute`) 199 } 200 201 func (s *spiInterfaceSuite) TestUDevSpec(c *C) { 202 spec := &udev.Specification{} 203 c.Assert(spec.AddConnectedPlug(s.iface, s.plug1, s.slotGadget1), IsNil) 204 c.Assert(spec.Snippets(), HasLen, 2) 205 c.Assert(spec.Snippets(), testutil.Contains, `# spi 206 KERNEL=="spidev0.0", TAG+="snap_consumer_app"`) 207 c.Assert(spec.Snippets(), testutil.Contains, `TAG=="snap_consumer_app", RUN+="/usr/lib/snapd/snap-device-helper $env{ACTION} snap_consumer_app $devpath $major:$minor"`) 208 } 209 210 func (s *spiInterfaceSuite) TestAppArmorSpec(c *C) { 211 spec := &apparmor.Specification{} 212 c.Assert(spec.AddConnectedPlug(s.iface, s.plug1, s.slotGadget1), IsNil) 213 c.Assert(spec.SecurityTags(), DeepEquals, []string{"snap.consumer.app"}) 214 c.Assert(spec.SnippetForTag("snap.consumer.app"), Equals, ""+ 215 "/dev/spidev0.0 rw,\n"+ 216 "/sys/devices/platform/**/**.spi/**/spidev0.0/** rw,") 217 } 218 219 func (s *spiInterfaceSuite) TestStaticInfo(c *C) { 220 si := interfaces.StaticInfoOf(s.iface) 221 c.Assert(si.ImplicitOnCore, Equals, false) 222 c.Assert(si.ImplicitOnClassic, Equals, false) 223 c.Assert(si.Summary, Equals, "allows access to specific spi controller") 224 c.Assert(si.BaseDeclarationSlots, testutil.Contains, "spi") 225 } 226 227 func (s *spiInterfaceSuite) TestAutoConnect(c *C) { 228 c.Check(s.iface.AutoConnect(nil, nil), Equals, true) 229 } 230 231 func (s *spiInterfaceSuite) TestInterfaces(c *C) { 232 c.Check(builtin.Interfaces(), testutil.DeepContains, s.iface) 233 }