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
|
# This file is part of cloud-init. See LICENSE file for license information.
import os
from collections import namedtuple
from io import StringIO
from cloudinit.cmd.devel import render
from cloudinit.helpers import Paths
from cloudinit.sources import INSTANCE_JSON_FILE, INSTANCE_JSON_SENSITIVE_FILE
from cloudinit.util import ensure_dir, write_file
from tests.unittests.helpers import CiTestCase, mock, skipUnlessJinja
class TestRender(CiTestCase):
with_logs = True
args = namedtuple("renderargs", "user_data instance_data debug")
def setUp(self):
super(TestRender, self).setUp()
self.tmp = self.tmp_dir()
def test_handle_args_error_on_missing_user_data(self):
"""When user_data file path does not exist, log an error."""
absent_file = self.tmp_path("user-data", dir=self.tmp)
instance_data = self.tmp_path("instance-data", dir=self.tmp)
write_file(instance_data, "{}")
args = self.args(
user_data=absent_file, instance_data=instance_data, debug=False
)
with mock.patch("sys.stderr", new_callable=StringIO):
self.assertEqual(1, render.handle_args("anyname", args))
self.assertIn(
"Missing user-data file: %s" % absent_file, self.logs.getvalue()
)
def test_handle_args_error_on_missing_instance_data(self):
"""When instance_data file path does not exist, log an error."""
user_data = self.tmp_path("user-data", dir=self.tmp)
absent_file = self.tmp_path("instance-data", dir=self.tmp)
args = self.args(
user_data=user_data, instance_data=absent_file, debug=False
)
with mock.patch("sys.stderr", new_callable=StringIO):
self.assertEqual(1, render.handle_args("anyname", args))
self.assertIn(
"Missing instance-data.json file: %s" % absent_file,
self.logs.getvalue(),
)
def test_handle_args_defaults_instance_data(self):
"""When no instance_data argument, default to configured run_dir."""
user_data = self.tmp_path("user-data", dir=self.tmp)
run_dir = self.tmp_path("run_dir", dir=self.tmp)
ensure_dir(run_dir)
paths = Paths({"run_dir": run_dir})
self.add_patch("cloudinit.cmd.devel.render.read_cfg_paths", "m_paths")
self.m_paths.return_value = paths
args = self.args(user_data=user_data, instance_data=None, debug=False)
with mock.patch("sys.stderr", new_callable=StringIO):
self.assertEqual(1, render.handle_args("anyname", args))
json_file = os.path.join(run_dir, INSTANCE_JSON_FILE)
self.assertIn(
"Missing instance-data.json file: %s" % json_file,
self.logs.getvalue(),
)
def test_handle_args_root_fallback_from_sensitive_instance_data(self):
"""When root user defaults to sensitive.json."""
user_data = self.tmp_path("user-data", dir=self.tmp)
run_dir = self.tmp_path("run_dir", dir=self.tmp)
ensure_dir(run_dir)
paths = Paths({"run_dir": run_dir})
self.add_patch("cloudinit.cmd.devel.render.read_cfg_paths", "m_paths")
self.m_paths.return_value = paths
args = self.args(user_data=user_data, instance_data=None, debug=False)
with mock.patch("sys.stderr", new_callable=StringIO):
with mock.patch("os.getuid") as m_getuid:
m_getuid.return_value = 0
self.assertEqual(1, render.handle_args("anyname", args))
json_file = os.path.join(run_dir, INSTANCE_JSON_FILE)
json_sensitive = os.path.join(run_dir, INSTANCE_JSON_SENSITIVE_FILE)
self.assertIn(
"WARNING: Missing root-readable %s. Using redacted %s"
% (json_sensitive, json_file),
self.logs.getvalue(),
)
self.assertIn(
"ERROR: Missing instance-data.json file: %s" % json_file,
self.logs.getvalue(),
)
def test_handle_args_root_uses_sensitive_instance_data(self):
"""When root user, and no instance-data arg, use sensitive.json."""
user_data = self.tmp_path("user-data", dir=self.tmp)
write_file(user_data, "##template: jinja\nrendering: {{ my_var }}")
run_dir = self.tmp_path("run_dir", dir=self.tmp)
ensure_dir(run_dir)
json_sensitive = os.path.join(run_dir, INSTANCE_JSON_SENSITIVE_FILE)
write_file(json_sensitive, '{"my-var": "jinja worked"}')
paths = Paths({"run_dir": run_dir})
self.add_patch("cloudinit.cmd.devel.render.read_cfg_paths", "m_paths")
self.m_paths.return_value = paths
args = self.args(user_data=user_data, instance_data=None, debug=False)
with mock.patch("sys.stderr", new_callable=StringIO):
with mock.patch("sys.stdout", new_callable=StringIO) as m_stdout:
with mock.patch("os.getuid") as m_getuid:
m_getuid.return_value = 0
self.assertEqual(0, render.handle_args("anyname", args))
self.assertIn("rendering: jinja worked", m_stdout.getvalue())
@skipUnlessJinja()
def test_handle_args_renders_instance_data_vars_in_template(self):
"""If user_data file is a jinja template render instance-data vars."""
user_data = self.tmp_path("user-data", dir=self.tmp)
write_file(user_data, "##template: jinja\nrendering: {{ my_var }}")
instance_data = self.tmp_path("instance-data", dir=self.tmp)
write_file(instance_data, '{"my-var": "jinja worked"}')
args = self.args(
user_data=user_data, instance_data=instance_data, debug=True
)
with mock.patch("sys.stderr", new_callable=StringIO) as m_console_err:
with mock.patch("sys.stdout", new_callable=StringIO) as m_stdout:
self.assertEqual(0, render.handle_args("anyname", args))
self.assertIn(
"DEBUG: Converted jinja variables\n{", self.logs.getvalue()
)
self.assertIn(
"DEBUG: Converted jinja variables\n{", m_console_err.getvalue()
)
self.assertEqual("rendering: jinja worked", m_stdout.getvalue())
@skipUnlessJinja()
def test_handle_args_warns_and_gives_up_on_invalid_jinja_operation(self):
"""If user_data file has invalid jinja operations log warnings."""
user_data = self.tmp_path("user-data", dir=self.tmp)
write_file(user_data, "##template: jinja\nrendering: {{ my-var }}")
instance_data = self.tmp_path("instance-data", dir=self.tmp)
write_file(instance_data, '{"my-var": "jinja worked"}')
args = self.args(
user_data=user_data, instance_data=instance_data, debug=True
)
with mock.patch("sys.stderr", new_callable=StringIO):
self.assertEqual(1, render.handle_args("anyname", args))
self.assertIn(
"WARNING: Ignoring jinja template for %s: Undefined jinja"
' variable: "my-var". Jinja tried subtraction. Perhaps you meant'
' "my_var"?' % user_data,
self.logs.getvalue(),
)
# vi: ts=4 expandtab
|
