Adding the spec tests for the registry helper

1 files changed, 310 insertions, 0 deletions

diff --git a/spec/functional/registry_helper_spec.rb b/spec/functional/registry_helper_spec.rb
new file mode 100644
index 0000000000..52ea70e8af
--- /dev/null
+++ b/spec/functional/registry_helper_spec.rb
@@ -0,0 +1,310 @@
+#
+# Author:: Prajakta Purohit (<prajakta@opscode.com>)
+# Copyright:: Copyright (c) 2011 Opscode, 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'
+
+require 'chef/win32/registry'
+
+describe 'Chef::Win32::Registry', :windows_only do
+
+  before(:all) do
+    #Create a registry item
+    ::Win32::Registry::HKEY_CURRENT_USER.create "Software\\Root"
+    ::Win32::Registry::HKEY_CURRENT_USER.create "Software\\Root\\Branch"
+    ::Win32::Registry::HKEY_CURRENT_USER.create "Software\\Root\\Branch\\Flower"
+    ::Win32::Registry::HKEY_CURRENT_USER.open('Software\\Root', Win32::Registry::KEY_ALL_ACCESS) do |reg|
+      reg['RootType1', Win32::Registry::REG_SZ] = 'fibrous'
+      reg.write('Roots', Win32::Registry::REG_MULTI_SZ, ["strong roots", "healthy tree"])
+    end
+    ::Win32::Registry::HKEY_CURRENT_USER.open('Software\\Root\\Branch', Win32::Registry::KEY_ALL_ACCESS) do |reg|
+      reg['Strong', Win32::Registry::REG_SZ] = 'bird nest'
+    end
+    ::Win32::Registry::HKEY_CURRENT_USER.open('Software\\Root\\Branch\\Flower', Win32::Registry::KEY_ALL_ACCESS) do |reg|
+      reg['Petals', Win32::Registry::REG_MULTI_SZ] = ["Pink", "Delicate"]
+    end
+
+    #Create the node with ohai data
+    events = Chef::EventDispatch::Dispatcher.new
+    node = Chef::Node.new
+    ohai = Ohai::System.new
+    ohai.all_plugins
+    node.consume_external_attrs(ohai.data,{})
+    run_context = Chef::RunContext.new(node, {}, events)
+
+    #Create a registry object that has access ot the node previously created
+    @registry = Chef::Win32::Registry.new(run_context)
+  end
+
+  #Delete what is left of the registry key-values previously created
+  after(:all) do
+    ::Win32::Registry::HKEY_CURRENT_USER.open("Software") do |reg|
+      reg.delete_key("Root", true)
+    end
+  end
+
+  # If hive_exists
+  it "returns true if the hive exists" do
+    hive = @registry.hive_exists?("HKCU\\Software\\Root")
+    hive.should == true
+  end
+  it "returns false if the hive does not exist" do
+    hive = @registry.hive_exists?("LYRU\\Software\\Root")
+    hive.should == false
+  end
+  it "returns false if the system architecture says 32bit but system is 64bit" do
+    #pending
+  end
+
+  #  key_exists
+  it "returns true if the key path exists" do
+    exists = @registry.key_exists?("HKCU\\Software\\Root\\Branch\\Flower", "x86_64")
+    exists.should == true
+  end
+  it "returns false if the key path does not exist" do
+    exists = @registry.key_exists?("HKCU\\Software\\Branch\\Flower", "x86_64")
+    exists.should == false
+  end
+  it "returns false if the architecture wrong" do
+    #pending
+  end
+
+  # get_values
+  it "returns all values for a key if it exists" do
+    values = @registry.get_values("HKCU\\Software\\Root", "x86_64")
+    values.should be_an_instance_of Array
+    values.should == [{:name=>"RootType1", :type=>1, :data=>"fibrous"},
+                      {:name=>"Roots", :type=>7, :data=>["strong roots", "healthy tree"]}]
+  end
+  it "returns a nil if the key does not exist" do
+    values = @registry.get_values("HKCU\\Software\\Branch\\Flower", "x86_64")
+    values.should == nil
+  end
+
+  #  update_value
+  it "updates a value if the key, value exist and type matches and value different" do
+    updated = @registry.update_value("HKCU\\Software\\Root\\Branch\\Flower", {:name=>"Petals", :type=>:multi_string, :data=>["Yellow", "Changed Color"]}, "x86_64")
+    ::Win32::Registry::HKEY_CURRENT_USER.open("Software\\Root\\Branch\\Flower", Win32::Registry::KEY_ALL_ACCESS) do |reg|
+      reg.each do |name, type, data|
+        if name == 'Petals'
+          if data == ["Yellow", "Changed Color"]
+            @exists=true
+          else
+            @exists=false
+          end
+        end
+      end
+    end
+    updated.should == true && @exists.should == true
+  end
+  it "gives an error if key and value exists and type does not match" do
+    updated = @registry.update_value("HKCU\\Software\\Root\\Branch\\Flower", {:name=>"Petals", :type=>:string, :data=>"Yellow"}, "x86_64")
+    updated.should == false
+  end
+  it "gives an error if key exists and value does not" do
+    updated = @registry.update_value("HKCU\\Software\\Root\\Branch\\Flower", {:name=>"Stamen", :type=>:multi_string, :data=>["Yellow", "Changed Color"]}, "x86_64")
+    updated.should == false
+  end
+  it "does nothing if all parameters are same" do
+    updated = @registry.update_value("HKCU\\Software\\Root\\Branch\\Flower", {:name=>"Petals", :type=>:multi_string, :data=>["Yellow", "Changed Color"]}, "x86_64")
+    updated.should == "no_action"
+  end
+  it "gives an error if the key does not exist" do
+    updated = @registry.update_value("HKCU\\Software\\Branch\\Flower", {:name=>"Petals", :type=>:multi_string, :data=>["Yellow", "Changed Color"]}, "x86_64")
+    updated.should == false
+  end
+  #NA
+  #it "updates and creates given a array of hashes and one exists and the other does not" do
+  #end
+
+  #  create_value
+  it "creates a value if it does not exist" do
+    creates = @registry.create_value("HKCU\\Software\\Root\\Branch\\Flower", {:name=>"Buds", :type=>:string, :data=>"Closed"}, "x86_64")
+    ::Win32::Registry::HKEY_CURRENT_USER.open("Software\\Root\\Branch\\Flower", Win32::Registry::KEY_ALL_ACCESS) do |reg|
+      reg.each do |name, type, data|
+        if name == "Buds" && type == 1 && data == "Closed"
+          @exists=true
+        else
+          @exists=false
+        end
+      end
+    end
+  end
+  it "does nothing if the value exists and does not check whether the type and data" do
+    @registry.create_value("HKCU\\Software\\Root\\Branch\\Flower", {:name=>"Buds", :type=>:string, :data=>"Closed"}, "x86_64")
+    ::Win32::Registry::HKEY_CURRENT_USER.open("Software\\Root\\Branch\\Flower", Win32::Registry::KEY_ALL_ACCESS) do |reg|
+      reg.each do |name, type, data|
+        if name == "Buds" && type == 1 && data == "Closed"
+          @exists=true
+        else
+          @exists=false
+        end
+      end
+    end
+    #test with timestamp?
+  end
+
+  #  create_key
+  it "gives and error if the path has missing keys but recursive set to false" do
+    created = @registry.create_key("HKCU\\Software\\Root\\Trunk\\Peck\\Woodpecker", {:name=>"Peter", :type=>:string, :data=>"Little"}, "x86_64", false)
+    ::Win32::Registry::HKEY_CURRENT_USER.open("Software\\Root", Win32::Registry::KEY_ALL_ACCESS) do |reg|
+      reg.each_key do |key_name|
+        if key_name == "Trunk"
+          @exists=true
+          break
+        else
+          @exists=false
+        end
+      end
+    end
+    created.should == false && @exists.should == false
+  end
+  it "creates the key_path of the keys were missing but recursive was set to true" do
+    @registry.create_key("HKCU\\Software\\Root\\Trunk\\Peck\\Woodpecker", {:name=>"Peter", :type=>:string, :data=>"Little"}, "x86_64", true)
+    ::Win32::Registry::HKEY_CURRENT_USER.open("Software\\Root\\Trunk\\Peck\\Woodpecker", Win32::Registry::KEY_ALL_ACCESS) do |reg|
+      reg.each do|name, type, data|
+        if name == "Peter" && type == 1 && data == "Little"
+          @exists=true
+        else
+          @exists=false
+        end
+      end
+    end
+    @exists.should == true
+  end
+  it "gives an error if the architecture is wrong" do
+    #pending
+  end
+
+  #  create_if_missing
+  it "does not update a key if it exists" do
+    @registry.create_key("HKCU\\Software\\Root\\Trunk\\Peck\\Woodpecker", {:name=>"Peter", :type=>:string, :data=>"Tiny"}, "x86_64", true)
+    ::Win32::Registry::HKEY_CURRENT_USER.open("Software\\Root\\Trunk\\Peck\\Woodpecker", Win32::Registry::KEY_ALL_ACCESS) do |reg|
+      reg.each do |name, type, data|
+        if name == "Peter" && type == 1 && data == "Little"
+          @exists=true
+        elsif name == "Peter" && type == 1 && data == "Tiny"
+          @exists=false
+        end
+      end
+    end
+    @exists.should == true
+  end
+
+  #  delete_values
+  it "deletes values if the value exists" do
+    @registry.delete_value("HKCU\\Software\\Root\\Trunk\\Peck\\Woodpecker", {:name=>"Peter", :type=>:string, :data=>"Tiny"}, "x86_64")
+    exists = false
+    ::Win32::Registry::HKEY_CURRENT_USER.open("Software\\Root\\Trunk\\Peck\\Woodpecker", Win32::Registry::KEY_ALL_ACCESS) do |reg|
+      reg.each do |name, type, data|
+        if name == "Peter" && type == 1 && data == "Little"
+          exists=true
+          break
+        else
+          exists=false
+        end
+      end
+    end
+    exists.should == false
+  end
+  it "does nothing if value does not exist" do
+    #pending
+  end
+
+  #  delete_key
+  it "deletes a key if it has no subkeys" do
+    #  create a key to be deleted in a before block
+    @registry.delete_key("HKCU\\Software\\Root\\Branch\\Flower", {:name=>"Buds", :type=>:string, :data=>"Closed"}, "x86_64", false)
+    exists = false
+    ::Win32::Registry::HKEY_CURRENT_USER.open("Software\\Root\\Branch", Win32::Registry::KEY_ALL_ACCESS) do |reg|
+      reg.each_key do |name|
+        if name == "Flower"
+          exists=true
+          break
+        else
+          exists=false
+        end
+      end
+    end
+    exists.should == false
+  end
+  it "gives an error if key to delete has subkeys and recursive is false" do
+    @registry.delete_key("HKCU\\Software\\Root\\Trunk", {:name=>"Strong", :type=>:string, :data=>"bird nest"}, "x86_64", false)
+    exists = true
+    ::Win32::Registry::HKEY_CURRENT_USER.open("Software\\Root", Win32::Registry::KEY_ALL_ACCESS) do |reg|
+      reg.each_key do |name|
+        if name == "Trunk"
+          exists=true
+          break
+        else
+          exists=false
+        end
+      end
+    end
+    exists.should == true
+  end
+  it "deletes a key if it has subkeys and recursive true" do
+    @registry.delete_key("HKCU\\Software\\Root\\Trunk", {:name=>"Strong", :type=>:string, :data=>"bird nest"}, "x86_64", true)
+    exists = true
+    ::Win32::Registry::HKEY_CURRENT_USER.open("Software\\Root", Win32::Registry::KEY_ALL_ACCESS) do |reg|
+      reg.each_key do |name|
+        if name == "Trunk"
+          exists=true
+          break
+        else
+          exists=false
+        end
+      end
+    end
+    exists.should == false
+  end
+  it "does nothing if the key does not exist" do
+    @registry.delete_key("HKCU\\Software\\Root\\Trunk", {:name=>"Strong", :type=>:string, :data=>"bird nest"}, "x86_64", true)
+    exists = true
+    ::Win32::Registry::HKEY_CURRENT_USER.open("Software\\Root", Win32::Registry::KEY_ALL_ACCESS) do |reg|
+      reg.each_key do |name|
+        if name == "Trunk"
+          exists=true
+          break
+        else
+          exists=false
+        end
+      end
+    end
+    exists.should == false
+  end
+
+  # has_subkeys
+  it "returns true if the key has subkeys" do
+    subkeys = @registry.has_subkeys("HKCU\\Software\\Root", "x86_64")
+    exists = false
+    ::Win32::Registry::HKEY_CURRENT_USER.open("Software\\Root", Win32::Registry::KEY_ALL_ACCESS) do |reg|
+      reg.each_key{|name| exists=true}
+    end
+    subkeys.should == true
+  end
+
+  #  get_subkeys
+  it "returns the array of subkeys for a given key" do
+    subkeys = @registry.get_subkeys("HKCU\\Software\\Root", "x86_64")
+    reg_subkeys = []
+    ::Win32::Registry::HKEY_CURRENT_USER.open("Software\\Root", Win32::Registry::KEY_ALL_ACCESS) do |reg|
+      reg.each_key{|name| reg_subkeys << name}
+    end
+    reg_subkeys.should == subkeys
+  end
+end