Class: Chef::Provider::Directory

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

Direct Known Subclasses

RemoteDirectory

Constant Summary

Constants included from Mixin::ShellOut

Mixin::ShellOut::DEPRECATED_OPTIONS

Instance Attribute Summary

Attributes inherited from Chef::Provider

#action, #current_resource, #new_resource, #run_context

Instance Method Summary collapse

Methods inherited from File

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

Methods included from Mixin::ShellOut

#run_command_compatible_options, #shell_out, #shell_out!

Methods included from Mixin::Checksum

#checksum

Methods inherited from Chef::Provider

#action_nothing, build_from_file, #cleanup_after_converge, #converge, #cookbook_name, #events, #initialize, #node, #process_resource_requirements, #requirements, #resource_collection, #run_action, #whyrun_mode?

Methods included from Mixin::ConvertToClassName

#convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #snake_case_basename

Methods included from Mixin::EnforceOwnershipAndPermissions

#access_controls, #enforce_ownership_and_permissions

Methods included from Mixin::RecipeDefinitionDSLCore

#method_missing

Methods included from Mixin::Language

#data_bag, #data_bag_item, #platform?, #platform_family?, #search, #value_for_platform, #value_for_platform_family

Constructor Details

This class inherits a constructor from Chef::Provider

Dynamic Method Handling

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

Instance Method Details

#action_createObject


99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/chef/provider/directory.rb', line 99

def action_create
  unless ::File.exist?(@new_resource.path)
    converge_by("create new directory #{@new_resource.path}") do 
      if @new_resource.recursive == true
        ::FileUtils.mkdir_p(@new_resource.path)
      else
        ::Dir.mkdir(@new_resource.path)
      end
      Chef::Log.info("#{@new_resource} created directory #{@new_resource.path}")
    end 
  end
  set_all_access_controls
end

#action_deleteObject


113
114
115
116
117
118
119
120
121
122
123
124
125
# File 'lib/chef/provider/directory.rb', line 113

def action_delete
  if ::File.exist?(@new_resource.path)
    converge_by("delete existing directory #{@new_resource.path}") do
      if @new_resource.recursive == true
        FileUtils.rm_rf(@new_resource.path)
        Chef::Log.info("#{@new_resource} deleted #{@new_resource.path} recursively")
      else
        ::Dir.delete(@new_resource.path)
        Chef::Log.info("#{@new_resource} deleted #{@new_resource.path}")
      end
    end
  end
end

#define_resource_requirementsObject


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
# File 'lib/chef/provider/directory.rb', line 42

def define_resource_requirements
  # this must be evaluated before whyrun messages are printed
  access_controls.requires_changes?

  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 { @new_resource.recursive || ::File.directory?(parent_directory) }
    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) 
            ::File.writable?(base_dir)
          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) 
          ::File.writable?(parent_directory)
        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) && ::File.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_resourceObject


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

def load_current_resource
  @current_resource = Chef::Resource::Directory.new(@new_resource.name)
  @current_resource.path(@new_resource.path)
  load_current_resource_attrs
  setup_acl

  @current_resource
end

#whyrun_supported?Boolean

Returns:

  • (Boolean)

29
30
31
# File 'lib/chef/provider/directory.rb', line 29

def whyrun_supported?
  true
end