Class: Chef::Provider::File
- Inherits:
-
Chef::Provider
- Object
- Chef::Provider
- Chef::Provider::File
- Defined in:
- lib/chef/provider/file.rb,
lib/chef/provider/file/content.rb
Direct Known Subclasses
Defined Under Namespace
Classes: Content
Instance Attribute Summary collapse
-
#deployment_strategy ⇒ Object
readonly
Returns the value of attribute deployment_strategy.
-
#managing_symlink ⇒ Object
Returns the value of attribute managing_symlink.
-
#needs_creating ⇒ Object
Returns the value of attribute needs_creating.
-
#needs_unlinking ⇒ Object
Returns the value of attribute needs_unlinking.
Attributes inherited from Chef::Provider
#action, #after_resource, #current_resource, #logger, #new_resource, #run_context
Instance Method Summary collapse
- #define_resource_requirements ⇒ Object
-
#initialize(new_resource, run_context) ⇒ File
constructor
A new instance of File.
- #load_current_resource ⇒ Object
-
#manage_symlink_access? ⇒ Boolean
Implementation components should follow symlinks when managing access control (e.g., use chmod instead of lchmod even if the path we’re managing is a symlink).
Methods included from Mixin::FileClass
Methods included from Util::Selinux
#restore_security_context, #selinux_enabled?
Methods included from Mixin::Checksum
#checksum, #checksum_match?, #short_cksum
Methods included from Mixin::EnforceOwnershipAndPermissions
#access_controls, #enforce_ownership_and_permissions
Methods inherited from Chef::Provider
action, action_description, action_descriptions, #action_nothing, #check_resource_semantics!, #cleanup_after_converge, #compile_and_converge_action, #converge_by, #converge_if_changed, #cookbook_name, #description, #events, include_resource_dsl?, include_resource_dsl_module, #introduced, #load_after_resource, #node, #process_resource_requirements, provides, provides?, #recipe_name, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, use, use_inline_resources, #validate_required_properties!, #whyrun_mode?, #whyrun_supported?
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
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
Methods included from DSL::PlatformIntrospection
#older_than_win_2012_or_8?, #platform?, #platform_family?, #value_for_platform, #value_for_platform_family
Methods included from DSL::Recipe
#exec, #have_resource_class_for?, #resource_class_for
Methods included from DSL::Definitions
add_definition, #evaluate_resource_definition, #has_resource_definition?
Methods included from DSL::Resources
add_resource_dsl, remove_resource_dsl
Methods included from DSL::Cheffish
Methods included from DSL::RebootPending
Methods included from DSL::IncludeRecipe
Methods included from Mixin::NotifyingBlock
#notifying_block, #subcontext_block
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
Methods included from DSL::Compliance
#include_input, #include_profile, #include_waiver
Constructor Details
#initialize(new_resource, run_context) ⇒ File
Returns a new instance of File.
65 66 67 68 69 70 71 |
# File 'lib/chef/provider/file.rb', line 65 def initialize(new_resource, run_context) @content_class ||= Chef::Provider::File::Content if new_resource.respond_to?(:atomic_update) @deployment_strategy = Chef::FileContentManagement::Deploy.strategy(new_resource.atomic_update) end super end |
Instance Attribute Details
#deployment_strategy ⇒ Object (readonly)
Returns the value of attribute deployment_strategy.
59 60 61 |
# File 'lib/chef/provider/file.rb', line 59 def deployment_strategy @deployment_strategy end |
#managing_symlink ⇒ Object
Returns the value of attribute managing_symlink.
63 64 65 |
# File 'lib/chef/provider/file.rb', line 63 def managing_symlink @managing_symlink end |
#needs_creating ⇒ Object
Returns the value of attribute needs_creating.
61 62 63 |
# File 'lib/chef/provider/file.rb', line 61 def needs_creating @needs_creating end |
#needs_unlinking ⇒ Object
Returns the value of attribute needs_unlinking.
62 63 64 |
# File 'lib/chef/provider/file.rb', line 62 def needs_unlinking @needs_unlinking end |
Instance Method Details
#define_resource_requirements ⇒ Object
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 |
# File 'lib/chef/provider/file.rb', line 115 def define_resource_requirements # deep inside FAC we have to assert requirements, so call FACs hook to set that up access_controls.define_resource_requirements # Make sure the parent directory exists, otherwise fail. For why-run assume it would have been created. requirements.assert(:create, :create_if_missing, :touch) do |a| parent_directory = ::File.dirname(new_resource.path) a.assertion { ::TargetIO::File.directory?(parent_directory) } a.(Chef::Exceptions::EnclosingDirectoryDoesNotExist, "Parent directory #{parent_directory} does not exist.") a.whyrun("Assuming directory #{parent_directory} would have been created") end # Make sure the file is deletable if it exists, otherwise fail. if ::TargetIO::File.exist?(new_resource.path) requirements.assert(:delete) do |a| a.assertion { ::TargetIO::File.writable?(new_resource.path) } a.(Chef::Exceptions::InsufficientPermissions, "File #{new_resource.path} exists but is not writable so it cannot be deleted") end end error, reason, = inspect_existing_fs_entry requirements.assert(:create) do |a| a.assertion { error.nil? } a.(error, reason) a.whyrun() # Subsequent attempts to read the fs entry at the path (e.g., for # calculating checksums) could blow up, so give up trying to continue # why-running. a.block_action! end end |
#load_current_resource ⇒ Object
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
# File 'lib/chef/provider/file.rb', line 73 def load_current_resource # true if there is a symlink and we need to manage what it points at @managing_symlink = file_class.symlink?(new_resource.path) && ( new_resource.manage_symlink_source || new_resource.manage_symlink_source.nil? ) # true if there is a non-file thing in the way that we need to unlink first @needs_unlinking = if ::TargetIO::File.exist?(new_resource.path) if managing_symlink? !symlink_to_real_file?(new_resource.path) else !real_file?(new_resource.path) end else false end # true if we are going to be creating a new file @needs_creating = !::TargetIO::File.exist?(new_resource.path) || needs_unlinking? # Let children resources override constructing the current_resource @current_resource ||= Chef::Resource::File.new(new_resource.name) current_resource.path(new_resource.path) unless needs_creating? # we are updating an existing file if managing_content? logger.trace("#{new_resource} checksumming file at #{new_resource.path}.") resource_to_check = current_resource.path resource_to_check = ::TargetIO::File.open(current_resource.path) if ChefConfig::Config.target_mode? current_resource.checksum(checksum(resource_to_check)) else # if the file does not exist or is not a file, then the checksum is invalid/pointless current_resource.checksum(nil) end load_resource_attributes_from_file(current_resource) end current_resource end |
#manage_symlink_access? ⇒ Boolean
Implementation components should follow symlinks when managing access control (e.g., use chmod instead of lchmod even if the path we’re managing is a symlink).
188 189 190 |
# File 'lib/chef/provider/file.rb', line 188 def manage_symlink_access? false end |