Class: Chef::Resource::Execute

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

Direct Known Subclasses

Script

Instance Attribute Summary

Attributes inherited from Chef::Resource

#actions, #allowed_actions, #collection, #cookbook_name, #enclosing_provider, #node, #params, #provider, #recipe_name, #resource_name, #source_line, #updated

Instance Method Summary collapse

Methods inherited from Chef::Resource

#action, attribute, build_from_file, #epic_fail, #ignore_failure, #is, json_create, #load_prior_resource, #method_missing, #name, #noop, #not_if, #notifies, #only_if, provider_base, #resources, #run_action, #subscribes, #supports, #to_hash, #to_json, #to_s

Methods included from Mixin::ConvertToClassName

#convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string

Methods included from Mixin::Language

#data_bag, #data_bag_item, #platform?, #search, #value_for_platform

Methods included from Mixin::ParamsValidate

#set_or_return, #validate

Methods included from Mixin::CheckHelper

#set_if_args

Constructor Details

#initialize(name, collection = nil, node = nil) ⇒ Execute

Returns a new instance of Execute.



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

def initialize(name, collection=nil, node=nil)
  super(name, collection, node)
  @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 



51
52
53
54
55
56
57
 
# File 'lib/chef/resource/execute.rb', line 51

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

#creates(arg = nil) ⇒ Object 



59
60
61
62
63
64
65
 
# File 'lib/chef/resource/execute.rb', line 59

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

#cwd(arg = nil) ⇒ Object 



67
68
69
70
71
72
73
 
# File 'lib/chef/resource/execute.rb', line 67

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

#environment(arg = nil) ⇒ Object 



75
76
77
78
79
80
81
 
# File 'lib/chef/resource/execute.rb', line 75

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

#group(arg = nil) ⇒ Object 



83
84
85
86
87
88
89
 
# File 'lib/chef/resource/execute.rb', line 83

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

#path(arg = nil) ⇒ Object 



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

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

#returns(arg = nil) ⇒ Object 



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

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

#timeout(arg = nil) ⇒ Object 



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

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

#umask(arg = nil) ⇒ Object 



43
44
45
46
47
48
49
 
# File 'lib/chef/resource/execute.rb', line 43

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

#user(arg = nil) ⇒ Object 



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

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