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
|
# -*- coding: utf-8 -*-
# Author: Adrián Tóth <adtoth@redhat.com>
#
# Copyright (c) 2020, Red Hat, 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.
from collections import namedtuple
import pytest
from ansiblelint.runner import Runner
PlayFile = namedtuple('PlayFile', ['name', 'content'])
FAIL_TASK_1LN = PlayFile('playbook.yml', '''
- hosts: all
tasks:
- name: one-level nesting
set_fact:
var_one: "2*(1+2) is {{ 2 * {{ 1 + 2 }} }}"
''')
FAIL_TASK_1LN_M = PlayFile('playbook.yml', '''
- hosts: all
tasks:
- name: one-level multiline nesting
set_fact:
var_one_ml: >
2*(1+2) is {{ 2 *
{{ 1 + 2 }}
}}
''')
FAIL_TASK_2LN = PlayFile('playbook.yml', '''
- hosts: all
tasks:
- name: two-level nesting
set_fact:
var_two: "2*(1+(3-1)) is {{ 2 * {{ 1 + {{ 3 - 1 }} }} }}"
''')
FAIL_TASK_2LN_M = PlayFile('playbook.yml', '''
- hosts: all
tasks:
- name: two-level multiline nesting
set_fact:
var_two_ml: >
2*(1+(3-1)) is {{ 2 *
{{ 1 +
{{ 3 - 1 }}
}} }}
''')
FAIL_TASK_W_5LN = PlayFile('playbook.yml', '''
- hosts: all
tasks:
- name: five-level wild nesting
set_fact:
var_three_wld: "{{ {{ {{ {{ {{ 234 }} }} }} }} }}"
''')
FAIL_TASK_W_5LN_M = PlayFile('playbook.yml', '''
- hosts: all
tasks:
- name: five-level wild multiline nesting
set_fact:
var_three_wld_ml: >
{{
{{
{{
{{
{{ 234 }}
}}
}}
}}
}}
''')
SUCCESS_TASK_P = PlayFile('playbook.yml', '''
- hosts: all
tasks:
- name: non-nested example
set_fact:
var_one: "number for 'one' is {{ 2 * 1 }}"
''')
SUCCESS_TASK_P_M = PlayFile('playbook.yml', '''
- hosts: all
tasks:
- name: multiline non-nested example
set_fact:
var_one_ml: >
number for 'one' is {{
2 * 1 }}
''')
SUCCESS_TASK_2P = PlayFile('playbook.yml', '''
- hosts: all
tasks:
- name: nesting far from each other
set_fact:
var_two: "number for 'two' is {{ 2 * 1 }} and number for 'three' is {{ 4 - 1 }}"
''')
SUCCESS_TASK_2P_M = PlayFile('playbook.yml', '''
- hosts: all
tasks:
- name: multiline nesting far from each other
set_fact:
var_two_ml: >
number for 'two' is {{ 2 * 1
}} and number for 'three' is {{
4 - 1 }}
''')
SUCCESS_TASK_C_2P = PlayFile('playbook.yml', '''
- hosts: all
tasks:
- name: nesting close to each other
set_fact:
var_three: "number for 'ten' is {{ 2 - 1 }}{{ 3 - 3 }}"
''')
SUCCESS_TASK_C_2P_M = PlayFile('playbook.yml', '''
- hosts: all
tasks:
- name: multiline nesting close to each other
set_fact:
var_three_ml: >
number for 'ten' is {{
2 - 1
}}{{ 3 - 3 }}
''')
@pytest.fixture
def runner(tmp_path, default_rules_collection):
return Runner(
default_rules_collection,
str(tmp_path / 'playbook.yml'),
[], [], [],
)
@pytest.fixture
def _playbook_file(tmp_path, request):
if request.param is None:
return
for play_file in request.param:
p = tmp_path / play_file.name
p.write_text(play_file.content)
@pytest.mark.parametrize(
'_playbook_file',
(
pytest.param([FAIL_TASK_1LN], id='file includes one-level nesting'),
pytest.param([FAIL_TASK_1LN_M], id='file includes one-level multiline nesting'),
pytest.param([FAIL_TASK_2LN], id='file includes two-level nesting'),
pytest.param([FAIL_TASK_2LN_M], id='file includes two-level multiline nesting'),
pytest.param([FAIL_TASK_W_5LN], id='file includes five-level wild nesting'),
pytest.param([FAIL_TASK_W_5LN_M], id='file includes five-level wild multiline nesting'),
),
indirect=['_playbook_file'],
)
@pytest.mark.usefixtures('_playbook_file')
def test_including_wrong_nested_jinja(runner):
rule_violations = runner.run()
assert rule_violations[0].rule.id == '207'
@pytest.mark.parametrize(
'_playbook_file',
(
pytest.param([SUCCESS_TASK_P], id='file includes non-nested example'),
pytest.param([SUCCESS_TASK_P_M], id='file includes multiline non-nested example'),
pytest.param([SUCCESS_TASK_2P], id='file includes nesting far from each other'),
pytest.param([SUCCESS_TASK_2P_M], id='file includes multiline nesting far from each other'),
pytest.param([SUCCESS_TASK_C_2P], id='file includes nesting close to each other'),
pytest.param(
[SUCCESS_TASK_C_2P_M],
id='file includes multiline nesting close to each other',
),
),
indirect=['_playbook_file'],
)
@pytest.mark.usefixtures('_playbook_file')
def test_including_proper_nested_jinja(runner):
rule_violations = runner.run()
assert not rule_violations
|
