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
|
require 'spec_helper'
require 'puppet_spec/files'
require 'puppet/indirector/indirector_testing/msgpack'
describe Puppet::Indirector::Msgpack, :if => Puppet.features.msgpack? do
include PuppetSpec::Files
subject { Puppet::IndirectorTesting::Msgpack.new }
let :model do Puppet::IndirectorTesting end
let :indirection do model.indirection end
context "#path" do
before :each do
Puppet[:server_datadir] = '/sample/datadir/master'
Puppet[:client_datadir] = '/sample/datadir/client'
end
it "uses the :server_datadir setting if this is the master" do
allow(Puppet.run_mode).to receive(:master?).and_return(true)
expected = File.join(Puppet[:server_datadir], 'indirector_testing', 'testing.msgpack')
expect(subject.path('testing')).to eq(expected)
end
it "uses the :client_datadir setting if this is not the master" do
allow(Puppet.run_mode).to receive(:master?).and_return(false)
expected = File.join(Puppet[:client_datadir], 'indirector_testing', 'testing.msgpack')
expect(subject.path('testing')).to eq(expected)
end
it "overrides the default extension with a supplied value" do
allow(Puppet.run_mode).to receive(:master?).and_return(true)
expected = File.join(Puppet[:server_datadir], 'indirector_testing', 'testing.not-msgpack')
expect(subject.path('testing', '.not-msgpack')).to eq(expected)
end
['../foo', '..\\foo', './../foo', '.\\..\\foo',
'/foo', '//foo', '\\foo', '\\\\goo',
"test\0/../bar", "test\0\\..\\bar",
"..\\/bar", "/tmp/bar", "/tmp\\bar", "tmp\\bar",
" / bar", " /../ bar", " \\..\\ bar",
"c:\\foo", "c:/foo", "\\\\?\\UNC\\bar", "\\\\foo\\bar",
"\\\\?\\c:\\foo", "//?/UNC/bar", "//foo/bar",
"//?/c:/foo",
].each do |input|
it "should resist directory traversal attacks (#{input.inspect})" do
expect { subject.path(input) }.to raise_error ArgumentError, 'invalid key'
end
end
end
context "handling requests" do
before :each do
allow(Puppet.run_mode).to receive(:master?).and_return(true)
Puppet[:server_datadir] = tmpdir('msgpackdir')
FileUtils.mkdir_p(File.join(Puppet[:server_datadir], 'indirector_testing'))
end
let :file do subject.path(request.key) end
def with_content(text)
FileUtils.mkdir_p(File.dirname(file))
File.open(file, 'w') {|f| f.write text }
yield if block_given?
end
it "data saves and then loads again correctly" do
subject.save(indirection.request(:save, 'example', model.new('banana')))
expect(subject.find(indirection.request(:find, 'example', nil)).value).to eq('banana')
end
context "#find" do
let :request do indirection.request(:find, 'example', nil) end
it "returns nil if the file doesn't exist" do
expect(subject.find(request)).to be_nil
end
it "can load a UTF-8 file from disk" do
rune_utf8 = "\u16A0\u16C7\u16BB" # ᚠᛇᚻ
with_content(model.new(rune_utf8).to_msgpack) do
instance = subject.find(request)
expect(instance).to be_an_instance_of model
expect(instance.value).to eq(rune_utf8)
end
end
it "raises a descriptive error when the file can't be read" do
with_content(model.new('foo').to_msgpack) do
# I don't like this, but there isn't a credible alternative that
# also works on Windows, so a stub it is. At least the expectation
# will fail if the implementation changes. Sorry to the next dev.
expect(Puppet::FileSystem).to receive(:read).with(file, {:encoding => 'utf-8'}).and_raise(Errno::EPERM)
expect { subject.find(request) }.
to raise_error Puppet::Error, /Could not read MessagePack/
end
end
it "raises a descriptive error when the file content is invalid" do
with_content("this is totally invalid MessagePack") do
expect { subject.find(request) }.
to raise_error Puppet::Error, /Could not parse MessagePack data/
end
end
it "should return an instance of the indirected object when valid" do
with_content(model.new(1).to_msgpack) do
instance = subject.find(request)
expect(instance).to be_an_instance_of model
expect(instance.value).to eq(1)
end
end
end
context "#save" do
let :instance do model.new(4) end
let :request do indirection.request(:find, 'example', instance) end
it "should save the instance of the request as MessagePack to disk" do
subject.save(request)
content = File.read(file)
expect(MessagePack.unpack(content)['value']).to eq(4)
end
it "should create the indirection directory if required" do
target = File.join(Puppet[:server_datadir], 'indirector_testing')
Dir.rmdir(target)
subject.save(request)
expect(File).to be_directory(target)
end
end
context "#destroy" do
let :request do indirection.request(:find, 'example', nil) end
it "removes an existing file" do
with_content('hello') do
subject.destroy(request)
end
expect(Puppet::FileSystem.exist?(file)).to be_falsey
end
it "silently succeeds when files don't exist" do
Puppet::FileSystem.unlink(file) rescue nil
expect(subject.destroy(request)).to be_truthy
end
it "raises an informative error for other failures" do
allow(Puppet::FileSystem).to receive(:unlink).with(file).and_raise(Errno::EPERM, 'fake permission problem')
with_content('hello') do
expect { subject.destroy(request) }.to raise_error(Puppet::Error)
end
end
end
end
context "#search" do
before :each do
allow(Puppet.run_mode).to receive(:master?).and_return(true)
Puppet[:server_datadir] = tmpdir('msgpackdir')
FileUtils.mkdir_p(File.join(Puppet[:server_datadir], 'indirector_testing'))
end
def request(glob)
indirection.request(:search, glob, nil)
end
def create_file(name, value = 12)
File.open(subject.path(name, ''), 'w') do |f|
f.write Puppet::IndirectorTesting.new(value).to_msgpack
end
end
it "returns an empty array when nothing matches the key as a glob" do
expect(subject.search(request('*'))).to eq([])
end
it "returns an array with one item if one item matches" do
create_file('foo.msgpack', 'foo')
create_file('bar.msgpack', 'bar')
expect(subject.search(request('f*')).map(&:value)).to eq(['foo'])
end
it "returns an array of items when more than one item matches" do
create_file('foo.msgpack', 'foo')
create_file('bar.msgpack', 'bar')
create_file('baz.msgpack', 'baz')
expect(subject.search(request('b*')).map(&:value)).to match_array(['bar', 'baz'])
end
it "only items with the .msgpack extension" do
create_file('foo.msgpack', 'foo-msgpack')
create_file('foo.msgpack~', 'foo-backup')
expect(subject.search(request('f*')).map(&:value)).to eq(['foo-msgpack'])
end
end
end
|
