Class: Chef::Resource::Execute

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

Direct Known Subclasses

Script

Constant Summary

Constants inherited from Chef::Resource

FORBIDDEN_IVARS, HIDDEN_IVARS

Instance Attribute Summary

Attributes inherited from Chef::Resource

#allowed_actions, #cookbook_name, #default_guard_interpreter, #elapsed_time, #enclosing_provider, #not_if_args, #only_if_args, #params, #provider, #recipe_name, #resource_name, #retries, #retry_delay, #run_context, #source_line, #updated

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Chef::Resource

#action, #after_created, #as_json, #cookbook_version, #custom_exception_message, #customize_exception, #defined_at, #delayed_notifications, dsl_name, #epic_fail, #events, #guard_interpreter, #identity, identity_attr, #ignore_failure, #immediate_notifications, #inspect, #is, json_create, #load_prior_resource, #method_missing, #name, #node, node_map, #noop, #not_if, #notifies, #notifies_delayed, #notifies_immediately, #only_if, provider_base, #provider_for_action, provides, #resolve_notification_references, resource_for_node, resource_matching_short_name, #resources, #run_action, #sensitive, #should_skip?, #state, state_attrs, strict_const_defined?, #subscribes, #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 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 Mixin::ParamsValidate

#lazy, #set_or_return, #validate

Methods included from DSL::DataQuery

#data_bag, #data_bag_item, #search

Methods included from EncryptedDataBagItem::CheckEncrypted

#encrypted?

Constructor Details

#initialize(name, run_context = nil) ⇒ Execute

Returns a new instance of Execute.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/chef/resource/execute.rb', line 29

def initialize(name, run_context=nil)
  super
  @resource_name = :execute
  @command = name
  @backup = 5
  @action = "run"
  @creates = nil
  @cwd = nil
  @environment = nil
  @group = nil
  @returns = 0
  @timeout = nil
  @user = nil
  @allowed_actions.push(:run)
  @umask = nil
  @default_guard_interpreter = :execute
end

Dynamic Method Handling

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

Class Method Details

.guard_inherited_attributes(*inherited_attributes) ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/chef/resource/execute.rb', line 125

def self.guard_inherited_attributes(*inherited_attributes)
  # Similar to patterns elsewhere, return attributes from this
  # class and superclasses as a form of inheritance
  ancestor_attributes = []

  if superclass.respond_to?(:guard_inherited_attributes)
    ancestor_attributes = superclass.guard_inherited_attributes
  end

  ancestor_attributes.concat(@class_inherited_attributes ? @class_inherited_attributes : []).uniq
end

.set_guard_inherited_attributes(*inherited_attributes) ⇒ Object 



121
122
123
 
# File 'lib/chef/resource/execute.rb', line 121

def self.set_guard_inherited_attributes(*inherited_attributes)
  @class_inherited_attributes = inherited_attributes
end

Instance Method Details

#command(arg = nil) ⇒ Object 



55
56
57
58
59
60
61
 
# File 'lib/chef/resource/execute.rb', line 55

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

#creates(arg = nil) ⇒ Object 



63
64
65
66
67
68
69
 
# File 'lib/chef/resource/execute.rb', line 63

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

#cwd(arg = nil) ⇒ Object 



71
72
73
74
75
76
77
 
# File 'lib/chef/resource/execute.rb', line 71

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

#environment(arg = nil) ⇒ Object Also known as: env 



79
80
81
82
83
84
85
 
# File 'lib/chef/resource/execute.rb', line 79

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

#group(arg = nil) ⇒ Object 



89
90
91
92
93
94
95
 
# File 'lib/chef/resource/execute.rb', line 89

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

#returns(arg = nil) ⇒ Object 



97
98
99
100
101
102
103
 
# File 'lib/chef/resource/execute.rb', line 97

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

#timeout(arg = nil) ⇒ Object 



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

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

#umask(arg = nil) ⇒ Object 



47
48
49
50
51
52
53
 
# File 'lib/chef/resource/execute.rb', line 47

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

#user(arg = nil) ⇒ Object 



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

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