Class: Chef::Resource::File

Inherits:
Chef::Resource show all
Includes:
Mixin::Securable
Defined in:
lib/chef/resource/file.rb,
lib/chef/resource/file/verification.rb,
lib/chef/resource/file/verification/json.rb,
lib/chef/resource/file/verification/yaml.rb,
lib/chef/resource/file/verification/systemd_unit.rb

Direct Known Subclasses

CookbookFile, RemoteFile, Template

Defined Under Namespace

Classes: Verification

Constant Summary

Constants inherited from Chef::Resource

FORBIDDEN_IVARS, HIDDEN_IVARS

Instance Attribute Summary collapse

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

Instance Method Summary collapse

Methods included from Mixin::Securable

#group, included, #mode, #owner

Methods included from Mixin::Securable::WindowsSecurableAttributes

#inherits

Methods inherited from Chef::Resource

#action, action, #action=, action_class, #action_description, #after_created, allowed_actions, allowed_actions=, #as_json, #before_notifications, chef_version_for_provides, #compile_time, #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?, #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, #subscribes, #suppress_up_to_date_messages?, #to_h, #to_json, #to_s, #to_text, #umask, unified_mode, #updated?, #updated_by_last_action, #updated_by_last_action?, use, #validate_action, #validate_resource_spec!, #value_to_text, #with_umask

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

#default_secret_config, #default_secret_service, #secret, #with_secret_config, #with_secret_service

Methods included from DSL::RenderHelpers

#render_json, #render_toml, #render_yaml

Methods included from DSL::ReaderHelpers

#parse_file, #parse_json, #parse_toml, #parse_yaml

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

#chef_vault, #chef_vault_item, #chef_vault_item_for_environment

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

#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

Instance Attribute Details

#checksum=(value) ⇒ Object (writeonly)

Sets the attribute checksum

Parameters:

  • value —

    the value to set the attribute checksum to.



43
44
45
 
# File 'lib/chef/resource/file.rb', line 43

def checksum=(value)
  @checksum = value
end

#final_checksum ⇒ String

The checksum of the rendered file. This has to be saved on the new_resource for the ‘after’ state for reporting but we cannot mutate the new_resource.checksum which would change the user intent in the new_resource if the resource is reused.

Returns:

  • (String) —

    Checksum of the file we actually rendered



52
53
54
 
# File 'lib/chef/resource/file.rb', line 52

def final_checksum
  @final_checksum
end

Instance Method Details

#special_docker_files?(file) ⇒ Boolean

Returns:

  • (Boolean) 


106
107
108
 
# File 'lib/chef/resource/file.rb', line 106

def special_docker_files?(file)
  %w{/etc/hosts /etc/hostname /etc/resolv.conf}.include?(Pathname(file.scrub).cleanpath.to_path)
end

#state_for_resource_reporter ⇒ Object 



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

def state_for_resource_reporter
  state_attrs = super()
  # fix up checksum state with final_checksum saved by the provider
  if checksum.nil? && final_checksum
    state_attrs[:checksum] = final_checksum
  end
  state_attrs
end

#verify(command = nil, opts = {}, &block) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/chef/resource/file.rb', line 85

def verify(command = nil, opts = {}, &block)
  unless command.nil? || [String, Symbol].include?(command.class)
    raise ArgumentError, "verify requires either a string, symbol, or a block"
  end

  if command || block_given?
    verifications << Verification.new(self, command, opts, &block)
  else
    verifications
  end
end