Class: Chef::Resource::DscScript

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

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, #ignore_failure, #not_if_args, #only_if_args, #params, #recipe_name, #resource_name, #retries, #retry_delay, #run_context, #sensitive, #source_line, #updated

Instance Method Summary collapse

Methods inherited from Chef::Resource

#action, #after_created, #as_json, #cookbook_version, #custom_exception_message, #customize_exception, #declared_key, #defined_at, #delayed_notifications, dsl_name, #epic_fail, #events, #guard_interpreter, #identity, identity_attr, #immediate_notifications, #inspect, #is, json_create, #load_from, #method_missing, #name, #node, node_map, #noop, #not_if, #notifies, #notifies_delayed, #notifies_immediately, #only_if, #provider, #provider=, provider_base, #provider_for_action, provides, #resolve_notification_references, resource_for_node, resource_matching_short_name, #resources, #run_action, #should_skip?, #state, state_attrs, #subscribes, #supports, #supports=, #to_hash, #to_json, #to_s, #to_text, #updated?, #updated_by_last_action, #updated_by_last_action?, #validate_action, #validate_resource_spec!

Methods included from Mixin::ConvertToClassName

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

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::Deprecation

#deprecated_ivar

Methods included from Mixin::ParamsValidate

#lazy, #set_or_return, #validate

Methods included from DSL::RebootPending

#reboot_pending?

Methods included from DSL::PlatformIntrospection

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

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.



27
28
29
30
31
32
33
 
# File 'lib/chef/resource/dsc_script.rb', line 27

def initialize(name, run_context=nil)
  super
  @allowed_actions.push(:run)
  @action = :run
  @resource_name = :dsc_script
  @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 



35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/chef/resource/dsc_script.rb', line 35

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 



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/chef/resource/dsc_script.rb', line 60

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 



71
72
73
74
75
76
77
78
79
80
 
# File 'lib/chef/resource/dsc_script.rb', line 71

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 



82
83
84
85
86
87
88
89
90
91
 
# File 'lib/chef/resource/dsc_script.rb', line 82

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 



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/chef/resource/dsc_script.rb', line 49

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 



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

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

#environment(arg = nil) ⇒ Object 



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

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

#flags(arg = nil) ⇒ Object 



106
107
108
109
110
111
112
 
# File 'lib/chef/resource/dsc_script.rb', line 106

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

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



93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/chef/resource/dsc_script.rb', line 93

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 



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

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