forked from juju/charm
/
dir_test.go
292 lines (245 loc) · 8.12 KB
/
dir_test.go
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
287
288
289
290
291
292
// Copyright 2011, 2012, 2013 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.
package charm_test
import (
"archive/zip"
"bytes"
"fmt"
"io/ioutil"
"os"
"path/filepath"
"strings"
"syscall"
"github.com/juju/charm"
charmtesting "github.com/juju/charm/testing"
"github.com/juju/testing"
gc "launchpad.net/gocheck"
)
type DirSuite struct {
testing.IsolationSuite
}
var _ = gc.Suite(&DirSuite{})
func (s *DirSuite) TestReadDir(c *gc.C) {
path := charmtesting.Charms.DirPath("dummy")
dir, err := charm.ReadDir(path)
c.Assert(err, gc.IsNil)
checkDummy(c, dir, path)
}
func (s *DirSuite) TestReadDirWithoutConfig(c *gc.C) {
path := charmtesting.Charms.DirPath("varnish")
dir, err := charm.ReadDir(path)
c.Assert(err, gc.IsNil)
// A lacking config.yaml file still causes a proper
// Config value to be returned.
c.Assert(dir.Config().Options, gc.HasLen, 0)
}
func (s *DirSuite) TestReadDirWithoutActions(c *gc.C) {
path := charmtesting.Charms.DirPath("wordpress")
dir, err := charm.ReadDir(path)
c.Assert(err, gc.IsNil)
// A lacking actions.yaml file still causes a proper
// Actions value to be returned.
c.Assert(dir.Actions().ActionSpecs, gc.HasLen, 0)
}
func (s *DirSuite) TestBundleTo(c *gc.C) {
baseDir := c.MkDir()
charmDir := charmtesting.Charms.ClonedDirPath(baseDir, "dummy")
s.assertBundleTo(c, baseDir, charmDir)
}
func (s *DirSuite) TestBundleToWithSymLinkedRootDir(c *gc.C) {
dir := c.MkDir()
baseDir := filepath.Join(dir, "precise")
err := os.MkdirAll(baseDir, 0755)
c.Assert(err, gc.IsNil)
charmtesting.Charms.ClonedDirPath(dir, "dummy")
err = os.Symlink(filepath.Join("..", "dummy"), filepath.Join(baseDir, "dummy"))
c.Assert(err, gc.IsNil)
charmDir := filepath.Join(baseDir, "dummy")
s.assertBundleTo(c, baseDir, charmDir)
}
func (s *DirSuite) assertBundleTo(c *gc.C, baseDir, charmDir string) {
var haveSymlinks = true
if err := os.Symlink("../target", filepath.Join(charmDir, "hooks/symlink")); err != nil {
haveSymlinks = false
}
dir, err := charm.ReadDir(charmDir)
c.Assert(err, gc.IsNil)
path := filepath.Join(baseDir, "bundle.charm")
file, err := os.Create(path)
c.Assert(err, gc.IsNil)
err = dir.BundleTo(file)
file.Close()
c.Assert(err, gc.IsNil)
zipr, err := zip.OpenReader(path)
c.Assert(err, gc.IsNil)
defer zipr.Close()
var metaf, instf, emptyf, revf, symf *zip.File
for _, f := range zipr.File {
c.Logf("Bundled file: %s", f.Name)
switch f.Name {
case "revision":
revf = f
case "metadata.yaml":
metaf = f
case "hooks/install":
instf = f
case "hooks/symlink":
symf = f
case "empty/":
emptyf = f
case "build/ignored":
c.Errorf("bundle includes build/*: %s", f.Name)
case ".ignored", ".dir/ignored":
c.Errorf("bundle includes .* entries: %s", f.Name)
}
}
c.Assert(revf, gc.NotNil)
reader, err := revf.Open()
c.Assert(err, gc.IsNil)
data, err := ioutil.ReadAll(reader)
reader.Close()
c.Assert(err, gc.IsNil)
c.Assert(string(data), gc.Equals, "1")
c.Assert(metaf, gc.NotNil)
reader, err = metaf.Open()
c.Assert(err, gc.IsNil)
meta, err := charm.ReadMeta(reader)
reader.Close()
c.Assert(err, gc.IsNil)
c.Assert(meta.Name, gc.Equals, "dummy")
c.Assert(instf, gc.NotNil)
// Despite it being 0751, we pack and unpack it as 0755.
c.Assert(instf.Mode()&0777, gc.Equals, os.FileMode(0755))
if haveSymlinks {
c.Assert(symf, gc.NotNil)
c.Assert(symf.Mode()&0777, gc.Equals, os.FileMode(0777))
reader, err = symf.Open()
c.Assert(err, gc.IsNil)
data, err = ioutil.ReadAll(reader)
reader.Close()
c.Assert(err, gc.IsNil)
c.Assert(string(data), gc.Equals, "../target")
} else {
c.Assert(symf, gc.IsNil)
}
c.Assert(emptyf, gc.NotNil)
c.Assert(emptyf.Mode()&os.ModeType, gc.Equals, os.ModeDir)
// Despite it being 0750, we pack and unpack it as 0755.
c.Assert(emptyf.Mode()&0777, gc.Equals, os.FileMode(0755))
}
// Bug #864164: Must complain if charm hooks aren't executable
func (s *DirSuite) TestBundleToWithNonExecutableHooks(c *gc.C) {
hooks := []string{"install", "start", "config-changed", "upgrade-charm", "stop"}
for _, relName := range []string{"foo", "bar", "self"} {
for _, kind := range []string{"joined", "changed", "departed", "broken"} {
hooks = append(hooks, relName+"-relation-"+kind)
}
}
dir := charmtesting.Charms.Dir("all-hooks")
path := filepath.Join(c.MkDir(), "bundle.charm")
file, err := os.Create(path)
c.Assert(err, gc.IsNil)
err = dir.BundleTo(file)
file.Close()
c.Assert(err, gc.IsNil)
tlog := c.GetTestLog()
for _, hook := range hooks {
fullpath := filepath.Join(dir.Path, "hooks", hook)
exp := fmt.Sprintf(`^(.|\n)*WARNING juju.charm making "%s" executable in charm(.|\n)*$`, fullpath)
c.Assert(tlog, gc.Matches, exp, gc.Commentf("hook %q was not made executable", fullpath))
}
// Expand it and check the hooks' permissions
// (But do not use ExpandTo(), just use the raw zip)
f, err := os.Open(path)
c.Assert(err, gc.IsNil)
defer f.Close()
fi, err := f.Stat()
c.Assert(err, gc.IsNil)
size := fi.Size()
zipr, err := zip.NewReader(f, size)
c.Assert(err, gc.IsNil)
allhooks := dir.Meta().Hooks()
for _, zfile := range zipr.File {
cleanName := filepath.Clean(zfile.Name)
if strings.HasPrefix(cleanName, "hooks") {
hookName := filepath.Base(cleanName)
if _, ok := allhooks[hookName]; ok {
perms := zfile.Mode()
c.Assert(perms&0100 != 0, gc.Equals, true, gc.Commentf("hook %q is not executable", hookName))
}
}
}
}
func (s *DirSuite) TestBundleToWithBadType(c *gc.C) {
charmDir := charmtesting.Charms.ClonedDirPath(c.MkDir(), "dummy")
badFile := filepath.Join(charmDir, "hooks", "badfile")
// Symlink targeting a path outside of the charm.
err := os.Symlink("../../target", badFile)
c.Assert(err, gc.IsNil)
dir, err := charm.ReadDir(charmDir)
c.Assert(err, gc.IsNil)
err = dir.BundleTo(&bytes.Buffer{})
c.Assert(err, gc.ErrorMatches, `symlink "hooks/badfile" links out of charm: "../../target"`)
// Symlink targeting an absolute path.
os.Remove(badFile)
err = os.Symlink("/target", badFile)
c.Assert(err, gc.IsNil)
dir, err = charm.ReadDir(charmDir)
c.Assert(err, gc.IsNil)
err = dir.BundleTo(&bytes.Buffer{})
c.Assert(err, gc.ErrorMatches, `symlink "hooks/badfile" is absolute: "/target"`)
// Can't bundle special files either.
os.Remove(badFile)
err = syscall.Mkfifo(badFile, 0644)
c.Assert(err, gc.IsNil)
dir, err = charm.ReadDir(charmDir)
c.Assert(err, gc.IsNil)
err = dir.BundleTo(&bytes.Buffer{})
c.Assert(err, gc.ErrorMatches, `file is a named pipe: "hooks/badfile"`)
}
func (s *DirSuite) TestDirRevisionFile(c *gc.C) {
charmDir := charmtesting.Charms.ClonedDirPath(c.MkDir(), "dummy")
revPath := filepath.Join(charmDir, "revision")
// Missing revision file
err := os.Remove(revPath)
c.Assert(err, gc.IsNil)
dir, err := charm.ReadDir(charmDir)
c.Assert(err, gc.IsNil)
c.Assert(dir.Revision(), gc.Equals, 0)
// Missing revision file with old revision in metadata
file, err := os.OpenFile(filepath.Join(charmDir, "metadata.yaml"), os.O_WRONLY|os.O_APPEND, 0)
c.Assert(err, gc.IsNil)
_, err = file.Write([]byte("\nrevision: 1234\n"))
c.Assert(err, gc.IsNil)
dir, err = charm.ReadDir(charmDir)
c.Assert(err, gc.IsNil)
c.Assert(dir.Revision(), gc.Equals, 1234)
// Revision file with bad content
err = ioutil.WriteFile(revPath, []byte("garbage"), 0666)
c.Assert(err, gc.IsNil)
dir, err = charm.ReadDir(charmDir)
c.Assert(err, gc.ErrorMatches, "invalid revision file")
c.Assert(dir, gc.IsNil)
}
func (s *DirSuite) TestDirSetRevision(c *gc.C) {
dir := charmtesting.Charms.ClonedDir(c.MkDir(), "dummy")
c.Assert(dir.Revision(), gc.Equals, 1)
dir.SetRevision(42)
c.Assert(dir.Revision(), gc.Equals, 42)
var b bytes.Buffer
err := dir.BundleTo(&b)
c.Assert(err, gc.IsNil)
bundle, err := charm.ReadBundleBytes(b.Bytes())
c.Assert(bundle.Revision(), gc.Equals, 42)
}
func (s *DirSuite) TestDirSetDiskRevision(c *gc.C) {
charmDir := charmtesting.Charms.ClonedDirPath(c.MkDir(), "dummy")
dir, err := charm.ReadDir(charmDir)
c.Assert(err, gc.IsNil)
c.Assert(dir.Revision(), gc.Equals, 1)
dir.SetDiskRevision(42)
c.Assert(dir.Revision(), gc.Equals, 42)
dir, err = charm.ReadDir(charmDir)
c.Assert(err, gc.IsNil)
c.Assert(dir.Revision(), gc.Equals, 42)
}