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
|
#! /usr/bin/env ruby
require 'spec_helper'
require 'puppet/util/logging'
class LoggingTester
include Puppet::Util::Logging
end
describe Puppet::Util::Logging do
before do
@logger = LoggingTester.new
end
Puppet::Util::Log.eachlevel do |level|
it "should have a method for sending '#{level}' logs" do
@logger.should respond_to(level)
end
end
it "should have a method for sending a log with a specified log level" do
@logger.expects(:to_s).returns "I'm a string!"
Puppet::Util::Log.expects(:create).with { |args| args[:source] == "I'm a string!" and args[:level] == "loglevel" and args[:message] == "mymessage" }
@logger.send_log "loglevel", "mymessage"
end
describe "when sending a log" do
it "should use the Log's 'create' entrance method" do
Puppet::Util::Log.expects(:create)
@logger.notice "foo"
end
it "should send itself converted to a string as the log source" do
@logger.expects(:to_s).returns "I'm a string!"
Puppet::Util::Log.expects(:create).with { |args| args[:source] == "I'm a string!" }
@logger.notice "foo"
end
it "should queue logs sent without a specified destination" do
Puppet::Util::Log.close_all
Puppet::Util::Log.expects(:queuemessage)
@logger.notice "foo"
end
it "should use the path of any provided resource type" do
resource = Puppet::Type.type(:host).new :name => "foo"
resource.expects(:path).returns "/path/to/host".to_sym
Puppet::Util::Log.expects(:create).with { |args| args[:source] == "/path/to/host" }
resource.notice "foo"
end
it "should use the path of any provided resource parameter" do
resource = Puppet::Type.type(:host).new :name => "foo"
param = resource.parameter(:name)
param.expects(:path).returns "/path/to/param".to_sym
Puppet::Util::Log.expects(:create).with { |args| args[:source] == "/path/to/param" }
param.notice "foo"
end
it "should send the provided argument as the log message" do
Puppet::Util::Log.expects(:create).with { |args| args[:message] == "foo" }
@logger.notice "foo"
end
it "should join any provided arguments into a single string for the message" do
Puppet::Util::Log.expects(:create).with { |args| args[:message] == "foo bar baz" }
@logger.notice ["foo", "bar", "baz"]
end
[:file, :line, :tags].each do |attr|
it "should include #{attr} if available" do
@logger.singleton_class.send(:attr_accessor, attr)
@logger.send(attr.to_s + "=", "myval")
Puppet::Util::Log.expects(:create).with { |args| args[attr] == "myval" }
@logger.notice "foo"
end
end
end
describe "when sending a deprecation warning" do
it "does not log a message when deprecation warnings are disabled" do
Puppet.expects(:[]).with(:disable_warnings).returns %w[deprecations]
@logger.expects(:warning).never
@logger.deprecation_warning 'foo'
end
it "logs the message with warn" do
@logger.expects(:warning).with do |msg|
msg =~ /^foo\n/
end
@logger.deprecation_warning 'foo'
end
it "only logs each offending line once" do
@logger.expects(:warning).with do |msg|
msg =~ /^foo\n/
end .once
5.times { @logger.deprecation_warning 'foo' }
end
it "ensures that deprecations from same origin are logged if their keys differ" do
@logger.expects(:warning).with(regexp_matches(/deprecated foo/)).times(5)
5.times { |i| @logger.deprecation_warning('deprecated foo', :key => "foo#{i}") }
end
it "does not duplicate deprecations for a given key" do
@logger.expects(:warning).with(regexp_matches(/deprecated foo/)).once
5.times { @logger.deprecation_warning('deprecated foo', :key => 'foo-msg') }
end
it "only logs the first 100 messages" do
(1..100).each { |i|
@logger.expects(:warning).with do |msg|
msg =~ /^#{i}\n/
end .once
# since the deprecation warning will only log each offending line once, we have to do some tomfoolery
# here in order to make it think each of these calls is coming from a unique call stack; we're basically
# mocking the method that it would normally use to find the call stack.
@logger.expects(:get_deprecation_offender).returns(["deprecation log count test ##{i}"])
@logger.deprecation_warning i
}
@logger.expects(:warning).with(101).never
@logger.deprecation_warning 101
end
end
describe "when sending a puppet_deprecation_warning" do
it "requires file and line or key options" do
expect do
@logger.puppet_deprecation_warning("foo")
end.to raise_error(Puppet::DevError, /Need either :file and :line, or :key/)
expect do
@logger.puppet_deprecation_warning("foo", :file => 'bar')
end.to raise_error(Puppet::DevError, /Need either :file and :line, or :key/)
expect do
@logger.puppet_deprecation_warning("foo", :key => 'akey')
@logger.puppet_deprecation_warning("foo", :file => 'afile', :line => 1)
end.to_not raise_error
end
it "warns with file and line" do
@logger.expects(:warning).with(regexp_matches(/deprecated foo.*afile:5/m))
@logger.puppet_deprecation_warning("deprecated foo", :file => 'afile', :line => 5)
end
it "warns keyed from file and line" do
@logger.expects(:warning).with(regexp_matches(/deprecated foo.*afile:5/m)).once
5.times do
@logger.puppet_deprecation_warning("deprecated foo", :file => 'afile', :line => 5)
end
end
it "warns with separate key only once regardless of file and line" do
@logger.expects(:warning).with(regexp_matches(/deprecated foo.*afile:5/m)).once
@logger.puppet_deprecation_warning("deprecated foo", :key => 'some_key', :file => 'afile', :line => 5)
@logger.puppet_deprecation_warning("deprecated foo", :key => 'some_key', :file => 'bfile', :line => 3)
end
it "warns with key but no file and line" do
@logger.expects(:warning).with(regexp_matches(/deprecated foo.*unknown:unknown/m))
@logger.puppet_deprecation_warning("deprecated foo", :key => 'some_key')
end
end
describe "when formatting exceptions" do
it "should be able to format a chain of exceptions" do
exc3 = Puppet::Error.new("original")
exc3.set_backtrace(["1.rb:4:in `a'","2.rb:2:in `b'","3.rb:1"])
exc2 = Puppet::Error.new("second", exc3)
exc2.set_backtrace(["4.rb:8:in `c'","5.rb:1:in `d'","6.rb:3"])
exc1 = Puppet::Error.new("third", exc2)
exc1.set_backtrace(["7.rb:31:in `e'","8.rb:22:in `f'","9.rb:9"])
# whoa ugly
@logger.format_exception(exc1).should =~ /third
.*7\.rb:31:in `e'
.*8\.rb:22:in `f'
.*9\.rb:9
Wrapped exception:
second
.*4\.rb:8:in `c'
.*5\.rb:1:in `d'
.*6\.rb:3
Wrapped exception:
original
.*1\.rb:4:in `a'
.*2\.rb:2:in `b'
.*3\.rb:1/
end
end
end
|
