1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
#
# Author:: John Keiser (<jkeiser@opscode.com>)
# Copyright:: Copyright (c) 2012 Opscode, Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
require 'chef/log'
require 'chef/chef_fs/path_utils'
class Chef
module ChefFS
#
# Helpers to take Chef::Config and create chef_fs and local_fs (ChefFS
# objects representing the server and local repository, respectively).
#
class 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. https://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
#
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
attr_reader :chef_config
attr_reader :cwd
attr_reader :cookbook_version
def is_hosted?
@chef_config[:chef_server_url] =~ /\/+organizations\/.+/
end
def chef_fs
@chef_fs ||= create_chef_fs
end
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
def local_fs
@local_fs ||= create_local_fs
end
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
# 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.
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
# The current directory, relative to server root
def base_path
@base_path ||= begin
if @chef_config[:chef_repo_path]
server_path(File.expand_path(@cwd))
else
nil
end
end
end
# Print the given server path, relative to the current directory
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
private
def object_paths
@object_paths ||= begin
result = {}
case @chef_config[:repo_mode]
when 'static'
object_names = %w(cookbooks data_bags environments roles)
when 'hosted_everything'
object_names = %w(acls clients cookbooks containers data_bags environments groups nodes roles)
else
object_names = %w(clients cookbooks data_bags environments nodes roles users)
end
object_names.each do |object_name|
variable_name = "#{object_name[0..-2]}_path" # cookbooks -> cookbook_path
paths = Array(@chef_config[variable_name]).flatten
result[object_name] = paths.map { |path| File.expand_path(path) }
end
result
end
end
end
end
end
|
