Class: Chef::Provider::Directory

Inherits:
File show all
Defined in:
lib/chef/provider/directory.rb

Direct Known Subclasses

RemoteDirectory

Instance Attribute Summary

Attributes inherited from File

#deployment_strategy, #managing_symlink, #needs_creating, #needs_unlinking

Attributes inherited from Chef::Provider

#action, #after_resource, #current_resource, #logger, #new_resource, #run_context

Instance Method Summary collapse

Methods inherited from File

#initialize, #manage_symlink_access?

Methods included from Mixin::FileClass

#file_class

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, #initialize, #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

#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 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

load_cheffish

Methods included from DSL::RebootPending

#reboot_pending?

Methods included from DSL::IncludeRecipe

#include_recipe, #load_recipe

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

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

Instance Method Details

#define_resource_requirements ⇒ Object

[View source]

41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
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
114
115
116
117
118
119
120
121
122
 
# File 'lib/chef/provider/directory.rb', line 41

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

  requirements.assert(:create) do |a|
    # Make sure the parent dir exists, or else fail.
    # for why run, print a message explaining the potential error.
    parent_directory = ::File.dirname(new_resource.path)
    a.assertion do
      if new_resource.recursive
        does_parent_exist = lambda do |base_dir|
          base_dir = ::File.dirname(base_dir)
          if ::File.exist?(base_dir)
            ::File.directory?(base_dir)
          else
            does_parent_exist.call(base_dir)
          end
        end
        does_parent_exist.call(new_resource.path)
      else
        ::File.directory?(parent_directory)
      end
    end
    a.failure_message(Chef::Exceptions::EnclosingDirectoryDoesNotExist, "Parent directory #{parent_directory} does not exist, cannot create #{new_resource.path}")
    a.whyrun("Assuming directory #{parent_directory} would have been created")
  end

  requirements.assert(:create) do |a|
    parent_directory = ::File.dirname(new_resource.path)
    a.assertion do
      if new_resource.recursive
        # find the lowest-level directory in new_resource.path that already exists
        # make sure we have write permissions to that directory
        is_parent_writable = lambda do |base_dir|
          base_dir = ::File.dirname(base_dir)
          if ::File.exist?(base_dir)
            if Chef::FileAccessControl.writable?(base_dir)
              true
            elsif Chef::Util::PathHelper.is_sip_path?(base_dir, node)
              Chef::Util::PathHelper.writable_sip_path?(base_dir)
            else
              false
            end
          else
            is_parent_writable.call(base_dir)
          end
        end
        is_parent_writable.call(new_resource.path)
      else
        # in why run mode & parent directory does not exist no permissions check is required
        # If not in why run, permissions must be valid and we rely on prior assertion that dir exists
        if !whyrun_mode? || ::File.exist?(parent_directory)
          if Chef::FileAccessControl.writable?(parent_directory)
            true
          elsif Chef::Util::PathHelper.is_sip_path?(parent_directory, node)
            Chef::Util::PathHelper.writable_sip_path?(new_resource.path)
          else
            false
          end
        else
          true
        end
      end
    end
    a.failure_message(Chef::Exceptions::InsufficientPermissions,
      "Cannot create #{new_resource} at #{new_resource.path} due to insufficient permissions")
  end

  requirements.assert(:delete) do |a|
    a.assertion do
      if ::File.exist?(new_resource.path)
        ::File.directory?(new_resource.path) && Chef::FileAccessControl.writable?(new_resource.path)
      else
        true
      end
    end
    a.failure_message(RuntimeError, "Cannot delete #{new_resource} at #{new_resource.path}!")
    # No why-run handling here:
    #  * if we don't have permissions, this is unlikely to be changed earlier in the run
    #  * if the target is a file (not a dir), there's no reasonable path by which this would have been changed
  end
end

#load_current_resource ⇒ Object

[View source]

32
33
34
35
36
37
38
39
 
# File 'lib/chef/provider/directory.rb', line 32

def load_current_resource
  @current_resource = Chef::Resource::Directory.new(new_resource.name)
  current_resource.path(new_resource.path)
  if ::File.exist?(current_resource.path) && @action != :create_if_missing
    load_resource_attributes_from_file(current_resource)
  end
  current_resource
end