Class: Chef::Provider::DscResource

Inherits:
Chef::Provider show all
Includes:
Mixin::PowershellTypeCoercions
Defined in:
lib/chef/provider/dsc_resource.rb

Constant Summary

Constants included from Mixin::ShellOut

Mixin::ShellOut::DEPRECATED_OPTIONS

Instance Attribute Summary

Attributes inherited from Chef::Provider

#action, #cookbook_name, #current_resource, #new_resource, #recipe_name, #run_context

Instance Method Summary collapse

Methods included from Mixin::PowershellTypeCoercions

#translate_type, #type_coercions

Methods inherited from Chef::Provider

#action_nothing, #check_resource_semantics!, #cleanup_after_converge, #converge_by, #converge_if_changed, #events, include_resource_dsl, include_resource_dsl_module, #node, #process_resource_requirements, provides, provides?, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, use_inline_resources, #whyrun_mode?

Methods included from Mixin::Provides

#provided_as, #provides, #provides?

Methods included from Mixin::DescendantsTracker

#descendants, descendants, direct_descendants, #direct_descendants, find_descendants_by_name, #find_descendants_by_name, #inherited, store_inherited

Methods included from DeprecatedLWRPClass

#const_missing, #deprecated_constants, #register_deprecated_lwrp_class

Methods included from Mixin::LazyModuleInclude

#descendants, #include, #included

Methods included from Mixin::NotifyingBlock

#notifying_block, #subcontext_block

Methods included from DSL::DeclareResource

#build_resource, #declare_resource, #delete_resource, #delete_resource!, #edit_resource, #edit_resource!, #find_resource, #find_resource!, #with_run_context

Methods included from Mixin::ShellOut

#run_command_compatible_options, #shell_out, #shell_out!, #shell_out_with_systems_locale, #shell_out_with_systems_locale!

Methods included from Mixin::PowershellOut

#powershell_out, #powershell_out!

Methods included from Mixin::WindowsArchitectureHelper

#assert_valid_windows_architecture!, #disable_wow64_file_redirection, #forced_32bit_override_required?, #is_i386_process_on_x86_64_windows?, #node_supports_windows_architecture?, #node_windows_architecture, #restore_wow64_file_redirection, #valid_windows_architecture?, #with_os_architecture, #wow64_architecture_override_required?, #wow64_directory

Methods included from DSL::PlatformIntrospection

#docker?, #platform?, #platform_family?, #value_for_platform, #value_for_platform_family

Constructor Details

#initialize(new_resource, run_context) ⇒ DscResource

Returns a new instance of DscResource.



28
29
30
31
32
33
# File 'lib/chef/provider/dsc_resource.rb', line 28

def initialize(new_resource, run_context)
  super
  @new_resource = new_resource
  @module_name = new_resource.module_name
  @reboot_resource = nil
end

Instance Method Details

#action_runObject



35
36
37
38
39
40
41
42
# File 'lib/chef/provider/dsc_resource.rb', line 35

def action_run
  if ! test_resource
    converge_by(generate_description) do
      result = set_resource
      reboot_if_required
    end
  end
end

#define_resource_requirementsObject



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# File 'lib/chef/provider/dsc_resource.rb', line 51

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::ProviderNotFound,
      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 { supports_refresh_mode_enabled? || dsc_refresh_mode_disabled? }
    err = ["The LCM must have its RefreshMode set to Disabled for" \
           " PowerShell versions before 5.0.10586.0."]
    a.failure_message Chef::Exceptions::ProviderNotFound, err.join(" ")
    a.whyrun err + ["Assuming a previous resource sets the RefreshMode."]
    a.block_action!
  end
end

#load_current_resourceObject



44
45
# File 'lib/chef/provider/dsc_resource.rb', line 44

def load_current_resource
end

#whyrun_supported?Boolean

Returns:

  • (Boolean)


47
48
49
# File 'lib/chef/provider/dsc_resource.rb', line 47

def whyrun_supported?
  true
end