/
config_test.go
457 lines (412 loc) · 11.6 KB
/
config_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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
// Copyright 2011, 2012, 2013 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.
package environs_test
import (
"fmt"
"os"
"path/filepath"
"sort"
"strings"
"github.com/juju/loggo"
jc "github.com/juju/testing/checkers"
gc "launchpad.net/gocheck"
"github.com/juju/core/environs"
"github.com/juju/core/environs/config"
"github.com/juju/core/provider/dummy"
_ "github.com/juju/core/provider/manual"
"github.com/juju/core/testing"
)
type suite struct {
testing.FakeJujuHomeSuite
}
var _ = gc.Suite(&suite{})
func (s *suite) TearDownTest(c *gc.C) {
dummy.Reset()
s.FakeJujuHomeSuite.TearDownTest(c)
}
var invalidConfigTests = []struct {
env string
err string
}{
{"'", "YAML error:.*"},
{`
default: unknown
environments:
only:
type: unknown
`, `default environment .* does not exist`,
},
}
func (*suite) TestInvalidConfig(c *gc.C) {
for i, t := range invalidConfigTests {
c.Logf("running test %v", i)
_, err := environs.ReadEnvironsBytes([]byte(t.env))
c.Check(err, gc.ErrorMatches, t.err)
}
}
var invalidEnvTests = []struct {
env string
name string
err string
}{
{`
environments:
only:
foo: bar
`, "", `environment "only" has no type`,
}, {`
environments:
only:
foo: bar
`, "only", `environment "only" has no type`,
}, {`
environments:
only:
foo: bar
type: crazy
`, "only", `environment "only" has an unknown provider type "crazy"`,
},
}
func (*suite) TestInvalidEnv(c *gc.C) {
for i, t := range invalidEnvTests {
c.Logf("running test %v", i)
es, err := environs.ReadEnvironsBytes([]byte(t.env))
c.Check(err, gc.IsNil)
cfg, err := es.Config(t.name)
c.Check(err, gc.ErrorMatches, t.err)
c.Check(cfg, gc.IsNil)
}
}
func (*suite) TestNoWarningForDeprecatedButUnusedEnv(c *gc.C) {
// This tests that a config that has a deprecated field doesn't
// generate a Warning if we don't actually ask for that environment.
// However, we can only really trigger that when we have a deprecated
// field. If support for the field is removed entirely, another
// mechanism will need to be used
content := `
environments:
valid:
type: dummy
state-server: false
deprecated:
type: dummy
state-server: false
tools-url: aknowndeprecatedfield
lxc-use-clone: true
`
tw := &loggo.TestWriter{}
// we only capture Warning or above
c.Assert(loggo.RegisterWriter("invalid-env-tester", tw, loggo.WARNING), gc.IsNil)
defer loggo.RemoveWriter("invalid-env-tester")
envs, err := environs.ReadEnvironsBytes([]byte(content))
c.Check(err, gc.IsNil)
names := envs.Names()
sort.Strings(names)
c.Check(names, gc.DeepEquals, []string{"deprecated", "valid"})
// There should be no warning in the log
c.Check(tw.Log, gc.HasLen, 0)
// Now we actually grab the 'valid' entry
_, err = envs.Config("valid")
c.Check(err, gc.IsNil)
// And still we have no warnings
c.Check(tw.Log, gc.HasLen, 0)
// Only once we grab the deprecated one do we see any warnings
_, err = envs.Config("deprecated")
c.Check(err, gc.IsNil)
c.Check(tw.Log, gc.HasLen, 2)
}
func (*suite) TestNoHomeBeforeConfig(c *gc.C) {
// Test that we don't actually need HOME set until we call envs.Config()
os.Setenv("HOME", "")
content := `
environments:
valid:
type: dummy
amazon:
type: ec2
`
_, err := environs.ReadEnvironsBytes([]byte(content))
c.Check(err, gc.IsNil)
}
func (*suite) TestNoEnv(c *gc.C) {
envPath := testing.HomePath(".juju", "environments.yaml")
err := os.Remove(envPath)
c.Assert(err, gc.IsNil)
es, err := environs.ReadEnvirons("")
c.Assert(es, gc.IsNil)
c.Assert(err, jc.Satisfies, environs.IsNoEnv)
}
var configTests = []struct {
env string
check func(c *gc.C, envs *environs.Environs)
}{
{`
environments:
only:
type: dummy
state-server: false
`, func(c *gc.C, envs *environs.Environs) {
cfg, err := envs.Config("")
c.Assert(err, gc.IsNil)
c.Assert(cfg.Name(), gc.Equals, "only")
}}, {`
default:
invalid
environments:
valid:
type: dummy
state-server: false
invalid:
type: crazy
`, func(c *gc.C, envs *environs.Environs) {
cfg, err := envs.Config("")
c.Assert(err, gc.ErrorMatches, `environment "invalid" has an unknown provider type "crazy"`)
c.Assert(cfg, gc.IsNil)
cfg, err = envs.Config("valid")
c.Assert(err, gc.IsNil)
c.Assert(cfg.Name(), gc.Equals, "valid")
}}, {`
environments:
one:
type: dummy
state-server: false
two:
type: dummy
state-server: false
`, func(c *gc.C, envs *environs.Environs) {
cfg, err := envs.Config("")
c.Assert(err, gc.ErrorMatches, `no default environment found`)
c.Assert(cfg, gc.IsNil)
}},
}
func (*suite) TestConfig(c *gc.C) {
for i, t := range configTests {
c.Logf("running test %v", i)
envs, err := environs.ReadEnvironsBytes([]byte(t.env))
c.Assert(err, gc.IsNil)
t.check(c, envs)
}
}
func (*suite) TestDefaultConfigFile(c *gc.C) {
env := `
environments:
only:
type: dummy
state-server: false
authorized-keys: i-am-a-key
`
outfile, err := environs.WriteEnvirons("", env)
c.Assert(err, gc.IsNil)
path := testing.HomePath(".juju", "environments.yaml")
c.Assert(path, gc.Equals, outfile)
envs, err := environs.ReadEnvirons("")
c.Assert(err, gc.IsNil)
cfg, err := envs.Config("")
c.Assert(err, gc.IsNil)
c.Assert(cfg.Name(), gc.Equals, "only")
}
func (s *suite) TestConfigPerm(c *gc.C) {
testing.MakeSampleJujuHome(c)
path := testing.HomePath(".juju")
info, err := os.Lstat(path)
c.Assert(err, gc.IsNil)
oldPerm := info.Mode().Perm()
env := `
environments:
only:
type: dummy
state-server: false
authorized-keys: i-am-a-key
`
outfile, err := environs.WriteEnvirons("", env)
c.Assert(err, gc.IsNil)
info, err = os.Lstat(outfile)
c.Assert(err, gc.IsNil)
c.Assert(info.Mode().Perm(), gc.Equals, os.FileMode(0600))
info, err = os.Lstat(filepath.Dir(outfile))
c.Assert(err, gc.IsNil)
c.Assert(info.Mode().Perm(), gc.Equals, oldPerm)
}
func (*suite) TestNamedConfigFile(c *gc.C) {
env := `
environments:
only:
type: dummy
state-server: false
authorized-keys: i-am-a-key
`
path := filepath.Join(c.MkDir(), "a-file")
outfile, err := environs.WriteEnvirons(path, env)
c.Assert(err, gc.IsNil)
c.Assert(path, gc.Equals, outfile)
envs, err := environs.ReadEnvirons(path)
c.Assert(err, gc.IsNil)
cfg, err := envs.Config("")
c.Assert(err, gc.IsNil)
c.Assert(cfg.Name(), gc.Equals, "only")
}
func inMap(attrs testing.Attrs, attr string) bool {
_, ok := attrs[attr]
return ok
}
func (*suite) TestBootstrapConfig(c *gc.C) {
attrs := dummySampleConfig().Merge(testing.Attrs{
"agent-version": "1.2.3",
})
c.Assert(inMap(attrs, "secret"), jc.IsTrue)
c.Assert(inMap(attrs, "ca-private-key"), jc.IsTrue)
c.Assert(inMap(attrs, "admin-secret"), jc.IsTrue)
cfg, err := config.New(config.NoDefaults, attrs)
c.Assert(err, gc.IsNil)
c.Assert(err, gc.IsNil)
cfg1, err := environs.BootstrapConfig(cfg)
c.Assert(err, gc.IsNil)
expect := cfg.AllAttrs()
expect["admin-secret"] = ""
expect["ca-private-key"] = ""
c.Assert(cfg1.AllAttrs(), gc.DeepEquals, expect)
}
type dummyProvider struct {
environs.EnvironProvider
}
func (s *suite) TestRegisterProvider(c *gc.C) {
s.PatchValue(environs.Providers, make(map[string]environs.EnvironProvider))
s.PatchValue(environs.ProviderAliases, make(map[string]string))
type step struct {
name string
aliases []string
err string
}
type test []step
tests := []test{
[]step{{
name: "providerName",
}},
[]step{{
name: "providerName",
aliases: []string{"providerName"},
err: "juju: duplicate provider alias \"providerName\"",
}},
[]step{{
name: "providerName",
aliases: []string{"providerAlias", "providerAlias"},
err: "juju: duplicate provider alias \"providerAlias\"",
}},
[]step{{
name: "providerName",
aliases: []string{"providerAlias1", "providerAlias2"},
}},
[]step{{
name: "providerName",
}, {
name: "providerName",
err: "juju: duplicate provider name \"providerName\"",
}},
[]step{{
name: "providerName1",
}, {
name: "providerName2",
aliases: []string{"providerName"},
}},
[]step{{
name: "providerName1",
}, {
name: "providerName2",
aliases: []string{"providerName1"},
err: "juju: duplicate provider alias \"providerName1\"",
}},
}
registerProvider := func(name string, aliases []string) (err error) {
defer func() { err, _ = recover().(error) }()
registered := &dummyProvider{}
environs.RegisterProvider(name, registered, aliases...)
p, err := environs.Provider(name)
c.Assert(err, gc.IsNil)
c.Assert(p, gc.Equals, registered)
for _, alias := range aliases {
p, err := environs.Provider(alias)
c.Assert(err, gc.IsNil)
c.Assert(p, gc.Equals, registered)
c.Assert(p, gc.Equals, registered)
}
return nil
}
for i, test := range tests {
c.Logf("test %d: %v", i, test)
for k := range *environs.Providers {
delete(*environs.Providers, k)
}
for k := range *environs.ProviderAliases {
delete(*environs.ProviderAliases, k)
}
for _, step := range test {
err := registerProvider(step.name, step.aliases)
if step.err == "" {
c.Assert(err, gc.IsNil)
} else {
c.Assert(err, gc.ErrorMatches, step.err)
}
}
}
}
type ConfigDeprecationSuite struct {
suite
writer *loggo.TestWriter
}
var _ = gc.Suite(&ConfigDeprecationSuite{})
func (s *ConfigDeprecationSuite) setupLogger(c *gc.C) func() {
var err error
s.writer = &loggo.TestWriter{}
err = loggo.RegisterWriter("test", s.writer, loggo.WARNING)
c.Assert(err, gc.IsNil)
return func() {
_, _, err := loggo.RemoveWriter("test")
c.Assert(err, gc.IsNil)
}
}
func (s *ConfigDeprecationSuite) checkDeprecationWarning(c *gc.C, attrs testing.Attrs, expectedMsg string) {
content := `
environments:
deprecated:
type: dummy
state-server: false
`
restore := s.setupLogger(c)
defer restore()
envs, err := environs.ReadEnvironsBytes([]byte(content))
c.Check(err, gc.IsNil)
environs.UpdateEnvironAttrs(envs, "deprecated", attrs)
_, err = envs.Config("deprecated")
c.Check(err, gc.IsNil)
c.Assert(s.writer.Log, gc.HasLen, 1)
stripped := strings.Replace(s.writer.Log[0].Message, "\n", "", -1)
c.Assert(stripped, gc.Matches, expectedMsg)
}
func (s *ConfigDeprecationSuite) TestDeprecatedToolsURLWarning(c *gc.C) {
attrs := testing.Attrs{
"tools-url": "aknowndeprecatedfield",
}
expected := fmt.Sprintf(`.*Config attribute "tools-url" \(aknowndeprecatedfield\) is deprecated\.` +
`The location to find tools is now specified using the "tools-metadata-url" attribute.*`)
s.checkDeprecationWarning(c, attrs, expected)
}
func (s *ConfigDeprecationSuite) TestDeprecatedToolsURLWithNewURLWarning(c *gc.C) {
attrs := testing.Attrs{
"tools-url": "aknowndeprecatedfield",
"tools-metadata-url": "newvalue",
}
expected := fmt.Sprintf(
`.*Config attribute "tools-url" \(aknowndeprecatedfield\) is deprecated and will be ignored since` +
`the new tools URL attribute "tools-metadata-url".*`)
s.checkDeprecationWarning(c, attrs, expected)
}
func (s *ConfigDeprecationSuite) TestDeprecatedTypeNullWarning(c *gc.C) {
attrs := testing.Attrs{"type": "null"}
expected := `Provider type \"null\" has been renamed to \"manual\"\.Please update your environment configuration\.`
s.checkDeprecationWarning(c, attrs, expected)
}
func (s *ConfigDeprecationSuite) TestDeprecatedLxcUseCloneWarning(c *gc.C) {
attrs := testing.Attrs{"lxc-use-clone": true}
expected := `Config attribute \"lxc-use-clone\" has been renamed to \"lxc-clone\".Please update your environment configuration\.`
s.checkDeprecationWarning(c, attrs, expected)
}