summaryrefslogtreecommitdiff
path: root/lib/chef/provider/windows_env.rb
diff options
context:
space:
mode:
authorharikesh-kolekar <harikesh.kolekar@msystechnologies.com>2018-01-29 12:55:28 +0000
committerharikesh-kolekar <harikesh.kolekar@msystechnologies.com>2018-01-30 07:41:03 +0000
commit85ad3ee585ab50d173c083325d106967d2161dab (patch)
treeab53f9baee15101758272642479ac51b2031d5cd /lib/chef/provider/windows_env.rb
parent4b8580ceb864961f77c87e5013eb1bf36463b895 (diff)
downloadchef-85ad3ee585ab50d173c083325d106967d2161dab.tar.gz
rename env resource to windows_env
Signed-off-by: harikesh-kolekar <harikesh.kolekar@msystechnologies.com>
Diffstat (limited to 'lib/chef/provider/windows_env.rb')
-rw-r--r--lib/chef/provider/windows_env.rb210
1 files changed, 210 insertions, 0 deletions
diff --git a/lib/chef/provider/windows_env.rb b/lib/chef/provider/windows_env.rb
new file mode 100644
index 0000000000..4cbcc8a478
--- /dev/null
+++ b/lib/chef/provider/windows_env.rb
@@ -0,0 +1,210 @@
+#
+# Author:: Doug MacEachern (<dougm@vmware.com>)
+# Copyright:: Copyright 2010-2016, VMware, 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 "chef/provider"
+require "chef/resource/windows_env"
+require "chef/mixin/windows_env_helper"
+
+class Chef
+ class Provider
+ class WindowsEnv < Chef::Provider
+ include Chef::Mixin::WindowsEnvHelper
+ attr_accessor :key_exists
+
+ provides :windows_env, os: "windows"
+
+ def whyrun_supported?
+ false
+ end
+
+ def initialize(new_resource, run_context)
+ super
+ @key_exists = true
+ end
+
+ def load_current_resource
+ @current_resource = Chef::Resource::WindowsEnv.new(new_resource.name)
+ current_resource.key_name(new_resource.key_name)
+
+ if env_key_exists(new_resource.key_name)
+ current_resource.value(env_value(new_resource.key_name))
+ else
+ @key_exists = false
+ Chef::Log.debug("#{new_resource} key does not exist")
+ end
+
+ current_resource
+ end
+
+ def env_value(key_name)
+ raise Chef::Exceptions::WindowsEnv, "#{self} provider does not implement env_value!"
+ end
+
+ def env_key_exists(key_name)
+ env_value(key_name) ? true : false
+ end
+
+ # Check to see if value needs any changes
+ #
+ # ==== Returns
+ # <true>:: If a change is required
+ # <false>:: If a change is not required
+ def requires_modify_or_create?
+ if new_resource.delim
+ #e.g. check for existing value within PATH
+ new_values.inject(0) do |index, val|
+ next_index = current_values.find_index val
+ return true if next_index.nil? || next_index < index
+ next_index
+ end
+ false
+ else
+ new_resource.value != current_resource.value
+ end
+ end
+
+ alias_method :compare_value, :requires_modify_or_create?
+
+ def action_create
+ if @key_exists
+ if requires_modify_or_create?
+ modify_env
+ Chef::Log.info("#{new_resource} altered")
+ new_resource.updated_by_last_action(true)
+ end
+ else
+ create_env
+ Chef::Log.info("#{new_resource} created")
+ new_resource.updated_by_last_action(true)
+ end
+ end
+
+ #e.g. delete a PATH element
+ #
+ # ==== Returns
+ # <true>:: If we handled the element case and caller should not delete the key
+ # <false>:: Caller should delete the key, either no :delim was specific or value was empty
+ # after we removed the element.
+ def delete_element
+ return false unless new_resource.delim #no delim: delete the key
+ needs_delete = new_values.any? { |v| current_values.include?(v) }
+ if !needs_delete
+ Chef::Log.debug("#{new_resource} element '#{new_resource.value}' does not exist")
+ return true #do not delete the key
+ else
+ new_value =
+ current_values.select do |item|
+ not new_values.include?(item)
+ end.join(new_resource.delim)
+
+ if new_value.empty?
+ return false #nothing left here, delete the key
+ else
+ old_value = new_resource.value(new_value)
+ create_env
+ Chef::Log.debug("#{new_resource} deleted #{old_value} element")
+ new_resource.updated_by_last_action(true)
+ return true #we removed the element and updated; do not delete the key
+ end
+ end
+ end
+
+ def action_delete
+ if ( ENV[new_resource.key_name] || @key_exists ) && !delete_element
+ delete_env
+ Chef::Log.info("#{new_resource} deleted")
+ new_resource.updated_by_last_action(true)
+ end
+ end
+
+ def action_modify
+ if @key_exists
+ if requires_modify_or_create?
+ modify_env
+ Chef::Log.info("#{new_resource} modified")
+ new_resource.updated_by_last_action(true)
+ end
+ else
+ raise Chef::Exceptions::WindowsEnv, "Cannot modify #{new_resource} - key does not exist!"
+ end
+ end
+
+ def create_env
+ obj = env_obj(@new_resource.key_name)
+ unless obj
+ obj = WIN32OLE.connect("winmgmts://").get("Win32_Environment").spawninstance_
+ obj.name = @new_resource.key_name
+ obj.username = new_resource.user
+ end
+ obj.variablevalue = @new_resource.value
+ obj.put_
+ value = @new_resource.value
+ value = expand_path(value) if @new_resource.key_name.casecmp("PATH") == 0
+ ENV[@new_resource.key_name] = value
+ broadcast_env_change
+ end
+
+ def delete_env
+ obj = env_obj(@new_resource.key_name)
+ if obj
+ obj.delete_
+ broadcast_env_change
+ end
+ if ENV[@new_resource.key_name]
+ ENV.delete(@new_resource.key_name)
+ end
+ end
+
+ def modify_env
+ if new_resource.delim
+ new_resource.value((new_values + current_values).uniq.join(new_resource.delim))
+ end
+ create_env
+ end
+
+ # Returns the current values to split by delimiter
+ def current_values
+ @current_values ||= current_resource.value.split(new_resource.delim)
+ end
+
+ # Returns the new values to split by delimiter
+ def new_values
+ @new_values ||= new_resource.value.split(new_resource.delim)
+ end
+
+ def env_value(key_name)
+ obj = env_obj(key_name)
+ obj.variablevalue if obj
+ end
+
+ def env_obj(key_name)
+ return @env_obj if @env_obj
+ wmi = WmiLite::Wmi.new
+ # Note that by design this query is case insensitive with regard to key_name
+ environment_variables = wmi.query("select * from Win32_Environment where name = '#{key_name}'")
+ if environment_variables && environment_variables.length > 0
+ environment_variables.each do |env|
+ @env_obj = env.wmi_ole_object
+ return @env_obj if @env_obj.username.split('\\').last.casecmp(new_resource.user) == 0
+ end
+ end
+ @env_obj = nil
+ end
+ end
+ end
+end