chef 14.5.27-universal-mingw32 → 14.5.33-universal-mingw32

data/lib/chef/resource/windows_auto_run.rb

@@ -1,87 +1,87 @@
-#
-# Author:: Paul Morton (<pmorton@biaprotect.com>)
-# Copyright:: 2011-2018, Business Intelligence Associates, Inc.
-# Copyright:: 2017-2018, Chef Software, Inc.
-#
-# 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/resource"
-
-class Chef
-  class Resource
-    class WindowsAutorun < Chef::Resource
-      resource_name :windows_auto_run
-      provides(:windows_auto_run) { true }
-
-      description "Use the windows_auto_run resource to set applications to run at login."
-      introduced "14.0"
-
-      property :program_name, String,
-               description: "The name of the program to run at login if different from the resource name.",
-               name_property: true
-
-      property :path, String,
-               coerce: proc { |x| x.tr("/", "\\") }, # make sure we have windows paths for the registry
-               description: "The path to the program that will run at login. "
-
-      property :args, String,
-               description: "Any arguments to be used with the program."
-
-      property :root, Symbol,
-               description: "The registry root key to put the entry under.",
-               equal_to: %i{machine user},
-               default: :machine
-
-      alias_method :program, :path
-
-      action :create do
-        description "Create an item to be run at login."
-
-        data = "\"#{new_resource.path}\""
-        data << " #{new_resource.args}" if new_resource.args
-
-        registry_key registry_path do
-          values [{
-            name: new_resource.program_name,
-            type: :string,
-            data: data,
-          }]
-          action :create
-        end
-      end
-
-      action :remove do
-        description "Remove an item that was previously setup to run at login"
-
-        registry_key registry_path do
-          values [{
-            name: new_resource.program_name,
-            type: :string,
-            data: "",
-          }]
-          action :delete
-        end
-      end
-
-      action_class do
-        # determine the full registry path based on the root property
-        # @return [String]
-        def registry_path
-          { machine: "HKLM", user: "HKCU" }[new_resource.root] + \
-            '\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Run'
-        end
-      end
-    end
-  end
-end
+#
+# Author:: Paul Morton (<pmorton@biaprotect.com>)
+# Copyright:: 2011-2018, Business Intelligence Associates, Inc.
+# Copyright:: 2017-2018, Chef Software, Inc.
+#
+# 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/resource"
+
+class Chef
+  class Resource
+    class WindowsAutorun < Chef::Resource
+      resource_name :windows_auto_run
+      provides(:windows_auto_run) { true }
+
+      description "Use the windows_auto_run resource to set applications to run at login."
+      introduced "14.0"
+
+      property :program_name, String,
+               description: "The name of the program to run at login if different from the resource name.",
+               name_property: true
+
+      property :path, String,
+               coerce: proc { |x| x.tr("/", "\\") }, # make sure we have windows paths for the registry
+               description: "The path to the program that will run at login. "
+
+      property :args, String,
+               description: "Any arguments to be used with the program."
+
+      property :root, Symbol,
+               description: "The registry root key to put the entry under.",
+               equal_to: %i{machine user},
+               default: :machine
+
+      alias_method :program, :path
+
+      action :create do
+        description "Create an item to be run at login."
+
+        data = "\"#{new_resource.path}\""
+        data << " #{new_resource.args}" if new_resource.args
+
+        registry_key registry_path do
+          values [{
+            name: new_resource.program_name,
+            type: :string,
+            data: data,
+          }]
+          action :create
+        end
+      end
+
+      action :remove do
+        description "Remove an item that was previously setup to run at login"
+
+        registry_key registry_path do
+          values [{
+            name: new_resource.program_name,
+            type: :string,
+            data: "",
+          }]
+          action :delete
+        end
+      end
+
+      action_class do
+        # determine the full registry path based on the root property
+        # @return [String]
+        def registry_path
+          { machine: "HKLM", user: "HKCU" }[new_resource.root] + \
+            '\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Run'
+        end
+      end
+    end
+  end
+end

data/lib/chef/resource/windows_env.rb

@@ -1,40 +1,40 @@
-#
-# Author:: Doug MacEachern (<dougm@vmware.com>)
-# Author:: Tyler Cloke (<tyler@chef.io>)
-# 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/resource"
-
-class Chef
-  class Resource
-    class WindowsEnv < Chef::Resource
-      resource_name :windows_env
-      provides :windows_env
-      provides :env # backwards compat with the pre-Chef 14 resource name
-
-      description "Use the env resource to manage environment keys in Microsoft Windows. After an environment key is set, Microsoft Windows must be restarted before the environment key will be available to the Task Scheduler."
-
-      default_action :create
-      allowed_actions :create, :delete, :modify
-
-      property :key_name, String, identity: true, name_property: true
-      property :value, String, required: true
-      property :delim, [ String, nil, false ], desired_state: false
-      property :user, String, default: "<System>"
-    end
-  end
-end
+#
+# Author:: Doug MacEachern (<dougm@vmware.com>)
+# Author:: Tyler Cloke (<tyler@chef.io>)
+# 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/resource"
+
+class Chef
+  class Resource
+    class WindowsEnv < Chef::Resource
+      resource_name :windows_env
+      provides :windows_env
+      provides :env # backwards compat with the pre-Chef 14 resource name
+
+      description "Use the env resource to manage environment keys in Microsoft Windows. After an environment key is set, Microsoft Windows must be restarted before the environment key will be available to the Task Scheduler."
+
+      default_action :create
+      allowed_actions :create, :delete, :modify
+
+      property :key_name, String, identity: true, name_property: true
+      property :value, String, required: true
+      property :delim, [ String, nil, false ], desired_state: false
+      property :user, String, default: "<System>"
+    end
+  end
+end

data/lib/chef/resource/windows_feature.rb

@@ -1,95 +1,95 @@
-#
-# Author:: Seth Chisamore (<schisamo@chef.io>)
-#
-# Copyright:: 2011-2018, Chef Software, Inc.
-#
-# 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/resource"
-
-class Chef
-  class Resource
-    class WindowsFeature < Chef::Resource
-      resource_name :windows_feature
-      provides(:windows_feature) { true }
-
-      description "Use the windows_feature resource to add, remove or delete Windows features and roles. This resource calls"\
-                  " the 'windows_feature_dism' or 'windows_feature_powershell' resources depending on the specified installation"\
-                  " method and defaults to dism, which is available on both Workstation and Server editions of Windows."
-      introduced "14.0"
-
-      property :feature_name, [Array, String],
-               description: "The name of the feature/role(s) to install. The same feature may have different"\
-                            " names depending on the underlying resource being used (ie DHCPServer vs DHCP;"\
-                            " DNS-Server-Full-Role vs DNS).",
-               name_property: true
-
-      property :source, String,
-               description: "Use a local repository for the feature install."
-
-      property :all, [TrueClass, FalseClass],
-               description: "Install all sub features.",
-               default: false
-
-      property :management_tools, [TrueClass, FalseClass],
-               description: "Install all applicable management tools of the roles, role services, or features (PowerShell only).",
-               default: false
-
-      property :install_method, Symbol,
-               description: "If DISM or PowerShell should be used for the installation. Note feature names differ"\
-                            " between the two installation methods.",
-               equal_to: [:windows_feature_dism, :windows_feature_powershell, :windows_feature_servermanagercmd]
-
-      property :timeout, Integer,
-               description: "Specifies a timeout (in seconds) for feature install.",
-               default: 600
-
-      action :install do
-        description "Install a Windows role/feature"
-
-        run_default_subresource :install
-      end
-
-      action :remove do
-        description "Remove a Windows role/feature"
-
-        run_default_subresource :remove
-      end
-
-      action :delete do
-        description "Remove a Windows role/feature from the image"
-
-        run_default_subresource :delete
-      end
-
-      action_class do
-        # call the appropriate windows_feature resource based on the specified subresource
-        # @return [void]
-        def run_default_subresource(desired_action)
-          raise "Support for Windows feature installation via servermanagercmd.exe has been removed as this support is no longer needed in Windows 2008 R2 and above. You will need to update your cookbook to install either via dism or powershell (preferred)." if new_resource.install_method == :windows_feature_servermanagercmd
-
-          subresource = new_resource.install_method || :windows_feature_dism
-          declare_resource(subresource, new_resource.name) do
-            action desired_action
-            feature_name new_resource.feature_name
-            source new_resource.source if new_resource.source
-            all new_resource.all
-            timeout new_resource.timeout
-            management_tools new_resource.management_tools if subresource == :windows_feature_powershell
-          end
-        end
-      end
-    end
-  end
-end
+#
+# Author:: Seth Chisamore (<schisamo@chef.io>)
+#
+# Copyright:: 2011-2018, Chef Software, Inc.
+#
+# 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/resource"
+
+class Chef
+  class Resource
+    class WindowsFeature < Chef::Resource
+      resource_name :windows_feature
+      provides(:windows_feature) { true }
+
+      description "Use the windows_feature resource to add, remove or delete Windows features and roles. This resource calls"\
+                  " the 'windows_feature_dism' or 'windows_feature_powershell' resources depending on the specified installation"\
+                  " method and defaults to dism, which is available on both Workstation and Server editions of Windows."
+      introduced "14.0"
+
+      property :feature_name, [Array, String],
+               description: "The name of the feature/role(s) to install. The same feature may have different"\
+                            " names depending on the underlying resource being used (ie DHCPServer vs DHCP;"\
+                            " DNS-Server-Full-Role vs DNS).",
+               name_property: true
+
+      property :source, String,
+               description: "Use a local repository for the feature install."
+
+      property :all, [TrueClass, FalseClass],
+               description: "Install all sub features.",
+               default: false
+
+      property :management_tools, [TrueClass, FalseClass],
+               description: "Install all applicable management tools of the roles, role services, or features (PowerShell only).",
+               default: false
+
+      property :install_method, Symbol,
+               description: "If DISM or PowerShell should be used for the installation. Note feature names differ"\
+                            " between the two installation methods.",
+               equal_to: [:windows_feature_dism, :windows_feature_powershell, :windows_feature_servermanagercmd]
+
+      property :timeout, Integer,
+               description: "Specifies a timeout (in seconds) for feature install.",
+               default: 600
+
+      action :install do
+        description "Install a Windows role/feature"
+
+        run_default_subresource :install
+      end
+
+      action :remove do
+        description "Remove a Windows role/feature"
+
+        run_default_subresource :remove
+      end
+
+      action :delete do
+        description "Remove a Windows role/feature from the image"
+
+        run_default_subresource :delete
+      end
+
+      action_class do
+        # call the appropriate windows_feature resource based on the specified subresource
+        # @return [void]
+        def run_default_subresource(desired_action)
+          raise "Support for Windows feature installation via servermanagercmd.exe has been removed as this support is no longer needed in Windows 2008 R2 and above. You will need to update your cookbook to install either via dism or powershell (preferred)." if new_resource.install_method == :windows_feature_servermanagercmd
+
+          subresource = new_resource.install_method || :windows_feature_dism
+          declare_resource(subresource, new_resource.name) do
+            action desired_action
+            feature_name new_resource.feature_name
+            source new_resource.source if new_resource.source
+            all new_resource.all
+            timeout new_resource.timeout
+            management_tools new_resource.management_tools if subresource == :windows_feature_powershell
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/resource/windows_feature_dism.rb

@@ -1,226 +1,226 @@
-#
-# Author:: Seth Chisamore (<schisamo@chef.io>)
-#
-# Copyright:: 2011-2018, Chef Software, Inc.
-#
-# 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/resource"
-require "chef/platform/query_helpers"
-
-class Chef
-  class Resource
-    class WindowsFeatureDism < Chef::Resource
-      resource_name :windows_feature_dism
-      provides(:windows_feature_dism) { true }
-
-      description "Use the windows_feature_dism resource to add, remove or delete Windows features and roles using DISM"
-      introduced "14.0"
-
-      property :feature_name, [Array, String],
-               description: "The name of the feature(s) or role(s) to install, if it differs from the resource name.",
-               coerce: proc { |x| to_formatted_array(x) },
-               name_property: true
-
-      property :source, String,
-               description: "Specify a local repository for the feature install."
-
-      property :all, [TrueClass, FalseClass],
-               description: "Install all sub-features. When set to 'true', this is the equivalent of specifying the /All switch to dism.exe",
-               default: false
-
-      property :timeout, Integer,
-               description: "Specifies a timeout (in seconds) for feature install.",
-               default: 600
-
-      # @return [Array] lowercase the array unless we're on < Windows 2012
-      def to_formatted_array(x)
-        x = x.split(/\s*,\s*/) if x.is_a?(String) # split multiple forms of a comma separated list
-
-        # feature installs on windows < 2012 are case sensitive so only downcase when on 2012+
-        older_than_win_2012_or_8? ? x : x.map(&:downcase)
-      end
-
-      action :install do
-        description "Install a Windows role/feature using DISM"
-
-        reload_cached_dism_data unless node["dism_features_cache"]
-        fail_if_unavailable # fail if the features don't exist
-        fail_if_removed # fail if the features are in removed state
-
-        logger.trace("Windows features needing installation: #{features_to_install.empty? ? 'none' : features_to_install.join(',')}")
-        unless features_to_install.empty?
-          message = "install Windows feature#{'s' if features_to_install.count > 1} #{features_to_install.join(',')}"
-          converge_by(message) do
-            install_command = "dism.exe /online /enable-feature #{features_to_install.map { |f| "/featurename:#{f}" }.join(' ')} /norestart"
-            install_command << " /LimitAccess /Source:\"#{new_resource.source}\"" if new_resource.source
-            install_command << " /All" if new_resource.all
-
-            shell_out!(install_command, returns: [0, 42, 127, 3010], timeout: new_resource.timeout)
-
-            reload_cached_dism_data # Reload cached dism feature state
-          end
-        end
-      end
-
-      action :remove do
-        description "Remove a Windows role/feature using DISM"
-
-        reload_cached_dism_data unless node["dism_features_cache"]
-
-        logger.trace("Windows features needing removal: #{features_to_remove.empty? ? 'none' : features_to_remove.join(',')}")
-        unless features_to_remove.empty?
-          message = "remove Windows feature#{'s' if features_to_remove.count > 1} #{features_to_remove.join(',')}"
-
-          converge_by(message) do
-            shell_out!("dism.exe /online /disable-feature #{features_to_remove.map { |f| "/featurename:#{f}" }.join(' ')} /norestart", returns: [0, 42, 127, 3010], timeout: new_resource.timeout)
-
-            reload_cached_dism_data # Reload cached dism feature state
-          end
-        end
-      end
-
-      action :delete do
-        description "Remove a Windows role/feature from the image using DISM"
-
-        raise_if_delete_unsupported
-
-        reload_cached_dism_data unless node["dism_features_cache"]
-
-        fail_if_unavailable # fail if the features don't exist
-
-        logger.trace("Windows features needing deletion: #{features_to_delete.empty? ? 'none' : features_to_delete.join(',')}")
-        unless features_to_delete.empty?
-          message = "delete Windows feature#{'s' if features_to_delete.count > 1} #{features_to_delete.join(',')} from the image"
-          converge_by(message) do
-            shell_out!("dism.exe /online /disable-feature #{features_to_delete.map { |f| "/featurename:#{f}" }.join(' ')} /Remove /norestart", returns: [0, 42, 127, 3010], timeout: new_resource.timeout)
-
-            reload_cached_dism_data # Reload cached dism feature state
-          end
-        end
-      end
-
-      action_class do
-        # @return [Array] features the user has requested to install which need installation
-        def features_to_install
-          @install ||= begin
-            # disabled features are always available to install
-            available_for_install = node["dism_features_cache"]["disabled"].dup
-
-            # if the user passes a source then removed features are also available for installation
-            available_for_install.concat(node["dism_features_cache"]["removed"]) if new_resource.source
-
-            # the intersection of the features to install & disabled/removed(if passing source) features are what needs installing
-            new_resource.feature_name & available_for_install
-          end
-        end
-
-        # @return [Array] features the user has requested to remove which need removing
-        def features_to_remove
-          # the intersection of the features to remove & enabled features are what needs removing
-          @remove ||= new_resource.feature_name & node["dism_features_cache"]["enabled"]
-        end
-
-        # @return [Array] features the user has requested to delete which need deleting
-        def features_to_delete
-          # the intersection of the features to remove & enabled/disabled features are what needs removing
-          @remove ||= begin
-            all_available = node["dism_features_cache"]["enabled"] +
-              node["dism_features_cache"]["disabled"]
-            new_resource.feature_name & all_available
-          end
-        end
-
-        # if any features are not supported on this release of Windows or
-        # have been deleted raise with a friendly message. At one point in time
-        # we just warned, but this goes against the behavior of ever other package
-        # provider in Chef and it isn't clear what you'd want if you passed an array
-        # and some features were available and others were not.
-        # @return [void]
-        def fail_if_unavailable
-          all_available = node["dism_features_cache"]["enabled"] +
-            node["dism_features_cache"]["disabled"] +
-            node["dism_features_cache"]["removed"]
-
-          # the difference of desired features to install to all features is what's not available
-          unavailable = (new_resource.feature_name - all_available)
-          raise "The Windows feature#{'s' if unavailable.count > 1} #{unavailable.join(',')} #{unavailable.count > 1 ? 'are' : 'is'} not available on this version of Windows. Run 'dism /online /Get-Features' to see the list of available feature names." unless unavailable.empty?
-        end
-
-        # run dism.exe to get a list of all available features and their state
-        # and save that to the node at node.override level.
-        # We do this because getting a list of features in dism takes at least a second
-        # and this data will be persisted across multiple resource runs which gives us
-        # a much faster run when no features actually need to be installed / removed.
-        # @return [void]
-        def reload_cached_dism_data
-          logger.trace("Caching Windows features available via dism.exe.")
-          node.override["dism_features_cache"] = Mash.new
-          node.override["dism_features_cache"]["enabled"] = []
-          node.override["dism_features_cache"]["disabled"] = []
-          node.override["dism_features_cache"]["removed"] = []
-
-          # Grab raw feature information from dism command line
-          raw_list_of_features = shell_out("dism.exe /Get-Features /Online /Format:Table /English").stdout
-
-          # Split stdout into an array by windows line ending
-          features_list = raw_list_of_features.split("\r\n")
-          features_list.each do |feature_details_raw|
-            case feature_details_raw
-            when /Payload Removed/ # matches 'Disabled with Payload Removed'
-              add_to_feature_mash("removed", feature_details_raw)
-            when /Enable/ # matches 'Enabled' and 'Enable Pending' aka after reboot
-              add_to_feature_mash("enabled", feature_details_raw)
-            when /Disable/ # matches 'Disabled' and 'Disable Pending' aka after reboot
-              add_to_feature_mash("disabled", feature_details_raw)
-            end
-          end
-          logger.trace("The cache contains\n#{node['dism_features_cache']}")
-        end
-
-        # parse the feature string and add the values to the appropriate array
-        # in the
-        # strips trailing whitespace characters then split on n number of spaces
-        # + | +  n number of spaces
-        # @return [void]
-        def add_to_feature_mash(feature_type, feature_string)
-          feature_details = feature_string.strip.split(/\s+[|]\s+/).first
-
-          # dism on windows 2012+ isn't case sensitive so it's best to compare
-          # lowercase lists so the user input doesn't need to be case sensitive
-          # @todo when we're ready to remove windows 2008R2 the gating here can go away
-          feature_details.downcase! unless older_than_win_2012_or_8?
-          node.override["dism_features_cache"][feature_type] << feature_details
-        end
-
-        # Fail if any of the packages are in a removed state
-        # @return [void]
-        def fail_if_removed
-          return if new_resource.source # if someone provides a source then all is well
-          if node["platform_version"].to_f > 6.2 # 2012R2 or later
-            return if registry_key_exists?('HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\Servicing') && registry_value_exists?('HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\Servicing', name: "LocalSourcePath") # if source is defined in the registry, still fine
-          end
-          removed = new_resource.feature_name & node["dism_features_cache"]["removed"]
-          raise "The Windows feature#{'s' if removed.count > 1} #{removed.join(',')} #{removed.count > 1 ? 'are' : 'is'} have been removed from the host and cannot be installed." unless removed.empty?
-        end
-
-        # Fail unless we're on windows 8+ / 2012+ where deleting a feature is supported
-        # @return [void]
-        def raise_if_delete_unsupported
-          raise Chef::Exceptions::UnsupportedAction, "#{self} :delete action not supported on Windows releases before Windows 8/2012. Cannot continue!" if older_than_win_2012_or_8?
-        end
-      end
-    end
-  end
-end
+#
+# Author:: Seth Chisamore (<schisamo@chef.io>)
+#
+# Copyright:: 2011-2018, Chef Software, Inc.
+#
+# 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/resource"
+require "chef/platform/query_helpers"
+
+class Chef
+  class Resource
+    class WindowsFeatureDism < Chef::Resource
+      resource_name :windows_feature_dism
+      provides(:windows_feature_dism) { true }
+
+      description "Use the windows_feature_dism resource to add, remove or delete Windows features and roles using DISM"
+      introduced "14.0"
+
+      property :feature_name, [Array, String],
+               description: "The name of the feature(s) or role(s) to install, if it differs from the resource name.",
+               coerce: proc { |x| to_formatted_array(x) },
+               name_property: true
+
+      property :source, String,
+               description: "Specify a local repository for the feature install."
+
+      property :all, [TrueClass, FalseClass],
+               description: "Install all sub-features. When set to 'true', this is the equivalent of specifying the /All switch to dism.exe",
+               default: false
+
+      property :timeout, Integer,
+               description: "Specifies a timeout (in seconds) for feature install.",
+               default: 600
+
+      # @return [Array] lowercase the array unless we're on < Windows 2012
+      def to_formatted_array(x)
+        x = x.split(/\s*,\s*/) if x.is_a?(String) # split multiple forms of a comma separated list
+
+        # feature installs on windows < 2012 are case sensitive so only downcase when on 2012+
+        older_than_win_2012_or_8? ? x : x.map(&:downcase)
+      end
+
+      action :install do
+        description "Install a Windows role/feature using DISM"
+
+        reload_cached_dism_data unless node["dism_features_cache"]
+        fail_if_unavailable # fail if the features don't exist
+        fail_if_removed # fail if the features are in removed state
+
+        logger.trace("Windows features needing installation: #{features_to_install.empty? ? 'none' : features_to_install.join(',')}")
+        unless features_to_install.empty?
+          message = "install Windows feature#{'s' if features_to_install.count > 1} #{features_to_install.join(',')}"
+          converge_by(message) do
+            install_command = "dism.exe /online /enable-feature #{features_to_install.map { |f| "/featurename:#{f}" }.join(' ')} /norestart"
+            install_command << " /LimitAccess /Source:\"#{new_resource.source}\"" if new_resource.source
+            install_command << " /All" if new_resource.all
+
+            shell_out!(install_command, returns: [0, 42, 127, 3010], timeout: new_resource.timeout)
+
+            reload_cached_dism_data # Reload cached dism feature state
+          end
+        end
+      end
+
+      action :remove do
+        description "Remove a Windows role/feature using DISM"
+
+        reload_cached_dism_data unless node["dism_features_cache"]
+
+        logger.trace("Windows features needing removal: #{features_to_remove.empty? ? 'none' : features_to_remove.join(',')}")
+        unless features_to_remove.empty?
+          message = "remove Windows feature#{'s' if features_to_remove.count > 1} #{features_to_remove.join(',')}"
+
+          converge_by(message) do
+            shell_out!("dism.exe /online /disable-feature #{features_to_remove.map { |f| "/featurename:#{f}" }.join(' ')} /norestart", returns: [0, 42, 127, 3010], timeout: new_resource.timeout)
+
+            reload_cached_dism_data # Reload cached dism feature state
+          end
+        end
+      end
+
+      action :delete do
+        description "Remove a Windows role/feature from the image using DISM"
+
+        raise_if_delete_unsupported
+
+        reload_cached_dism_data unless node["dism_features_cache"]
+
+        fail_if_unavailable # fail if the features don't exist
+
+        logger.trace("Windows features needing deletion: #{features_to_delete.empty? ? 'none' : features_to_delete.join(',')}")
+        unless features_to_delete.empty?
+          message = "delete Windows feature#{'s' if features_to_delete.count > 1} #{features_to_delete.join(',')} from the image"
+          converge_by(message) do
+            shell_out!("dism.exe /online /disable-feature #{features_to_delete.map { |f| "/featurename:#{f}" }.join(' ')} /Remove /norestart", returns: [0, 42, 127, 3010], timeout: new_resource.timeout)
+
+            reload_cached_dism_data # Reload cached dism feature state
+          end
+        end
+      end
+
+      action_class do
+        # @return [Array] features the user has requested to install which need installation
+        def features_to_install
+          @install ||= begin
+            # disabled features are always available to install
+            available_for_install = node["dism_features_cache"]["disabled"].dup
+
+            # if the user passes a source then removed features are also available for installation
+            available_for_install.concat(node["dism_features_cache"]["removed"]) if new_resource.source
+
+            # the intersection of the features to install & disabled/removed(if passing source) features are what needs installing
+            new_resource.feature_name & available_for_install
+          end
+        end
+
+        # @return [Array] features the user has requested to remove which need removing
+        def features_to_remove
+          # the intersection of the features to remove & enabled features are what needs removing
+          @remove ||= new_resource.feature_name & node["dism_features_cache"]["enabled"]
+        end
+
+        # @return [Array] features the user has requested to delete which need deleting
+        def features_to_delete
+          # the intersection of the features to remove & enabled/disabled features are what needs removing
+          @remove ||= begin
+            all_available = node["dism_features_cache"]["enabled"] +
+              node["dism_features_cache"]["disabled"]
+            new_resource.feature_name & all_available
+          end
+        end
+
+        # if any features are not supported on this release of Windows or
+        # have been deleted raise with a friendly message. At one point in time
+        # we just warned, but this goes against the behavior of ever other package
+        # provider in Chef and it isn't clear what you'd want if you passed an array
+        # and some features were available and others were not.
+        # @return [void]
+        def fail_if_unavailable
+          all_available = node["dism_features_cache"]["enabled"] +
+            node["dism_features_cache"]["disabled"] +
+            node["dism_features_cache"]["removed"]
+
+          # the difference of desired features to install to all features is what's not available
+          unavailable = (new_resource.feature_name - all_available)
+          raise "The Windows feature#{'s' if unavailable.count > 1} #{unavailable.join(',')} #{unavailable.count > 1 ? 'are' : 'is'} not available on this version of Windows. Run 'dism /online /Get-Features' to see the list of available feature names." unless unavailable.empty?
+        end
+
+        # run dism.exe to get a list of all available features and their state
+        # and save that to the node at node.override level.
+        # We do this because getting a list of features in dism takes at least a second
+        # and this data will be persisted across multiple resource runs which gives us
+        # a much faster run when no features actually need to be installed / removed.
+        # @return [void]
+        def reload_cached_dism_data
+          logger.trace("Caching Windows features available via dism.exe.")
+          node.override["dism_features_cache"] = Mash.new
+          node.override["dism_features_cache"]["enabled"] = []
+          node.override["dism_features_cache"]["disabled"] = []
+          node.override["dism_features_cache"]["removed"] = []
+
+          # Grab raw feature information from dism command line
+          raw_list_of_features = shell_out("dism.exe /Get-Features /Online /Format:Table /English").stdout
+
+          # Split stdout into an array by windows line ending
+          features_list = raw_list_of_features.split("\r\n")
+          features_list.each do |feature_details_raw|
+            case feature_details_raw
+            when /Payload Removed/ # matches 'Disabled with Payload Removed'
+              add_to_feature_mash("removed", feature_details_raw)
+            when /Enable/ # matches 'Enabled' and 'Enable Pending' aka after reboot
+              add_to_feature_mash("enabled", feature_details_raw)
+            when /Disable/ # matches 'Disabled' and 'Disable Pending' aka after reboot
+              add_to_feature_mash("disabled", feature_details_raw)
+            end
+          end
+          logger.trace("The cache contains\n#{node['dism_features_cache']}")
+        end
+
+        # parse the feature string and add the values to the appropriate array
+        # in the
+        # strips trailing whitespace characters then split on n number of spaces
+        # + | +  n number of spaces
+        # @return [void]
+        def add_to_feature_mash(feature_type, feature_string)
+          feature_details = feature_string.strip.split(/\s+[|]\s+/).first
+
+          # dism on windows 2012+ isn't case sensitive so it's best to compare
+          # lowercase lists so the user input doesn't need to be case sensitive
+          # @todo when we're ready to remove windows 2008R2 the gating here can go away
+          feature_details.downcase! unless older_than_win_2012_or_8?
+          node.override["dism_features_cache"][feature_type] << feature_details
+        end
+
+        # Fail if any of the packages are in a removed state
+        # @return [void]
+        def fail_if_removed
+          return if new_resource.source # if someone provides a source then all is well
+          if node["platform_version"].to_f > 6.2 # 2012R2 or later
+            return if registry_key_exists?('HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\Servicing') && registry_value_exists?('HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\Servicing', name: "LocalSourcePath") # if source is defined in the registry, still fine
+          end
+          removed = new_resource.feature_name & node["dism_features_cache"]["removed"]
+          raise "The Windows feature#{'s' if removed.count > 1} #{removed.join(',')} #{removed.count > 1 ? 'are' : 'is'} removed from the host and cannot be installed." unless removed.empty?
+        end
+
+        # Fail unless we're on windows 8+ / 2012+ where deleting a feature is supported
+        # @return [void]
+        def raise_if_delete_unsupported
+          raise Chef::Exceptions::UnsupportedAction, "#{self} :delete action not supported on Windows releases before Windows 8/2012. Cannot continue!" if older_than_win_2012_or_8?
+        end
+      end
+    end
+  end
+end