File: spec_test.go

package info (click to toggle)
snapd 2.72-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 80,412 kB
  • sloc: sh: 16,506; ansic: 16,211; python: 11,213; makefile: 1,919; exp: 190; awk: 58; xml: 22
file content (151 lines) | stat: -rw-r--r-- 6,064 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
139
140
141
142
143
144
145
146
147
148
149
150
151
// -*- Mode: Go; indent-tabs-mode: t -*-

/*
 * Copyright (C) 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 configfiles_test

import (
	. "gopkg.in/check.v1"

	"github.com/snapcore/snapd/interfaces"
	"github.com/snapcore/snapd/interfaces/configfiles"
	"github.com/snapcore/snapd/interfaces/ifacetest"
	"github.com/snapcore/snapd/osutil"
	"github.com/snapcore/snapd/snap"
)

type specSuite struct {
	spec     *configfiles.Specification
	iface1   *ifacetest.TestInterface
	plugInfo *snap.PlugInfo
	plug     *interfaces.ConnectedPlug
	slotInfo *snap.SlotInfo
	slot     *interfaces.ConnectedSlot
}

var _ = Suite(&specSuite{
	iface1: &ifacetest.TestInterface{
		InterfaceName: "test",
		ConfigfilesConnectedPlugCallback: func(spec *configfiles.Specification,
			plug *interfaces.ConnectedPlug, slot *interfaces.ConnectedSlot) error {
			spec.AddPathContent("/etc/conf1.d/a.conf",
				&osutil.MemoryFileState{Content: []byte("aaaa"), Mode: 0655})
			return nil
		},
		ConfigfilesConnectedSlotCallback: func(spec *configfiles.Specification,
			plug *interfaces.ConnectedPlug, slot *interfaces.ConnectedSlot) error {
			spec.AddPathContent("/etc/conf2.d/b.conf",
				&osutil.MemoryFileState{Content: []byte("bbbb"), Mode: 0655})
			return nil
		},
		ConfigfilesPermanentPlugCallback: func(spec *configfiles.Specification,
			plug *snap.PlugInfo) error {
			spec.AddPathContent("/etc/conf3.d/c.conf",
				&osutil.MemoryFileState{Content: []byte("cccc"), Mode: 0655})
			return nil
		},
		ConfigfilesPermanentSlotCallback: func(spec *configfiles.Specification,
			slot *snap.SlotInfo) error {
			spec.AddPathContent("/etc/conf4.d/d.conf",
				&osutil.MemoryFileState{Content: []byte("dddd"), Mode: 0655})
			return nil
		},
	},
})

func (s *specSuite) SetUpTest(c *C) {
	s.spec = &configfiles.Specification{}
	const plugYaml = `name: snapd
version: 1
apps:
  app:
    plugs: [name]
`
	s.plug, s.plugInfo = ifacetest.MockConnectedPlug(c, plugYaml, nil, "name")

	const slotYaml = `name: snap
version: 1
slots:
  name:
    interface: test
`
	s.slot, s.slotInfo = ifacetest.MockConnectedSlot(c, slotYaml, nil, "name")
}

// The configfiles.Specification can be used through the interfaces.Specification interface
func (s *specSuite) TestSpecificationIface(c *C) {
	var r interfaces.Specification = s.spec
	c.Assert(r.AddConnectedPlug(s.iface1, s.plug, s.slot), IsNil)
	c.Assert(s.spec.PathContent(), DeepEquals, map[string]osutil.FileState{
		"/etc/conf1.d/a.conf": &osutil.MemoryFileState{Content: []byte("aaaa"), Mode: 0655},
	})
	c.Assert(r.AddConnectedSlot(s.iface1, s.plug, s.slot), IsNil)
	c.Assert(s.spec.PathContent(), DeepEquals, map[string]osutil.FileState{
		"/etc/conf1.d/a.conf": &osutil.MemoryFileState{Content: []byte("aaaa"), Mode: 0655},
		"/etc/conf2.d/b.conf": &osutil.MemoryFileState{Content: []byte("bbbb"), Mode: 0655},
	})
	c.Assert(r.AddPermanentPlug(s.iface1, s.plugInfo), IsNil)
	c.Assert(s.spec.PathContent(), DeepEquals, map[string]osutil.FileState{
		"/etc/conf1.d/a.conf": &osutil.MemoryFileState{Content: []byte("aaaa"), Mode: 0655},
		"/etc/conf2.d/b.conf": &osutil.MemoryFileState{Content: []byte("bbbb"), Mode: 0655},
		"/etc/conf3.d/c.conf": &osutil.MemoryFileState{Content: []byte("cccc"), Mode: 0655},
	})
	c.Assert(s.spec.Plugs(), DeepEquals, []string{"name"})
	c.Assert(r.AddPermanentSlot(s.iface1, s.slotInfo), IsNil)
	c.Assert(s.spec.PathContent(), DeepEquals, map[string]osutil.FileState{
		"/etc/conf1.d/a.conf": &osutil.MemoryFileState{Content: []byte("aaaa"), Mode: 0655},
		"/etc/conf2.d/b.conf": &osutil.MemoryFileState{Content: []byte("bbbb"), Mode: 0655},
		"/etc/conf3.d/c.conf": &osutil.MemoryFileState{Content: []byte("cccc"), Mode: 0655},
		"/etc/conf4.d/d.conf": &osutil.MemoryFileState{Content: []byte("dddd"), Mode: 0655},
	})
}

func (s *specSuite) TestPlugNotFromSystem(c *C) {
	const plugYaml = `name: notsystem
version: 1
apps:
  app:
    plugs: [name]
`
	s.plug, s.plugInfo = ifacetest.MockConnectedPlug(c, plugYaml, nil, "name")

	var r interfaces.Specification = s.spec
	c.Assert(r.AddConnectedPlug(s.iface1, s.plug, s.slot), ErrorMatches,
		"internal error: configfiles plugs can be defined only by the system snap")
	c.Assert(r.AddConnectedSlot(s.iface1, s.plug, s.slot), ErrorMatches,
		"internal error: configfiles plugs can be defined only by the system snap")
	c.Assert(r.AddPermanentPlug(s.iface1, s.plugInfo), ErrorMatches,
		"internal error: configfiles plugs can be defined only by the system snap")
}

func (s *specSuite) TestAddPathContentErrors(c *C) {
	c.Check(s.spec.AddPathContent("/../conf/snap.name.conf",
		&osutil.MemoryFileState{Content: []byte("aaaa"), Mode: 0655}), ErrorMatches,
		`configfiles internal error: unclean path: "/../conf/snap.name.conf"`)
	c.Check(s.spec.AddPathContent("/etc/conf/",
		&osutil.MemoryFileState{Content: []byte("aaaa"), Mode: 0655}), ErrorMatches,
		`configfiles internal error: unclean path: "/etc/conf/"`)
	c.Check(s.spec.AddPathContent("../etc/conf/snap.name.conf",
		&osutil.MemoryFileState{Content: []byte("aaaa"), Mode: 0655}), ErrorMatches,
		`configfiles internal error: relative paths not supported: "../etc/conf/snap.name.conf"`)
	c.Check(s.spec.AddPathContent("/etc/conf/snap.name.conf",
		&osutil.MemoryFileState{Content: []byte("aaaa"), Mode: 0655}), IsNil)
	c.Check(s.spec.AddPathContent("/etc/conf/snap.name.conf",
		&osutil.MemoryFileState{Content: []byte("aaaa"), Mode: 0655}), ErrorMatches,
		`configfiles internal error: already managed path: "/etc/conf/snap.name.conf"`)
}