forked from tobami/littlechef
-
Notifications
You must be signed in to change notification settings - Fork 0
/
lib.py
348 lines (301 loc) · 12.1 KB
/
lib.py
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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
#Copyright 2010-2011 Miquel Torres <tobami@googlemail.com>
#
#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.
#
"""library for parsing and printing role, cookbook and node information"""
import os
import simplejson as json
import subprocess
from fabric import colors
from fabric.api import env, settings
from fabric.utils import abort
from littlechef.settings import cookbook_paths
knife_installed = True
def get_nodes():
"""Gets all nodes found in the nodes/ directory"""
if not os.path.exists('nodes/'):
return []
nodes = []
for filename in sorted([f for f in os.listdir('nodes/')
if not os.path.isdir(f) and ".json" in f
and not f.startswith('.')]):
fqdn = ".".join(filename.split('.')[:-1]) # Remove .json from name
node = get_node(fqdn)
# Add node name so that we can tell to which node the data belongs to
node['name'] = fqdn
nodes.append(node)
return nodes
def get_node(name):
node_path = os.path.join("nodes", name + ".json")
if not os.path.exists(node_path):
return {'run_list': []}
# Read node.json
with open(node_path, 'r') as f:
try:
node = json.loads(f.read())
except json.JSONDecodeError as e:
msg = 'LittleChef found the following error in'
msg += ' "{0}":\n {1}'.format(node_path, str(e))
abort(msg)
return node
def print_node(node, detailed=False):
"""Pretty prints the given node"""
nodename = node['name']
print(colors.yellow("\n" + nodename))
# Roles
if detailed:
for role in get_roles_in_node(node):
print_role(_get_role(role), detailed=False)
else:
print(' Roles: {0}'.format(", ".join(get_roles_in_node(node))))
# Recipes
if detailed:
for recipe in get_recipes_in_node(node):
print " Recipe:", recipe
print " attributes: {0}".format(node.get(recipe, ""))
else:
print(' Recipes: {0}'.format(", ".join(get_recipes_in_node(node))))
# Node attributes
print " Node attributes:"
for attribute in node.keys():
if attribute == "run_list" or attribute == "name":
continue
print " {0}: {1}".format(attribute, node[attribute])
def _generate_metadata(path, cookbook_path, name):
"""Checks whether metadata.rb has changed and regenerate metadata.json"""
global knife_installed
if not knife_installed:
return
metadata_path_rb = os.path.join(path, 'metadata.rb')
metadata_path_json = os.path.join(path, 'metadata.json')
if (os.path.exists(metadata_path_rb) and
(not os.path.exists(metadata_path_json) or
os.stat(metadata_path_rb).st_mtime > \
os.stat(metadata_path_json).st_mtime)):
try:
proc = subprocess.Popen(
['knife', 'cookbook', 'metadata', '-o', cookbook_path, name],
stdout=subprocess.PIPE, stderr=subprocess.PIPE)
resp, error = proc.communicate()
if ('FATAL:' in resp or 'Generating metadata for' not in resp):
msg = "Unkown error while generating metadata.json for "
msg += "{0}. Cookbook attributes may be out of date".format(
path)
print(msg)
if env.loglevel == 'debug':
print "\n".join(resp.split("\n")[:2])
else:
print("Generated metadata.json for {0}".format(path))
except OSError:
knife_installed = False
msg = "Warning: metadata.json for {0}".format(name)
msg += " in {0} is older that metadata.rb".format(cookbook_path)
msg += ", and cookbook attributes could be out of date\n"
msg += "If you locally install Chef's knife tool, LittleChef will"
msg += " regenerate metadata files automatically"
print(msg)
def get_recipes_in_cookbook(name):
"""Gets the name of all recipes present in a cookbook
Returns a list of dictionaries
"""
recipes = []
path = None
cookbook_exists = False
metadata_exists = False
for cookbook_path in cookbook_paths:
path = os.path.join(cookbook_path, name)
path_exists = os.path.exists(path)
# cookbook exists if present in any of the cookbook paths
cookbook_exists = cookbook_exists or path_exists
if not path_exists:
continue
_generate_metadata(path, cookbook_path, name)
# Now try to open metadata.json
try:
with open(os.path.join(path, 'metadata.json'), 'r') as f:
try:
cookbook = json.loads(f.read())
except json.JSONDecodeError as e:
msg = "Little Chef found the following error in your"
msg += " {0}.json file:\n {1}".format(
os.path.join(path, 'metadata.json'), e)
abort(msg)
# Add each recipe defined in the cookbook
metadata_exists = True
for recipe in cookbook.get('recipes', []):
recipes.append({
'name': recipe,
'description': cookbook['recipes'][recipe],
'version': cookbook.get('version'),
'dependencies': cookbook.get('dependencies', {}).keys(),
'attributes': cookbook.get('attributes', {}),
})
# When a recipe has no default recipe (libraries?),
# add one so that it is listed
if not recipes:
recipes.append({
'name': name,
'description': 'This cookbook has no default recipe',
'version': cookbook.get('version'),
'dependencies': cookbook.get('dependencies', {}).keys(),
'attributes': cookbook.get('attributes', {})
})
# Cookbook metadata.json was found, don't try next cookbook path
# because metadata.json in site-cookbooks has preference
break
except IOError:
# metadata.json was not found, try next cookbook_path
pass
if not cookbook_exists:
abort('Unable to find cookbook "{0}"'.format(name))
elif not metadata_exists:
abort('Cookbook "{0}" has no metadata.json'.format(name))
return recipes
def get_recipes_in_role(rolename):
"""Gets all recipes defined in a role's run_list"""
recipes = []
role = _get_role(rolename)
recipes.extend(get_recipes_in_node(role))
return recipes
def get_recipes_in_node(node):
"""Gets the name of all recipes present in the run_list of a node"""
recipes = []
for elem in node.get('run_list'):
if elem.startswith("recipe"):
recipe = elem.split('[')[1].split(']')[0]
recipes.append(recipe)
return recipes
def get_recipes():
"""Gets all recipes found in the cookbook directories"""
dirnames = set()
for path in cookbook_paths:
dirnames.update([d for d in os.listdir(path) if os.path.isdir(
os.path.join(path, d)) and not d.startswith('.')])
recipes = []
for dirname in dirnames:
recipes.extend(get_recipes_in_cookbook(dirname))
return sorted(recipes, key=lambda x: x['name'])
def print_recipe(recipe):
"""Pretty prints the given recipe"""
print(colors.yellow("\n{0}".format(recipe['name'])))
print " description: {0}".format(recipe['description'])
print " version: {0}".format(recipe['version'])
print " dependencies: {0}".format(", ".join(recipe['dependencies']))
print " attributes: {0}".format(", ".join(recipe['attributes']))
def get_roles_in_role(rolename):
"""Gets all roles defined in a role's run_list"""
return get_roles_in_node(_get_role(rolename))
def get_roles_in_node(node):
"""Gets the name of all roles found in the run_list of a node"""
roles = []
for elem in node.get('run_list'):
if elem.startswith("role"):
role = elem.split('[')[1].split(']')[0]
roles.append(role)
return roles
def _get_role(rolename):
"""Reads and parses a file containing a role"""
path = 'roles/' + rolename + '.json'
if not os.path.exists(path):
abort("Couldn't read role file {0}".format(path))
with open(path, 'r') as f:
try:
role = json.loads(f.read())
except json.JSONDecodeError as e:
msg = "Little Chef found the following error in your"
msg += " {0}.json file:\n {1}".format(rolename, str(e))
abort(msg)
role['fullname'] = rolename
return role
def get_roles():
"""Gets all roles found in the roles/ directory"""
roles = []
for root, subfolders, files in os.walk('roles/'):
for filename in files:
if filename.endswith(".json"):
path = os.path.join(
root[len('roles/'):], filename[:-len('.json')])
roles.append(_get_role(path))
return sorted(roles, key=lambda x: x['fullname'])
def get_nodes_with_role(rolename):
"""Get all nodes which include a given role,
prefix-searches are also supported
"""
prefix_search = rolename.endswith("*")
if prefix_search:
rolename = rolename.rstrip("*")
for n in get_nodes():
if prefix_search:
roles = get_roles_in_node(n)
if any(role.startswith(rolename) for role in roles):
yield n
else:
if rolename in get_roles_in_node(n):
yield n
def print_role(role, detailed=True):
"""Pretty prints the given role"""
if detailed:
print(colors.yellow(role.get('fullname')))
else:
print(" Role: {0}".format(role.get('fullname')))
if detailed:
print(" description: {0}".format(role.get('description')))
if 'default_attributes' in role:
print(" default_attributes:")
_pprint(role['default_attributes'])
if 'override_attributes' in role:
print(" override_attributes:")
_pprint(role['override_attributes'])
print("")
def get_cookbook_path(cookbook_name):
"""Returns path to the cookbook for the given cookbook name"""
for cookbook_path in cookbook_paths:
path = os.path.join(cookbook_path, cookbook_name)
if os.path.exists(path):
return path
raise IOError('Can\'t find cookbook with name "{0}"'.format(cookbook_name))
def _pprint(dic):
"""Prints a dictionary with one indentation level"""
for key, value in dic.items():
print(" {0}: {1}".format(key, value))
def print_header(string):
"""Prints a colored header"""
print(colors.yellow("\n== {0} ==".format(string)))
def get_margin(length):
"""Add enough tabs to align in two columns"""
if length > 23:
margin_left = "\t"
chars = 1
elif length > 15:
margin_left = "\t\t"
chars = 2
elif length > 7:
margin_left = "\t\t\t"
chars = 3
else:
margin_left = "\t\t\t\t"
chars = 4
return margin_left
def credentials(*args, **kwargs):
"""Override default credentials with contents of .ssh/config,
if appropriate
"""
if env.ssh_config:
credentials = env.ssh_config.lookup(env.host)
# translate from paramiko params to fabric params
if 'identityfile' in credentials:
credentials['key_filename'] = credentials['identityfile']
credentials.update(kwargs)
else:
credentials = kwargs
return settings(*args, **credentials)