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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
|
# -*- coding: utf-8 -*-
# Copyright 2017 Michael De La Rue | Ansible
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
"""This module adds shared support for generic Amazon AWS modules
In order to use this module, include it as part of a custom
module as shown below.
from ansible_collections.amazon.aws.plugins.module_utils.modules import AnsibleAWSModule
module = AnsibleAWSModule(argument_spec=dictionary, supports_check_mode=boolean
mutually_exclusive=list1, required_together=list2)
The 'AnsibleAWSModule' module provides similar, but more restricted,
interfaces to the normal Ansible module. It also includes the
additional methods for connecting to AWS using the standard module arguments
m.resource('lambda') # - get an AWS connection as a boto3 resource.
or
m.client('sts') # - get an AWS connection as a boto3 client.
To make use of AWSRetry easier, it can now be wrapped around any call from a
module-created client. To add retries to a client, create a client:
m.client('ec2', retry_decorator=AWSRetry.jittered_backoff(retries=10))
Any calls from that client can be made to use the decorator passed at call-time
using the `aws_retry` argument. By default, no retries are used.
ec2 = m.client('ec2', retry_decorator=AWSRetry.jittered_backoff(retries=10))
ec2.describe_instances(InstanceIds=['i-123456789'], aws_retry=True)
The call will be retried the specified number of times, so the calling functions
don't need to be wrapped in the backoff decorator.
"""
import logging
import os
import re
import traceback
try:
from cStringIO import StringIO
except ImportError:
# Python 3
from io import StringIO
from ansible.module_utils._text import to_native
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.basic import env_fallback
from ansible.module_utils.basic import missing_required_lib
from ansible.module_utils.common.dict_transformations import camel_dict_to_snake_dict
from .botocore import boto3_at_least
from .botocore import boto3_conn
from .botocore import botocore_at_least
from .botocore import check_sdk_version_supported
from .botocore import gather_sdk_versions
from .botocore import get_aws_connection_info
from .botocore import get_aws_region
from .exceptions import AnsibleBotocoreError
from .retries import RetryingBotoClientWrapper
# Currently only AnsibleAWSModule. However we have a lot of Copy and Paste code
# for Inventory and Lookup modules which we should refactor
class AnsibleAWSModule:
"""An ansible module class for AWS modules
AnsibleAWSModule provides an a class for building modules which
connect to Amazon Web Services. The interface is currently more
restricted than the basic module class with the aim that later the
basic module class can be reduced. If you find that any key
feature is missing please contact the author/Ansible AWS team
(available on #ansible-aws on IRC) to request the additional
features needed.
"""
default_settings = {"default_args": True, "check_boto3": True, "auto_retry": True, "module_class": AnsibleModule}
def __init__(self, **kwargs):
local_settings = {}
for key, default_value in AnsibleAWSModule.default_settings.items():
try:
local_settings[key] = kwargs.pop(key)
except KeyError:
local_settings[key] = default_value
self.settings = local_settings
if local_settings["default_args"]:
argument_spec_full = aws_argument_spec()
try:
argument_spec_full.update(kwargs["argument_spec"])
except (TypeError, NameError):
pass
kwargs["argument_spec"] = argument_spec_full
self._module = AnsibleAWSModule.default_settings["module_class"](**kwargs)
if local_settings["check_boto3"]:
try:
check_sdk_version_supported(warn=self.warn)
except AnsibleBotocoreError as e:
self._module.fail_json(to_native(e))
deprecated_vars = {"EC2_REGION", "EC2_SECURITY_TOKEN", "EC2_SECRET_KEY", "EC2_ACCESS_KEY", "EC2_URL", "S3_URL"}
if deprecated_vars.intersection(set(os.environ.keys())):
self._module.deprecate(
(
"Support for the 'EC2_REGION', 'EC2_ACCESS_KEY', 'EC2_SECRET_KEY', "
"'EC2_SECURITY_TOKEN', 'EC2_URL', and 'S3_URL' environment "
"variables has been deprecated. "
"These variables are currently used for all AWS services which can "
"cause confusion. We recomend using the relevant module "
"parameters or alternatively the 'AWS_REGION', 'AWS_ACCESS_KEY_ID', "
"'AWS_SECRET_ACCESS_KEY', 'AWS_SESSION_TOKEN', and 'AWS_URL' "
"environment variables can be used instead."
),
date="2024-12-01",
collection_name="amazon.aws",
)
if "AWS_SECURITY_TOKEN" in os.environ.keys():
self._module.deprecate(
(
"Support for the 'AWS_SECURITY_TOKEN' environment variable "
"has been deprecated. This variable was based on the original "
"boto SDK, support for which has now been dropped. "
"We recommend using the 'session_token' module parameter "
"or alternatively the 'AWS_SESSION_TOKEN' environment variable "
"can be used instead."
),
date="2024-12-01",
collection_name="amazon.aws",
)
self.check_mode = self._module.check_mode
self._diff = self._module._diff
self._name = self._module._name
self._botocore_endpoint_log_stream = StringIO()
self.logger = None
if self.params.get("debug_botocore_endpoint_logs"):
self.logger = logging.getLogger("botocore.endpoint")
self.logger.setLevel(logging.DEBUG)
self.logger.addHandler(logging.StreamHandler(self._botocore_endpoint_log_stream))
@property
def params(self):
return self._module.params
def _get_resource_action_list(self):
actions = []
for ln in self._botocore_endpoint_log_stream.getvalue().split("\n"):
ln = ln.strip()
if not ln:
continue
found_operational_request = re.search(r"OperationModel\(name=.*?\)", ln)
if found_operational_request:
operation_request = found_operational_request.group(0)[20:-1]
resource = re.search(r"https://.*?\.", ln).group(0)[8:-1]
actions.append(f"{resource}:{operation_request}")
return list(set(actions))
def exit_json(self, *args, **kwargs):
if self.params.get("debug_botocore_endpoint_logs"):
kwargs["resource_actions"] = self._get_resource_action_list()
return self._module.exit_json(*args, **kwargs)
def fail_json(self, *args, **kwargs):
if self.params.get("debug_botocore_endpoint_logs"):
kwargs["resource_actions"] = self._get_resource_action_list()
return self._module.fail_json(*args, **kwargs)
def debug(self, *args, **kwargs):
return self._module.debug(*args, **kwargs)
def warn(self, *args, **kwargs):
return self._module.warn(*args, **kwargs)
def deprecate(self, *args, **kwargs):
return self._module.deprecate(*args, **kwargs)
def boolean(self, *args, **kwargs):
return self._module.boolean(*args, **kwargs)
def md5(self, *args, **kwargs):
return self._module.md5(*args, **kwargs)
def client(self, service, retry_decorator=None, **extra_params):
region, endpoint_url, aws_connect_kwargs = get_aws_connection_info(self)
kw_args = dict(region=region, endpoint=endpoint_url, **aws_connect_kwargs)
kw_args.update(extra_params)
conn = boto3_conn(self, conn_type="client", resource=service, **kw_args)
return conn if retry_decorator is None else RetryingBotoClientWrapper(conn, retry_decorator)
def resource(self, service, **extra_params):
region, endpoint_url, aws_connect_kwargs = get_aws_connection_info(self)
kw_args = dict(region=region, endpoint=endpoint_url, **aws_connect_kwargs)
kw_args.update(extra_params)
return boto3_conn(self, conn_type="resource", resource=service, **kw_args)
@property
def region(self):
return get_aws_region(self)
def fail_json_aws(self, exception, msg=None, **kwargs):
"""call fail_json with processed exception
function for converting exceptions thrown by AWS SDK modules,
botocore, boto3 and boto, into nice error messages.
"""
last_traceback = traceback.format_exc()
# to_native is trusted to handle exceptions that str() could
# convert to text.
try:
except_msg = to_native(exception.message)
except AttributeError:
except_msg = to_native(exception)
if msg is not None:
message = f"{msg}: {except_msg}"
else:
message = except_msg
try:
response = exception.response
except AttributeError:
response = None
failure = dict(msg=message, exception=last_traceback, **self._gather_versions())
failure.update(kwargs)
if response is not None:
failure.update(**camel_dict_to_snake_dict(response))
self.fail_json(**failure)
def fail_json_aws_error(self, exception):
"""A helper to call the right failure mode after catching an AnsibleAWSError"""
if exception.exception:
self.fail_json_aws(exception.exception, msg=exception.message)
self.fail_json(msg=exception.message)
def _gather_versions(self):
"""Gather AWS SDK (boto3 and botocore) dependency versions
Returns {'boto3_version': str, 'botocore_version': str}
Returns {} if either is not installed
"""
return gather_sdk_versions()
def require_boto3_at_least(self, desired, **kwargs):
"""Check if the available boto3 version is greater than or equal to a desired version.
calls fail_json() when the boto3 version is less than the desired
version
Usage:
module.require_boto3_at_least("1.2.3", reason="to update tags")
module.require_boto3_at_least("1.1.1")
:param desired the minimum desired version
:param reason why the version is required (optional)
"""
if not self.boto3_at_least(desired):
self._module.fail_json(
msg=missing_required_lib(f"boto3>={desired}", **kwargs),
**self._gather_versions(),
)
def boto3_at_least(self, desired):
return boto3_at_least(desired)
def require_botocore_at_least(self, desired, **kwargs):
"""Check if the available botocore version is greater than or equal to a desired version.
calls fail_json() when the botocore version is less than the desired
version
Usage:
module.require_botocore_at_least("1.2.3", reason="to update tags")
module.require_botocore_at_least("1.1.1")
:param desired the minimum desired version
:param reason why the version is required (optional)
"""
if not self.botocore_at_least(desired):
self._module.fail_json(
msg=missing_required_lib(f"botocore>={desired}", **kwargs),
**self._gather_versions(),
)
def botocore_at_least(self, desired):
return botocore_at_least(desired)
def _aws_common_argument_spec():
"""
This does not include 'region' as some AWS APIs don't require a
region. However, it's not recommended to do this as it means module_defaults
can't include the region parameter.
"""
return dict(
access_key=dict(
aliases=["aws_access_key_id", "aws_access_key", "ec2_access_key"],
deprecated_aliases=[
dict(name="ec2_access_key", date="2024-12-01", collection_name="amazon.aws"),
],
fallback=(env_fallback, ["AWS_ACCESS_KEY_ID", "AWS_ACCESS_KEY", "EC2_ACCESS_KEY"]),
no_log=False,
),
secret_key=dict(
aliases=["aws_secret_access_key", "aws_secret_key", "ec2_secret_key"],
deprecated_aliases=[
dict(name="ec2_secret_key", date="2024-12-01", collection_name="amazon.aws"),
],
fallback=(env_fallback, ["AWS_SECRET_ACCESS_KEY", "AWS_SECRET_KEY", "EC2_SECRET_KEY"]),
no_log=True,
),
session_token=dict(
aliases=["aws_session_token", "security_token", "access_token", "aws_security_token"],
deprecated_aliases=[
dict(name="access_token", date="2024-12-01", collection_name="amazon.aws"),
dict(name="security_token", date="2024-12-01", collection_name="amazon.aws"),
dict(name="aws_security_token", date="2024-12-01", collection_name="amazon.aws"),
],
fallback=(env_fallback, ["AWS_SESSION_TOKEN", "AWS_SECURITY_TOKEN", "EC2_SECURITY_TOKEN"]),
no_log=True,
),
profile=dict(
aliases=["aws_profile"],
fallback=(env_fallback, ["AWS_PROFILE", "AWS_DEFAULT_PROFILE"]),
),
endpoint_url=dict(
aliases=["aws_endpoint_url", "ec2_url", "s3_url"],
deprecated_aliases=[
dict(name="ec2_url", date="2024-12-01", collection_name="amazon.aws"),
dict(name="s3_url", date="2024-12-01", collection_name="amazon.aws"),
],
fallback=(env_fallback, ["AWS_URL", "EC2_URL", "S3_URL"]),
),
validate_certs=dict(
type="bool",
default=True,
),
aws_ca_bundle=dict(
type="path",
fallback=(env_fallback, ["AWS_CA_BUNDLE"]),
),
aws_config=dict(
type="dict",
),
debug_botocore_endpoint_logs=dict(
type="bool",
default=False,
fallback=(env_fallback, ["ANSIBLE_DEBUG_BOTOCORE_LOGS"]),
),
)
def aws_argument_spec():
"""
Returns a dictionary containing the argument_spec common to all AWS modules.
"""
region_spec = dict(
region=dict(
aliases=["aws_region", "ec2_region"],
deprecated_aliases=[
dict(name="ec2_region", date="2024-12-01", collection_name="amazon.aws"),
],
fallback=(env_fallback, ["AWS_REGION", "AWS_DEFAULT_REGION", "EC2_REGION"]),
),
)
spec = _aws_common_argument_spec()
spec.update(region_spec)
return spec
|