Class: Chef::Resource::DscScript

Inherits:
Chef::Resource show all
Includes:
DSL::Powershell
Defined in:
lib/chef/resource/dsc_script.rb

Overview

Many DSC resources are comparable to built-in Chef resources. For example, both DSC and Chef have file, package, and service resources. The dsc_script resource is most useful for those DSC resources that do not have a direct comparison to a resource in Chef, such as the Archive resource, a custom DSC resource, an existing DSC script that performs an important task, and so on. Use the dsc_script resource to embed the code that defines a DSC configuration directly within a Chef recipe.

Constant Summary

Constants inherited from Chef::Resource

FORBIDDEN_IVARS, HIDDEN_IVARS

Instance Attribute Summary

Attributes inherited from Chef::Resource

#allowed_actions, #cookbook_name, #declared_type, #default_guard_interpreter, #elapsed_time, #enclosing_provider, #params, #recipe_name, #resource_initializing, #run_context, #source_line, #updated

Instance Method Summary collapse

Methods included from DSL::Powershell

#ps_credential

Methods inherited from Chef::Resource

action, #action, #action=, action_class, #after_created, allowed_actions, allowed_actions=, #as_json, #before_notifications, #cookbook_version, #current_value, #current_value_does_not_exist!, #custom_exception_message, custom_resource?, #customize_exception, declare_action_class, #declared_key, default_action, default_action=, #defined_at, #delayed_action, #delayed_notifications, #events, from_hash, from_json, #guard_interpreter, #identity, identity_attr, identity_property, #ignore_failure, #immediate_notifications, inherited, #inspect, is_custom_resource!, json_create, load_current_value, #load_from, #lookup_provider_constant, #method_missing, #name, #node, #not_if, #notifies, #notifies_before, #notifies_delayed, #notifies_immediately, #only_if, #provider, #provider=, #provider_for_action, provides, provides?, remove_canonical_dsl, #resolve_notification_references, resource_for_node, resource_matching_short_name, #resource_name, resource_name, resource_name=, #resources, #retries, #retry_delay, #run_action, #sensitive, #should_skip?, sorted_descendants, #source_line_file, #source_line_number, state_attrs, #state_for_resource_reporter, #subscribes, #to_hash, #to_json, #to_s, #to_text, #updated?, #updated_by_last_action, #updated_by_last_action?, use_automatic_resource_name, #validate_action, #validate_resource_spec!, #value_to_text

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 Mixin::ConvertToClassName

#constantize, #convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #normalize_snake_case_name, #snake_case_basename

Methods included from Mixin::Deprecation

#deprecated_attr, #deprecated_attr_reader, #deprecated_attr_writer, #deprecated_ivar

Methods included from Mixin::Properties

included, #property_is_set?, #reset_property

Methods included from Mixin::ParamsValidate

#lazy, #set_or_return, #validate

Methods included from Mixin::ShellOut

#a_to_s, #clean_array, #shell_out, #shell_out!, #shell_out_compact, #shell_out_compact!, #shell_out_compact_timeout, #shell_out_compact_timeout!, #shell_out_with_systems_locale, #shell_out_with_systems_locale!

Methods included from Mixin::PathSanity

#enforce_path_sanity, #sanitized_path

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

Methods included from DSL::RebootPending

#reboot_pending?

Methods included from DSL::RegistryHelper

#registry_data_exists?, #registry_get_subkeys, #registry_get_values, #registry_has_subkeys?, #registry_key_exists?, #registry_value_exists?

Methods included from DSL::DataQuery

#data_bag, #data_bag_item, #search

Methods included from EncryptedDataBagItem::CheckEncrypted

#encrypted?

Constructor Details

#initialize(name, run_context = nil) ⇒ DscScript

Returns a new instance of DscScript.



37
38
39
40
 
# File 'lib/chef/resource/dsc_script.rb', line 37

def initialize(name, run_context = nil)
  super
  @imports = {}
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Chef::Resource

Instance Method Details

#code(arg = nil) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/chef/resource/dsc_script.rb', line 42

def code(arg = nil)
  if arg && command
    raise ArgumentError, "Only one of 'code' and 'command' attributes may be specified"
  end
  if arg && configuration_name
    raise ArgumentError, "The 'code' and 'command' attributes may not be used together"
  end
  set_or_return(
    :code,
    arg,
    :kind_of => [ String ]
  )
end

#command(arg = nil) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/chef/resource/dsc_script.rb', line 67

def command(arg = nil)
  if arg && code
    raise ArgumentError, "The 'code' and 'command' attributes may not be used together"
  end
  set_or_return(
    :command,
    arg,
    :kind_of => [ String ]
  )
end

#configuration_data(arg = nil) ⇒ Object 



78
79
80
81
82
83
84
85
86
87
 
# File 'lib/chef/resource/dsc_script.rb', line 78

def configuration_data(arg = nil)
  if arg && configuration_data_script
    raise ArgumentError, "The 'configuration_data' and 'configuration_data_script' attributes may not be used together"
  end
  set_or_return(
    :configuration_data,
    arg,
    :kind_of => [ String ]
  )
end

#configuration_data_script(arg = nil) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
 
# File 'lib/chef/resource/dsc_script.rb', line 89

def configuration_data_script(arg = nil)
  if arg && configuration_data
    raise ArgumentError, "The 'configuration_data' and 'configuration_data_script' attributes may not be used together"
  end
  set_or_return(
    :configuration_data_script,
    arg,
    :kind_of => [ String ]
  )
end

#configuration_name(arg = nil) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
 
# File 'lib/chef/resource/dsc_script.rb', line 56

def configuration_name(arg = nil)
  if arg && code
    raise ArgumentError, "Attribute `configuration_name` may not be set if `code` is set"
  end
  set_or_return(
    :configuration_name,
    arg,
    :kind_of => [ String ]
  )
end

#cwd(arg = nil) ⇒ Object 



121
122
123
124
125
126
127
 
# File 'lib/chef/resource/dsc_script.rb', line 121

def cwd(arg = nil)
  set_or_return(
    :cwd,
    arg,
    :kind_of => [ String ]
  )
end

#environment(arg = nil) ⇒ Object 



129
130
131
132
133
134
135
 
# File 'lib/chef/resource/dsc_script.rb', line 129

def environment(arg = nil)
  set_or_return(
    :environment,
    arg,
    :kind_of => [ Hash ]
  )
end

#flags(arg = nil) ⇒ Object 



113
114
115
116
117
118
119
 
# File 'lib/chef/resource/dsc_script.rb', line 113

def flags(arg = nil)
  set_or_return(
    :flags,
    arg,
    :kind_of => [ Hash ]
  )
end

#imports(module_name = nil, *args) ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/chef/resource/dsc_script.rb', line 100

def imports(module_name = nil, *args)
  if module_name
    @imports[module_name] ||= []
    if args.length == 0
      @imports[module_name] << "*"
    else
      @imports[module_name].push(*args)
    end
  else
    @imports
  end
end

#timeout(arg = nil) ⇒ Object 



137
138
139
140
141
142
143
 
# File 'lib/chef/resource/dsc_script.rb', line 137

def timeout(arg = nil)
  set_or_return(
    :timeout,
    arg,
    :kind_of => [ Integer ]
  )
end