-
Notifications
You must be signed in to change notification settings - Fork 656
/
yamllint.py
157 lines (122 loc) · 4.66 KB
/
yamllint.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
# 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.lint import base
LOG = logger.get_logger(__name__)
class Yamllint(base.Base):
"""
`yamllint`_ is the default projet linter.
`yamllint`_ is a linter for YAML files. In addition to checking for syntax
validity it also checks for key repetition as well as cosmetic problems
such as line length, trailing spaces, and indentation.
The default ``yamllint`` settings that ship with ``molecule`` can be found
in the `cookiecutter template`_.
Additional options can be passed to ``yamllint`` through the options
dict. Any option set in this section will override the defaults. See the
`yamllint rules`_ for more options.
.. code-block:: yaml
lint:
name: yamllint
options:
config-file: foo/bar
The project linting can be disabled by setting ``enabled`` to ``False``.
.. code-block:: yaml
lint:
name: yamllint
enabled: False
Environment variables can be passed to lint.
.. code-block:: yaml
lint:
name: yamllint
env:
FOO: bar
Paths can be ignored.
.. code-block:: yaml
lint:
name: yamllint
options:
config-data:
ignore: path_to_ignore
.. _`yamllint`: https://github.com/adrienverge/yamllint
.. _`yamllint rules`: https://yamllint.readthedocs.io/en/stable/rules.html
.. _`cookiecutter template`: https://github.com/ansible/molecule/blob/ma\
ster/molecule/cookiecutter/molecule/%7B%7Bcookiecutter.role_name%7\
D%7D/.yamllint
"""
def __init__(self, config):
"""
Sets up the requirements to execute ``yamllint`` and returns None.
:param config: An instance of a Molecule config.
:return: None
"""
super(Yamllint, self).__init__(config)
self._yamllint_command = None
self._files = self._get_files()
@property
def default_options(self):
return {'s': True}
@property
def default_env(self):
return util.merge_dicts(os.environ, self._config.env)
def bake(self):
"""
Bake a ``yamllint`` command so it's ready to execute and returns None.
:return: None
"""
self._yamllint_command = sh.yamllint.bake(
self.options, self._files, _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._yamllint_command is None:
self.bake()
msg = 'Executing Yamllint on files found in {}/...'.format(
self._config.project_directory
)
LOG.info(msg)
try:
util.run_command(self._yamllint_command, debug=self._config.debug)
msg = 'Lint completed successfully.'
LOG.success(msg)
except sh.ErrorReturnCode as e:
util.sysexit(e.exit_code)
def _get_files(self):
"""
Walk the project directory for tests and returns a list.
:return: list
"""
excludes = [
'.git',
'.tox',
'.vagrant',
'.venv',
os.path.basename(self._config.verifier.directory),
]
generators = [
util.os_walk(self._config.project_directory, '*.yml', excludes),
util.os_walk(self._config.project_directory, '*.yaml', excludes),
]
return [f for g in generators for f in g]