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

Instance Method Summary collapse

Methods inherited from Chef::Resource

#action, #after_created, #as_json, #cookbook_version, #customize_exception, #defined_at, #delayed_notifications, dsl_name, #epic_fail, #events, #identity, identity_attr, #ignore_failure, #immediate_notifications, #inspect, #is, json_create, #load_prior_resource, #method_missing, #name, #node, #noop, #not_if, #notifies, #notifies_delayed, #notifies_immediately, #only_if, platform_map, provider_base, #provider_for_action, provides, #resolve_notification_references, resource_for_node, resource_for_platform, #resources, #run_action, #should_skip?, #state, state_attrs, #subscribes, #supports, #to_hash, #to_json, #to_s, #to_text, #updated?, #updated_by_last_action, #updated_by_last_action?, #validate_action

Methods included from Mixin::ConvertToClassName

#convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #snake_case_basename

Methods included from Mixin::Deprecation

#deprecated_ivar

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

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

Methods included from Mixin::ParamsValidate

#set_or_return, #validate

Methods included from DSL::DataQuery

#data_bag, #data_bag_item, #search

Constructor Details

#initialize(name, run_context = nil) ⇒ Execute

Returns a new instance of Execute.



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

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

Dynamic Method Handling

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

Instance Method Details

#command(arg = nil) ⇒ Object



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

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

#creates(arg = nil) ⇒ Object



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

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

#cwd(arg = nil) ⇒ Object



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

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

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



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

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

#group(arg = nil) ⇒ Object



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

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

#path(arg = nil) ⇒ Object



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

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

#returns(arg = nil) ⇒ Object



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

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

#timeout(arg = nil) ⇒ Object



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

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

#umask(arg = nil) ⇒ Object



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

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

#user(arg = nil) ⇒ Object



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

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