Class: Chef::Resource::Cron

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

Constant Summary

Constants inherited from Chef::Resource

FORBIDDEN_IVARS, HIDDEN_IVARS

Constants included from Mixin::ShellOut

Mixin::ShellOut::DEPRECATED_OPTIONS

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_initializing, #retries, #retry_delay, #run_context, #sensitive, #source_line, #updated

Instance Method Summary collapse

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, #customize_exception, declare_action_class, #declared_key, default_action, default_action=, #defined_at, #delayed_notifications, dsl_name, #events, #guard_interpreter, #identity, identity_attr, identity_property, #immediate_notifications, inherited, #inspect, #is, json_create, load_current_value, #load_from, #lookup_provider_constant, #method_missing, #name, #node, #noop, #not_if, #notifies, #notifies_before, #notifies_delayed, #notifies_immediately, #only_if, #provider, #provider=, provider_base, #provider_for_action, provides, provides?, #resolve_notification_references, resource_for_node, resource_matching_short_name, resource_name, #resource_name, resource_name=, #resources, #run_action, #should_skip?, sorted_descendants, #source_line_file, #source_line_number, state_attrs, #state_for_resource_reporter, #subscribes, #supports, #supports=, #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!

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 DeprecatedLWRPClass

#deprecated_constants, #register_deprecated_lwrp_class

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

#run_command_compatible_options, #shell_out, #shell_out!, #shell_out_with_systems_locale, #shell_out_with_systems_locale!

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) ⇒ Cron

Returns a new instance of Cron.



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

def initialize(name, run_context = nil)
  super
  @minute = "*"
  @hour = "*"
  @day = "*"
  @month = "*"
  @weekday = "*"
  @command = nil
  @user = "root"
  @mailto = nil
  @path = nil
  @shell = nil
  @home = nil
  @time = nil
  @environment = {}
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 



182
183
184
185
186
187
188
 
# File 'lib/chef/resource/cron.rb', line 182

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

#day(arg = nil) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/chef/resource/cron.rb', line 84

def day(arg = nil)
  if arg.is_a?(Integer)
    converted_arg = arg.to_s
  else
    converted_arg = arg
  end
  begin
    if integerize(arg) > 31 then raise RangeError end
  rescue ArgumentError
  end
  set_or_return(
    :day,
    converted_arg,
    :kind_of => String
  )
end

#environment(arg = nil) ⇒ Object 



198
199
200
201
202
203
204
 
# File 'lib/chef/resource/cron.rb', line 198

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

#home(arg = nil) ⇒ Object 



166
167
168
169
170
171
172
 
# File 'lib/chef/resource/cron.rb', line 166

def home(arg = nil)
  set_or_return(
    :home,
    arg,
    :kind_of => String
  )
end

#hour(arg = nil) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/chef/resource/cron.rb', line 67

def hour(arg = nil)
  if arg.is_a?(Integer)
    converted_arg = arg.to_s
  else
    converted_arg = arg
  end
  begin
    if integerize(arg) > 23 then raise RangeError end
  rescue ArgumentError
  end
  set_or_return(
    :hour,
    converted_arg,
    :kind_of => String
  )
end

#mailto(arg = nil) ⇒ Object 



150
151
152
153
154
155
156
 
# File 'lib/chef/resource/cron.rb', line 150

def mailto(arg = nil)
  set_or_return(
    :mailto,
    arg,
    :kind_of => String
  )
end

#minute(arg = nil) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/chef/resource/cron.rb', line 50

def minute(arg = nil)
  if arg.is_a?(Integer)
    converted_arg = arg.to_s
  else
    converted_arg = arg
  end
  begin
    if integerize(arg) > 59 then raise RangeError end
  rescue ArgumentError
  end
  set_or_return(
    :minute,
    converted_arg,
    :kind_of => String
  )
end

#month(arg = nil) ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/chef/resource/cron.rb', line 101

def month(arg = nil)
  if arg.is_a?(Integer)
    converted_arg = arg.to_s
  else
    converted_arg = arg
  end
  begin
    if integerize(arg) > 12 then raise RangeError end
  rescue ArgumentError
  end
  set_or_return(
    :month,
    converted_arg,
    :kind_of => String
  )
end

#path(arg = nil) ⇒ Object 



158
159
160
161
162
163
164
 
# File 'lib/chef/resource/cron.rb', line 158

def path(arg = nil)
  set_or_return(
    :path,
    arg,
    :kind_of => String
  )
end

#shell(arg = nil) ⇒ Object 



174
175
176
177
178
179
180
 
# File 'lib/chef/resource/cron.rb', line 174

def shell(arg = nil)
  set_or_return(
    :shell,
    arg,
    :kind_of => String
  )
end

#time(arg = nil) ⇒ Object 



142
143
144
145
146
147
148
 
# File 'lib/chef/resource/cron.rb', line 142

def time(arg = nil)
  set_or_return(
    :time,
    arg,
    :equal_to => Chef::Provider::Cron::SPECIAL_TIME_VALUES
  )
end

#user(arg = nil) ⇒ Object 



190
191
192
193
194
195
196
 
# File 'lib/chef/resource/cron.rb', line 190

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

#weekday(arg = nil) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/chef/resource/cron.rb', line 118

def weekday(arg = nil)
  if arg.is_a?(Integer)
    converted_arg = arg.to_s
  else
    converted_arg = arg
  end
  begin
    error_message = "You provided '#{arg}' as a weekday, acceptable values are "
    error_message << Provider::Cron::WEEKDAY_SYMBOLS.map { |sym| ":#{sym}" }.join(", ")
    error_message << " and a string in crontab format"
    if (arg.is_a?(Symbol) && !Provider::Cron::WEEKDAY_SYMBOLS.include?(arg)) ||
        (!arg.is_a?(Symbol) && integerize(arg) > 7) ||
        (!arg.is_a?(Symbol) && integerize(arg) < 0)
      raise RangeError, error_message
    end
  rescue ArgumentError
  end
  set_or_return(
    :weekday,
    converted_arg,
    :kind_of => [String, Symbol]
  )
end