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
|
# Copyright (c) 2013-2014 Will Thames <will@thames.id.au>
#
# 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 re
import six
from ansiblelint import AnsibleLintRule
class UsingBareVariablesIsDeprecatedRule(AnsibleLintRule):
id = '104'
shortdesc = 'Using bare variables is deprecated'
description = (
'Using bare variables is deprecated. Update your '
'playbooks so that the environment value uses the full variable '
'syntax ``{{ your_variable }}``'
)
severity = 'VERY_HIGH'
tags = ['deprecated', 'formatting', 'ANSIBLE0015']
version_added = 'historic'
_jinja = re.compile(r"{{.*}}")
_glob = re.compile('[][*?]')
def matchtask(self, file, task):
loop_type = next((key for key in task
if key.startswith("with_")), None)
if loop_type:
if loop_type in ["with_nested", "with_together", "with_flattened"]:
# These loops can either take a list defined directly in the task
# or a variable that is a list itself. When a single variable is used
# we just need to check that one variable, and not iterate over it like
# it's a list. Otherwise, loop through and check all items.
items = task[loop_type]
if not isinstance(items, (list, tuple)):
items = [items]
for var in items:
return self._matchvar(var, task, loop_type)
elif loop_type == "with_subelements":
return self._matchvar(task[loop_type][0], task, loop_type)
elif loop_type in ["with_sequence", "with_ini",
"with_inventory_hostnames"]:
pass
else:
return self._matchvar(task[loop_type], task, loop_type)
def _matchvar(self, varstring, task, loop_type):
if (isinstance(varstring, six.string_types) and
not self._jinja.match(varstring)):
if loop_type != 'with_fileglob' or not (self._jinja.search(varstring) or
self._glob.search(varstring)):
message = "Found a bare variable '{0}' used in a '{1}' loop." + \
" You should use the full variable syntax ('{{{{{0}}}}}')"
return message.format(task[loop_type], loop_type)
|
