Class: Chef::Provider::RemoteFile

Inherits:
File show all
Includes:
Mixin::FindPreferredFile
Defined in:
lib/chef/provider/remote_file.rb

Instance Attribute Summary

Attributes inherited from Chef::Provider

#current_resource, #new_resource, #node

Instance Method Summary collapse

Methods included from Mixin::FindPreferredFile

#find_preferred_file, #load_cookbook_files

Methods inherited from File

#action_delete, #action_touch, #backup, #compare_group, #compare_mode, #compare_owner, #generate_url, #load_current_resource, #set_group, #set_mode, #set_owner

Methods included from Mixin::GenerateURL

#generate_cookbook_url, #generate_cookbook_url_from_uri

Methods included from Mixin::Checksum

#checksum

Methods inherited from Chef::Provider

#action_nothing, build_from_file, #initialize, #load_current_resource

Methods included from Mixin::ConvertToClassName

#convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string

Methods included from Mixin::RecipeDefinitionDSLCore

#method_missing

Methods included from Mixin::Language

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

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_create ⇒ Object 



32
33
34
35
 
# File 'lib/chef/provider/remote_file.rb', line 32

def action_create
  Chef::Log.debug("Checking #{@new_resource} for changes")
  do_remote_file(@new_resource.source, @current_resource.path)
end

#action_create_if_missing ⇒ Object 



37
38
39
40
41
42
43
 
# File 'lib/chef/provider/remote_file.rb', line 37

def action_create_if_missing
  if ::File.exists?(@new_resource.path)
    Chef::Log.debug("File #{@new_resource.path} exists, taking no action.")
  else
    action_create
  end
end

#do_remote_file(source, path) ⇒ Object 



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

def do_remote_file(source, path)
  retval = true

  if(@new_resource.checksum && @current_resource.checksum && @current_resource.checksum =~ /^#{@new_resource.checksum}/)
    Chef::Log.debug("File #{@new_resource} checksum matches, not updating")
  else
    begin
      # The remote filehandle
      raw_file = get_from_uri(source)    ||
                 get_from_server(source, @current_resource.checksum) ||
                 get_from_local_cookbook(source)

      # If the file exists
      Chef::Log.debug "#{@new_resource}: Checking for file existence of #{@new_resource.path}"
      if ::File.exists?(@new_resource.path)
        # And it matches the checksum of the raw file
        @new_resource.checksum(self.checksum(raw_file.path))
        Chef::Log.debug "#{@new_resource}: File exists at #{@new_resource.path}"
        Chef::Log.debug "#{@new_resource}: Target checksum: #{@current_resource.checksum}"
        Chef::Log.debug "#{@new_resource}: Source checksum: #{@new_resource.checksum}"
        if @new_resource.checksum != @current_resource.checksum
          # Updating target file, let's perform a backup!
          Chef::Log.debug "#{@new_resource}: checksum changed from #{@current_resource.checksum} to #{@new_resource.checksum}"
          Chef::Log.info "#{@new_resource}: Updating #{@new_resource.path}"
          backup @new_resource.path
          FileUtils.cp raw_file.path, @new_resource.path
          @new_resource.updated = true
        else
          Chef::Log.debug "#{@new_resource}: Target and Source checksums are the same, taking no action"
        end
      else
        # We're creating a new file
        Chef::Log.info "#{@new_resource}: Creating #{@new_resource.path}"
        FileUtils.cp raw_file.path, @new_resource.path
        @new_resource.updated = true
      end

      # We're done with the file, so make sure to close it if it was open.
      raw_file.close unless raw_file.closed?
    rescue Net::HTTPRetriableError => e
      if e.response.kind_of?(Net::HTTPNotModified)
        Chef::Log.debug("File #{path} is unchanged")
        retval = false
      else
        raise e
      end
    end
  end
  
  set_owner if @new_resource.owner
  set_group if @new_resource.group
  set_mode  if @new_resource.mode

  retval
end

#get_from_local_cookbook(source) ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/chef/provider/remote_file.rb', line 123

def get_from_local_cookbook(source)
  if Chef::Config[:solo]
    cookbook_name = @new_resource.cookbook || @new_resource.cookbook_name
    filename = find_preferred_file(
      cookbook_name,
      :remote_file,
      source,
      @node[:fqdn],
      @node[:platform],
      @node[:platform_version]
    )
    Chef::Log.debug("Using local file for remote_file:#{filename}")
    ::File.open(filename)
  end
end

#get_from_server(source, current_checksum) ⇒ Object 



114
115
116
117
118
119
120
121
 
# File 'lib/chef/provider/remote_file.rb', line 114

def get_from_server(source, current_checksum)
  unless Chef::Config[:solo]
    r = Chef::REST.new(Chef::Config[:remotefile_url])
    url = generate_url(source, "files", :checksum => current_checksum)
    Chef::Log.debug("Downloading from server: #{url}")
    r.get_rest(url, true).open
  end
end

#get_from_uri(source) ⇒ Object 



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

def get_from_uri(source)
  begin
    uri = URI.parse(source)
    if uri.absolute
      r = Chef::REST.new(source, nil, nil)
      Chef::Log.debug("Downloading from absolute URI: #{source}")
      r.get_rest(source, true).open
    end
  rescue URI::InvalidURIError
    nil
  end
end