gitee.com/mysnapcore/mysnapd@v0.1.0/interfaces/builtin/system_packages_doc_test.go (about)

     1  // -*- Mode: Go; indent-tabs-mode: t -*-
     2  
     3  /*
     4   * Copyright (C) 2020 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  	"gitee.com/mysnapcore/mysnapd/dirs"
    26  	"gitee.com/mysnapcore/mysnapd/interfaces"
    27  	"gitee.com/mysnapcore/mysnapd/interfaces/apparmor"
    28  	"gitee.com/mysnapcore/mysnapd/interfaces/builtin"
    29  	"gitee.com/mysnapcore/mysnapd/interfaces/mount"
    30  	"gitee.com/mysnapcore/mysnapd/release"
    31  	"gitee.com/mysnapcore/mysnapd/snap"
    32  	"gitee.com/mysnapcore/mysnapd/testutil"
    33  )
    34  
    35  type systemPackagesDocSuite struct {
    36  	iface        interfaces.Interface
    37  	coreSlotInfo *snap.SlotInfo
    38  	coreSlot     *interfaces.ConnectedSlot
    39  	plugInfo     *snap.PlugInfo
    40  	plug         *interfaces.ConnectedPlug
    41  }
    42  
    43  var _ = Suite(&systemPackagesDocSuite{iface: builtin.MustInterface("system-packages-doc")})
    44  
    45  const systemPackagesDocConsumerYaml = `name: consumer
    46  version: 0
    47  apps:
    48   app:
    49    plugs: [system-packages-doc]
    50  `
    51  
    52  const systemPackagesDocCoreYaml = `name: core
    53  version: 0
    54  type: os
    55  slots:
    56    system-packages-doc:
    57  `
    58  
    59  func (s *systemPackagesDocSuite) SetUpTest(c *C) {
    60  	s.plug, s.plugInfo = MockConnectedPlug(c, systemPackagesDocConsumerYaml, nil, "system-packages-doc")
    61  	s.coreSlot, s.coreSlotInfo = MockConnectedSlot(c, systemPackagesDocCoreYaml, nil, "system-packages-doc")
    62  }
    63  
    64  func (s *systemPackagesDocSuite) TearDownTest(c *C) {
    65  	dirs.SetRootDir("/")
    66  }
    67  
    68  func (s *systemPackagesDocSuite) TestName(c *C) {
    69  	c.Assert(s.iface.Name(), Equals, "system-packages-doc")
    70  }
    71  
    72  func (s *systemPackagesDocSuite) TestSanitizeSlot(c *C) {
    73  	c.Assert(interfaces.BeforePrepareSlot(s.iface, s.coreSlotInfo), IsNil)
    74  }
    75  
    76  func (s *systemPackagesDocSuite) TestSanitizePlug(c *C) {
    77  	c.Assert(interfaces.BeforePreparePlug(s.iface, s.plugInfo), IsNil)
    78  }
    79  
    80  func (s *systemPackagesDocSuite) TestAppArmorSpec(c *C) {
    81  	restore := release.MockOnClassic(true)
    82  	defer restore()
    83  
    84  	spec := &apparmor.Specification{}
    85  	c.Assert(spec.AddConnectedPlug(s.iface, s.plug, s.coreSlot), IsNil)
    86  	c.Assert(spec.SecurityTags(), DeepEquals, []string{"snap.consumer.app"})
    87  	c.Assert(spec.SnippetForTag("snap.consumer.app"), testutil.Contains, "# Description: can access documentation of system packages.")
    88  	c.Assert(spec.SnippetForTag("snap.consumer.app"), testutil.Contains, "/usr/share/doc/{,**} r,")
    89  	c.Assert(spec.SnippetForTag("snap.consumer.app"), testutil.Contains, "/usr/share/cups/doc-root/{,**} r,")
    90  	c.Assert(spec.SnippetForTag("snap.consumer.app"), testutil.Contains, "/usr/share/gimp/2.0/help/{,**} r,")
    91  	c.Assert(spec.SnippetForTag("snap.consumer.app"), testutil.Contains, "/usr/share/libreoffice/help/{,**} r,")
    92  	c.Assert(spec.SnippetForTag("snap.consumer.app"), testutil.Contains, "/usr/share/xubuntu-docs/{,**} r,")
    93  
    94  	updateNS := spec.UpdateNS()
    95  	c.Check(updateNS, testutil.Contains, "  # Mount documentation of system packages\n")
    96  	c.Check(updateNS, testutil.Contains, "  mount options=(bind) /var/lib/snapd/hostfs/usr/share/doc/ -> /usr/share/doc/,\n")
    97  	c.Check(updateNS, testutil.Contains, "  remount options=(bind, ro) /usr/share/doc/,\n")
    98  	c.Check(updateNS, testutil.Contains, "  umount /usr/share/doc/,\n")
    99  
   100  	c.Check(updateNS, testutil.Contains, "  mount options=(bind) /var/lib/snapd/hostfs/usr/share/cups/doc-root/ -> /usr/share/cups/doc-root/,\n")
   101  	c.Check(updateNS, testutil.Contains, "  remount options=(bind, ro) /usr/share/cups/doc-root/,\n")
   102  	c.Check(updateNS, testutil.Contains, "  umount /usr/share/cups/doc-root/,\n")
   103  
   104  	c.Check(updateNS, testutil.Contains, "  mount options=(bind) /var/lib/snapd/hostfs/usr/share/gimp/2.0/help/ -> /usr/share/gimp/2.0/help/,\n")
   105  	c.Check(updateNS, testutil.Contains, "  remount options=(bind, ro) /usr/share/gimp/2.0/help/,\n")
   106  	c.Check(updateNS, testutil.Contains, "  umount /usr/share/gimp/2.0/help/,\n")
   107  
   108  	c.Check(updateNS, testutil.Contains, "  mount options=(bind) /var/lib/snapd/hostfs/usr/share/gtk-doc/ -> /usr/share/gtk-doc/,\n")
   109  	c.Check(updateNS, testutil.Contains, "  remount options=(bind, ro) /usr/share/gtk-doc/,\n")
   110  	c.Check(updateNS, testutil.Contains, "  umount /usr/share/gtk-doc/,\n")
   111  
   112  	c.Check(updateNS, testutil.Contains, "  mount options=(bind) /var/lib/snapd/hostfs/usr/share/libreoffice/help/ -> /usr/share/libreoffice/help/,\n")
   113  	c.Check(updateNS, testutil.Contains, "  remount options=(bind, ro) /usr/share/libreoffice/help/,\n")
   114  	c.Check(updateNS, testutil.Contains, "  umount /usr/share/libreoffice/help/,\n")
   115  
   116  	c.Check(updateNS, testutil.Contains, "  mount options=(bind) /var/lib/snapd/hostfs/usr/share/xubuntu-docs/ -> /usr/share/xubuntu-docs/,\n")
   117  	c.Check(updateNS, testutil.Contains, "  remount options=(bind, ro) /usr/share/xubuntu-docs/,\n")
   118  	c.Check(updateNS, testutil.Contains, "  umount /usr/share/xubuntu-docs/,\n")
   119  	// check mimic bits
   120  	c.Check(updateNS, testutil.Contains, "  # Writable mimic /usr/share/libreoffice\n")
   121  	c.Check(updateNS, testutil.Contains, "  mount fstype=tmpfs options=(rw) tmpfs -> \"/usr/share/\",\n")
   122  	c.Check(updateNS, testutil.Contains, "  \"/usr/share/\" r,\n")
   123  	c.Check(updateNS, testutil.Contains, "  \"/usr/share/*/\" rw,\n")
   124  	c.Check(updateNS, testutil.Contains, "  \"/usr/share/cups/*/\" rw,\n")
   125  	c.Check(updateNS, testutil.Contains, "  \"/usr/share/gimp/*/\" rw,\n")
   126  	c.Check(updateNS, testutil.Contains, "  \"/usr/share/gimp/2.0/*/\" rw,\n")
   127  	c.Check(updateNS, testutil.Contains, "  \"/usr/share/libreoffice/*/\" rw,\n")
   128  	c.Check(updateNS, testutil.Contains, "  \"/tmp/.snap/usr/share/\" rw,\n")
   129  	c.Check(updateNS, testutil.Contains, "  \"/tmp/.snap/usr/share/cups/\" rw,\n")
   130  	c.Check(updateNS, testutil.Contains, "  \"/tmp/.snap/usr/share/cups/*/\" rw,\n")
   131  	c.Check(updateNS, testutil.Contains, "  \"/tmp/.snap/usr/share/gimp/2.0/\" rw,\n")
   132  	c.Check(updateNS, testutil.Contains, "  \"/tmp/.snap/usr/share/gimp/2.0/*/\" rw,\n")
   133  	c.Check(updateNS, testutil.Contains, "  \"/tmp/.snap/usr/share/libreoffice/\" rw,\n")
   134  	c.Check(updateNS, testutil.Contains, "  \"/tmp/.snap/usr/share/libreoffice/*/\" rw,\n")
   135  	c.Check(updateNS, testutil.Contains, "  mount options=(bind, rw) \"/tmp/.snap/usr/share/*\" -> \"/usr/share/*\",\n")
   136  
   137  }
   138  
   139  func (s *systemPackagesDocSuite) TestMountSpec(c *C) {
   140  	restore := release.MockOnClassic(true)
   141  	defer restore()
   142  
   143  	spec := &mount.Specification{}
   144  	c.Assert(spec.AddConnectedPlug(s.iface, s.plug, s.coreSlot), IsNil)
   145  
   146  	entries := spec.MountEntries()
   147  	c.Assert(entries, HasLen, 6)
   148  	c.Check(entries[0].Name, Equals, "/var/lib/snapd/hostfs/usr/share/doc")
   149  	c.Check(entries[0].Dir, Equals, "/usr/share/doc")
   150  	c.Check(entries[0].Options, DeepEquals, []string{"bind", "ro"})
   151  	c.Check(entries[1].Name, Equals, "/var/lib/snapd/hostfs/usr/share/cups/doc-root")
   152  	c.Check(entries[1].Dir, Equals, "/usr/share/cups/doc-root")
   153  	c.Check(entries[1].Options, DeepEquals, []string{"bind", "ro"})
   154  	c.Check(entries[2].Name, Equals, "/var/lib/snapd/hostfs/usr/share/gimp/2.0/help")
   155  	c.Check(entries[2].Dir, Equals, "/usr/share/gimp/2.0/help")
   156  	c.Check(entries[2].Options, DeepEquals, []string{"bind", "ro"})
   157  	c.Check(entries[3].Name, Equals, "/var/lib/snapd/hostfs/usr/share/gtk-doc")
   158  	c.Check(entries[3].Dir, Equals, "/usr/share/gtk-doc")
   159  	c.Check(entries[3].Options, DeepEquals, []string{"bind", "ro"})
   160  	c.Check(entries[4].Name, Equals, "/var/lib/snapd/hostfs/usr/share/libreoffice/help")
   161  	c.Check(entries[4].Dir, Equals, "/usr/share/libreoffice/help")
   162  	c.Check(entries[4].Options, DeepEquals, []string{"bind", "ro"})
   163  	c.Check(entries[5].Name, Equals, "/var/lib/snapd/hostfs/usr/share/xubuntu-docs")
   164  	c.Check(entries[5].Dir, Equals, "/usr/share/xubuntu-docs")
   165  	c.Check(entries[5].Options, DeepEquals, []string{"bind", "ro"})
   166  
   167  	entries = spec.UserMountEntries()
   168  	c.Assert(entries, HasLen, 0)
   169  }
   170  
   171  func (s *systemPackagesDocSuite) TestStaticInfo(c *C) {
   172  	si := interfaces.StaticInfoOf(s.iface)
   173  	c.Assert(si.ImplicitOnCore, Equals, false)
   174  	c.Assert(si.ImplicitOnClassic, Equals, true)
   175  	c.Assert(si.Summary, Equals, `allows access to documentation of system packages`)
   176  	c.Assert(si.BaseDeclarationSlots, testutil.Contains, "system-packages-doc")
   177  	c.Assert(si.BaseDeclarationSlots, testutil.Contains, "deny-auto-connection: true")
   178  	c.Assert(si.AffectsPlugOnRefresh, Equals, true)
   179  }
   180  
   181  func (s *systemPackagesDocSuite) TestInterfaces(c *C) {
   182  	c.Check(builtin.Interfaces(), testutil.DeepContains, s.iface)
   183  }