summaryrefslogtreecommitdiff
path: root/spec/unit/win32/registry_spec.rb
blob: 2485d9ee4799b929b60ec758799f2e3fc260b577 (plain)
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
#
# Author:: Prajakta Purohit (prajakta@chef.io)
# Copyright:: Copyright 2012-2016, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

require "spec_helper"

describe Chef::Win32::Registry do
  include_context "Win32"

  let(:value1) { { name: "one", type: :string, data: "1" } }
  let(:value1_upcase_name) { { name: "ONE", type: :string, data: "1" } }
  let(:key_path) { 'HKCU\Software\OpscodeNumbers' }
  let(:key) { 'Software\OpscodeNumbers' }
  let(:key_parent) { "Software" }
  let(:key_to_delete) { "OpscodeNumbers" }
  let(:sub_key) { "OpscodePrimes" }
  let(:missing_key_path) { 'HKCU\Software' }
  let(:registry) { Chef::Win32::Registry.new }
  let(:hive_mock) { double("::Win32::Registry::KHKEY_CURRENT_USER") }
  let(:reg_mock) { double("reg") }

  before(:all) do
    Win32::Registry = Class.new
    Win32::Registry::Error = Class.new(RuntimeError)
  end

  before(:each) do
    allow_any_instance_of(Chef::Win32::Registry).to receive(:machine_architecture).and_return(:x86_64)

    # Making the values for registry constants available on unix
    Win32::Registry::KEY_SET_VALUE = 0x0002
    Win32::Registry::KEY_QUERY_VALUE = 0x0001
    Win32::Registry::KEY_WRITE = 0x00020000 | 0x0002 | 0x0004
    Win32::Registry::KEY_READ = 0x00020000 | 0x0001 | 0x0008 | 0x0010
  end

  after(:each) do
    Win32::Registry.send(:remove_const, "KEY_SET_VALUE") if defined?(Win32::Registry::KEY_SET_VALUE)
    Win32::Registry.send(:remove_const, "KEY_QUERY_VALUE") if defined?(Win32::Registry::KEY_QUERY_VALUE)
    Win32::Registry.send(:remove_const, "KEY_READ") if defined?(Win32::Registry::KEY_READ)
    Win32::Registry.send(:remove_const, "KEY_WRITE") if defined?(Win32::Registry::KEY_WRITE)
  end

  describe "get_values" do
    it "gets all values for a key if the key exists" do
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_return([hive_mock, key])
      expect(registry).to receive(:key_exists!).with(key_path).and_return(true)
      expect(hive_mock).to receive(:open).with(key, ::Win32::Registry::KEY_READ | registry.registry_system_architecture).and_yield(reg_mock)
      expect(reg_mock).to receive(:map)
      registry.get_values(key_path)
    end

    it "throws an exception if key does not exist" do
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_return([hive_mock, key])
      expect(registry).to receive(:key_exists!).with(key_path).and_raise(Chef::Exceptions::Win32RegKeyMissing)
      expect { registry.get_values(key_path) }.to raise_error(Chef::Exceptions::Win32RegKeyMissing)
    end
  end

  describe "set_value" do
    it "does nothing if key and hive and value exist" do
      expect(registry).to receive(:key_exists!).with(key_path).and_return(true)
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_return([hive_mock, key])
      expect(registry).to receive(:value_exists?).with(key_path, value1).and_return(true)
      expect(registry).to receive(:data_exists?).with(key_path, value1).and_return(true)
      registry.set_value(key_path, value1)
    end
    it "does nothing if case insensitive key and hive and value exist" do
      expect(registry).to receive(:key_exists!).with(key_path.downcase).and_return(true)
      expect(registry).to receive(:get_hive_and_key).with(key_path.downcase).and_return([hive_mock, key])
      expect(registry).to receive(:value_exists?).with(key_path.downcase, value1).and_return(true)
      expect(registry).to receive(:data_exists?).with(key_path.downcase, value1).and_return(true)
      registry.set_value(key_path.downcase, value1)
    end
    it "does nothing if key and hive and value with a case insensitive name exist" do
      expect(registry).to receive(:key_exists!).with(key_path.downcase).and_return(true)
      expect(registry).to receive(:get_hive_and_key).with(key_path.downcase).and_return([hive_mock, key])
      expect(registry).to receive(:value_exists?).with(key_path.downcase, value1_upcase_name).and_return(true)
      expect(registry).to receive(:data_exists?).with(key_path.downcase, value1_upcase_name).and_return(true)
      registry.set_value(key_path.downcase, value1_upcase_name)
    end
    it "updates value if key and hive and value exist, but data is different" do
      expect(registry).to receive(:key_exists!).with(key_path).and_return(true)
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_return([hive_mock, key])
      expect(registry).to receive(:value_exists?).with(key_path, value1).and_return(true)
      expect(registry).to receive(:data_exists?).with(key_path, value1).and_return(false)
      expect(hive_mock).to receive(:open).with(key, Win32::Registry::KEY_SET_VALUE | ::Win32::Registry::KEY_QUERY_VALUE | registry.registry_system_architecture).and_yield(reg_mock)
      expect(registry).to receive(:get_type_from_name).with(:string).and_return(1)
      expect(reg_mock).to receive(:write).with("one", 1, "1")
      registry.set_value(key_path, value1)
    end

    it "creates value if the key exists and the value does not exist" do
      expect(registry).to receive(:key_exists!).with(key_path).and_return(true)
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_return([hive_mock, key])
      expect(registry).to receive(:value_exists?).with(key_path, value1).and_return(false)
      expect(hive_mock).to receive(:open).with(key, ::Win32::Registry::KEY_SET_VALUE | ::Win32::Registry::KEY_QUERY_VALUE | registry.registry_system_architecture).and_yield(reg_mock)
      expect(registry).to receive(:get_type_from_name).with(:string).and_return(1)
      expect(reg_mock).to receive(:write).with("one", 1, "1")
      registry.set_value(key_path, value1)
    end

    it "should raise an exception if the key does not exist" do
      expect(registry).to receive(:key_exists!).with(key_path).and_raise(Chef::Exceptions::Win32RegKeyMissing)
      expect { registry.set_value(key_path, value1) }.to raise_error(Chef::Exceptions::Win32RegKeyMissing)
    end
  end

  describe "delete_value" do
    it "deletes value if value exists" do
      expect(registry).to receive(:value_exists?).with(key_path, value1).and_return(true)
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_return([hive_mock, key])
      expect(hive_mock).to receive(:open).with(key, ::Win32::Registry::KEY_SET_VALUE | registry.registry_system_architecture).and_yield(reg_mock)
      expect(reg_mock).to receive(:delete_value).with("one").and_return(true)
      registry.delete_value(key_path, value1)
    end

    it "raises an exception if the key does not exist" do
      expect(registry).to receive(:value_exists?).with(key_path, value1).and_return(true)
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_raise(Chef::Exceptions::Win32RegKeyMissing)
      registry.delete_value(key_path, value1)
    end

    it "does nothing if the value does not exist" do
      expect(registry).to receive(:value_exists?).with(key_path, value1).and_return(false)
      registry.delete_value(key_path, value1)
    end
  end

  describe "create_key" do
    it "creates key if intermediate keys are missing and recursive is set to true" do
      expect(registry).to receive(:keys_missing?).with(key_path).and_return(true)
      expect(registry).to receive(:create_missing).with(key_path)
      expect(registry).to receive(:key_exists?).with(key_path).and_return(false)
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_return([hive_mock, key])
      expect(hive_mock).to receive(:create).with(key, ::Win32::Registry::KEY_WRITE | registry.registry_system_architecture)
      registry.create_key(key_path, true)
    end

    it "raises an exception if intermediate keys are missing and recursive is set to false" do
      expect(registry).to receive(:keys_missing?).with(key_path).and_return(true)
      expect { registry.create_key(key_path, false) }.to raise_error(Chef::Exceptions::Win32RegNoRecursive)
    end

    it "does nothing if the key exists" do
      expect(registry).to receive(:keys_missing?).with(key_path).and_return(true)
      expect(registry).to receive(:create_missing).with(key_path)
      expect(registry).to receive(:key_exists?).with(key_path).and_return(true)
      registry.create_key(key_path, true)
    end

    it "create key if intermediate keys not missing and recursive is set to false" do
      expect(registry).to receive(:keys_missing?).with(key_path).and_return(false)
      expect(registry).to receive(:key_exists?).with(key_path).and_return(false)
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_return([hive_mock, key])
      expect(hive_mock).to receive(:create).with(key, ::Win32::Registry::KEY_WRITE | registry.registry_system_architecture)
      registry.create_key(key_path, false)
    end

    it "create key if intermediate keys not missing and recursive is set to true" do
      expect(registry).to receive(:keys_missing?).with(key_path).and_return(false)
      expect(registry).to receive(:key_exists?).with(key_path).and_return(false)
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_return([hive_mock, key])
      expect(hive_mock).to receive(:create).with(key, ::Win32::Registry::KEY_WRITE | registry.registry_system_architecture)
      registry.create_key(key_path, true)
    end
  end

  describe "delete_key", :windows_only do
    it "deletes key if it has subkeys and recursive is set to true" do
      expect(registry).to receive(:key_exists?).with(key_path).and_return(true)
      expect(registry).to receive(:has_subkeys?).with(key_path).and_return(true)
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_return([hive_mock, key])
      expect(hive_mock).to receive(:open).with(key_parent, ::Win32::Registry::KEY_WRITE | registry.registry_system_architecture).and_yield(reg_mock)
      expect(reg_mock).to receive(:delete_key).with(key_to_delete, true).and_return(true)
      registry.delete_key(key_path, true)
    end

    it "raises an exception if it has subkeys but recursive is set to false" do
      expect(registry).to receive(:key_exists?).with(key_path).and_return(true)
      expect(registry).to receive(:has_subkeys?).with(key_path).and_return(true)
      expect { registry.delete_key(key_path, false) }.to raise_error(Chef::Exceptions::Win32RegNoRecursive)
    end

    it "deletes key if the key exists and has no subkeys" do
      expect(registry).to receive(:key_exists?).with(key_path).and_return(true)
      expect(registry).to receive(:has_subkeys?).with(key_path).and_return(false)
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_return([hive_mock, key])
      expect(hive_mock).to receive(:open).with(key_parent, ::Win32::Registry::KEY_WRITE | registry.registry_system_architecture).and_yield(reg_mock)
      expect(reg_mock).to receive(:delete_key).with(key_to_delete, true).and_return(true)
      registry.delete_key(key_path, true)
    end
  end

  describe "key_exists?" do
    it "returns true if key_exists" do
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_return([hive_mock, key])
      expect(hive_mock).to receive(:open).with(key, ::Win32::Registry::KEY_READ | registry.registry_system_architecture).and_yield(reg_mock)
      expect(registry.key_exists?(key_path)).to eq(true)
    end

    it "returns false if key does not exist" do
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_return([hive_mock, key])
      expect(hive_mock).to receive(:open).with(key, ::Win32::Registry::KEY_READ | registry.registry_system_architecture).and_raise(::Win32::Registry::Error)
      expect(registry.key_exists?(key_path)).to eq(false)
    end
  end

  describe "key_exists!" do
    it "throws an exception if the key_parent does not exist" do
      expect(registry).to receive(:key_exists?).with(key_path).and_return(false)
      expect { registry.key_exists!(key_path) }.to raise_error(Chef::Exceptions::Win32RegKeyMissing)
    end
  end

  describe "hive_exists?" do
    it "returns true if the hive exists" do
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_return([hive_mock, key])
      registry.hive_exists?(key_path) == true
    end

    it "returns false if the hive does not exist" do
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_raise(Chef::Exceptions::Win32RegHiveMissing)
      registry.hive_exists?(key_path) == false
    end
  end

  describe "has_subkeys?" do
    it "returns true if the key has subkeys" do
      expect(registry).to receive(:key_exists!).with(key_path).and_return(true)
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_return([hive_mock, key])
      expect(hive_mock).to receive(:open).with(key, ::Win32::Registry::KEY_READ | registry.registry_system_architecture).and_yield(reg_mock)
      expect(reg_mock).to receive(:each_key).and_yield(key)
      registry.has_subkeys?(key_path) == true
    end

    it "returns false if the key does not have subkeys" do
      expect(registry).to receive(:key_exists!).with(key_path).and_return(true)
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_return([hive_mock, key])
      expect(hive_mock).to receive(:open).with(key, ::Win32::Registry::KEY_READ | registry.registry_system_architecture).and_yield(reg_mock)
      expect(reg_mock).to receive(:each_key).and_return(no_args)
      expect(registry.has_subkeys?(key_path)).to eq(false)
    end

    it "throws an exception if the key does not exist" do
      expect(registry).to receive(:key_exists!).with(key_path).and_raise(Chef::Exceptions::Win32RegKeyMissing)
      expect { registry.set_value(key_path, value1) }.to raise_error(Chef::Exceptions::Win32RegKeyMissing)
    end
  end

  describe "get_subkeys" do
    it "returns the subkeys if they exist" do
      expect(registry).to receive(:key_exists!).with(key_path).and_return(true)
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_return([hive_mock, key])
      expect(hive_mock).to receive(:open).with(key, ::Win32::Registry::KEY_READ | registry.registry_system_architecture).and_yield(reg_mock)
      expect(reg_mock).to receive(:each_key).and_yield(sub_key)
      registry.get_subkeys(key_path)
    end
  end

  describe "value_exists?" do
    it "throws an exception if the key does not exist" do
      expect(registry).to receive(:key_exists!).with(key_path).and_raise(Chef::Exceptions::Win32RegKeyMissing)
      expect { registry.value_exists?(key_path, value1) }.to raise_error(Chef::Exceptions::Win32RegKeyMissing)
    end

    it "returns true if the value exists" do
      expect(registry).to receive(:key_exists!).with(key_path).and_return(true)
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_return([hive_mock, key])
      expect(hive_mock).to receive(:open).with(key, ::Win32::Registry::KEY_READ | registry.registry_system_architecture).and_yield(reg_mock)
      expect(reg_mock).to receive(:any?).and_yield("one")
      registry.value_exists?(key_path, value1) == true
    end

    it "returns false if the value does not exist" do
      expect(registry).to receive(:key_exists!).with(key_path).and_return(true)
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_return([hive_mock, key])
      expect(hive_mock).to receive(:open).with(key, ::Win32::Registry::KEY_READ | registry.registry_system_architecture).and_yield(reg_mock)
      expect(reg_mock).to receive(:any?).and_yield(no_args)
      registry.value_exists?(key_path, value1) == false
    end
  end

  describe "data_exists?" do
    it "throws an exception if the key does not exist" do
      expect(registry).to receive(:key_exists!).with(key_path).and_raise(Chef::Exceptions::Win32RegKeyMissing)
      expect { registry.data_exists?(key_path, value1) }.to raise_error(Chef::Exceptions::Win32RegKeyMissing)
    end

    it "returns true if the data exists" do
      expect(registry).to receive(:key_exists!).with(key_path).and_return(true)
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_return([hive_mock, key])
      expect(registry).to receive(:get_type_from_name).with(:string).and_return(1)
      expect(reg_mock).to receive(:each).with(no_args).and_yield("one", 1, "1")
      expect(hive_mock).to receive(:open).with(key, ::Win32::Registry::KEY_READ | registry.registry_system_architecture).and_yield(reg_mock)
      expect(registry.data_exists?(key_path, value1)).to eq(true)
    end

    it "returns false if the data does not exist" do
      expect(registry).to receive(:key_exists!).with(key_path).and_return(true)
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_return([hive_mock, key])
      expect(hive_mock).to receive(:open).with(key, ::Win32::Registry::KEY_READ | registry.registry_system_architecture).and_yield(reg_mock)
      expect(registry).to receive(:get_type_from_name).with(:string).and_return(1)
      expect(reg_mock).to receive(:each).with(no_args).and_yield("one", 1, "2")
      expect(registry.data_exists?(key_path, value1)).to eq(false)
    end
  end

  describe "value_exists!" do
    it "does nothing if the value exists" do
      expect(registry).to receive(:value_exists?).with(key_path, value1).and_return(true)
      registry.value_exists!(key_path, value1)
    end

    it "throws an exception if the value does not exist" do
      expect(registry).to receive(:value_exists?).with(key_path, value1).and_return(false)
      expect { registry.value_exists!(key_path, value1) }.to raise_error(Chef::Exceptions::Win32RegValueMissing)
    end
  end

  describe "data_exists!" do
    it "does nothing if the data exists" do
      expect(registry).to receive(:data_exists?).with(key_path, value1).and_return(true)
      registry.data_exists!(key_path, value1)
    end

    it "throws an exception if the data does not exist" do
      expect(registry).to receive(:data_exists?).with(key_path, value1).and_return(false)
      expect { registry.data_exists!(key_path, value1) }.to raise_error(Chef::Exceptions::Win32RegDataMissing)
    end
  end

  describe "type_matches?" do
    it "returns true if type matches" do
      expect(registry).to receive(:value_exists!).with(key_path, value1).and_return(true)
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_return([hive_mock, key])
      expect(hive_mock).to receive(:open).with(key, ::Win32::Registry::KEY_READ | registry.registry_system_architecture).and_yield(reg_mock)
      expect(registry).to receive(:get_type_from_name).with(:string).and_return(1)
      expect(reg_mock).to receive(:each).and_yield("one", 1)
      expect(registry.type_matches?(key_path, value1)).to eq(true)
    end

    it "returns false if type does not match" do
      expect(registry).to receive(:value_exists!).with(key_path, value1).and_return(true)
      expect(registry).to receive(:get_hive_and_key).with(key_path).and_return([hive_mock, key])
      expect(hive_mock).to receive(:open).with(key, ::Win32::Registry::KEY_READ | registry.registry_system_architecture).and_yield(reg_mock)
      expect(reg_mock).to receive(:each).and_yield("two", 2)
      expect(registry.type_matches?(key_path, value1)).to eq(false)
    end

    it "throws an exception if value does not exist" do
      expect(registry).to receive(:value_exists?).with(key_path, value1).and_return(false)
      expect { registry.type_matches?(key_path, value1) }.to raise_error(Chef::Exceptions::Win32RegValueMissing)
    end
  end

  describe "type_matches!" do
    it "does nothing if the type_matches" do
      expect(registry).to receive(:type_matches?).with(key_path, value1).and_return(true)
      registry.type_matches!(key_path, value1)
    end

    it "throws an exception if the type does not match" do
      expect(registry).to receive(:type_matches?).with(key_path, value1).and_return(false)
      expect { registry.type_matches!(key_path, value1) }.to raise_error(Chef::Exceptions::Win32RegTypesMismatch)
    end
  end

  describe "keys_missing?" do
    it "returns true if the keys are missing" do
      expect(registry).to receive(:key_exists?).with(missing_key_path).and_return(false)
      expect(registry.keys_missing?(key_path)).to eq(true)
    end

    it "returns false if no keys in the path are missing" do
      expect(registry).to receive(:key_exists?).with(missing_key_path).and_return(true)
      expect(registry.keys_missing?(key_path)).to eq(false)
    end
  end
end