Class: Chef::Resource::CronD

Inherits:
Chef::Resource show all
Defined in:
lib/chef/resource/cron_d.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, #executed_by_runner, #logger, #params, #recipe_name, #resource_initializing, #run_context, #source_line, #updated

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Chef::Resource

#action, action, #action=, action_class, allowed_actions, allowed_actions=, #as_json, #before_notifications, chef_version_for_provides, #cookbook_version, #current_value, #current_value_does_not_exist!, #custom_exception_message, custom_resource?, #customize_exception, declare_action_class, #declared_key, default_action, default_action=, default_description, #defined_at, #delayed_action, #delayed_notifications, deprecated, description, #events, examples, from_hash, from_json, #guard_interpreter, #identity, identity_attr, identity_property, #ignore_failure, #immediate_notifications, inherited, #initialize, #inspect, introduced, is_custom_resource!, json_create, load_current_value, #load_from, #lookup_provider_constant, #method_missing, #name, #node, #not_if, #notifies, #notifies_before, #notifies_delayed, #notifies_immediately, #only_if, preview_resource, #provider, #provider=, #provider_for_action, provides, provides?, remove_canonical_dsl, #resolve_notification_references, resource_for_node, resource_matching_short_name, #resource_name, resource_name, resource_name=, #retries, #retry_delay, #run_action, #sensitive, #should_skip?, skip_docs, sorted_descendants, #source_line_file, #source_line_number, state_attrs, #state_for_resource_reporter, #subscribes, #to_h, #to_json, #to_s, #to_text, unified_mode, #updated?, #updated_by_last_action, #updated_by_last_action?, use_automatic_resource_name, #validate_action, #validate_resource_spec!, #value_to_text

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

#descendants, #include, #included

Methods included from Mixin::ShellOut

apply_default_env, maybe_add_timeout, #shell_out, #shell_out!

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 Mixin::PowershellExec

#powershell_exec

Methods included from DSL::Powershell

#ps_credential

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, #tagged?

Methods included from EncryptedDataBagItem::CheckEncrypted

#encrypted?

Methods included from DSL::PlatformIntrospection

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

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

#deprecated_attr, #deprecated_attr_reader, #deprecated_attr_writer, #deprecated_ivar

Methods included from Mixin::Properties

#copy_properties_from, included, #property_description, #property_is_set?, #reset_property

Methods included from Mixin::ParamsValidate

#lazy, #set_or_return, #validate

Methods included from DSL::RebootPending

#reboot_pending?

Methods included from DSL::DeclareResource

#build_resource, #declare_resource, #delete_resource, #delete_resource!, #edit_resource, #edit_resource!, #find_resource, #find_resource!, #resources, #with_run_context

Constructor Details

This class inherits a constructor from Chef::Resource

Dynamic Method Handling

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

Class Method Details

.validate_dow(spec) ⇒ Boolean

validate the provided day of the week is sun-sat, 0-7, or *

Parameters:

  • spec —

    the value to validate

Returns:

  • (Boolean) —

    valid or not?



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/chef/resource/cron_d.rb', line 125

def self.validate_dow(spec)
  return true if spec == "*"

  if spec.respond_to? :to_int
    validate_numeric(spec, 0, 7)
  elsif spec.respond_to? :to_str
    return true if spec == "*"
    # Named abbreviations are permitted but not as part of a range or with stepping
    return true if %w{sun mon tue wed thu fri sat}.include? spec.downcase

    # 0-7 are legal for days of week
    validate_numeric(spec, 0, 7)
  else
    false
  end
end

.validate_month(spec) ⇒ Boolean

validate the provided month value to be jan - dec, 1 - 12, or *

Parameters:

  • spec —

    the value to validate

Returns:

  • (Boolean) —

    valid or not?



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/chef/resource/cron_d.rb', line 105

def self.validate_month(spec)
  return true if spec == "*"

  if spec.respond_to? :to_int
    validate_numeric(spec, 1, 12)
  elsif spec.respond_to? :to_str
    return true if spec == "*"
    # Named abbreviations are permitted but not as part of a range or with stepping
    return true if %w{jan feb mar apr may jun jul aug sep oct nov dec}.include? spec.downcase

    # 1-12 are legal for months
    validate_numeric(spec, 1, 12)
  else
    false
  end
end

.validate_numeric(spec, min, max) ⇒ Boolean

validate a provided value is between two other provided values we also allow * as a valid input

Parameters:

  • spec —

    the value to validate

  • min —

    the lowest value allowed

  • max —

    the highest value allowed

Returns:

  • (Boolean) —

    valid or not?



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

def self.validate_numeric(spec, min, max)
  return true if spec == "*"

  #  binding.pry
  if spec.respond_to? :to_int
    return false unless spec >= min && spec <= max

    return true
  end

  # Lists of invidual values, ranges, and step values all share the validity range for type
  spec.split(%r{\/|-|,}).each do |x|
    next if x == "*"
    return false unless x =~ /^\d+$/

    x = x.to_i
    return false unless x >= min && x <= max
  end
  true
end

Instance Method Details

#after_created ⇒ Object

warn if someone passes the deprecated cookbook property

Raises:

  • (ArgumentError) 


217
218
219
 
# File 'lib/chef/resource/cron_d.rb', line 217

def after_created
  raise ArgumentError, "The 'cookbook' property for the cron_d resource is no longer supported now that it ships as a core resource." if cookbook
end