-
Notifications
You must be signed in to change notification settings - Fork 22
/
minion.py
280 lines (253 loc) · 10.3 KB
/
minion.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
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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
"""
Salt Minion Factory.
..
PYTEST_DONT_REWRITE
"""
import copy
import logging
import pathlib
import shutil
import attr
import salt.config
import salt.utils.dictupdate
from pytestskipmarkers.utils import platform
from pytestskipmarkers.utils import ports
from saltfactories import cli
from saltfactories.bases import SaltDaemon
from saltfactories.utils import cli_scripts
from saltfactories.utils.tempfiles import SaltPillarTree
from saltfactories.utils.tempfiles import SaltStateTree
log = logging.getLogger(__name__)
@attr.s(kw_only=True, slots=True)
class SaltMinion(SaltDaemon):
"""
salt-minion daemon factory.
"""
state_tree = attr.ib(init=False, hash=False, repr=False)
pillar_tree = attr.ib(init=False, hash=False, repr=False)
@state_tree.default
def __setup_state_tree(self):
if "file_roots" in self.config:
return SaltStateTree(envs=copy.deepcopy(self.config.get("file_roots") or {}))
@pillar_tree.default
def __setup_pillar_tree(self):
if "pillar_roots" in self.config:
return SaltPillarTree(envs=copy.deepcopy(self.config.get("pillar_roots") or {}))
@classmethod
def default_config(
cls,
root_dir,
minion_id,
defaults=None,
overrides=None,
master=None,
system_install=False,
):
"""
Return the default configuration.
"""
if defaults is None:
defaults = {}
master_id = master_port = None
if master is not None:
master_id = master.id
master_port = master.config["ret_port"]
# Match transport if not set
defaults.setdefault("transport", master.config["transport"])
if system_install is True:
conf_dir = root_dir / "etc" / "salt"
conf_dir.mkdir(parents=True, exist_ok=True)
conf_file = str(conf_dir / "minion")
pki_dir = conf_dir / "pki" / "minion"
logs_dir = root_dir / "var" / "log" / "salt"
logs_dir.mkdir(parents=True, exist_ok=True)
state_tree_root = root_dir / "srv" / "salt"
state_tree_root.mkdir(parents=True, exist_ok=True)
pillar_tree_root = root_dir / "srv" / "pillar"
pillar_tree_root.mkdir(parents=True, exist_ok=True)
_defaults = {
"id": master_id,
"conf_file": conf_file,
"root_dir": str(root_dir),
"interface": "127.0.0.1",
"master": "127.0.0.1",
"master_port": master_port or salt.config.DEFAULT_MINION_OPTS["master_port"],
"tcp_pub_port": salt.config.DEFAULT_MINION_OPTS["tcp_pub_port"],
"tcp_pull_port": salt.config.DEFAULT_MINION_OPTS["tcp_pull_port"],
"pki_dir": str(pki_dir),
"log_file": str(logs_dir / "minion.log"),
"log_level_logfile": "debug",
"log_fmt_console": (
"%(asctime)s,%(msecs)03.0f [%(name)-17s:%(lineno)-4d][%(levelname)-8s]"
"[%(processName)18s(%(process)d)] %(message)s"
),
"log_fmt_logfile": (
"[%(asctime)s,%(msecs)03.0f][%(name)-17s:%(lineno)-4d][%(levelname)-8s]"
"[%(processName)18s(%(process)d)] %(message)s"
),
"file_roots": {
"base": [str(state_tree_root)],
},
"pillar_roots": {
"base": [str(pillar_tree_root)],
},
"pytest-minion": {
"master-id": master_id,
"log": {"prefix": "{}(id={!r})".format(cls.__name__, minion_id)},
},
}
else:
conf_dir = root_dir / "conf"
conf_dir.mkdir(parents=True, exist_ok=True)
conf_file = str(conf_dir / "minion")
state_tree_root = root_dir / "state-tree"
state_tree_root.mkdir(exist_ok=True)
state_tree_root_base = state_tree_root / "base"
state_tree_root_base.mkdir(exist_ok=True)
state_tree_root_prod = state_tree_root / "prod"
state_tree_root_prod.mkdir(exist_ok=True)
pillar_tree_root = root_dir / "pillar-tree"
pillar_tree_root.mkdir(exist_ok=True)
pillar_tree_root_base = pillar_tree_root / "base"
pillar_tree_root_base.mkdir(exist_ok=True)
pillar_tree_root_prod = pillar_tree_root / "prod"
pillar_tree_root_prod.mkdir(exist_ok=True)
_defaults = {
"id": minion_id,
"conf_file": conf_file,
"root_dir": str(root_dir),
"interface": "127.0.0.1",
"master": "127.0.0.1",
"master_port": master_port or ports.get_unused_localhost_port(),
"tcp_pub_port": ports.get_unused_localhost_port(),
"tcp_pull_port": ports.get_unused_localhost_port(),
"pidfile": "run/minion.pid",
"pki_dir": "pki",
"cachedir": "cache",
"sock_dir": "run/minion",
"log_file": "logs/minion.log",
"log_level_logfile": "debug",
"loop_interval": 0.05,
"log_fmt_console": (
"%(asctime)s,%(msecs)03.0f [%(name)-17s:%(lineno)-4d][%(levelname)-8s]"
"[%(processName)18s(%(process)d)] %(message)s"
),
"log_fmt_logfile": (
"[%(asctime)s,%(msecs)03.0f][%(name)-17s:%(lineno)-4d][%(levelname)-8s]"
"[%(processName)18s(%(process)d)] %(message)s"
),
"file_roots": {
"base": [str(state_tree_root_base)],
"prod": [str(state_tree_root_prod)],
},
"pillar_roots": {
"base": [str(pillar_tree_root_base)],
"prod": [str(pillar_tree_root_prod)],
},
"enable_legacy_startup_events": False,
"acceptance_wait_time": 0.5,
"acceptance_wait_time_max": 5,
"pytest-minion": {
"master-id": master_id,
"log": {"prefix": "{}(id={!r})".format(cls.__name__, minion_id)},
},
}
# Merge in the initial default options with the internal _defaults
salt.utils.dictupdate.update(defaults, _defaults, merge_lists=True)
if overrides:
# Merge in the default options with the minion_overrides
salt.utils.dictupdate.update(defaults, overrides, merge_lists=True)
return defaults
@classmethod
def _configure( # pylint: disable=arguments-differ
cls,
factories_manager,
daemon_id,
root_dir=None,
defaults=None,
overrides=None,
master=None,
):
return cls.default_config(
root_dir,
daemon_id,
defaults=defaults,
overrides=overrides,
master=master,
system_install=factories_manager.system_install,
)
@classmethod
def _get_verify_config_entries(cls, config):
# verify env to make sure all required directories are created and have the
# right permissions
pki_dir = pathlib.Path(config["pki_dir"])
verify_env_entries = [
str(pki_dir / "minions"),
str(pki_dir / "minions_pre"),
str(pki_dir / "minions_rejected"),
str(pki_dir / "accepted"),
str(pki_dir / "rejected"),
str(pki_dir / "pending"),
str(pathlib.Path(config["log_file"]).parent),
str(pathlib.Path(config["cachedir"]) / "proc"),
# config['extension_modules'],
config["sock_dir"],
]
verify_env_entries.extend(config["file_roots"]["base"])
if "prod" in config["file_roots"]:
verify_env_entries.extend(config["file_roots"]["prod"])
verify_env_entries.extend(config["pillar_roots"]["base"])
if "prod" in config["pillar_roots"]:
verify_env_entries.extend(config["pillar_roots"]["prod"])
return verify_env_entries
@classmethod
def load_config(cls, config_file, config):
"""
Return the loaded configuration.
"""
return salt.config.minion_config(config_file, minion_id=config["id"], cache_minion_id=True)
def get_script_args(self):
"""
Return the script arguments.
"""
args = super().get_script_args()
if platform.is_windows() is False:
args.append("--disable-keepalive")
return args
def get_check_events(self):
"""
Return salt events to check.
Return a list of tuples in the form of `(master_id, event_tag)` check against to ensure the daemon is running
"""
pytest_config = self.config["pytest-{}".format(self.config["__role"])]
if not pytest_config.get("master-id"):
log.warning(
"Will not be able to check for start events for %s since it's missing the 'master-id' key "
"in the 'pytest-%s' dictionary, or it's value is None.",
self,
self.config["__role"],
)
else:
yield pytest_config["master-id"], "salt/{role}/{id}/start".format(
role=self.config["__role"], id=self.id
)
def salt_call_cli(self, factory_class=cli.call.SaltCall, **factory_class_kwargs):
"""
Return a `salt-call` CLI process for this minion instance.
"""
if self.system_install is False:
script_path = cli_scripts.generate_script(
self.factories_manager.scripts_dir,
"salt-call",
code_dir=self.factories_manager.code_dir,
inject_coverage=self.factories_manager.inject_coverage,
inject_sitecustomize=self.factories_manager.inject_sitecustomize,
)
else:
script_path = shutil.which("salt-call")
return factory_class(
script_name=script_path,
config=self.config.copy(),
system_install=self.factories_manager.system_install,
**factory_class_kwargs
)