github.com/hugh712/snapd@v0.0.0-20200910133618-1a99902bd583/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  	slotOsCleanedInfo *snap.SlotInfo
    45  	slotOsCleaned     *interfaces.ConnectedSlot
    46  
    47  	slotGadget1Info    *snap.SlotInfo
    48  	slotGadget1        *interfaces.ConnectedSlot
    49  	slotGadget2Info    *snap.SlotInfo
    50  	slotGadget2        *interfaces.ConnectedSlot
    51  	slotGadget3Info    *snap.SlotInfo
    52  	slotGadget3        *interfaces.ConnectedSlot
    53  	slotGadgetBad1Info *snap.SlotInfo
    54  	slotGadgetBad1     *interfaces.ConnectedSlot
    55  	slotGadgetBad2Info *snap.SlotInfo
    56  	slotGadgetBad2     *interfaces.ConnectedSlot
    57  	slotGadgetBad3Info *snap.SlotInfo
    58  	slotGadgetBad3     *interfaces.ConnectedSlot
    59  	slotGadgetBad4Info *snap.SlotInfo
    60  	slotGadgetBad4     *interfaces.ConnectedSlot
    61  	slotGadgetBad5Info *snap.SlotInfo
    62  	slotGadgetBad5     *interfaces.ConnectedSlot
    63  	slotGadgetBad6Info *snap.SlotInfo
    64  	slotGadgetBad6     *interfaces.ConnectedSlot
    65  
    66  	plug1Info *snap.PlugInfo
    67  	plug1     *interfaces.ConnectedPlug
    68  	plug2Info *snap.PlugInfo
    69  	plug2     *interfaces.ConnectedPlug
    70  	plug3Info *snap.PlugInfo
    71  	plug3     *interfaces.ConnectedPlug
    72  }
    73  
    74  var _ = Suite(&spiInterfaceSuite{
    75  	iface: builtin.MustInterface("spi"),
    76  })
    77  
    78  func (s *spiInterfaceSuite) SetUpTest(c *C) {
    79  	info := snaptest.MockInfo(c, `
    80  name: core
    81  version: 0
    82  type: os
    83  slots:
    84    spi-1:
    85      interface: spi
    86      path: /dev/spidev0.0
    87    spi-2:
    88      interface: spi
    89      path: /dev/spidev0.1
    90    spi-3:
    91      interface: spi
    92      path: /dev/spidev33566.0
    93    spi-unclean:
    94      interface: spi
    95      path: /dev/./spidev33567.0
    96  `, nil)
    97  	s.slotOs1Info = info.Slots["spi-1"]
    98  	s.slotOs1 = interfaces.NewConnectedSlot(s.slotOs1Info, nil, nil)
    99  	s.slotOs2Info = info.Slots["spi-2"]
   100  	s.slotOs2 = interfaces.NewConnectedSlot(s.slotOs2Info, nil, nil)
   101  	s.slotOs3Info = info.Slots["spi-3"]
   102  	s.slotOs3 = interfaces.NewConnectedSlot(s.slotOs3Info, nil, nil)
   103  	s.slotOsCleanedInfo = info.Slots["spi-unclean"]
   104  	s.slotOsCleaned = interfaces.NewConnectedSlot(s.slotOsCleanedInfo, nil, nil)
   105  
   106  	info = snaptest.MockInfo(c, `
   107  name: gadget
   108  version: 0
   109  type: gadget
   110  slots:
   111    spi-1:
   112      interface: spi
   113      path: /dev/spidev0.0
   114    spi-2:
   115      interface: spi
   116      path: /dev/spidev0.1
   117    spi-3:
   118      interface: spi
   119      path: /dev/spidev33566.0
   120    bad-spi-1:
   121      interface: spi
   122      path: /dev/spev0.0
   123    bad-spi-2:
   124      interface: spi
   125      path: /dev/sidv0.0
   126    bad-spi-3:
   127      interface: spi
   128      path: /dev/slpiv0.3
   129    bad-spi-4:
   130      interface: spi
   131      path: /dev/sdev-00
   132    bad-spi-5:
   133      interface: spi
   134      path: /dev/spi-foo
   135    bad-spi-6:
   136      interface: spi
   137  `, nil)
   138  	s.slotGadget1Info = info.Slots["spi-1"]
   139  	s.slotGadget1 = interfaces.NewConnectedSlot(s.slotGadget1Info, nil, nil)
   140  	s.slotGadget2Info = info.Slots["spi-2"]
   141  	s.slotGadget2 = interfaces.NewConnectedSlot(s.slotGadget2Info, nil, nil)
   142  	s.slotGadget3Info = info.Slots["spi-3"]
   143  	s.slotGadget3 = interfaces.NewConnectedSlot(s.slotGadget3Info, nil, nil)
   144  	s.slotGadgetBad1Info = info.Slots["bad-spi-1"]
   145  	s.slotGadgetBad1 = interfaces.NewConnectedSlot(s.slotGadgetBad1Info, nil, nil)
   146  	s.slotGadgetBad2Info = info.Slots["bad-spi-2"]
   147  	s.slotGadgetBad2 = interfaces.NewConnectedSlot(s.slotGadgetBad2Info, nil, nil)
   148  	s.slotGadgetBad3Info = info.Slots["bad-spi-3"]
   149  	s.slotGadgetBad3 = interfaces.NewConnectedSlot(s.slotGadgetBad3Info, nil, nil)
   150  	s.slotGadgetBad4Info = info.Slots["bad-spi-4"]
   151  	s.slotGadgetBad4 = interfaces.NewConnectedSlot(s.slotGadgetBad4Info, nil, nil)
   152  	s.slotGadgetBad5Info = info.Slots["bad-spi-5"]
   153  	s.slotGadgetBad5 = interfaces.NewConnectedSlot(s.slotGadgetBad5Info, nil, nil)
   154  	s.slotGadgetBad6Info = info.Slots["bad-spi-6"]
   155  	s.slotGadgetBad6 = interfaces.NewConnectedSlot(s.slotGadgetBad6Info, nil, nil)
   156  
   157  	info = snaptest.MockInfo(c, `
   158  name: consumer
   159  version: 0
   160  plugs:
   161    spi-1:
   162      interface: spi
   163      path: /dev/spidev.0.0
   164    spi-2:
   165      interface: spi
   166      path: /dev/spidev0.1
   167    spi-3:
   168      interface: spi
   169      path: /dev/spidev33566.0
   170  apps:
   171    app:
   172      command: foo
   173      plugs: [spi-1]
   174  `, nil)
   175  	s.plug1Info = info.Plugs["spi-1"]
   176  	s.plug1 = interfaces.NewConnectedPlug(s.plug1Info, nil, nil)
   177  	s.plug2Info = info.Plugs["spi-2"]
   178  	s.plug2 = interfaces.NewConnectedPlug(s.plug2Info, nil, nil)
   179  	s.plug3Info = info.Plugs["spi-3"]
   180  	s.plug3 = interfaces.NewConnectedPlug(s.plug3Info, nil, nil)
   181  }
   182  
   183  func (s *spiInterfaceSuite) TestName(c *C) {
   184  	c.Assert(s.iface.Name(), Equals, "spi")
   185  }
   186  
   187  func (s *spiInterfaceSuite) TestSanitizeSlot(c *C) {
   188  	c.Assert(interfaces.BeforePrepareSlot(s.iface, s.slotOs1Info), IsNil)
   189  	c.Assert(interfaces.BeforePrepareSlot(s.iface, s.slotOs2Info), IsNil)
   190  	c.Assert(interfaces.BeforePrepareSlot(s.iface, s.slotOs3Info), IsNil)
   191  	// Verify historically filepath.Clean()d paths are still valid
   192  	c.Assert(interfaces.BeforePrepareSlot(s.iface, s.slotOsCleanedInfo), IsNil)
   193  	c.Assert(interfaces.BeforePrepareSlot(s.iface, s.slotGadget1Info), IsNil)
   194  	c.Assert(interfaces.BeforePrepareSlot(s.iface, s.slotGadget2Info), IsNil)
   195  	c.Assert(interfaces.BeforePrepareSlot(s.iface, s.slotGadget3Info), IsNil)
   196  	err := interfaces.BeforePrepareSlot(s.iface, s.slotGadgetBad1Info)
   197  	c.Assert(err, ErrorMatches, `"/dev/spev0.0" is not a valid SPI device`)
   198  	err = interfaces.BeforePrepareSlot(s.iface, s.slotGadgetBad2Info)
   199  	c.Assert(err, ErrorMatches, `"/dev/sidv0.0" is not a valid SPI device`)
   200  	err = interfaces.BeforePrepareSlot(s.iface, s.slotGadgetBad3Info)
   201  	c.Assert(err, ErrorMatches, `"/dev/slpiv0.3" is not a valid SPI device`)
   202  	err = interfaces.BeforePrepareSlot(s.iface, s.slotGadgetBad4Info)
   203  	c.Assert(err, ErrorMatches, `"/dev/sdev-00" is not a valid SPI device`)
   204  	err = interfaces.BeforePrepareSlot(s.iface, s.slotGadgetBad5Info)
   205  	c.Assert(err, ErrorMatches, `"/dev/spi-foo" is not a valid SPI device`)
   206  	err = interfaces.BeforePrepareSlot(s.iface, s.slotGadgetBad6Info)
   207  	c.Assert(err, ErrorMatches, `slot "gadget:bad-spi-6" must have a path attribute`)
   208  }
   209  
   210  func (s *spiInterfaceSuite) TestUDevSpec(c *C) {
   211  	spec := &udev.Specification{}
   212  	c.Assert(spec.AddConnectedPlug(s.iface, s.plug1, s.slotGadget1), IsNil)
   213  	c.Assert(spec.Snippets(), HasLen, 2)
   214  	c.Assert(spec.Snippets(), testutil.Contains, `# spi
   215  KERNEL=="spidev0.0", TAG+="snap_consumer_app"`)
   216  	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"`)
   217  }
   218  
   219  func (s *spiInterfaceSuite) TestAppArmorSpec(c *C) {
   220  	spec := &apparmor.Specification{}
   221  	c.Assert(spec.AddConnectedPlug(s.iface, s.plug1, s.slotGadget1), IsNil)
   222  	c.Assert(spec.SecurityTags(), DeepEquals, []string{"snap.consumer.app"})
   223  	c.Assert(spec.SnippetForTag("snap.consumer.app"), Equals, ""+
   224  		"/dev/spidev0.0 rw,\n"+
   225  		"/sys/devices/platform/**/**.spi/**/spidev0.0/** rw,  # Add any condensed parametric rules")
   226  	c.Assert(spec.AddConnectedPlug(s.iface, s.plug1, s.slotGadget2), IsNil)
   227  	c.Assert(spec.SnippetForTag("snap.consumer.app"), Equals, ""+
   228  		"/dev/spidev0.0 rw,\n"+
   229  		"/dev/spidev0.1 rw,\n"+
   230  		"/sys/devices/platform/**/**.spi/**/spidev{0.0,0.1}/** rw,  # Add any condensed parametric rules")
   231  }
   232  
   233  func (s *spiInterfaceSuite) TestStaticInfo(c *C) {
   234  	si := interfaces.StaticInfoOf(s.iface)
   235  	c.Assert(si.ImplicitOnCore, Equals, false)
   236  	c.Assert(si.ImplicitOnClassic, Equals, false)
   237  	c.Assert(si.Summary, Equals, "allows access to specific spi controller")
   238  	c.Assert(si.BaseDeclarationSlots, testutil.Contains, "spi")
   239  }
   240  
   241  func (s *spiInterfaceSuite) TestAutoConnect(c *C) {
   242  	c.Check(s.iface.AutoConnect(nil, nil), Equals, true)
   243  }
   244  
   245  func (s *spiInterfaceSuite) TestInterfaces(c *C) {
   246  	c.Check(builtin.Interfaces(), testutil.DeepContains, s.iface)
   247  }