-
Notifications
You must be signed in to change notification settings - Fork 656
/
ansible.py
264 lines (215 loc) · 7.86 KB
/
ansible.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
# Copyright (c) 2015-2017 Cisco Systems, Inc.
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
import collections
import os
import yaml
import yaml.representer
import jinja2
from molecule import ansible_playbook
from molecule import util
class Ansible(object):
"""
`Ansible`_ is the default provisioner. No other provisioner will be
supported.
Additional options can be passed to `ansible-playbook` through the options
dict. Any option set in this section will override the defaults.
.. code-block:: yaml
provisioner:
name: ansible
options:
debug: True
"""
def __init__(self, config):
"""
A class encapsulating the provisioner.
:param config: An instance of a Molecule config.
:return: None
"""
self._config = config
self._setup()
@property
def default_config_options(self):
"""
Default options provided to construct ansible.cfg and returns a dict.
:return: dict
"""
return {
'defaults': {
'ansible_managed':
'Ansible managed: Do NOT edit this file manually!',
'retry_files_enabled': False,
'roles_path': '../../../../:$ANSIBLE_LIBRARY',
'filter_plugins': '{}:$ANSIBLE_FILTER_PLUGINS'.format(
self._get_filter_plugin_directory()),
}
}
@property
def default_options(self):
"""
Default CLI arguments provided to `ansible-playbook` and returns a
dict.
:return: dict
"""
d = {}
if self._config.args.get('debug'):
d['debug'] = True
return d
@property
def name(self):
return self._config.config['provisioner']['name']
@property
def config_options(self):
return self._config.merge_dicts(
self.default_config_options,
self._config.config['provisioner']['config_options'])
@property
def options(self):
return self._config.merge_dicts(
self.default_options,
self._config.config['provisioner']['options'])
@property
def inventory(self):
# ungrouped:
# hosts:
# instance-1-default:
# instance-2-default:
# $group_name:
# hosts:
# instance-1-default:
# ansible_connection: docker
# instance-2-default:
# ansible_connection: docker
dd = self._vivify()
for platform in self._config.platforms_with_scenario_name:
for group in platform.get('groups', ['ungrouped']):
instance_name = platform['name']
connection_options = self._config.driver.connection_options
dd[group]['hosts'][instance_name] = connection_options
return dd
@property
def inventory_file(self):
return os.path.join(self._config.ephemeral_directory,
'ansible_inventory.yml')
@property
def config_file(self):
return os.path.join(self._config.ephemeral_directory, 'ansible.cfg')
def converge(self, playbook, **kwargs):
"""
Executes `ansible-playbook` and returns a string.
:param playbook: A string containing an absolute path to a
provisioner's playbook.
:param kwargs: Optional keyword arguments.
:return: str
"""
pb = self._get_ansible_playbook(playbook, **kwargs)
return pb.execute()
def syntax(self, playbook):
"""
Executes `ansible-playbook` syntax check and returns None.
:param playbook: A string containing an absolute path to a
provisioner's playbook.
:return: None
"""
pb = self._get_ansible_playbook(playbook)
pb.add_cli_arg('syntax-check', True)
pb.execute()
def check(self, playbook):
"""
Executes `ansible-playbook` check and returns None.
:param playbook: A string containing an absolute path to a
provisioner's playbook.
:return: None
"""
pb = self._get_ansible_playbook(playbook)
pb.add_cli_arg('check', True)
pb.execute()
def write_inventory(self):
"""
Writes the provisioner's inventory file to disk and returns None.
:return: None
"""
self._verify_inventory()
yaml.add_representer(collections.defaultdict,
yaml.representer.Representer.represent_dict)
util.write_file(self.inventory_file, yaml.dump(self.inventory))
# TODO(retr0h): Move to safe dump
# util.write_file(self.inventory_file, util.safe_dump(self.inventory))
def write_config(self):
"""
Writes the provisioner's config file to disk and returns None.
:return: None
"""
# self._verify_config()
template = jinja2.Environment()
template = template.from_string(self._get_config_template())
template = template.render(config_options=self.config_options)
util.write_file(self.config_file, template)
def _get_ansible_playbook(self, playbook, **kwargs):
"""
Get an instance of AnsiblePlaybook and returns it.
:param playbook: A string containing an absolute path to a
provisioner's playbook.
:param kwargs: Optional keyword arguments.
:return: object
"""
return ansible_playbook.AnsiblePlaybook(self.inventory_file, playbook,
self._config, **kwargs)
def _setup(self):
"""
Prepare the system for using the provisioner and returns None.
:return: None
"""
self.write_inventory()
self.write_config()
def _verify_inventory(self):
"""
Verify the inventory is valid and returns None.
:return: None
"""
if not self.inventory:
msg = ("Instances missing from the 'platform' "
"section of molecule.yml.")
util.print_error(msg)
util.sysexit()
def _get_config_template(self):
"""
Returns a config template string.
:return: str
"""
return """
# Molecule managed
{% for section, section_dict in config_options.iteritems() -%}
[{{ section }}]
{% for k, v in section_dict.iteritems() -%}
{{ k }} = {{ v }}
{% endfor -%}
{% endfor -%}
"""
def _vivify(self):
"""
Return an autovivification default dict.
:return: dict
"""
return collections.defaultdict(self._vivify)
def _get_plugin_directory(self):
return os.path.join(
os.path.dirname(__file__), '..', '..', 'molecule', 'provisioner',
'ansible', 'plugins')
def _get_filter_plugin_directory(self):
return os.path.join(self._get_plugin_directory(), 'filters')