Class: Chef::Provider::RemoteDirectory

Inherits:
Directory show all
Extended by:
Deprecation::Warnings, Forwardable
Includes:
Deprecation::Provider::RemoteDirectory, Mixin::FileClass
Defined in:
lib/chef/provider/remote_directory.rb

Constant Summary

Constants included from Mixin::ShellOut

Mixin::ShellOut::DEPRECATED_OPTIONS

Instance Attribute Summary collapse

Attributes inherited from File

#deployment_strategy, #managing_symlink, #needs_creating, #needs_unlinking

Attributes inherited from Chef::Provider

#action, #cookbook_name, #current_resource, #new_resource, #recipe_name, #run_context

Instance Method Summary collapse

Methods included from Deprecation::Warnings

add_deprecation_warnings_for

Methods included from Deprecation::Provider::RemoteDirectory

#directory_root_in_cookbook_cache, #ls

Methods included from Mixin::FileClass

#file_class

Methods inherited from Directory

#action_delete, #define_resource_requirements, #load_current_resource, #whyrun_supported?

Methods inherited from File

#action_delete, #action_touch, #define_resource_requirements, #initialize, #load_current_resource, #manage_symlink_access?, #whyrun_supported?

Methods included from Deprecation::Provider::File

#backup, #compare_content, #deploy_tempfile, #diff_current, #diff_current_from_content, #is_binary?, #set_all_access_controls, #set_content, #setup_acl, #update_new_file_state

Methods included from Util::Selinux

#restore_security_context, #selinux_enabled?

Methods included from Mixin::Which

#which

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

#checksum

Methods included from Mixin::EnforceOwnershipAndPermissions

#access_controls, #enforce_ownership_and_permissions

Methods inherited from Chef::Provider

#action_nothing, #check_resource_semantics!, #cleanup_after_converge, #converge_by, #converge_if_changed, #define_resource_requirements, #events, include_resource_dsl, include_resource_dsl_module, #initialize, #load_current_resource, #node, #process_resource_requirements, provides, provides?, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, use_inline_resources, #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 DeprecatedLWRPClass

#const_missing, #deprecated_constants, #register_deprecated_lwrp_class

Methods included from Mixin::LazyModuleInclude

#descendants, #include, #included

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!, #with_run_context

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

Constructor Details

This class inherits a constructor from Chef::Provider::File

Instance Attribute Details

#managed_filesSet

Hash containing keys of the paths for all the files that we sync, plus all their parent directories.

Returns:

  • (Set)

    Ruby Set of the files that we manage



59
60
61
# File 'lib/chef/provider/remote_directory.rb', line 59

def managed_files
  @managed_files
end

Instance Method Details

#action_createObject

Handle action :create.



65
66
67
68
69
70
71
72
73
74
75
76
# File 'lib/chef/provider/remote_directory.rb', line 65

def action_create
  super

  # Transfer files
  files_to_transfer.each do |cookbook_file_relative_path|
    create_cookbook_file(cookbook_file_relative_path)
    # parent directories and file being transferred need to not be removed in the purge
    add_managed_file(cookbook_file_relative_path)
  end

  purge_unmanaged_files
end

#action_create_if_missingObject

Handle action :create_if_missing.



80
81
82
83
84
# File 'lib/chef/provider/remote_directory.rb', line 80

def action_create_if_missing
  # if this action is called, ignore the existing overwrite flag
  @overwrite = false
  action_create
end

#overwrite?Boolean

The overwrite property on the resource. Delegates to new_resource but can be mutated.

Returns:

  • (Boolean)

    if we are overwriting



47
48
49
50
# File 'lib/chef/provider/remote_directory.rb', line 47

def overwrite?
  @overwrite = new_resource.overwrite if @overwrite.nil?
  !!@overwrite
end