1
=== modified file 'environs/config/config.go'
2
--- environs/config/config.go	2013-11-04 02:01:19 +0000
3
+++ environs/config/config.go	2013-11-11 02:04:03 +0000
4
@@ -244,6 +244,28 @@
5
244
			}
244
			}
6
245
		}
245
		}
7
246
	}
246
	}
8
247
9
248
	// The tools url has changed so see if the old one is still in use.
10
249
	if oldToolsURL := cfg.m["tools-url"]; oldToolsURL != nil && oldToolsURL.(string) != "" {
11
250
		_, newToolsSpecified := cfg.ToolsURL()
12
251
		var msg string
13
252
		if newToolsSpecified {
14
253
			msg = fmt.Sprintf(
15
254
				"Config attribute %q (%v) is deprecated and will be ignored since\n"+
16
255
					"the new tools URL attribute %q has also been used.\n"+
17
256
					"The attribute % should be removed from your configuration.",
18
257
				"tools-url", oldToolsURL, "tools-metadata-url", "tools-url")
19
258
		} else {
20
259
			msg = fmt.Sprintf(
21
260
				"Config attribute %q (%v) is deprecated.\n"+
22
261
					"The location to find tools is now specified using the %q attribute.\n"+
23
262
					"Your configuration should be upddated to set %q as follows\n%v: %v.",
24
263
				"tools-url", oldToolsURL, "tools-metadata-url", "tools-metadata-url", "tools-metadata-url", oldToolsURL)
25
264
			cfg.m["tools-metadata-url"] = oldToolsURL
26
265
		}
27
266
		logger.Warningf(msg)
28
267
		delete(cfg.m, "tools-url")
29
268
	}
30
247
	return nil
269
	return nil
31
248
}
270
}
32
249
271
33
@@ -495,6 +517,9 @@
34
495
	"state-port":                schema.ForceInt(),
517
	"state-port":                schema.ForceInt(),
35
496
	"api-port":                  schema.ForceInt(),
518
	"api-port":                  schema.ForceInt(),
36
497
	"logging-config":            schema.String(),
519
	"logging-config":            schema.String(),
37
520
38
521
	// Deprecated fields, retain for backwards compatibility.
39
522
	"tools-url": schema.String(),
40
498
}
523
}
41
499
524
42
500
// alwaysOptional holds configuration defaults for attributes that may
525
// alwaysOptional holds configuration defaults for attributes that may
43
@@ -514,6 +539,9 @@
44
514
	"ca-private-key-path":  schema.Omit,
539
	"ca-private-key-path":  schema.Omit,
45
515
	"logging-config":       schema.Omit,
540
	"logging-config":       schema.Omit,
46
516
541
47
542
	// Deprecated fields, retain for backwards compatibility.
48
543
	"tools-url": schema.Omit,
49
544
50
517
	// For backward compatibility reasons, the following
545
	// For backward compatibility reasons, the following
51
518
	// attributes default to empty strings rather than being
546
	// attributes default to empty strings rather than being
52
519
	// omitted.
547
	// omitted.
53
520
548
54
=== modified file 'environs/config/config_test.go'
55
--- environs/config/config_test.go	2013-11-04 02:01:19 +0000
56
+++ environs/config/config_test.go	2013-11-11 02:04:03 +0000
57
@@ -5,6 +5,7 @@
58
5
5
59
6
import (
6
import (
60
7
	"fmt"
7
	"fmt"
61
8
	"strings"
62
8
	stdtesting "testing"
9
	stdtesting "testing"
63
9
	"time"
10
	"time"
64
10
11
65
@@ -79,6 +80,23 @@
66
79
			"tools-metadata-url": "tools-metadata-url",
80
			"tools-metadata-url": "tools-metadata-url",
67
80
		},
81
		},
68
81
	}, {
82
	}, {
69
83
		about:       "Deprecated tools metadata URL used",
70
84
		useDefaults: config.UseDefaults,
71
85
		attrs: testing.Attrs{
72
86
			"type":      "my-type",
73
87
			"name":      "my-name",
74
88
			"tools-url": "tools-metadata-url",
75
89
		},
76
90
	}, {
77
91
		about:       "Deprecated tools metadata URL ignored",
78
92
		useDefaults: config.UseDefaults,
79
93
		attrs: testing.Attrs{
80
94
			"type":               "my-type",
81
95
			"name":               "my-name",
82
96
			"tools-metadata-url": "tools-metadata-url",
83
97
			"tools-url":          "ignore-me",
84
98
		},
85
99
	}, {
86
82
		about:       "Explicit series",
100
		about:       "Explicit series",
87
83
		useDefaults: config.UseDefaults,
101
		useDefaults: config.UseDefaults,
88
84
		attrs: testing.Attrs{
102
		attrs: testing.Attrs{
89
@@ -745,13 +763,21 @@
90
745
	} else {
763
	} else {
91
746
		c.Assert(urlPresent, jc.IsFalse)
764
		c.Assert(urlPresent, jc.IsFalse)
92
747
	}
765
	}
96
748
	url, urlPresent = cfg.ToolsURL()
766
	toolsURL, urlPresent := cfg.ToolsURL()
97
749
	if v, _ := test.attrs["tools-metadata-url"].(string); v != "" {
767
	deprecatedToolsURLTestValue, deprecatedURLPresent := test.attrs["tools-url"]
98
750
		c.Assert(url, gc.Equals, v)
768
	toolsURLTestValue := test.attrs["tools-metadata-url"]
99
769
	if toolsURLTestValue == nil {
100
770
		toolsURLTestValue = deprecatedToolsURLTestValue
101
771
	}
102
772
	if toolsURLTestValue != nil && toolsURLTestValue != "" {
103
773
		c.Assert(toolsURL, gc.Equals, toolsURLTestValue)
104
751
		c.Assert(urlPresent, jc.IsTrue)
774
		c.Assert(urlPresent, jc.IsTrue)
105
752
	} else {
775
	} else {
106
753
		c.Assert(urlPresent, jc.IsFalse)
776
		c.Assert(urlPresent, jc.IsFalse)
107
777
		c.Assert(deprecatedURLPresent, jc.IsFalse)
108
754
	}
778
	}
109
779
	_, urlPresent = cfg.AllAttrs()["tools-url"]
110
780
	c.Assert(urlPresent, jc.IsFalse)
111
755
}
781
}
112
756
782
113
757
func (s *ConfigSuite) TestConfigAttrs(c *gc.C) {
783
func (s *ConfigSuite) TestConfigAttrs(c *gc.C) {
114
@@ -1101,3 +1127,61 @@
115
1101
MIIBOgIBAAJAZabKgKInuOxj5vDWLwHHQtK3/45KB+32D15w94Nt83BmuGxo90lw
1127
MIIBOgIBAAJAZabKgKInuOxj5vDWLwHHQtK3/45KB+32D15w94Nt83BmuGxo90lw
116
1102
-----END CERTIFICATE-----
1128
-----END CERTIFICATE-----
117
1103
`[1:]
1129
`[1:]
118
1130
119
1131
type ConfigDeprecationSuite struct {
120
1132
	ConfigSuite
121
1133
	writer *testWriter
122
1134
}
123
1135
124
1136
var _ = gc.Suite(&ConfigDeprecationSuite{})
125
1137
126
1138
func (s *ConfigDeprecationSuite) SetUpTest(c *gc.C) {
127
1139
	s.ConfigSuite.SetUpTest(c)
128
1140
}
129
1141
130
1142
func (s *ConfigDeprecationSuite) TearDownTest(c *gc.C) {
131
1143
	s.ConfigSuite.TearDownTest(c)
132
1144
}
133
1145
134
1146
func (s *ConfigDeprecationSuite) setupLogger(c *gc.C) {
135
1147
	var err error
136
1148
	s.writer = &testWriter{}
137
1149
	err = loggo.RegisterWriter("test", s.writer, loggo.WARNING)
138
1150
	c.Assert(err, gc.IsNil)
139
1151
}
140
1152
141
1153
func (s *ConfigDeprecationSuite) resetLogger(c *gc.C) {
142
1154
	_, _, err := loggo.RemoveWriter("test")
143
1155
	c.Assert(err, gc.IsNil)
144
1156
}
145
1157
146
1158
type testWriter struct {
147
1159
	messages []string
148
1160
}
149
1161
150
1162
func (t *testWriter) Write(level loggo.Level, module, filename string, line int, timestamp time.Time, message string) {
151
1163
	t.messages = append(t.messages, message)
152
1164
}
153
1165
154
1166
func (s *ConfigDeprecationSuite) setupEnv(c *gc.C, deprecatedKey, value string) {
155
1167
	attrs := testing.FakeConfig().Merge(testing.Attrs{
156
1168
		"name":        "testenv",
157
1169
		"type":        "openstack",
158
1170
		deprecatedKey: value,
159
1171
	})
160
1172
	_, err := config.New(config.NoDefaults, attrs)
161
1173
	c.Assert(err, gc.IsNil)
162
1174
}
163
1175
164
1176
func (s *ConfigDeprecationSuite) TestDeprecationWarnings(c *gc.C) {
165
1177
	for attr, value := range map[string]string{
166
1178
		"tools-url": "foo",
167
1179
	} {
168
1180
		s.setupLogger(c)
169
1181
		s.setupEnv(c, attr, value)
170
1182
		s.resetLogger(c)
171
1183
		stripped := strings.Replace(s.writer.messages[0], "\n", "", -1)
172
1184
		expected := fmt.Sprintf(`.*Config attribute "%s" \(%s\) is deprecated.*`, attr, value)
173
1185
		c.Assert(stripped, gc.Matches, expected)
174
1186
	}
175
1187
}
Reviewer	Review Type	Date Requested	Status
Juju Engineering		2013-11-11	Pending
Review via email: mp+194649@code.launchpad.net