chef 12.1.2 → 12.2.0.rc.1

data/lib/chef/provider/dsc_resource.rb

@@ -0,0 +1,157 @@
+#
+# Author:: Adam Edwards (<adamed@getchef.com>)
+#
+# Copyright:: 2014, 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/util/powershell/cmdlet'
+require 'chef/util/dsc/local_configuration_manager'
+require 'chef/mixin/powershell_type_coercions'
+require 'chef/util/dsc/resource_store'
+
+class Chef
+  class Provider
+    class DscResource < Chef::Provider
+      include Chef::Mixin::PowershellTypeCoercions
+
+      provides :dsc_resource, os: "windows"
+
+      def initialize(new_resource, run_context)
+        super
+        @new_resource = new_resource
+        @module_name = new_resource.module_name
+      end
+
+      def action_run
+        if ! test_resource
+          converge_by(generate_description) do
+            result = set_resource
+          end
+        end
+      end
+
+      def load_current_resource
+      end
+
+      def whyrun_supported?
+        true
+      end
+
+      def define_resource_requirements
+        requirements.assert(:run) do |a|
+          a.assertion { supports_dsc_invoke_resource? }
+          err = ["You must have Powershell version >= 5.0.10018.0 to use dsc_resource."]
+          a.failure_message Chef::Exceptions::NoProviderAvailable,
+            err
+          a.whyrun err + ["Assuming a previous resource installs Powershell 5.0.10018.0 or higher."]
+          a.block_action!
+        end
+        requirements.assert(:run) do |a|
+          a.assertion {
+            meta_configuration['RefreshMode'] == 'Disabled'
+          }
+          err = ["The LCM must have its RefreshMode set to Disabled. "]
+          a.failure_message Chef::Exceptions::NoProviderAvailable, err.join(' ')
+          a.whyrun err + ["Assuming a previous resource sets the RefreshMode."]
+          a.block_action!
+        end
+      end
+
+      protected
+
+      def local_configuration_manager
+        @local_configuration_manager ||= Chef::Util::DSC::LocalConfigurationManager.new(
+          node,
+          nil
+        )
+      end
+
+      def resource_store
+        Chef::Util::DSC::ResourceStore.instance
+      end
+
+      def supports_dsc_invoke_resource?
+        run_context && Chef::Platform.supports_dsc_invoke_resource?(node)
+      end
+
+      def generate_description
+        @converge_description
+      end
+
+      def dsc_resource_name
+        new_resource.resource.to_s
+      end
+
+      def module_name
+        @module_name ||= begin
+          found = resource_store.find(dsc_resource_name)
+
+          r = case found.length
+              when 0
+                raise Chef::Exceptions::ResourceNotFound,
+                  "Could not find #{dsc_resource_name}. Check to make "\
+                  "sure that it shows up when running Get-DscResource"
+              when 1
+                if found[0]['Module'].nil?
+                  :none
+                else
+                  found[0]['Module']
+                end
+              else
+                raise Chef::Exceptions::MultipleDscResourcesFound, found
+              end
+        end
+      end
+
+      def test_resource
+        result = invoke_resource(:test)
+        # We really want this information from the verbose stream,
+        # however Invoke-DscResource is not correctly writing to that
+        # stream and instead just dumping to stdout
+        @converge_description = result.stdout
+        result.return_value[0]["InDesiredState"]
+      end
+
+      def set_resource
+        result = invoke_resource(:set)
+        result.return_value
+      end
+
+      def invoke_resource(method, output_format=:object)
+        properties = translate_type(@new_resource.properties)
+        switches = "-Method #{method.to_s} -Name #{@new_resource.resource}"\
+                   " -Property #{properties} -Verbose"
+
+        if module_name != :none
+          switches += " -Module #{module_name}"
+        end
+
+        cmdlet = Chef::Util::Powershell::Cmdlet.new(
+          node,
+          "Invoke-DscResource #{switches}",
+          output_format
+        )
+        cmdlet.run!
+      end
+
+      def meta_configuration
+        cmdlet = Chef::Util::Powershell::Cmdlet.new(node, "Get-DscLocalConfigurationManager", :object)
+        result = cmdlet.run!
+        result.return_value
+      end
+
+    end
+  end
+end

data/lib/chef/provider/env.rb

@@ -26,6 +26,8 @@ class Chef
       include Chef::Mixin::Command
       attr_accessor :key_exists
 
+      provides :env, os: "!windows"
+
       def initialize(new_resource, run_context)
         super
         @key_exists = true

data/lib/chef/provider/env/windows.rb

@@ -24,6 +24,8 @@ class Chef
       class Windows < Chef::Provider::Env
         include Chef::Mixin::WindowsEnvHelper
 
+        provides :env, os: "windows"
+
         def create_env
           obj = env_obj(@new_resource.key_name)
           unless obj

data/lib/chef/provider/git.rb

@@ -39,6 +39,10 @@ class Chef
         end
       end
 
+      def additional_remotes
+        new_resource.additional_remotes || {}
+      end
+
       def define_resource_requirements
         # Parent directory of the target must exist.
         requirements.assert(:checkout, :sync) do |a|

data/lib/chef/provider/group.rb

@@ -125,13 +125,13 @@ class Chef
       def action_create
         case @group_exists
         when false
-          converge_by("create #{@new_resource}") do
+          converge_by("create #{@new_resource.group_name}") do
             create_group
             Chef::Log.info("#{@new_resource} created")
           end
         else
           if compare_group
-            converge_by(["alter group #{@new_resource}"] + change_desc) do
+            converge_by(["alter group #{@new_resource.group_name}"] + change_desc) do
               manage_group
               Chef::Log.info("#{@new_resource} altered")
             end
@@ -141,7 +141,7 @@ class Chef
 
       def action_remove
         if @group_exists
-          converge_by("remove group #{@new_resource}") do
+          converge_by("remove group #{@new_resource.group_name}") do
             remove_group
             Chef::Log.info("#{@new_resource} removed")
           end
@@ -150,7 +150,7 @@ class Chef
 
       def action_manage
         if @group_exists && compare_group
-          converge_by(["manage group #{@new_resource}"] + change_desc) do
+          converge_by(["manage group #{@new_resource.group_name}"] + change_desc) do
             manage_group
             Chef::Log.info("#{@new_resource} managed")
           end
@@ -159,7 +159,7 @@ class Chef
 
       def action_modify
         if compare_group
-          converge_by(["modify group #{@new_resource}"] + change_desc) do
+          converge_by(["modify group #{@new_resource.group_name}"] + change_desc) do
             manage_group
             Chef::Log.info("#{@new_resource} modified")
           end

data/lib/chef/provider/group/dscl.rb

@@ -21,6 +21,8 @@ class Chef
     class Group
       class Dscl < Chef::Provider::Group
 
+        provides :group, os: "darwin"
+
         def dscl(*args)
           host = "."
           stdout_result = ""; stderr_result = ""; cmd = "dscl #{host} -#{args.join(' ')}"

data/lib/chef/provider/group/groupmod.rb

@@ -21,6 +21,8 @@ class Chef
     class Group
       class Groupmod < Chef::Provider::Group
 
+        provides :group, os: "netbsd"
+
         def load_current_resource
           super
           [ "group", "user" ].each do |binary|

data/lib/chef/provider/group/usermod.rb

@@ -23,6 +23,8 @@ class Chef
     class Group
       class Usermod < Chef::Provider::Group::Groupadd
 
+        provides :group, os: "openbsd"
+
         def load_current_resource
           super
         end

data/lib/chef/provider/group/windows.rb

@@ -26,6 +26,8 @@ class Chef
     class Group
       class Windows < Chef::Provider::Group
 
+        provides :group, os: "windows"
+
         def initialize(new_resource,run_context)
           super
           @net_group = Chef::Util::Windows::NetGroup.new(@new_resource.group_name)

data/lib/chef/provider/mdadm.rb

@@ -23,6 +23,8 @@ class Chef
   class Provider
     class Mdadm < Chef::Provider
 
+      provides :mdadm
+
       def popen4
         raise Exception, "deprecated"
       end

data/lib/chef/provider/mount/windows.rb

@@ -27,6 +27,8 @@ class Chef
     class Mount
       class Windows < Chef::Provider::Mount
 
+        provides :mount, os: "windows"
+
         def is_volume(name)
           name =~ /^\\\\\?\\Volume\{[\w-]+\}\\$/ ? true : false
         end

data/lib/chef/provider/package/homebrew.rb

@@ -27,7 +27,7 @@ class Chef
       class Homebrew < Chef::Provider::Package
 
         provides :homebrew_package
-        provides :package, os: ["mac_os_x", "darwin"]
+        provides :package, os: "darwin"
 
         include Chef::Mixin::HomebrewUser
 

data/lib/chef/provider/package/openbsd.rb

@@ -24,6 +24,7 @@ require 'chef/resource/package'
 require 'chef/provider/package'
 require 'chef/mixin/shell_out'
 require 'chef/mixin/get_source_from_package'
+require 'chef/exceptions'
 
 class Chef
   class Provider
@@ -37,25 +38,42 @@ class Chef
 
         def initialize(*args)
           super
-          @current_resource = Chef::Resource::Package.new(@new_resource.name)
-          @new_resource.source(pkg_path) if !@new_resource.source
+          @current_resource = Chef::Resource::Package.new(new_resource.name)
         end
 
         def load_current_resource
-          @current_resource.package_name(@new_resource.package_name)
+          @current_resource.package_name(new_resource.package_name)
           @current_resource.version(installed_version)
           @current_resource
         end
 
+        def define_resource_requirements
+          super
+
+          # Below are incomplete/missing features for this package provider
+          requirements.assert(:all_actions) do |a|
+            a.assertion { !new_resource.source }
+            a.failure_message(Chef::Exceptions::Package, 'The openbsd package provider does not support the source attribute')
+          end
+          requirements.assert(:all_actions) do |a|
+            a.assertion do
+              if new_resource.package_name =~ /^(.+?)--(.+)/
+                !new_resource.version
+              else
+                true
+              end
+            end
+            a.failure_message(Chef::Exceptions::Package, 'The openbsd package provider does not support providing a version and flavor')
+          end
+        end
+
         def install_package(name, version)
           unless @current_resource.version
-            version_string  = ''
-            version_string += "-#{version}" if version
             if parts = name.match(/^(.+?)--(.+)/) # use double-dash for stems with flavors, see man page for pkg_add
               name = parts[1]
             end
-            shell_out!("pkg_add -r #{name}#{version_string}", :env => {"PKG_PATH" => @new_resource.source}).status
-            Chef::Log.debug("#{@new_resource} installed from: #{@new_resource.source}")
+            shell_out!("pkg_add -r #{name}#{version_string}", :env => {"PKG_PATH" => pkg_path}).status
+            Chef::Log.debug("#{new_resource.package_name} installed")
           end
         end
 
@@ -71,32 +89,45 @@ class Chef
         private
 
         def installed_version
-          if parts = @new_resource.package_name.match(/^(.+?)--(.+)/)
+          if parts = new_resource.package_name.match(/^(.+?)--(.+)/)
             name = parts[1]
           else
-            name = @new_resource.package_name
+            name = new_resource.package_name
           end
           pkg_info = shell_out!("pkg_info -e \"#{name}->0\"", :env => nil, :returns => [0,1])
           result = pkg_info.stdout[/^inst:#{Regexp.escape(name)}-(.+?)\s/, 1]
-          Chef::Log.debug("installed_version of '#{@new_resource.package_name}' is '#{result}'")
+          Chef::Log.debug("installed_version of '#{new_resource.package_name}' is '#{result}'")
           result
         end
 
         def candidate_version
           @candidate_version ||= begin
-            version_string  = ''
-            version_string += "-#{version}" if @new_resource.version
-            pkg_info = shell_out!("pkg_info -I \"#{@new_resource.package_name}#{version_string}\"", :env => nil, :returns => [0,1])
-            if parts = @new_resource.package_name.match(/^(.+?)--(.+)/)
-              result = pkg_info.stdout[/^#{Regexp.escape(parts[1])}-(.+?)\s/, 1]
+            results = []
+            shell_out!("pkg_info -I \"#{new_resource.package_name}#{version_string}\"", :env => nil, :returns => [0,1]).stdout.each_line do |line|
+              if parts = new_resource.package_name.match(/^(.+?)--(.+)/)
+                results << line[/^#{Regexp.escape(parts[1])}-(.+?)\s/, 1]
+              else
+                results << line[/^#{Regexp.escape(new_resource.package_name)}-(.+?)\s/, 1]
+              end
+            end
+            results = results.reject(&:nil?)
+            Chef::Log.debug("candidate versions of '#{new_resource.package_name}' are '#{results}'")
+            case results.length
+            when 0
+              []
+            when 1
+              results[0]
             else
-              result = pkg_info.stdout[/^#{Regexp.escape(@new_resource.package_name)}-(.+?)\s/, 1]
+              raise Chef::Exceptions::Package, "#{new_resource.name} has multiple matching candidates. Please use a more specific name" if results.length > 1
             end
-            Chef::Log.debug("candidate_version of '#{@new_resource.package_name}' is '#{result}'")
-            result
           end
         end
 
+        def version_string
+          ver  = ''
+          ver += "-#{new_resource.version}" if new_resource.version
+        end
+
         def pkg_path
           ENV['PKG_PATH'] || "http://ftp.OpenBSD.org/pub/#{node.kernel.name}/#{node.kernel.release}/packages/#{node.kernel.machine}/"
         end

data/lib/chef/provider/package/rubygems.rb

@@ -380,8 +380,13 @@ class Chef
             # Opscode Omnibus - The ruby that ships inside omnibus is only used for Chef
             # Default to installing somewhere more functional
             if new_resource.options && new_resource.options.kind_of?(Hash)
-              msg = "options should be a string instead of a hash\n"
-              msg << "in #{new_resource} from #{new_resource.source_line}"
+              msg = [
+                "Gem options must be passed to gem_package as a string instead of a hash when",
+                "using this installation of Chef because it runs with its own packaged Ruby. A hash",
+                "may only be used when installing a gem to the same Ruby installation that Chef is",
+                "running under.  See https://docs.chef.io/resource_gem_package.html for more information.",
+                "Error raised at #{new_resource} from #{new_resource.source_line}",
+              ].join("\n")
               raise ArgumentError, msg
             end
             gem_location = find_gem_by_path

data/lib/chef/provider/powershell_script.rb

@@ -22,6 +22,8 @@ class Chef
   class Provider
     class PowershellScript < Chef::Provider::WindowsScript
 
+      provides :powershell_script, os: "windows"
+
       protected
       EXIT_STATUS_EXCEPTION_HANDLER = "\ntrap [Exception] {write-error -exception ($_.Exception.Message);exit 1}".freeze
       EXIT_STATUS_NORMALIZATION_SCRIPT = "\nif ($? -ne $true) { if ( $LASTEXITCODE ) {exit $LASTEXITCODE} else { exit 1 }}".freeze

data/lib/chef/provider/service/macosx.rb

@@ -33,8 +33,7 @@ class Chef
                          /Library/LaunchDaemons
                          /System/Library/LaunchAgents
                          /System/Library/LaunchDaemons }
-
-          locations << "#{ENV['HOME']}/Library/LaunchAgents" if ENV['HOME']
+          Chef::Util::PathHelper.home('Library', 'LaunchAgents') { |p| locations << p }
           locations
         end