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
|
require 'spec_helper'
require 'puppet/util/pidlock'
describe Puppet::Util::Pidlock, if: !Puppet::Util::Platform.jruby? do
require 'puppet_spec/files'
include PuppetSpec::Files
before(:each) do
@lockfile = tmpfile("lock")
@lock = Puppet::Util::Pidlock.new(@lockfile)
allow(Facter).to receive(:value).with(:kernel).and_return('Linux')
end
describe "#ps pid argument on posix", unless: Puppet::Util::Platform.windows? do
let(:other_pid) { Process.pid + 1 }
before do
# another process has locked the pidfile
File.write(@lockfile, other_pid)
# and it's still active
allow(Process).to receive(:kill).with(0, other_pid)
end
it "should fallback to '-p' when ps execution fails with '-eq' on Linux" do
allow(Puppet::Util::Execution).to receive(:execute).with(['ps', '-eq', other_pid, '-o', 'comm=']).and_raise(Puppet::ExecutionFailure, 'Execution of command returned 1: error')
expect(Puppet::Util::Execution).to receive(:execute).with(['ps', "-p", other_pid, '-o', 'comm=']).and_return('puppet')
expect(Puppet::Util::Execution).to receive(:execute).with(['ps', "-p", other_pid, '-o', 'args=']).and_return('puppet')
expect(@lock).to be_locked
end
shared_examples_for 'a valid ps argument was provided' do |desired_kernel, ps_argument|
it "should be '#{ps_argument}' when current kernel is #{desired_kernel}" do
allow(Facter).to receive(:value).with(:kernel).and_return(desired_kernel)
allow(Puppet::Util::Execution).to receive(:execute).with(['ps', ps_argument, other_pid, '-o', 'comm=']).and_return('ruby')
allow(Puppet::Util::Execution).to receive(:execute).with(['ps', ps_argument, other_pid, '-o', 'args=']).and_return('puppet')
expect(@lock).to be_locked
end
end
context "when current kernel is Linux" do
it_should_behave_like 'a valid ps argument was provided', "Linux", "-eq"
end
context "when current kernel is AIX" do
it_should_behave_like 'a valid ps argument was provided', "AIX", "-T"
end
context "when current kernel is Darwin" do
it_should_behave_like 'a valid ps argument was provided', "Darwin", "-p"
end
end
describe "#lock" do
it "should not be locked at start" do
expect(@lock).not_to be_locked
end
it "should not be mine at start" do
expect(@lock).not_to be_mine
end
it "should become locked" do
@lock.lock
expect(@lock).to be_locked
end
it "should become mine" do
@lock.lock
expect(@lock).to be_mine
end
it "should be possible to lock multiple times" do
@lock.lock
expect { @lock.lock }.not_to raise_error
end
it "should return true when locking" do
expect(@lock.lock).to be_truthy
end
it "should return true if locked by me" do
@lock.lock
expect(@lock.lock).to be_truthy
end
it "should create a lock file" do
@lock.lock
expect(Puppet::FileSystem.exist?(@lockfile)).to be_truthy
end
it 'should create an empty lock file even when pid is missing' do
allow(Process).to receive(:pid).and_return('')
@lock.lock
expect(Puppet::FileSystem.exist?(@lock.file_path)).to be_truthy
expect(Puppet::FileSystem.read(@lock.file_path)).to be_empty
end
it 'should replace an existing empty lockfile with a pid, given a subsequent lock call made against a valid pid' do
# empty pid results in empty lockfile
allow(Process).to receive(:pid).and_return('')
@lock.lock
expect(Puppet::FileSystem.exist?(@lock.file_path)).to be_truthy
# next lock call with valid pid kills existing empty lockfile
allow(Process).to receive(:pid).and_return(1234)
@lock.lock
expect(Puppet::FileSystem.exist?(@lock.file_path)).to be_truthy
expect(Puppet::FileSystem.read(@lock.file_path)).to eq('1234')
end
it "should expose the lock file_path" do
expect(@lock.file_path).to eq(@lockfile)
end
end
describe "#unlock" do
it "should not be locked anymore" do
@lock.lock
@lock.unlock
expect(@lock).not_to be_locked
end
it "should return false if not locked" do
expect(@lock.unlock).to be_falsey
end
it "should return true if properly unlocked" do
@lock.lock
expect(@lock.unlock).to be_truthy
end
it "should get rid of the lock file" do
@lock.lock
@lock.unlock
expect(Puppet::FileSystem.exist?(@lockfile)).to be_falsey
end
end
describe "#locked?" do
it "should return true if locked" do
@lock.lock
expect(@lock).to be_locked
end
it "should remove the lockfile when pid is missing" do
allow(Process).to receive(:pid).and_return('')
@lock.lock
expect(@lock.locked?).to be_falsey
expect(Puppet::FileSystem.exist?(@lock.file_path)).to be_falsey
end
end
describe '#lock_pid' do
it 'should return nil if the pid is empty' do
# fake pid to get empty lockfile
allow(Process).to receive(:pid).and_return('')
@lock.lock
expect(@lock.lock_pid).to eq(nil)
end
end
describe "with a stale lock" do
before(:each) do
# fake our pid to be 1234
allow(Process).to receive(:pid).and_return(1234)
# lock the file
@lock.lock
# fake our pid to be a different pid, to simulate someone else
# holding the lock
allow(Process).to receive(:pid).and_return(6789)
allow(Process).to receive(:kill).with(0, 6789)
allow(Process).to receive(:kill).with(0, 1234).and_raise(Errno::ESRCH)
end
it "should not be locked" do
expect(@lock).not_to be_locked
end
describe "#lock" do
it "should clear stale locks" do
expect(@lock.locked?).to be_falsey
expect(Puppet::FileSystem.exist?(@lockfile)).to be_falsey
end
it "should replace with new locks" do
@lock.lock
expect(Puppet::FileSystem.exist?(@lockfile)).to be_truthy
expect(@lock.lock_pid).to eq(6789)
expect(@lock).to be_mine
expect(@lock).to be_locked
end
end
describe "#unlock" do
it "should not be allowed" do
expect(@lock.unlock).to be_falsey
end
it "should not remove the lock file" do
@lock.unlock
expect(Puppet::FileSystem.exist?(@lockfile)).to be_truthy
end
end
end
describe "with no access to open the process on Windows", :if => Puppet.features.microsoft_windows? do
before(:each) do
allow(Process).to receive(:pid).and_return(6789)
@lock.lock
allow(Process).to receive(:pid).and_return(1234)
exception = Puppet::Util::Windows::Error.new('Access Denied', 5) # ERROR_ACCESS_DENIED
allow(Puppet::Util::Windows::Process).to receive(:get_process_image_name_by_pid).with(6789).and_raise(exception)
allow(Process).to receive(:kill).with(0, 6789)
allow(Process).to receive(:kill).with(0, 1234)
end
it "should be locked" do
expect(@lock).to be_locked
end
describe "#lock" do
it "should not be possible" do
expect(@lock.lock).to be_falsey
end
it "should not overwrite the lock" do
@lock.lock
expect(@lock).not_to be_mine
end
end
describe "#unlock" do
it "should not be possible" do
expect(@lock.unlock).to be_falsey
end
it "should not remove the lock file" do
@lock.unlock
expect(Puppet::FileSystem.exist?(@lockfile)).to be_truthy
end
it "should still not be our lock" do
@lock.unlock
expect(@lock).not_to be_mine
end
end
end
describe "with another process lock" do
before(:each) do
# fake our pid to be 1234
allow(Process).to receive(:pid).and_return(1234)
if Puppet::Util::Platform.windows?
allow(Puppet::Util::Windows::Process).to receive(:get_process_image_name_by_pid).with(1234).and_return('C:\Program Files\Puppet Labs\Puppet\puppet\bin\ruby.exe')
else
allow(Puppet::Util::Execution).to receive(:execute).with(['ps', '-eq', 1234, '-o', 'comm=']).and_return('puppet')
allow(Puppet::Util::Execution).to receive(:execute).with(['ps', '-eq', 1234, '-o', 'args=']).and_return('puppet')
end
# lock the file
@lock.lock
# fake our pid to be a different pid, to simulate someone else
# holding the lock
allow(Process).to receive(:pid).and_return(6789)
allow(Process).to receive(:kill).with(0, 6789)
allow(Process).to receive(:kill).with(0, 1234)
end
it "should be locked" do
expect(@lock).to be_locked
end
it "should not be mine" do
expect(@lock).not_to be_mine
end
it "should be locked if the other process is a puppet gem" do
File.write(@lockfile, "1234")
if Puppet::Util::Platform.windows?
allow(Puppet::Util::Windows::Process).to receive(:get_process_image_name_by_pid).with(1234).and_return('C:\Program Files\Puppet Labs\Puppet\puppet\bin\ruby.exe')
else
allow(Puppet::Util::Execution).to receive(:execute).with(['ps', '-p', 1234, '-o', 'comm=']).and_return('ruby')
allow(Puppet::Util::Execution).to receive(:execute).with(['ps', '-p', 1234, '-o', 'args=']).and_return('ruby /root/puppet/.bundle/ruby/2.3.0/bin/puppet agent --no-daemonize -v')
end
expect(@lock).to be_locked
end
it "should not be mine if the other process is a puppet gem" do
File.write(@lockfile, "1234")
if Puppet::Util::Platform.windows?
allow(Puppet::Util::Windows::Process).to receive(:get_process_image_name_by_pid).with(1234).and_return('C:\Program Files\Puppet Labs\Puppet\puppet\bin\ruby.exe')
else
allow(Puppet::Util::Execution).to receive(:execute).with(['ps', '-p', 1234, '-o', 'comm=']).and_return('ruby')
allow(Puppet::Util::Execution).to receive(:execute).with(['ps', '-p', 1234, '-o', 'args=']).and_return('ruby /root/puppet/.bundle/ruby/2.3.0/bin/puppet agent --no-daemonize -v')
end
expect(@lock).to_not be_mine
end
describe "#lock" do
it "should not be possible" do
expect(@lock.lock).to be_falsey
end
it "should not overwrite the lock" do
@lock.lock
expect(@lock).not_to be_mine
end
end
describe "#unlock" do
it "should not be possible" do
expect(@lock.unlock).to be_falsey
end
it "should not remove the lock file" do
@lock.unlock
expect(Puppet::FileSystem.exist?(@lockfile)).to be_truthy
end
it "should still not be our lock" do
@lock.unlock
expect(@lock).not_to be_mine
end
end
end
end
|
