-
Notifications
You must be signed in to change notification settings - Fork 656
/
ansible_lint.py
165 lines (130 loc) · 4.81 KB
/
ansible_lint.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
# Copyright (c) 2015-2018 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 os
import sh
from molecule import logger
from molecule import util
from molecule.provisioner.lint import base
LOG = logger.get_logger(__name__)
__metaclass__ = type
class AnsibleLintMixin:
def __init__(self, config):
"""
Sets up the requirements to execute `ansible-lint` and returns None.
:param config: An instance of a Molecule config.
:return: None
"""
super(AnsibleLintMixin, self).__init__(config)
self._ansible_lint_command = None
@property
def default_options(self):
d = {
'default_exclude': [self._config.scenario.ephemeral_directory],
'exclude': [],
'x': [],
}
if self._config.debug:
d['v'] = True
return d
@property
def default_env(self):
env = util.merge_dicts(os.environ, self._config.env)
env = util.merge_dicts(env, self._action_env)
return env
def bake(self):
"""
Bake an `ansible-lint` command so it's ready to execute and returns
None.
:return: None
"""
options = self.options
default_exclude_list = options.pop('default_exclude')
options_exclude_list = options.pop('exclude')
excludes = default_exclude_list + options_exclude_list
x_list = options.pop('x')
exclude_args = ['--exclude={}'.format(exclude) for exclude in excludes]
x_args = tuple(('-x', x) for x in x_list)
self._ansible_lint_command = sh.ansible_lint.bake(
options,
exclude_args,
sum(x_args, ()),
self._playbook,
_env=self.env,
_out=LOG.out,
_err=LOG.error,
)
def execute(self):
if not self.enabled:
msg = 'Skipping, lint is disabled.'
LOG.warn(msg)
return
if self._ansible_lint_command is None:
self.bake()
msg = 'Executing Ansible Lint on {}...'.format(self._playbook)
LOG.info(msg)
try:
util.run_command(self._ansible_lint_command, debug=self._config.debug)
msg = 'Lint completed successfully.'
LOG.success(msg)
except sh.ErrorReturnCode as e:
util.sysexit(e.exit_code)
class AnsibleLint(AnsibleLintMixin, base.Base):
"""
`Ansible Lint`_ is the default role linter.
`Ansible Lint`_ checks playbooks for practices, and behaviour that could
potentially be improved.
Additional options can be passed to `ansible-lint` through the options
dict. Any option set in this section will override the defaults.
.. code-block:: yaml
provisioner:
name: ansible
lint:
name: ansible-lint
options:
exclude:
- path/exclude1
- path/exclude2
x: ["ANSIBLE0011,ANSIBLE0012"]
force-color: True
The `x` option has to be passed like this due to a `bug`_ in Ansible Lint.
The role linting can be disabled by setting ``enabled`` to ``False``.
.. code-block:: yaml
provisioner:
name: ansible
lint:
name: ansible-lint
enabled: False
Environment variables can be passed to lint.
.. code-block:: yaml
provisioner:
name: ansible
lint:
name: ansible-lint
env:
FOO: bar
.. _`Ansible Lint`: https://github.com/ansible/ansible-lint
.. _`bug`: https://github.com/ansible/ansible-lint/issues/279
"""
@property
def _playbook(self):
return self._config.provisioner.playbooks.converge
@property
def _action_env(self):
return self._config.verifier.env