Class: Chef::ChefFS::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/chef/chef_fs/config.rb

Overview

Helpers to take Chef::Config and create chef_fs and local_fs (ChefFS objects representing the server and local repository, respectively).

Constant Summary collapse

INFLECTIONS =

Not all of our object types pluralize by adding an ‘s’, so we map them out here:

{
  "acls" => "acl",
  "clients" => "client",
  "cookbooks" => "cookbook",
  "containers" => "container",
  "data_bags" => "data_bag",
  "environments" => "environment",
  "groups" => "group",
  "nodes" => "node",
  "roles" => "role",
  "users" => "user",
  "policies" => "policy"
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(chef_config = Chef::Config, cwd = Dir.pwd, options = {}, ui = nil) ⇒ Config

Create a new Config object which can produce a chef_fs and local_fs.

Arguments

chef_config

A hash that looks suspiciously like Chef::Config. These hash keys include:

:chef_repo_path

The root where all local chef object data is stored. Mirrors Chef::Config.chef_repo_path

:cookbook_path, node_path, …

Paths to cookbooks/, nodes/, data_bags/, etc. Mirrors Chef::Config.cookbook_path, etc. Defaults to <chef_repo_path>/cookbooks, etc.

:repo_mode

The directory format on disk. ‘everything’, ‘hosted_everything’ and ‘static’. Default: autodetected based on whether the URL has “/organizations/NAME.”

:versioned_cookbooks

If true, the repository contains cookbooks with versions in their name (apache2-1.0.0). If false, the repository just has one version of each cookbook and the directory has the cookbook name (apache2). Default: false

:chef_server_url

The URL to the Chef server, e.g. api.opscode.com/organizations/foo. Used as the server for the remote chef_fs, and to “guess” repo_mode if not specified.

:node_name

The username to authenticate to the Chef server with.

:client_key

The private key for the user for authentication

:environment

The environment in which you are presently working

:repo_mode

The repository mode, :hosted_everything, :everything or :static. This determines the set of subdirectories the Chef server will offer up.

:versioned_cookbooks

Whether or not to include versions in cookbook names

cwd

The current working directory to base relative Chef paths from. Defaults to Dir.pwd.

options

A hash of other, not-suspiciously-like-chef-config options:

:cookbook_version

When downloading cookbooks, download this cookbook version instead of the latest.

ui

The object to print output to, with “output”, “warn” and “error” (looks a little like a Chef::Knife::UI object, obtainable from Chef::Knife.ui).

Example

require 'chef/chef_fs/config'
config = Chef::ChefFS::Config.new
config.chef_fs.child('cookbooks').children.each do |cookbook|
  puts "Cookbook on server: #{cookbook.name}"
end
config.local_fs.child('cookbooks').children.each do |cookbook|
  puts "Local cookbook: #{cookbook.name}"
end



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/chef/chef_fs/config.rb', line 112

def initialize(chef_config = Chef::Config, cwd = Dir.pwd, options = {}, ui = nil)
  @chef_config = chef_config
  @cwd = cwd
  @cookbook_version = options[:cookbook_version]

  if @chef_config[:repo_mode] == 'everything' && is_hosted? && !ui.nil?
    ui.warn %Q{You have repo_mode set to 'everything', but your chef_server_url
        looks like it might be a hosted setup.  If this is the case please use
        hosted_everything or allow repo_mode to default}
  end
  # Default to getting *everything* from the server.
  if !@chef_config[:repo_mode]
    if is_hosted?
      @chef_config[:repo_mode] = 'hosted_everything'
    else
      @chef_config[:repo_mode] = 'everything'
    end
  end
end

Instance Attribute Details

#chef_config ⇒ Object (readonly)

Returns the value of attribute chef_config.



132
133
134
 
# File 'lib/chef/chef_fs/config.rb', line 132

def chef_config
  @chef_config
end

#cookbook_version ⇒ Object (readonly)

Returns the value of attribute cookbook_version.



134
135
136
 
# File 'lib/chef/chef_fs/config.rb', line 134

def cookbook_version
  @cookbook_version
end

#cwd ⇒ Object (readonly)

Returns the value of attribute cwd.



133
134
135
 
# File 'lib/chef/chef_fs/config.rb', line 133

def cwd
  @cwd
end

Instance Method Details

#base_path ⇒ Object

The current directory, relative to server root



205
206
207
208
209
210
211
212
213
 
# File 'lib/chef/chef_fs/config.rb', line 205

def base_path
  @base_path ||= begin
    if @chef_config[:chef_repo_path]
      server_path(File.expand_path(@cwd))
    else
      nil
    end
  end
end

#chef_fs ⇒ Object 



140
141
142
 
# File 'lib/chef/chef_fs/config.rb', line 140

def chef_fs
  @chef_fs ||= create_chef_fs
end

#create_chef_fs ⇒ Object 



144
145
146
147
 
# File 'lib/chef/chef_fs/config.rb', line 144

def create_chef_fs
  require 'chef/chef_fs/file_system/chef_server_root_dir'
  Chef::ChefFS::FileSystem::ChefServerRootDir.new("remote", @chef_config, :cookbook_version => @cookbook_version)
end

#create_local_fs ⇒ Object 



153
154
155
156
 
# File 'lib/chef/chef_fs/config.rb', line 153

def create_local_fs
  require 'chef/chef_fs/file_system/chef_repository_file_system_root_dir'
  Chef::ChefFS::FileSystem::ChefRepositoryFileSystemRootDir.new(object_paths, Array(chef_config[:chef_repo_path]).flatten, @chef_config)
end

#format_path(entry) ⇒ Object

Print the given server path, relative to the current directory



216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/chef/chef_fs/config.rb', line 216

def format_path(entry)
  server_path = entry.path
  if base_path && server_path[0,base_path.length] == base_path
    if server_path == base_path
      return "."
    elsif server_path[base_path.length,1] == "/"
      return server_path[base_path.length + 1, server_path.length - base_path.length - 1]
    elsif base_path == "/" && server_path[0,1] == "/"
      return server_path[1, server_path.length - 1]
    end
  end
  server_path
end

#is_hosted? ⇒ Boolean

Returns:

  • (Boolean) 


136
137
138
 
# File 'lib/chef/chef_fs/config.rb', line 136

def is_hosted?
  @chef_config[:chef_server_url] =~ /\/+organizations\/.+/
end

#local_fs ⇒ Object 



149
150
151
 
# File 'lib/chef/chef_fs/config.rb', line 149

def local_fs
  @local_fs ||= create_local_fs
end

#server_path(file_path) ⇒ Object

Returns the given real path’s location relative to the server root.

If chef_repo is /home/jkeiser/chef_repo, and pwd is /home/jkeiser/chef_repo/cookbooks, server_path(‘blah’) == ‘/cookbooks/blah’ server_path(‘../roles/blah.json’) == ‘/roles/blah’ server_path(‘../../readme.txt’) == nil server_path(‘*/ab’) == ‘/cookbooks/*/ab’ server_path(‘/home/jkeiser/chef_repo/cookbooks/blah’) == ‘/cookbooks/blah’ server_path(‘/home/*/chef_repo/cookbooks/blah’) == nil

If there are multiple paths (cookbooks, roles, data bags, etc. can all have separate paths), and cwd+the path reaches into one of them, we will return a path relative to that. Otherwise we will return a path to chef_repo.

Globs are allowed as well, but globs outside server paths are NOT (presently) supported. See above examples. TODO support that.

If the path does not reach into ANY specified directory, nil is returned.



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
 
# File 'lib/chef/chef_fs/config.rb', line 178

def server_path(file_path)
  pwd = File.expand_path(Dir.pwd)
  absolute_pwd = Chef::ChefFS::PathUtils.realest_path(File.expand_path(file_path, pwd))

  # Check all object paths (cookbooks_dir, data_bags_dir, etc.)
  object_paths.each_pair do |name, paths|
    paths.each do |path|
      realest_path = Chef::ChefFS::PathUtils.realest_path(path)
      if PathUtils.descendant_of?(absolute_pwd, realest_path)
        relative_path = Chef::ChefFS::PathUtils::relative_to(absolute_pwd, realest_path)
        return relative_path == '.' ? "/#{name}" : "/#{name}/#{relative_path}"
      end
    end
  end

  # Check chef_repo_path
  Array(@chef_config[:chef_repo_path]).flatten.each do |chef_repo_path|
    realest_chef_repo_path = Chef::ChefFS::PathUtils.realest_path(chef_repo_path)
    if absolute_pwd == realest_chef_repo_path
      return '/'
    end
  end

  nil
end