Class: Chef::ChefFS::FileSystem::CookbookDir

Inherits:
BaseFSDir show all
Defined in:
lib/chef/chef_fs/file_system/cookbook_dir.rb

Constant Summary collapse

COOKBOOK_SEGMENT_INFO = 
{
  :attributes => { :ruby_only => true },
  :definitions => { :ruby_only => true },
  :recipes => { :ruby_only => true },
  :libraries => { :ruby_only => true },
  :templates => { :recursive => true },
  :files => { :recursive => true },
  :resources => { :ruby_only => true, :recursive => true },
  :providers => { :ruby_only => true, :recursive => true },
  :root_files => { }
}
VALID_VERSIONED_COOKBOOK_NAME =

See Erchef code github.com/opscode/chef_objects/blob/968a63344d38fd507f6ace05f73d53e9cd7fb043/src/chef_regex.erl#L94

/^([.a-zA-Z0-9_-]+)-(\d+\.\d+\.\d+)$/

Instance Attribute Summary collapse

Attributes inherited from BaseFSObject

#name, #parent, #path

Instance Method Summary collapse

Methods inherited from BaseFSObject

#create_child, #path_for_printing, #read, #root, #write

Constructor Details

#initialize(name, parent, options = {}) ⇒ CookbookDir

Returns a new instance of CookbookDir.



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/chef/chef_fs/file_system/cookbook_dir.rb', line 30

def initialize(name, parent, options = {})
  super(name, parent)
  @exists = options[:exists]
  # If the name is apache2-1.0.0 and versioned_cookbooks is on, we know
  # the actual cookbook_name and version.
  if Chef::Config[:versioned_cookbooks]
    if name =~ VALID_VERSIONED_COOKBOOK_NAME
      @cookbook_name = $1
      @version = $2
    else
      @exists = false
    end
  else
    @cookbook_name = name
    @version = root.cookbook_version # nil unless --cookbook-version specified in download/diff
  end
end

Instance Attribute Details

#cookbook_name ⇒ Object (readonly)

Returns the value of attribute cookbook_name.



48
49
50
 
# File 'lib/chef/chef_fs/file_system/cookbook_dir.rb', line 48

def cookbook_name
  @cookbook_name
end

#version ⇒ Object (readonly)

Returns the value of attribute version.



48
49
50
 
# File 'lib/chef/chef_fs/file_system/cookbook_dir.rb', line 48

def version
  @version
end

Instance Method Details

#add_child(child) ⇒ Object 



66
67
68
 
# File 'lib/chef/chef_fs/file_system/cookbook_dir.rb', line 66

def add_child(child)
  @children << child
end

#api_path ⇒ Object 



70
71
72
 
# File 'lib/chef/chef_fs/file_system/cookbook_dir.rb', line 70

def api_path
  "#{parent.api_path}/#{cookbook_name}/#{version || "_latest"}"
end

#can_have_child?(name, is_dir) ⇒ Boolean

Returns:

  • (Boolean) 


86
87
88
89
90
 
# File 'lib/chef/chef_fs/file_system/cookbook_dir.rb', line 86

def can_have_child?(name, is_dir)
  # A cookbook's root may not have directories unless they are segment directories
  return name != 'root_files' && COOKBOOK_SEGMENT_INFO.keys.include?(name.to_sym) if is_dir
  return true
end

#chef_object ⇒ Object 



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/chef/chef_fs/file_system/cookbook_dir.rb', line 175

def chef_object
  # We cheat and cache here, because it seems like a good idea to keep
  # the cookbook view consistent with the directory structure.
  return @chef_object if @chef_object

  # The negative (not found) response is cached
  if @could_not_get_chef_object
    raise Chef::ChefFS::FileSystem::NotFoundError.new(self, @could_not_get_chef_object)
  end

  begin
    # We want to fail fast, for now, because of the 500 issue :/
    # This will make things worse for parallelism, a little, because
    # Chef::Config is global and this could affect other requests while
    # this request is going on.  (We're not parallel yet, but we will be.)
    # Chef bug http://tickets.opscode.com/browse/CHEF-3066
    old_retry_count = Chef::Config[:http_retry_count]
    begin
      Chef::Config[:http_retry_count] = 0
      @chef_object ||= Chef::CookbookVersion.json_create(root.get_json(api_path))
    ensure
      Chef::Config[:http_retry_count] = old_retry_count
    end

  rescue Timeout::Error => e
    raise Chef::ChefFS::FileSystem::OperationFailedError.new(:read, self, e), "Timeout reading: #{e}"

  rescue Net::HTTPServerException => e
    if e.response.code == "404"
      @could_not_get_chef_object = e
      raise Chef::ChefFS::FileSystem::NotFoundError.new(self, @could_not_get_chef_object)
    else
      raise Chef::ChefFS::FileSystem::OperationFailedError.new(:read, self, e), "HTTP error reading: #{e}"
    end

  # Chef bug http://tickets.opscode.com/browse/CHEF-3066 ... instead of 404 we get 500 right now.
  # Remove this when that bug is fixed.
  rescue Net::HTTPFatalError => e
    if e.response.code == "500"
      @could_not_get_chef_object = e
      raise Chef::ChefFS::FileSystem::NotFoundError.new(self, @could_not_get_chef_object)
    else
      raise Chef::ChefFS::FileSystem::OperationFailedError.new(:read, self, e), "HTTP error reading: #{e}"
    end
  end
end

#child(name) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/chef/chef_fs/file_system/cookbook_dir.rb', line 74

def child(name)
  # Since we're ignoring the rules and doing a network request here,
  # we need to make sure we don't rethrow the exception.  (child(name)
  # is not supposed to fail.)
  begin
    result = children.select { |child| child.name == name }.first
    return result if result
  rescue Chef::ChefFS::FileSystem::NotFoundError
  end
  return NonexistentFSObject.new(name, self)
end

#children ⇒ Object 



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
 
# File 'lib/chef/chef_fs/file_system/cookbook_dir.rb', line 92

def children
  if @children.nil?
    @children = []
    manifest = chef_object.manifest
    COOKBOOK_SEGMENT_INFO.each do |segment, segment_info|
      next unless manifest.has_key?(segment)

      # Go through each file in the manifest for the segment, and
      # add cookbook subdirs and files for it.
      manifest[segment].each do |segment_file|
        parts = segment_file[:path].split('/')
        # Get or create the path to the file
        container = self
        parts[0,parts.length-1].each do |part|
          old_container = container
          container = old_container.children.select { |child| part == child.name }.first
          if !container
            container = CookbookSubdir.new(part, old_container, segment_info[:ruby_only], segment_info[:recursive])
            old_container.add_child(container)
          end
        end
        # Create the file itself
        container.add_child(CookbookFile.new(parts[parts.length-1], container, segment_file))
      end
    end
    @children = @children.sort_by { |c| c.name }
  end
  @children
end

#compare_to(other) ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/chef/chef_fs/file_system/cookbook_dir.rb', line 154

def compare_to(other)
  if !other.dir?
    return [ !exists?, nil, nil ]
  end
  are_same = true
  Chef::ChefFS::CommandLine::diff_entries(self, other, nil, :name_only).each do |type, old_entry, new_entry|
    if [ :directory_to_file, :file_to_directory, :deleted, :added, :modified ].include?(type)
      are_same = false
    end
  end
  [ are_same, nil, nil ]
end

#copy_from(other, options = {}) ⇒ Object 



167
168
169
 
# File 'lib/chef/chef_fs/file_system/cookbook_dir.rb', line 167

def copy_from(other, options = {})
  parent.upload_cookbook_from(other, options)
end

#delete(recurse) ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/chef/chef_fs/file_system/cookbook_dir.rb', line 126

def delete(recurse)
  if recurse
    begin
      rest.delete(api_path)
    rescue Timeout::Error => e
      raise Chef::ChefFS::FileSystem::OperationFailedError.new(:delete, self, e), "Timeout deleting: #{e}"
    rescue Net::HTTPServerException
      if $!.response.code == "404"
        raise Chef::ChefFS::FileSystem::NotFoundError.new(self, $!)
      else
        raise Chef::ChefFS::FileSystem::OperationFailedError.new(:delete, self, e), "HTTP error deleting: #{e}"
      end
    end
  else
    raise NotFoundError.new(self) if !exists?
    raise MustDeleteRecursivelyError.new(self), "#{path_for_printing} must be deleted recursively"
  end
end

#dir? ⇒ Boolean

Returns:

  • (Boolean) 


122
123
124
 
# File 'lib/chef/chef_fs/file_system/cookbook_dir.rb', line 122

def dir?
  exists?
end

#exists? ⇒ Boolean

In versioned cookbook mode, actually check if the version exists Probably want to cache this.

Returns:

  • (Boolean) 


147
148
149
150
151
152
 
# File 'lib/chef/chef_fs/file_system/cookbook_dir.rb', line 147

def exists?
  if @exists.nil?
    @exists = parent.children.any? { |child| child.name == name }
  end
  @exists
end

#rest ⇒ Object 



171
172
173
 
# File 'lib/chef/chef_fs/file_system/cookbook_dir.rb', line 171

def rest
  parent.rest
end