Debian Codegraph @

docs/changelog.rst

raw
1
2 .. _changelog:
3
4 Release Notes
5 =============
6
7
8 .. raw:: html
9
10 <style>
11 div#release-notes h2 {
12 border-bottom: 1px dotted #c0c0c0;
13 margin-top: 50px !important;
14 }
15 </style>
16
17 To avail of fixes in an unreleased version, please download a ZIP file
18 `directly from GitHub <https://github.com/mitogen-hq/mitogen/>`_.
19
20
21 v0.3.50 (2026-06-19)
22 --------------------
23
24 * :gh:issue:`1529` :mod:`ansible_mitogen`: Use Mitogen context for embedded DNF
25 script with Ansible 14 (ansible-core 2.21)
26 * :gh:issue:`1529` :mod:`ansible_mitogen`: Make injected ``__main__`` on target
27 more identifiable/greppable
28 * :gh:issue:`1529` :mod:`ansible_mitogen`: Remove
29 :attr:`ansible_mitogen.runner.NewStyleRunner.main_module_name`
30 * :gh:issue:`1523` tests: Bump Ansible 14 tests to 14.x
31 * :gh:issue:`1529` tests: Cleanup after issue 109 regression test
32 * :gh:issue:`1529` tests: Enable issue 776 regression test for recent Ansibles
33
34
35 v0.3.49 (2026-06-03)
36 --------------------
37
38 * :gh:issue:`1523` :mod:`ansible_mitogen`: First Ansible 14 support
39 * :gh:issue:`1518` :mod:`mitogen`: Fix sudo authentication when the translated
40 password prompt doesn't contain U+003A COLON
41 * :gh:issue:`1523` tests: Split auto, auto_legacy, auto_legacy_silent
42 interpreter discovery tests
43 * :gh:issue:`1385` :mod:`ansible_mitogen`: Replace imports of deprecated
44 ``ansible.module_utils.six``
45
46
47 v0.3.48 (2026-05-22)
48 --------------------
49
50 * :gh:issue:`1514` :mod:`mitogen`: Fix sudo authentication with translated
51 password prompt
52 * :gh:issue:`1514` :mod:`mitogen`: Handle U+00A0 NO-BREAK SPACE characters seen
53 in some translations of sudo's password prompt
54
55
56 v0.3.47 (2026-04-19)
57 --------------------
58
59 * :gh:issue:`1506` :mod:`mitogen`: Support sudo-rs, used by Ubuntu 26.04
60 * :gh:issue:`1509` :mod:`mitogen`: Support sudo and sudo-rs pwfeedback
61 * :gh:issue:`1506` tests: Add Ubuntu 26.04 test image
62 * :gh:issue:`1506` tests: Test Ubuntu 26.04 targets
63 * :gh:issue:`1118` tests: Switch from 2025.02 test images to 2026.04 test images
64 * :gh:issue:`1118` tests: sshd ``AllowEnv`` for ``ANSIBLE_*`` and ``MITOGEN_*``
65 * :gh:issue:`1317` tests: Send sshd debug output to stderr for container logger
66 * :gh:issue:`1118` tests: Give up hiding Mitogen test users from graphical login
67 screens
68 * :gh:issue:`1118` tests: Explicitly set mode of ~mitogen__readonly_homedir
69 * :gh:issue:`1118` image_prep: Containerize the HTTPS proxy for old repos
70 * :gh:issue:`1118` image_prep: Fix Ansible 2.3 <-> Docker container tasks
71 * :gh:issue:`1118` image_prep: Workaround password authentication failures in
72 Alama 9 containers due to /etc/shadow and AppArmor interaction
73 * :gh:issue:`1118` image_prep: Explicitly specify AMD64 base images
74 * :gh:issue:`1118` image_prep: Parameterise sudoers configs
75 * :gh:issue:`1506` image_prep: Specify installtion of sudo package per-host
76 * :gh:issue:`1118` image_prep: Update repos of archived Debian versions
77 * :gh:issue:`849` image_prep: Workaround Python respawn using Ansible apt
78 * :gh:issue:`1118` image_prep: Fixup Tox config for the march of time
79
80
81 v0.3.46 (2026-04-16)
82 --------------------
83
84 * :gh:issue:`1502` :mod:`mitogen`: Preserve :py:mod:`logging` config in forked
85 children
86 * :gh:issue:`1499` tests: Fix uses of ``testlib.LogCapturer``
87 * :gh:issue:`1499` tests: Run Mitogen unittests without
88 ``MITOGEN_LOG_LEVEL=debug``
89 * :gh:issue:`1505` CI: Upgrade to GitHub Actions runners that use Node 24
90 * :gh:issue:`1498` :mod:`ansible_mitogen`: Allow using temporary directories on
91 filesystems mounted noexec
92
93
94 v0.3.45 (2026-03-30)
95 --------------------
96
97 * :gh:issue:`963` :mod:`ansible_mitogen`: Hide Mitogen debugging by default at
98 high Ansible verbosity
99 * :gh:issue:`1485` :mod:`mitogen`: Remove testlib log propagtion manipulation
100 and lingering Operon references
101 * :gh:issue:`1482` :mod:`mitogen`: Remove ``mitogen.core._v`` logging shortcut
102 * :gh:issue:`1482` :mod:`mitogen`: Remove ``mitogen.core._vv`` logging shortcut
103 * :gh:issue:`1482` :mod:`mitogen`: Fix :meth:`mitogen.core.LogHandler.emit`
104 signature
105 * :gh:issue:`1490` :mod:`mitogen`: Remove unused ``io`` argument from
106 :func:`mitogen.utils.log_to_file`
107 * :gh:issue:`1482` :mod:`mitogen`: Consolidate log levels configuration
108
109
110 v0.3.44 (2026-03-15)
111 --------------------
112
113 * :gh:issue:`1477` :mod:`ansible_mitogen`: Fix cross-task warnings pollution
114
115
116 v0.3.43 (2026-03-02)
117 --------------------
118
119 * :gh:issue:`1462` tests: Consolidate sudoers config into a role
120 * :gh:issue:`1464` tests: Profile Ansible plays
121 * :gh:issue:`1464` tests: Remove last traces of MODE environment variable
122 * :gh:issue:`1464` CI: Remove unused pause_if_interactive()
123 * :gh:issue:`1464` CI: Factor out sudoers defaults setup
124 * :gh:issue:`1464` CI: Factor out chmod of tests/data/docker/mitogen__has_sudo_pubkey.key
125 * :gh:issue:`1464` CI: Unify skipping of container tests
126 * :gh:issue:`1464` CI: Factor out setup of localhost ssh keys
127 * :gh:issue:`1464` CI: Remove macOS Python 2.x PYTHON_LAUNCHED_FROM_WRAPPER debug
128 * :gh:issue:`1464` CI: Factor out setup of localhost ssh and users
129 * :gh:issue:`1464` CI: Explicitly pull container images for Ansible tests
130 * :gh:issue:`1464` CI: Explicitly create Tox environments
131 * :gh:issue:`1464` ci: Replace run_tests with .ci/unit_tests, remove coverage
132 as test requirement
133 * :gh:issue:`1455` tests: Fix missing and unused imports of Mitogen
134 * :gh:issue:`1455` CI: Remove sys.path manipulation in .ci/unit_tests.py
135 * :gh:issue:`1455` tests: Consolidate modules used by tests in tests/testmods
136 * :gh:issue:`1466` CI: Remove PYTHONPATH & CWD manipulations from ci_lib
137 * :gh:issue:`1466` CI: Allow writing bytecode (.pyc) when running tests
138 * :gh:issue:`1310` tests: Add missing ``super()`` calls
139
140
141 v0.3.42 (2026-02-20)
142 --------------------
143
144 * :gh:issue:`1451` :mod:`mitogen`: Refactor module whitelist & blacklist with
145 module overrides and blocks. Improve error messages for denied modules.
146 * :gh:issue:`1394` :mod:`ansible_mitogen`, :mod:`mitogen`: Add Incus connection
147 support, allowing users who migrated from LXD to Incus to use ansible-mitogen
148 * :gh:issue:`1456` :mod:`ansible_mitogen`: Fix Ansible collections
149 :exc:`!mitogen.core.ModuleDeniedByOverridesError`
150
151
152 v0.3.41 (2026-02-10)
153 --------------------
154
155 * :gh:issue:`1441` :mod:`mitogen`: Consolidate :mod:`pickle` imports and
156 backward compatibility handling.
157 * :gh:issue:`126` :mod:`mitogen`: Switch :class:`mitogen.core.Unpickler`
158 to default deny policy when handling :data:`pickle.GLOBAL` opcode.
159 * :gh:issue:`1430` :mod:`mitogen`: Pickle top-level ``bytes`` objects
160 ourself on Python 3.x, to avoid ``_codecs.encode()`` call injected by
161 :class:`pickle.Pickler`
162 * :gh:issue:`1430` :mod:`mitogen`: Remove caching of result of
163 :meth:`mitogen.core.Message.unpickle`
164 * :gh:issue:`1430` :mod:`mitogen`: Allow mutiple pickle streams in a single
165 :class:`mitogen.core.Message`, add :meth:`mitogen.core.Message.unpickle_iter`
166 * :gh:issue:`1430` :mod:`mitogen`: Speed up :class:`mitogen.core.ResourceReader`
167 using 2 pickle streams in :data:`mitogen.core.LOAD_RESOURCE` messages
168 * :gh:issue:`1430` :mod:`mitogen`: Default to :func:`mitogen.core.find_deny`
169 in :meth:`mitogen.core.Message.unpickle_iter`
170
171
172 v0.3.40 (2026-02-04)
173 --------------------
174
175 * :gh:issue:`946` :mod:`mitogen`: Fix handling of PEP 420 implicit namespace
176 packages, in which ``module.__file__`` can be ``None``
177
178
179 v0.3.39 (2026-01-27)
180 --------------------
181
182 * :gh:issue:`1430` :mod:`mitogen`: Pickle :data:`mitogen.core.GET_RESOURCE`
183 parameters directly as textual strings (rather than ASCII in byte strings)
184 * :gh:issue:`1430` :mod:`mitogen`: Explicitly mark messages known to carry
185 pickled data, using :data:`mitogen.core.Message.ENC_PKL`. This repurposes
186 the magic field as a content encoding enumeration.
187 * :gh:issue:`1430` :mod:`mitogen`: Add explicit binary Message encoding,
188 marked using :data:`mitogen.core.Message.ENC_BIN`.
189 * :gh:issue:`1430` :mod:`mitogen`: Send :class:`mitogen.service.FileService`
190 content raw, without pickle encoding
191
192
193 v0.3.38 (2026-01-23)
194 --------------------
195
196 * :gh:issue:`1418` :mod:`mitogen`: Format :class:`mitogen.core.Message` source
197 and destination as ``<context>:<handle>``, for clarity
198 * :gh:issue:`1415` :mod:`mitogen`: Put fallbacks & polyfills into
199 ``if sys.version_info`` blocks
200 * :gh:issue:`1423` tests: Group and unify naming of connection benchmarks
201 * :gh:issue:`1424` tests: Parameterize connection benchmarks
202 * :gh:issue:`1424` tests: Standardise output of connection benchmarks
203 * :gh:issue:`1424` tests: Parameterize throughput benchmark
204 * :gh:issue:`1424` tests: Parameterize large message benchmark
205 * :gh:issue:`1424` :mod:`mitogen`: Consolidate all ``range`` and ``xrange``
206 polyfills into :attr:`mitogen.core.range`
207
208
209 v0.3.37 (2026-01-08)
210 --------------------
211
212 * :gh:issue:`1398` :mod:`mitogen`: Fix :exc:`FileNotFoundError` during
213 ``import requests`` in a Mitogen child
214 * :gh:issue:`1403` :mod:`mitogen`: Add initial support for
215 :py:class:`importlib.resource.abc.ResourceReader` protocol
216 * :gh:issue:`1407` :mod:`mitogen`: Fix :exc:`AttributeError` in
217 :mod:`mitogen.profiler`
218
219
220 v0.3.36 (2025-12-01)
221 --------------------
222
223 * :gh:issue:`1237` :mod:`mitogen`: Re-declare Python 2.4 compatibility
224 * :gh:issue:`1385` :mod:`ansible_mitogen`: Remove a use of
225 ``ansible.module_utils.six``
226 * :gh:issue:`1354` docs: Document Ansible 13 (ansible-core 2.20) support
227 * :gh:issue:`1354` :mod:`mitogen`: Clarify error message when a module
228 request would be refused by allow or deny listing
229 * :gh:issue:`1348` :mod:`mitogen`: Fix hanging process with 100% CPU usage
230
231
232 v0.3.35 (2025-12-01)
233 --------------------
234
235 * :gh:issue:`1132` :mod:`ansible_mitogen` During intrepreter discovery use
236 Ansible ``INTERPRETER_PYTHON_FALLBACK`` config as list of candidates
237
238
239 v0.3.34 (2025-11-27)
240 --------------------
241
242 * :gh:issue:`1118` CI: Use 2025.02 test images, keeping same OS releases
243 * :gh:issue:`1358` CI: Bump deprecated macOS 13 runner to macOS 15
244 * :gh:issue:`1118` CI: Add OS release coverage: AlmaLinux 9
245 * :gh:issue:`1118` CI: Add OS release coverage: CentOS 5
246 * :gh:issue:`1118` CI: Add OS release coverage: Debian 12
247 * :gh:issue:`1118` CI: Add OS release coverage: Ubuntu 22.04, Ubuntu 24.04
248 * :gh:issue:`1124` :mod:`mitogen`: Log why a module is sent or not sent by
249 :class:`mitogen.master.ModuleResponder`
250 * :gh:issue:`1124` :mod:`ansible_mitogen`: Speedup startup by not sending
251 ``__main__`` as a related module
252
253
254 v0.3.33 (2025-11-22)
255 --------------------
256
257 * :gh:issue:`1354` :mod:`ansible_mitogen`: ansible_mitogen: Ansible 13
258 (ansible-core 2.20) support
259
260
261 v0.3.32 (2025-11-21)
262 --------------------
263
264 * :gh:issue:`1243` :mod:`mitogen`: Pass first stage, context name, & preamble
265 size as seperate **argv** arguments
266 * :gh:issue:`1218` :mod:`ansible_mitogen`: Remove maximum Ansible version check
267 * :gh:issue:`1260` CI: Remove integration of retired lgtm.com
268
269
270 v0.3.31 (2025-11-05)
271 --------------------
272
273 * :gh:issue:`1350` :mod:`ansible_mitogen`: Fix regression when loading plugins
274 from ``/custom/path/to/mitogen``
275
276
277 v0.3.30 (2025-10-30)
278 --------------------
279
280 * :gh:issue:`1266` Import cleanups
281 * :gh:issue:`1266` :mod:`ansible_mitogen`: De-duplicate sys.path manipulations
282 * :gh:issue:`1344` Correct SPDX license declarations
283 * :gh:issue:`1344` Declare BSD-3-Clause SPDX license in package metadata
284 * :gh:issue:`1344` :mod:`mitogen`: Use :py:func:`logging.makeLogRecord`
285
286
287 v0.3.29 (2025-09-18)
288 --------------------
289
290 * :gh:issue:`1287` Python 3.14 support
291 * :gh:issue:`1287` tests: Bump dependencies
292
293
294 v0.3.28 (2025-09-17)
295 --------------------
296
297 * :gh:issue:`1306` :mod:`ansible_mitogen`: Fix non-blocking IO errors in
298 first stage of bootstrap
299 * :gh:issue:`1306` CI: Report sudo version on Ansible targets
300 * :gh:issue:`1306` CI: Move sudo test users defaults into ``/etc/sudoers.d``
301 * :gh:issue:`1306` preamble_size: Fix variability of measured command size
302 * :gh:issue:`1306` tests: Count bytes written in ``stdio_test.StdIOTest``
303 * :gh:issue:`1306` tests: Check stdio is blocking in sudo contexts
304 * :gh:issue:`1327` :mod:`ansible_mitogen`: Add FreeIPA client modules to the
305 always-fork list
306
307
308 v0.3.27 (2025-08-20)
309 --------------------
310
311 * :gh:issue:`1325` :mod:`mitogen`: Refactor
312 ``mitogen.master.scan_code_imports()`` as
313 :func:`mitogen.import.codeobj_imports` and speed-up by 1.5 - 2.5 x
314 * :gh:issue:`1329` CI: Refactor and de-duplicate Github Actions workflow
315 * :gh:issue:`1315` CI: macOS: Increase failed logins limit of test users
316 * :gh:issue:`1325` tests: Improve ``master_test.ScanCodeImportsTest`` coverage
317
318
319 v0.3.26 (2025-08-04)
320 --------------------
321
322 * :gh:issue:`1318` CI: Abbreviate Github Actions job names
323 * :gh:issue:`1309` :mod:`ansible_mitogen`: Fix ``become_method: doas``
324 * :gh:issue:`712` :mod:`mitogen`: Fix :exc:`BlockingIOError` & ``EAGAIN``
325 errors in subprocesses that write to stdio
326
327
328 v0.3.25 (2025-07-29)
329 --------------------
330
331 Ansible 12 has deprecated third-party strategy plugins. This is currently
332 how Mitogen integrates with Ansible (e.g. `ANSIBLE_STRATEGY=mitogen_linear`).
333 Running Ansible 12 + Mitogen will currently print a deprecation warning
334
335 [DEPRECATION WARNING]: Use of strategy plugins not included in
336 ansible.builtin are deprecated [...]. This feature will be removed from
337 ansible-core in a future release.
338
339 Ansible + Mitogen will still work for now. Mitogen is considering alternatives
340 to strategy plugins under :gh:issue:`1278`.
341
342 * :gh:issue:`1258` Ansible 12 (ansible-core 2.19) support
343
344
345 v0.3.25b1 (2025-07-21)
346 ----------------------
347
348 * :gh:issue:`1303` CI: Switch to archived Debian 10 (buster) apt repository
349
350
351 v0.3.25a3 (2025-07-02)
352 ----------------------
353
354 * :gh:issue:`1285` CI: use `result_format = yaml` for Ansible test output,
355 instead of deprecated `stdout_callback = yaml`
356 * :gh:issue:`1293` CI: Fix ``ansible_version`` comparisons when an Ansible
357 release candidate is under test
358 * :gh:issue:`1275` CI: Test ``ansible_ssh_password`` behaviour without
359 ``sshpass`` installed
360 * :gh:issue:`1282` :mod:`ansible_mitogen`: Support ``ANSIBLE_SSH_VERBOSITY``
361 with Ansible 12
362
363
364 v0.3.25a2 (2025-06-21)
365 ----------------------
366
367 * :gh:issue:`1274` :mod:`ansible_mitogen`: Replace use of `jsonify()`, which
368 is deprecated form Ansible 12 (ansible-core 2.19)
369
370
371 v0.3.25a1 (2025-06-05)
372 ----------------------
373
374 * :gh:issue:`1258` Initial Ansible 12 (ansible-core 2.19) support
375 * :gh:issue:`1258` :mod:`ansible_mitogen`: Initial Ansible datatag support
376 (:gh:anspull:`84621`)
377 * :gh:issue:`1258` :mod:`ansible_mitogen`: Ansible 12 (ansible-core 2.19) test
378 jobs
379
380
381 v0.3.24 (2025-05-29)
382 --------------------
383
384 * :gh:issue:`1268` :mod:`mitogen` Only close stdin, stdout, and stderr file
385 descriptors (0, 1, and 2) if they were open at process startup.
386
387
388 v0.3.23 (2025-04-28)
389 --------------------
390
391 * :gh:issue:`1121` :mod:`mitogen`: Log skipped :py:mod:`termios` attributes
392 * :gh:issue:`1238` packaging: Avoid :py:mod:`ast`, requires Python = 2.6
393 * :gh:issue:`1118` CI: Statically specify test usernames and group names
394 * :gh:issue:`1118` CI: Don't copy SSH private key to temporary dir
395 * :gh:issue:`1118` CI: Don't share temporary directory between test groupings
396 * :gh:issue:`1256` CI: Upgrade Github jobs from Ubuntu 20.04 to 22.04 & 24.04
397 * :gh:issue:`1263` packaging: Fix InvalidVersion in release versions
398
399
400 v0.3.22 (2025-02-04)
401 --------------------
402
403 * :gh:issue:`1213` tests: Enable default Python warnings
404 * :gh:issue:`1111` :mod:`mitogen`: Replace uses of deprecated
405 :py:func:`pkgutil.find_loader`
406 * :gh:issue:`1213` :mod:`mitogen`: Fix unclosed file in first stage
407 * :gh:issue:`1213` tests: Fix unclosed file in fd_check script
408 * :gh:issue:`1213` :mod:`ansible_mitogen`: Don't redeclare Ansible interpreter
409 discovery attributes
410 * :gh:issue:`1213` :mod:`ansible_mitogen`: Rename Mitogen interpreter discovery
411 attributes
412 * :gh:issue:`1213` :mod:`ansible_mitogen`: Decouple possible_pythons order &
413 error handling
414 * :gh:issue:`1213` :mod:`ansible_mitogen`: Return ``stderr_lines`` from
415 ``_low_level_execute_command()``
416 * :gh:issue:`1227` tests: Name transport_config tests that use ``mitogen_via``
417 * :gh:issue:`1143` :mod:`ansible_mitogen`: Fix dnf module include for dnf.cli
418 * :gh:issue:`1234` :mod:`ansible_mitogen`: Fix :exc:`TypeError` in
419 :func:`ansible_mitogen.target.set_file_owner`
420
421
422 v0.3.21 (2025-01-20)
423 --------------------
424
425 * :gh:issue:`1209` docs: Fix Netlify build of website
426 * :gh:issue:`1216` :mod:`ansible_mitogen`: Add all ansible_freeipa modules to
427 the always-fork list.
428 * :gh:issue:`766` :mod:`ansible_mitogen`: Fix ""could not recover task_vars"
429 and "get_with_context_result object has no attribute _create_control_path"
430 when using ``kubectl``, ``netconf``, or ``network_cli`` connection plugins.
431
432
433 v0.3.20 (2025-01-07)
434 --------------------
435
436 * :gh:issue:`1079` :mod:`ansible_mitogen`: Fix :ans:mod:`wait_for_connection`
437 timeout with templated ``ansible_python_interpreter``
438 * :gh:issue:`1079` :mod:`ansible_mitogen`: Fix templated python interpreter
439 with `meta: reset_connection`
440 * :gh:issue:`1083` :mod:`ansible_mitogen`: Templated connection timeout
441 (e.g. ``ansible_timeout``).
442 * :gh:issue:`740` :mod:`ansible_mitogen`: Respect ``interpreter_python``
443 in ``ansible.cfg`` and ``ANSIBLE_PYTHON_INTERPRETER`` environment variable.
444
445
446 v0.3.19 (2024-12-02)
447 --------------------
448
449 * :gh:issue:`1129` :mod:`ansible_mitogen`: Ansible 11 support
450
451
452 v0.3.18 (2024-11-07)
453 --------------------
454
455 * :gh:issue:`1083` :mod:`ansible_mitogen`: Templated become method
456 (e.g. ``ansible_become_method``).
457 * :gh:issue:`1083` :mod:`ansible_mitogen`: Templated become flag
458 (e.g. ``ansible_become_method``, ``become`` keyword).
459
460
461 v0.3.17 (2024-11-07)
462 --------------------
463
464 * :gh:issue:`1182` CI: Fix incorrect world readable/writable file permissions
465 on SSH key ``mitogen__has_sudo_pubkey.key`` during Ansible tests.
466 * :gh:issue:`1083` :mod:`ansible_mitogen`: Templated SSH private key file
467 (e.g. ``ansible_private_key_file``).
468 * :gh:issue:`1083` :mod:`ansible_mitogen`: Templated SSH host key checking
469 (e.g. ``ansible_host_key_checking``, ``ansible_ssh_host_key_checking``).
470 * :gh:issue:`1083` :mod:`ansible_mitogen`: Templated host address
471 (e.g. ``ansible_host``, ``ansible_ssh_host``)
472 * :gh:issue:`1184` Test templated SSH host key checking in task vars
473
474
475 v0.3.16 (2024-11-05)
476 --------------------
477
478 * :gh:issue:`1083` :mod:`ansible_mitogen`: Templated become executable
479 (e.g. ``become_exe``).
480 * :gh:issue:`1083` :mod:`ansible_mitogen`: Templated become executable
481 arguments (e.g. ``become_flags``).
482 * :gh:issue:`1083` :mod:`ansible_mitogen`: Templated ssh executable
483 (``ansible_ssh_executable``).
484 * :gh:issue:`1083` :mod:`ansible_mitogen`: Fixed templated connection options
485 during a ``meta: reset_connection`` task.
486 * :gh:issue:`1129` CI: Migrated macOS 12 runners to macOS 13, due to EOL.
487
488
489 v0.3.15 (2024-10-28)
490 --------------------
491
492 * :gh:issue:`905` :mod:`ansible_mitogen`: Support templated SSH command
493 arguments (e.g. ``ansible_ssh_args``, ``ansible_ssh_extra_args``).
494 * :gh:issue:`692` tests: Fix and re-enable several sudo tests
495 * :gh:issue:`1083` :mod:`ansible_mitogen`: Support templated become password
496 (e.g. ``ansible_become_pass``, ``ansible_sudo_pass``)
497
498
499 v0.3.14 (2024-10-16)
500 --------------------
501
502 * :gh:issue:`1159` CI: Reduce number of Jobs by parameterizing Mitogen Docker
503 SSH tests
504 * :gh:issue:`1083` :mod:`ansible_mitogen`: Support templated become username.
505
506
507 v0.3.13 (2024-10-09)
508 --------------------
509
510 * :gh:issue:`1138` CI: Complete migration from Azure DevOps Pipelines to
511 GitHub Actions
512 * :gh:issue:`1116` :mod:`ansible_mitogen`: Support for templated variable
513 `ansible_ssh_user`.
514 * :gh:issue:`978` :mod:`ansible_mitogen`: Support templated Ansible SSH port.
515 * :gh:issue:`1073` Python 3.13 support
516
517
518 v0.3.12 (2024-10-07)
519 --------------------
520
521 * :gh:issue:`1106` :mod:`ansible_mitogen`: Support for `ansible_ssh_password`
522 connection variable, and templated SSH connection password.
523 * :gh:issue:`1136` tests: Improve Ansible fail_msg formatting.
524 * :gh:issue:`1137` tests: Ignore inventory files of inactive tests & benchmarks
525 * :gh:issue:`1138` CI: Add re-actors/alls-green GitHub Actions job to simplify
526 branch protections configuration.
527
528
529 v0.3.11 (2024-09-30)
530 --------------------
531
532 * :gh:issue:`1127` :mod:`mitogen`: Consolidate mitogen backward compatibility
533 fallbacks and polyfills into :mod:`mitogen.core`
534 * :gh:issue:`1127` :mod:`ansible_mitogen`: Remove backward compatibility
535 fallbacks for Python 2.4 & 2.5.
536 * :gh:issue:`1127` :mod:`ansible_mitogen`: Remove fallback imports for Ansible
537 releases before 2.10
538 * :gh:issue:`1127` :mod:`ansible_mitogen`: Consolidate Python 2 & 3
539 compatibility
540 * :gh:issue:`1128` CI: Start migration from Azure DevOps to GitHub Actions
541
542
543 v0.3.10 (2024-09-20)
544 --------------------
545
546 * :gh:issue:`950` Fix Solaris/Illumos/SmartOS compatibility with become
547 * :gh:issue:`1087` Fix :exc:`mitogen.core.StreamError` when Ansible template
548 module is called with a ``dest:`` filename that has an extension
549 * :gh:issue:`1110` Fix :exc:`mitogen.core.StreamError` when Ansible copy
550 module is called with a file larger than 124 kibibytes
551 (:data:`ansible_mitogen.connection.Connection.SMALL_FILE_LIMIT`)
552 * :gh:issue:`905` Initial support for templated ``ansible_ssh_args``,
553 ``ansible_ssh_common_args``, and ``ansible_ssh_extra_args`` variables.
554 NB: play or task scoped variables will probably still fail.
555 * :gh:issue:`694` CI: Fixed a race condition and some resource leaks causing
556 some of intermittent failures when running the test suite.
557
558
559 v0.3.9 (2024-08-13)
560 -------------------
561
562 * :gh:issue:`1097` Respect `ansible_facts.discovered_interpreter_python` when
563 executing non new-style modules (e.g. JSONARGS style, WANT_JSON style).
564 * :gh:issue:`1074` Support Ansible 10 (ansible-core 2.17)
565
566
567 v0.3.8 (2024-07-30)
568 -------------------
569
570 * :gh:issue:`952` Fix Ansible `--ask-become-pass`, add test coverage
571 * :gh:issue:`957` Fix Ansible exception when executing against 10s of hosts
572 "ValueError: filedescriptor out of range in select()"
573 * :gh:issue:`1066` Support Ansible `ansible_host_key_checking` & `ansible_ssh_host_key_checking`
574 * :gh:issue:`1090` CI: Migrate macOS integration tests to macOS 12, drop Python 2.7 jobs
575
576
577 v0.3.7 (2024-04-08)
578 -------------------
579
580 * :gh:issue:`1021` Support for Ansible 8 (ansible-core 2.15)
581 * tests: Replace uses of ``include:`` & ``import:``, unsupported in Ansible 9
582 * :gh:issue:`1053` Support for Ansible 9 (ansible-core 2.16)
583
584
585 v0.3.6 (2024-04-04)
586 -------------------
587
588 * :gh:issue:`974` Support Ansible 7
589 * :gh:issue:`1046` Raise :py:exc:`TypeError` in :func:`<mitogen.util.cast()>`
590 when casting a string subtype to `bytes()` or `str()` fails. This is
591 potentially an API breaking change. Failures previously passed silently.
592 * :gh:issue:`1046` Add :func:`<ansible_mitogen.util.cast()>`, to cast
593 :class:`ansible.utils.unsafe_proxy.AnsibleUnsafe` objects in Ansible 7+.
594
595
596 v0.3.5 (2024-03-17)
597 -------------------
598
599 * :gh:issue:`987` Support Python 3.11
600 * :gh:issue:`885` Fix :py:exc:`PermissionError` in :py:mod:`importlib` when
601 becoming an unprivileged user with Python 3.x
602 * :gh:issue:`1033` Support `PEP 451 <https://peps.python.org/pep-0451/>`_,
603 required by Python 3.12
604 * :gh:issue:`1033` Support Python 3.12
605
606
607 v0.3.4 (2023-07-02)
608 -------------------
609
610 * :gh:issue:`929` Support Ansible 6 and ansible-core 2.13
611 * :gh:issue:`832` Fix runtime error when using the ansible.builtin.dnf module multiple times
612 * :gh:issue:`925` :class:`ansible_mitogen.connection.Connection` no longer tries to close the
613 connection on destruction. This is expected to reduce cases of `mitogen.core.Error: An attempt
614 was made to enqueue a message with a Broker that has already exitted`. However it may result in
615 resource leaks.
616 * :gh:issue:`659` Removed :mod:`mitogen.compat.simplejson`, not needed with Python 2.7+, contained Python 3.x syntax errors
617 * :gh:issue:`983` CI: Removed PyPI faulthandler requirement from tests
618 * :gh:issue:`1001` CI: Fixed Debian 9 & 11 tests
619
620 v0.3.3 (2022-06-03)
621 -------------------
622
623 * :gh:issue:`906` Support packages dynamically inserted into sys.modules, e.g. `distro` >= 1.7.0 as `ansible.module_utils.distro`.
624 * :gh:issue:`918` Support Python 3.10
625 * :gh:issue:`920` Support Ansible :ans:conn:`~podman` connection plugin
626 * :gh:issue:`836` :func:`mitogen.utils.with_router` decorator preserves the docstring in addition to the name.
627 * :gh:issue:`936` :ans:mod:`fetch` no longer emits `[DEPRECATION WARNING]: The '_remote_checksum()' method is deprecated.`
628
629
630 v0.3.2 (2022-01-12)
631 -------------------
632
633 * :gh:issue:`891` Correct `Framework :: Ansible` Trove classifier
634
635
636 v0.3.1 (unreleased)
637 -------------------
638
639 * :gh:issue:`874` Support for Ansible 5 (ansible-core 2.12)
640 * :gh:issue:`774` Fix bootstrap failures on macOS 11.x and 12.x, involving Python 2.7 wrapper
641 * :gh:issue:`834` Support for Ansible 3 and 4 (ansible-core 2.11)
642 * :gh:issue:`869` Continuous Integration tests are now run with Tox
643 * :gh:issue:`869` Continuous Integration tests now cover CentOS 6 & 8, Debian 9 & 11, Ubuntu 16.04 & 20.04
644 * :gh:issue:`860` Add initial support for podman connection (w/o Ansible support yet)
645 * :gh:issue:`873` `python -c ...` first stage no longer uses :py:mod:`platform`` to detect the macOS release
646 * :gh:issue:`876` `python -c ...` first stage no longer contains tab characters, to reduce size
647 * :gh:issue:`878` Continuous Integration tests now correctly perform comparisons of 2 digit versions
648 * :gh:issue:`878` Kubectl connector fixed with Ansible 2.10 and above
649
650
651 v0.3.0 (2021-10-28)
652 -------------------
653
654 This release separates itself from the v0.2.X releases. Ansible's API changed too much to support backwards compatibility so from now on, v0.2.X releases will be for Ansible < 2.10 and v0.3.X will be for Ansible 2.10+.
655 `See here for details <https://github.com/mitogen-hq/mitogen/pull/715#issuecomment-750697248>`_.
656
657 * :gh:issue:`827` NewStylePlanner: detect `ansible_collections` imports
658 * :gh:issue:`770` better check for supported Ansible version
659 * :gh:issue:`731` ansible 2.10 support
660 * :gh:issue:`652` support for ansible collections import hook
661 * :gh:issue:`847` Removed historic Continuous Integration reverse shell
662
663
664 v0.2.10 (2021-10-28)
665 --------------------
666
667 * :gh:issue:`597` mitogen does not support Ansible 2.8 Python interpreter detection
668 * :gh:issue:`655` wait_for_connection gives errors
669 * :gh:issue:`672` cannot perform relative import error
670 * :gh:issue:`673` mitogen fails on RHEL8 server with bash /usr/bin/python: No such file or directory
671 * :gh:issue:`676` mitogen fail to run playbook without “/usr/bin/python” on target host
672 * :gh:issue:`716` fetch fails with "AttributeError: 'ShellModule' object has no attribute 'tmpdir'"
673 * :gh:issue:`756` ssh connections with `check_host_keys='accept'` would
674 timeout, when using recent OpenSSH client versions.
675 * :gh:issue:`758` fix initilialisation of callback plugins in test suite, to address a `KeyError` in
676 :py:meth:`ansible.plugins.callback.CallbackBase.v2_runner_on_start`
677 * :gh:issue:`775` Test with Python 3.9
678 * :gh:issue:`775` Add msvcrt to the default module deny list
679 * :gh:issue:`847` Removed historic Continuous Integration reverse shell
680
681
682 v0.2.9 (2019-11-02)
683 -------------------
684
685 This release contains minimal fixes beyond those required for Ansible 2.9.
686
687 * :gh:issue:`633`: :ans:mod:`meta: reset_connection <meta>` could fail to reset
688 a connection when ``become: true`` was set on the playbook.
689
690
691 Thanks!
692 ~~~~~~~
693
694 Mitogen would not be possible without the support of users. A huge thanks for
695 bug reports, testing, features and fixes in this release contributed by
696 `Can Ozokur <https://github.com/canozokur/>`_.
697
698
699 v0.2.8 (2019-08-18)
700 -------------------
701
702 This release includes Ansible 2.8 and SELinux support, fixes for two deadlocks,
703 and major internal design overhauls in preparation for future functionality.
704
705
706 Enhancements
707 ~~~~~~~~~~~~
708
709 * :gh:issue:`556`,
710 :gh:issue:`587`: Ansible 2.8 is supported.
711 `Become plugins <https://docs.ansible.com/ansible/latest/plugins/become.html>`_ (:gh:issue:`631`) and
712 `interpreter discovery <https://docs.ansible.com/ansible/latest/reference_appendices/interpreter_discovery.html>`_ (:gh:issue:`630`)
713 are not yet handled.
714
715 * :gh:issue:`419`, :gh:issue:`470`: file descriptor usage is approximately
716 halved, as it is no longer necessary to separately manage read and write
717 sides to work around a design problem.
718
719 * :gh:issue:`419`: setup for all connections happens almost entirely on one
720 thread, reducing contention and context switching early in a run.
721
722 * :gh:issue:`419`: Connection setup is better pipelined, eliminating some
723 network round-trips. Most infrastructure is in place to support future
724 removal of the final round-trips between a target booting and receiving
725 function calls.
726
727 * :gh:pull:`595`: the :meth:`~mitogen.parent.Router.buildah` connection method
728 is available to manipulate `Buildah <https://buildah.io/>`_ containers, and
729 is exposed to Ansible as the :ans:conn:`buildah`.
730
731 * :gh:issue:`615`: a modified :ans:mod:`fetch` implements streaming transfer
732 even when ``become`` is active, avoiding excess CPU and memory spikes, and
733 improving performance. A representative copy of two 512 MiB files drops from
734 55.7 seconds to 6.3 seconds, with peak memory usage dropping from 10.7 GiB to
735 64.8 MiB. [#i615]_
736
737 * `Operon <https://networkgenomics.com/operon/>`_ no longer requires a custom
738 library installation, both Ansible and Operon are supported by a single
739 Mitogen release.
740
741 * The ``MITOGEN_CPU_COUNT`` variable shards the connection multiplexer into
742 per-CPU workers. This may improve throughput for large runs involving file
743 transfer, and is required for future functionality. One multiplexer starts by
744 default, to match existing behaviour.
745
746 * :gh:commit:`d6faff06`, :gh:commit:`807cbef9`, :gh:commit:`e93762b3`,
747 :gh:commit:`50bfe4c7`: locking is avoided on hot paths, and some locks are
748 released before waking a thread that must immediately acquire the same lock.
749
750
751 Mitogen for Ansible
752 ~~~~~~~~~~~~~~~~~~~
753
754 * :gh:issue:`363`: fix an obscure race matching *Permission denied* errors from
755 some versions of :linux:man1:`su` running on heavily loaded machines.
756
757 * :gh:issue:`410`: Uses of :linux:man7:`unix` sockets are replaced with
758 traditional :linux:man7:`pipe` pairs when SELinux is detected, to work around
759 a broken heuristic in common SELinux policies that prevents inheriting
760 :linux:man7:`unix` sockets across privilege domains.
761
762 * :gh:issue:`467`: an incompatibility running Mitogen under `Molecule
763 <https://ansible.readthedocs.io/projects/molecule/>`_ was resolved.
764
765 * :gh:issue:`547`, :gh:issue:`598`: fix a deadlock during initialization of
766 connections, ``async`` tasks, tasks using custom :mod:`module_utils`,
767 ``mitogen_task_isolation: fork`` modules, and modules present on an internal
768 blacklist. This would manifest as a timeout or hang, was easily hit, had been
769 present since 0.2.0, and likely impacted many users.
770
771 * :gh:issue:`549`: the open file limit is increased to the permitted hard
772 limit. It is common for distributions to ship with a higher hard limit than
773 the default soft limit, allowing *"too many open files"* errors to be avoided
774 more often in large runs without user intervention.
775
776 * :gh:issue:`558`, :gh:issue:`582`: on Ansible 2.3 a directory was
777 unconditionally deleted after the first module belonging to an action plug-in
778 had executed, causing the :ans:mod:`unarchive` to fail.
779
780 * :gh:issue:`578`: the extension could crash while rendering an error due to an
781 incorrect format string.
782
783 * :gh:issue:`590`: the importer can handle modules that replace themselves in
784 :data:`sys.modules` with completely unrelated modules during import, as in
785 the case of Ansible 2.8 :mod:`ansible.module_utils.distro`.
786
787 * :gh:issue:`591`: the working directory is reset between tasks to ensure
788 :func:`os.getcwd` cannot fail, in the same way :class:`AnsibleModule`
789 resets it during initialization. However this restore happens before the
790 module executes, ensuring code that calls :func:`os.getcwd` prior to
791 :class:`AnsibleModule` initialization, such as the Ansible 2.7
792 :ans:mod:`pip`, cannot fail due to the actions of a prior task.
793
794 * :gh:issue:`593`: the SSH connection method exposes
795 ``mitogen_ssh_keepalive_interval`` and ``mitogen_ssh_keepalive_count``
796 variables, and the default timeout for an SSH server has been increased from
797 `15*3` seconds to `30*10` seconds.
798
799 * :gh:issue:`600`: functionality to reflect changes to ``/etc/environment`` did
800 not account for Unicode file contents. The file may now use any single byte
801 encoding.
802
803 * :gh:issue:`602`: connection configuration is more accurately inferred for
804 :ans:mod:`meta: reset_connection <meta>`, the :ans:mod:`synchronize`, and for
805 any action plug-ins that establish additional connections.
806
807 * :gh:issue:`598`, :gh:issue:`605`: fix a deadlock managing a shared counter
808 used for load balancing, present since 0.2.4.
809
810 * :gh:issue:`615`: streaming is implemented for the :ans:mod:`fetch` and other
811 actions that transfer files from targets to the controller. Previously files
812 were sent in one message, requiring them to fit in RAM and be smaller than an
813 internal message size sanity check. Transfers from controller to targets have
814 been streaming since 0.2.0.
815
816 * :gh:commit:`7ae926b3`: the :ans:mod:`lineinfile` leaked writable temporary
817 file descriptors between Ansible 2.7.0 and 2.8.2. When :ans:mod:`~lineinfile`
818 created or modified a script, and that script was later executed, the
819 execution could fail with "*text file busy*". Temporary descriptors are now
820 tracked and cleaned up on exit for all modules.
821
822
823 Core Library
824 ~~~~~~~~~~~~
825
826 * Log readability is improving and many :func:`repr` strings are more
827 descriptive. The old pseudo-function-call format is migrating to
828 readable output where possible. For example, *"Stream(ssh:123).connect()"*
829 might be written *"connecting to ssh:123"*.
830
831 * In preparation for reducing default log output, many messages are delivered
832 to per-component loggers, including messages originating from children,
833 enabling :mod:`logging` aggregation to function as designed. An importer
834 message like::
835
836 12:00:00 D mitogen.ctx.remotehost mitogen: loading module "foo"
837
838 Might instead be logged to the ``mitogen.importer.[remotehost]`` logger::
839
840 12:00:00 D mitogen.importer.[remotehost] loading module "foo"
841
842 Allowing a filter or handler for ``mitogen.importer`` to select that logger
843 in every process. This introduces a small risk of leaking memory in
844 long-lived programs, as logger objects are internally persistent.
845
846 * :func:`bytearray` was removed from the list of supported serialization types.
847 It was never portable between Python versions, unused, and never made much
848 sense to support.
849
850 * :gh:issue:`170`: to improve subprocess
851 management and asynchronous connect, a :class:`~mitogen.parent.TimerList`
852 interface is available, accessible as :attr:`Broker.timers` in an
853 asynchronous context.
854
855 * :gh:issue:`419`: the internal
856 :class:`~mitogen.core.Stream` has been refactored into many new classes,
857 modularizing protocol behaviour, output buffering, line-oriented input
858 parsing, option handling and connection management. Connection setup is
859 internally asynchronous, laying most groundwork for fully asynchronous
860 connect, proxied Ansible become plug-ins, and in-process SSH.
861
862 * :gh:issue:`169`,
863 :gh:issue:`419`: zombie subprocess reaping
864 has vastly improved, by using timers to efficiently poll for a child to exit,
865 and delaying shutdown while any subprocess remains. Polling avoids
866 process-global configuration such as a `SIGCHLD` handler, or
867 :func:`signal.set_wakeup_fd` available in modern Python.
868
869 * :gh:issue:`256`, :gh:issue:`419`: most :func:`os.dup` use was eliminated,
870 along with most manual file descriptor management. Descriptors are trapped in
871 :func:`os.fdopen` objects at creation, ensuring a leaked object will close
872 itself, and ensuring every descriptor is fused to a `closed` flag, preventing
873 historical bugs where a double close could destroy unrelated descriptors.
874
875 * :gh:issue:`533`: routing accounts for
876 a race between a parent (or cousin) sending a message to a child via an
877 intermediary, where the child had recently disconnected, and
878 :data:`~mitogen.core.DEL_ROUTE` propagating from the intermediary
879 to the sender, informing it that the child no longer exists. This condition
880 is detected at the intermediary and a :ref:`dead message <IS_DEAD>` is
881 returned to the sender.
882
883 Previously since the intermediary had already removed its route for the
884 child, the *route messages upwards* rule would be triggered, causing the
885 message (with a privileged :ref:`src_id/auth_id <stream-protocol>`) to be
886 sent upstream, resulting in a ``bad auth_id`` error logged at the first
887 upstream parent, and a possible hang due to a request message being dropped.
888
889 * :gh:issue:`586`: fix import of
890 :mod:`__main__` on later versions of Python 3 when running from the
891 interactive console.
892
893 * :gh:issue:`606`: fix example code on the
894 documentation front page.
895
896 * :gh:issue:`612`: fix various errors
897 introduced by stream refactoring.
898
899 * :gh:issue:`615`: when routing fails to
900 deliver a message for some reason other than the sender cannot or should not
901 reach the recipient, and no reply-to address is present on the message,
902 instead send a :ref:`dead message <IS_DEAD>` to the original recipient. This
903 ensures a descriptive message is delivered to a thread sleeping on the reply
904 to a function call, where the reply might be dropped due to exceeding the
905 maximum configured message size.
906
907 * :gh:issue:`624`: the number of threads used for a child's automatically
908 initialized service thread pool has been reduced from 16 to 2. This may drop
909 to 1 in future, and become configurable via a :class:`Router` option.
910
911 * :gh:commit:`a5536c35`: avoid quadratic
912 buffer management when logging lines received from a child's redirected
913 standard IO.
914
915 * :gh:commit:`49a6446a`: the
916 :meth:`empty` methods of :class:`~mitogen.core.Latch`,
917 :class:`~mitogen.core.Receiver` and :class:`~mitogen.select.Select` are
918 obsoleted by a more general :meth:`size` method. :meth:`empty` will be
919 removed in 0.3
920
921 * :gh:commit:`ecc570cb`: previously
922 :meth:`mitogen.select.Select.add` would enqueue one wake event when adding an
923 existing receiver, latch or subselect that contained multiple buffered items,
924 causing :meth:`get` calls to block or fail even though data existed to return.
925
926 * :gh:commit:`5924af15`: *[security]*
927 unidirectional routing, where contexts may optionally only communicate with
928 parents and never siblings (so that air-gapped networks cannot be
929 unintentionally bridged) was not inherited when a child was initiated
930 directly from another child. This did not effect Ansible, since the
931 controller initiates any new child used for routing, only forked tasks are
932 initiated by children.
933
934
935 Thanks!
936 ~~~~~~~
937
938 Mitogen would not be possible without the support of users. A huge thanks for
939 bug reports, testing, features and fixes in this release contributed by
940 `Andreas Hubert <https://github.com/peshay>`_,
941 `Anton Markelov <https://github.com/strangeman>`_,
942 `Dan <https://github.com/dsgnr>`_,
943 `Dave Cottlehuber <https://github.com/dch>`_,
944 `Denis Krienbühl <https://github.com/href>`_,
945 `El Mehdi CHAOUKI <https://github.com/elmchaouki>`_,
946 `Florent Dutheil <https://github.com/fdutheil>`_,
947 `James Hogarth <https://github.com/hogarthj>`_,
948 `Jordan Webb <https://github.com/jordemort>`_,
949 `Julian Andres Klode <https://github.com/julian-klode>`_,
950 `Marc Hartmayer <https://github.com/marc1006>`_,
951 `Nigel Metheringham <https://github.com/nigelm>`_,
952 `Orion Poplawski <https://github.com/opoplawski>`_,
953 `Pieter Voet <https://github.com/pietervoet/>`_,
954 `Stefane Fermigier <https://github.com/sfermigier>`_,
955 `Szabó Dániel Ernő <https://github.com/r3ap3rpy>`_,
956 `Ulrich Schreiner <https://github.com/ulrichSchreiner>`_,
957 `Vincent S. Cojot <https://github.com/ElCoyote27>`_,
958 `yen <https://github.com/antigenius0910>`_,
959 `Yuki Nishida <https://github.com/yuki-nishida-exa>`_,
960 `@alexhexabeam <https://github.com/alexhexabeam>`_,
961 `@DavidVentura <https://github.com/DavidVentura>`_,
962 `@dbiegunski <https://github.com/dbiegunski>`_,
963 `@ghp-rr <https://github.com/ghp-rr>`_,
964 `@migalsp <https://github.com/migalsp>`_,
965 `@rizzly <https://github.com/rizzly>`_,
966 `@SQGE <https://github.com/SQGE>`_, and
967 `@tho86 <https://github.com/tho86>`_.
968
969
970 .. rubric:: Footnotes
971
972 .. [#i615] Peak RSS of controller and target as measured with ``/usr/bin/time
973 -v ansible-playbook -c local`` using the reproduction supplied in
974 :gh:issue:`615`.
975
976
977 v0.2.7 (2019-05-19)
978 -------------------
979
980 This release primarily exists to add a descriptive error message when running
981 on Ansible 2.8, which is not yet supported.
982
983 Fixes
984 ~~~~~
985
986 * :gh:issue:`557`: fix a crash when running
987 on machines with high CPU counts.
988
989 * :gh:issue:`570`: the :ans:mod:`firewalld` internally caches a dbus name that
990 changes across :ans:mod:`~firewalld` restarts, causing a failure if the
991 service is restarted between :ans:mod:`~firewalld` module invocations.
992
993 * :gh:issue:`575`: fix a crash when
994 rendering an error message to indicate no usable temporary directories could
995 be found.
996
997 * :gh:issue:`576`: fix a crash during
998 startup on SuSE Linux 11, due to an incorrect version compatibility check in
999 the Mitogen code.
1000
1001 * :gh:issue:`581`: a
1002 ``mitogen_mask_remote_name`` Ansible variable is exposed, to allow masking
1003 the username, hostname and process ID of ``ansible-playbook`` running on the
1004 controller machine.
1005
1006 * :gh:issue:`587`: display a friendly
1007 message when running on an unsupported version of Ansible, to cope with
1008 potential influx of 2.8-related bug reports.
1009
1010
1011 Thanks!
1012 ~~~~~~~
1013
1014 Mitogen would not be possible without the support of users. A huge thanks for
1015 bug reports, testing, features and fixes in this release contributed by
1016 `Orion Poplawski <https://github.com/opoplawski>`_,
1017 `Thibaut Barrère <https://github.com/thbar>`_,
1018 `@Moumoutaru <https://github.com/Moumoutaru>`_, and
1019 `@polski-g <https://github.com/polski-g>`_.
1020
1021
1022 v0.2.6 (2019-03-06)
1023 -------------------
1024
1025 Fixes
1026 ~~~~~
1027
1028 * :gh:issue:`542`: some versions of OS X
1029 ship a default Python that does not support :func:`select.poll`. Restore the
1030 0.2.3 behaviour of defaulting to Kqueue in this case, but still prefer
1031 :func:`select.poll` if it is available.
1032
1033 * :gh:issue:`545`: an optimization
1034 introduced in :gh:issue:`493` caused a
1035 64-bit integer to be assigned to a 32-bit field on ARM 32-bit targets,
1036 causing runs to fail.
1037
1038 * :gh:issue:`548`: `mitogen_via=` could fail
1039 when the selected transport was set to ``smart``.
1040
1041 * :gh:issue:`550`: avoid some broken
1042 TTY-related `ioctl()` calls on Windows Subsystem for Linux 2016 Anniversary
1043 Update.
1044
1045 * :gh:issue:`554`: third party Ansible
1046 action plug-ins that invoked :func:`_make_tmp_path` repeatedly could trigger
1047 an assertion failure.
1048
1049 * :gh:issue:`555`: work around an old idiom
1050 that reloaded :mod:`sys` in order to change the interpreter's default encoding.
1051
1052 * :gh:commit:`ffae0355`: needless
1053 information was removed from the documentation and installation procedure.
1054
1055
1056 Core Library
1057 ~~~~~~~~~~~~
1058
1059 * :gh:issue:`535`: to support function calls
1060 on a service pool from another thread, :class:`mitogen.select.Select`
1061 additionally permits waiting on :class:`mitogen.core.Latch`.
1062
1063 * :gh:issue:`535`:
1064 :class:`mitogen.service.Pool.defer` allows any function to be enqueued for
1065 the thread pool from another thread.
1066
1067 * :gh:issue:`535`: a new
1068 :mod:`mitogen.os_fork` module provides a :func:`os.fork` wrapper that pauses
1069 thread activity during fork. On Python<2.6, :class:`mitogen.core.Broker` and
1070 :class:`mitogen.service.Pool` automatically record their existence so that a
1071 :func:`os.fork` monkey-patch can automatically pause them for any attempt to
1072 start a subprocess.
1073
1074 * :gh:commit:`ca63c26e`:
1075 :meth:`mitogen.core.Latch.put`'s `obj` argument was made optional.
1076
1077
1078 Thanks!
1079 ~~~~~~~
1080
1081 Mitogen would not be possible without the support of users. A huge thanks for
1082 bug reports, testing, features and fixes in this release contributed by
1083 `Fabian Arrotin <https://github.com/arrfab>`_,
1084 `Giles Westwood <https://github.com/gilesw>`_,
1085 `Matt Layman <https://github.com/mblayman>`_,
1086 `Percy Grunwald <https://github.com/percygrunwald>`_,
1087 `Petr Enkov <https://github.com/enkov>`_,
1088 `Tony Finch <https://github.com/fanf2>`_,
1089 `@elbunda <https://github.com/elbunda>`_, and
1090 `@zyphermonkey <https://github.com/zyphermonkey>`_.
1091
1092
1093 v0.2.5 (2019-02-14)
1094 -------------------
1095
1096 Fixes
1097 ~~~~~
1098
1099 * :gh:issue:`511`,
1100 :gh:issue:`536`: changes in 0.2.4 to
1101 repair ``delegate_to`` handling broke default ``ansible_python_interpreter``
1102 handling. Test coverage was added.
1103
1104 * :gh:issue:`532`: fix a race in the service
1105 used to propagate Ansible modules, that could easily manifest when starting
1106 asynchronous tasks in a loop.
1107
1108 * :gh:issue:`536`: changes in 0.2.4 to
1109 support Python 2.4 interacted poorly with modules that imported
1110 ``simplejson`` from a controller that also loaded an incompatible newer
1111 version of ``simplejson``.
1112
1113 * :gh:issue:`537`: a swapped operator in the
1114 CPU affinity logic meant 2 cores were reserved on 1<n<4 core machines, rather
1115 than 1 core as desired. Test coverage was added.
1116
1117 * :gh:issue:`538`: the source distribution
1118 includes a ``LICENSE`` file.
1119
1120 * :gh:issue:`539`: log output is no longer
1121 duplicated when the Ansible ``log_path`` setting is enabled.
1122
1123 * :gh:issue:`540`: the ``stderr`` stream of
1124 async module invocations was previously discarded.
1125
1126 * :gh:issue:`541`: Python error logs
1127 originating from the ``boto`` package are quiesced, and only appear in
1128 ``-vvv`` output. This is since EC2 modules may trigger errors during normal
1129 operation, when retrying transiently failing requests.
1130
1131 * :gh:commit:`748f5f67`,
1132 :gh:commit:`21ad299d`,
1133 :gh:commit:`8ae6ca1d`,
1134 :gh:commit:`7fd0d349`:
1135 the ``ansible_ssh_host``, ``ansible_ssh_user``, ``ansible_user``,
1136 ``ansible_become_method``, and ``ansible_ssh_port`` variables more correctly
1137 match typical behaviour when ``mitogen_via=`` is active.
1138
1139 * :gh:commit:`2a8567b4`: fix a race
1140 initializing a child's service thread pool on Python 3.4+, due to a change in
1141 locking scheme used by the Python import mechanism.
1142
1143
1144 Thanks!
1145 ~~~~~~~
1146
1147 Mitogen would not be possible without the support of users. A huge thanks for
1148 bug reports, testing, features and fixes in this release contributed by
1149 `Carl George <https://github.com/carlwgeorge>`_,
1150 `Guy Knights <https://github.com/knightsg>`_, and
1151 `Josh Smift <https://github.com/jbscare>`_.
1152
1153
1154 v0.2.4 (2019-02-10)
1155 -------------------
1156
1157 Mitogen for Ansible
1158 ~~~~~~~~~~~~~~~~~~~
1159
1160 This release includes a huge variety of important fixes and new optimizations.
1161 It is 35% faster than 0.2.3 on a synthetic 64 target run that places heavy load
1162 on the connection multiplexer.
1163
1164 Enhancements
1165 ^^^^^^^^^^^^
1166
1167 * :gh:issue:`76`,
1168 :gh:issue:`351`,
1169 :gh:issue:`352`: disconnect propagation
1170 has improved, allowing Ansible to cancel waits for responses from abruptly
1171 disconnected targets. This ensures a task will reliably fail rather than
1172 hang, for example on network failure or EC2 instance maintenance.
1173
1174 * :gh:issue:`369`,
1175 :gh:issue:`407`: :meth:`Connection.reset`
1176 is implemented, allowing :ans:mod:`meta: reset_connection <meta>` to shut
1177 down the remote interpreter as documented, and improving support for the
1178 :ans:mod:`reboot`.
1179
1180 * :gh:commit:`09aa27a6`: the
1181 ``mitogen_host_pinned`` strategy wraps the ``host_pinned`` strategy
1182 introduced in Ansible 2.7.
1183
1184 * :gh:issue:`477`: Python 2.4 is fully
1185 supported by the core library and tested automatically, in any parent/child
1186 combination of 2.4, 2.6, 2.7 and 3.6 interpreters.
1187
1188 * :gh:issue:`477`: Ansible 2.3 is fully
1189 supported and tested automatically. In combination with the core library
1190 Python 2.4 support, this allows Red Hat Enterprise Linux 5 targets to be
1191 managed with Mitogen. The ``simplejson`` package need not be installed on
1192 such targets, as is usually required by Ansible.
1193
1194 * :gh:issue:`412`: to simplify diagnosing
1195 connection configuration problems, Mitogen ships a ``mitogen_get_stack``
1196 action that is automatically added to the action plug-in path. See
1197 :ref:`mitogen-get-stack` for more information.
1198
1199 * :gh:commit:`152effc2`,
1200 :gh:commit:`bd4b04ae`: a CPU affinity
1201 policy was added for Linux controllers, reducing latency and SMP overhead on
1202 hot paths exercised for every task. This yielded a 19% speedup in a 64-target
1203 job composed of many short tasks, and should easily be visible as a runtime
1204 improvement in many-host runs.
1205
1206 * :gh:commit:`2b44d598`: work around a
1207 defective caching mechanism by pre-heating it before spawning workers. This
1208 saves 40% runtime on a synthetic repetitive task.
1209
1210 * :gh:commit:`0979422a`: an expensive
1211 dependency scanning step was redundantly invoked for every task,
1212 bottlenecking the connection multiplexer.
1213
1214 * :gh:commit:`eaa990a97`: a new
1215 ``mitogen_ssh_compression`` variable is supported, allowing Mitogen's default
1216 SSH compression to be disabled. SSH compression is a large contributor to CPU
1217 usage in many-target runs, and severely limits file transfer. On a `"shell:
1218 hostname"` task repeated 500 times, Mitogen requires around 800 bytes per
1219 task with compression, rising to 3 KiB without. File transfer throughput
1220 rises from ~25MiB/s when enabled to ~200MiB/s when disabled.
1221
1222 * :gh:issue:`260`,
1223 :gh:commit:`a18a083c`: brokers no
1224 longer wait for readiness indication to transmit, and instead assume
1225 transmission will succeed. As this is usually true, one loop iteration and
1226 two poller reconfigurations are avoided, yielding a significant reduction in
1227 interprocess round-trip latency.
1228
1229 * :gh:issue:`415`, :gh:issue:`491`, :gh:issue:`493`: the interface employed
1230 for in-process queues changed from :freebsd:man2:`kqueue` /
1231 :linux:man7:`epoll` to :linux:man2:`poll`, which requires no setup or
1232 teardown, yielding a 38% latency reduction for inter-thread communication.
1233
1234
1235 Fixes
1236 ^^^^^
1237
1238 * :gh:issue:`251`,
1239 :gh:issue:`359`,
1240 :gh:issue:`396`,
1241 :gh:issue:`401`,
1242 :gh:issue:`404`,
1243 :gh:issue:`412`,
1244 :gh:issue:`434`,
1245 :gh:issue:`436`,
1246 :gh:issue:`465`: connection delegation and
1247 ``delegate_to:`` handling suffered a major regression in 0.2.3. The 0.2.2
1248 behaviour has been restored, and further work has been made to improve the
1249 compatibility of connection delegation's configuration building methods.
1250
1251 * :gh:issue:`323`,
1252 :gh:issue:`333`: work around a Windows
1253 Subsystem for Linux bug that caused tracebacks to appear during shutdown.
1254
1255 * :gh:issue:`334`: the SSH method
1256 tilde-expands private key paths using Ansible's logic. Previously the path
1257 was passed unmodified to SSH, which expanded it using :func:`pwd.getpwnam`.
1258 This differs from :func:`os.path.expanduser`, which uses the ``HOME``
1259 environment variable if it is set, causing behaviour to diverge when Ansible
1260 was invoked across user accounts via ``sudo``.
1261
1262 * :gh:issue:`364`: file transfers from
1263 controllers running Python 2.7.2 or earlier could be interrupted due to a
1264 forking bug in the :mod:`tempfile` module.
1265
1266 * :gh:issue:`370`: the Ansible :ans:mod:`reboot` is supported.
1267
1268 * :gh:issue:`373`: the LXC and LXD methods print a useful hint on failure, as
1269 no useful error is normally logged to the console by these tools.
1270
1271 * :gh:issue:`374`,
1272 :gh:issue:`391`: file transfer and module
1273 execution from 2.x controllers to 3.x targets was broken due to a regression
1274 caused by refactoring, and compounded by :gh:issue:`426`.
1275
1276 * :gh:issue:`400`: work around a threading
1277 bug in the AWX display callback when running with high verbosity setting.
1278
1279 * :gh:issue:`409`: the setns method was
1280 silently broken due to missing tests. Basic coverage was added to prevent a
1281 recurrence.
1282
1283 * :gh:issue:`409`: the LXC and LXD methods
1284 support ``mitogen_lxc_path`` and ``mitogen_lxc_attach_path`` variables to
1285 control the location of third pary utilities.
1286
1287 * :gh:issue:`410`: the sudo method supports
1288 the SELinux ``--type`` and ``--role`` options.
1289
1290 * :gh:issue:`420`: if a :class:`Connection`
1291 was constructed in the Ansible top-level process, for example while executing
1292 ``meta: reset_connection``, resources could become undesirably shared in
1293 subsequent children.
1294
1295 * :gh:issue:`426`: an oversight while
1296 porting to Python 3 meant no automated 2->3 tests were running. A significant
1297 number of 2->3 bugs were fixed, mostly in the form of Unicode/bytes
1298 mismatches.
1299
1300 * :gh:issue:`429`: the ``sudo`` method can
1301 now recognize internationalized password prompts.
1302
1303 * :gh:issue:`362`,
1304 :gh:issue:`435`: the previous fix for slow
1305 Python 2.x subprocess creation on Red Hat caused newly spawned children to
1306 have a reduced open files limit. A more intrusive fix has been added to
1307 directly address the problem without modifying the subprocess environment.
1308
1309 * :gh:issue:`397`,
1310 :gh:issue:`454`: the previous approach to
1311 handling modern Ansible temporary file cleanup was too aggressive, and could
1312 trigger early finalization of Cython-based extension modules, leading to
1313 segmentation faults.
1314
1315 * :gh:issue:`499`: the ``allow_same_user``
1316 Ansible configuration setting is respected.
1317
1318 * :gh:issue:`527`: crashes in modules are
1319 trapped and reported in a manner that matches Ansible. In particular, a
1320 module crash no longer leads to an exception that may crash the corresponding
1321 action plug-in.
1322
1323 * :gh:commit:`dc1d4251`: the :ans:mod:`synchronize` could fail with the Docker
1324 transport due to a missing attribute.
1325
1326 * :gh:commit:`599da068`: fix a race
1327 when starting async tasks, where it was possible for the controller to
1328 observe no status file on disk before the task had a chance to write one.
1329
1330 * :gh:commit:`2c7af9f04`: Ansible
1331 modules were repeatedly re-transferred. The bug was hidden by the previously
1332 mandatorily enabled SSH compression.
1333
1334
1335 Core Library
1336 ~~~~~~~~~~~~
1337
1338 * :gh:issue:`76`: routing records the
1339 destination context IDs ever received on each stream, and when disconnection
1340 occurs, propagates :data:`mitogen.core.DEL_ROUTE` messages towards every
1341 stream that ever communicated with the disappearing peer, rather than simply
1342 towards parents. Conversations between nodes anywhere in the tree receive
1343 :data:`mitogen.core.DEL_ROUTE` when either participant disconnects, allowing
1344 receivers to wake with :class:`mitogen.core.ChannelError`, even when one
1345 participant is not a parent of the other.
1346
1347 * :gh:issue:`109`,
1348 :gh:commit:`57504ba6`: newer Python 3
1349 releases explicitly populate :data:`sys.meta_path` with importer internals,
1350 causing Mitogen to install itself at the end of the importer chain rather
1351 than the front.
1352
1353 * :gh:issue:`310`: support has returned for
1354 trying to figure out the real source of non-module objects installed in
1355 :data:`sys.modules`, so they can be imported. This is needed to handle syntax
1356 sugar used by packages like :mod:`plumbum`.
1357
1358 * :gh:issue:`349`: an incorrect format
1359 string could cause large stack traces when attempting to import built-in
1360 modules on Python 3.
1361
1362 * :gh:issue:`387`,
1363 :gh:issue:`413`: dead messages include an
1364 optional reason in their body. This is used to cause
1365 :class:`mitogen.core.ChannelError` to report far more useful diagnostics at
1366 the point the error occurs that previously would have been buried in debug
1367 log output from an unrelated context.
1368
1369 * :gh:issue:`408`: a variety of fixes were
1370 made to restore Python 2.4 compatibility.
1371
1372 * :gh:issue:`399`,
1373 :gh:issue:`437`: ignore a
1374 :class:`DeprecationWarning` to avoid failure of the ``su`` method on Python
1375 3.7.
1376
1377 * :gh:issue:`405`: if an oversized message
1378 is rejected, and it has a ``reply_to`` set, a dead message is returned to the
1379 sender. This ensures function calls exceeding the configured maximum size
1380 crash rather than hang.
1381
1382 * :gh:issue:`406`:
1383 :class:`mitogen.core.Broker` did not call :meth:`mitogen.core.Poller.close`
1384 during shutdown, leaking the underlying poller FD in masters and parents.
1385
1386 * :gh:issue:`406`: connections could leak
1387 FDs when a child process failed to start.
1388
1389 * :gh:issue:`288`,
1390 :gh:issue:`406`,
1391 :gh:issue:`417`: connections could leave
1392 FD wrapper objects that had not been closed lying around to be closed during
1393 garbage collection, causing reused FD numbers to be closed at random moments.
1394
1395 * :gh:issue:`411`: the SSH method typed
1396 "``y``" rather than the requisite "``yes``" when `check_host_keys="accept"`
1397 was configured. This would lead to connection timeouts due to the hung
1398 response.
1399
1400 * :gh:issue:`414`,
1401 :gh:issue:`425`: avoid deadlock of forked
1402 children by reinitializing the :mod:`mitogen.service` pool lock.
1403
1404 * :gh:issue:`416`: around 1.4KiB of memory
1405 was leaked on every RPC, due to a list of strong references keeping alive any
1406 handler ever registered for disconnect notification.
1407
1408 * :gh:issue:`418`: the
1409 :func:`mitogen.parent.iter_read` helper would leak poller FDs, because
1410 execution of its :keyword:`finally` block was delayed on Python 3. Now
1411 callers explicitly close the generator when finished.
1412
1413 * :gh:issue:`422`: the fork method could
1414 fail to start if :data:`sys.stdout` was opened in block buffered mode, and
1415 buffered data was pending in the parent prior to fork.
1416
1417 * :gh:issue:`438`: a descriptive error is
1418 logged when stream corruption is detected.
1419
1420 * :gh:issue:`439`: descriptive errors are
1421 raised when attempting to invoke unsupported function types.
1422
1423 * :gh:issue:`444`: messages regarding
1424 unforwardable extension module are no longer logged as errors.
1425
1426 * :gh:issue:`445`: service pools unregister
1427 the :data:`mitogen.core.CALL_SERVICE` handle at shutdown, ensuring any
1428 outstanding messages are either processed by the pool as it shuts down, or
1429 have dead messages sent in reply to them, preventing peer contexts from
1430 hanging due to a forgotten buffered message.
1431
1432 * :gh:issue:`446`: given thread A calling
1433 :meth:`mitogen.core.Receiver.close`, and thread B, C, and D sleeping in
1434 :meth:`mitogen.core.Receiver.get`, previously only one sleeping thread would
1435 be woken with :class:`mitogen.core.ChannelError` when the receiver was
1436 closed. Now all threads are woken per the docstring.
1437
1438 * :gh:issue:`447`: duplicate attempts to
1439 invoke :meth:`mitogen.core.Router.add_handler` cause an error to be raised,
1440 ensuring accidental re-registration of service pools are reported correctly.
1441
1442 * :gh:issue:`448`: the import hook
1443 implementation now raises :class:`ModuleNotFoundError` instead of
1444 :class:`ImportError` in Python 3.6 and above, to cope with an upcoming
1445 version of the :mod:`subprocess` module requiring this new subclass to be
1446 raised.
1447
1448 * :gh:issue:`453`: the loggers used in
1449 children for standard IO redirection have propagation disabled, preventing
1450 accidental reconfiguration of the :mod:`logging` package in a child from
1451 setting up a feedback loop.
1452
1453 * :gh:issue:`456`: a descriptive error is
1454 logged when :meth:`mitogen.core.Broker.defer` is called after the broker has
1455 shut down, preventing new messages being enqueued that will never be sent,
1456 and subsequently producing a program hang.
1457
1458 * :gh:issue:`459`: the beginnings of a
1459 :meth:`mitogen.master.Router.get_stats` call has been added. The initial
1460 statistics cover the module loader only.
1461
1462 * :gh:issue:`462`: Mitogen could fail to
1463 open a PTY on broken Linux systems due to a bad interaction between the glibc
1464 :func:`grantpt` function and an incorrectly mounted ``/dev/pts`` filesystem.
1465 Since correct group ownership is not required in most scenarios, when this
1466 problem is detected, the PTY is allocated and opened directly by the library.
1467
1468 * :gh:issue:`479`: Mitogen could fail to
1469 import :mod:`__main__` on Python 3.4 and newer due to a breaking change in
1470 the :mod:`pkgutil` API. The program's main script is now handled specially.
1471
1472 * :gh:issue:`481`: the version of `sudo`
1473 that shipped with CentOS 5 replaced itself with the program to be executed,
1474 and therefore did not hold any child PTY open on our behalf. The child
1475 context is updated to preserve any PTY FD in order to avoid the kernel
1476 sending `SIGHUP` early during startup.
1477
1478 * :gh:issue:`523`: the test suite didn't
1479 generate a code coverage report if any test failed.
1480
1481 * :gh:issue:`524`: Python 3.6+ emitted a
1482 :class:`DeprecationWarning` for :func:`mitogen.utils.run_with_router`.
1483
1484 * :gh:issue:`529`: Code coverage of the
1485 test suite was not measured across all Python versions.
1486
1487 * :gh:commit:`16ca111e`: handle OpenSSH
1488 7.5 permission denied prompts when ``~/.ssh/config`` rewrites are present.
1489
1490 * :gh:commit:`9ec360c2`: a new
1491 :meth:`mitogen.core.Broker.defer_sync` utility function is provided.
1492
1493 * :gh:commit:`f20e0bba`:
1494 :meth:`mitogen.service.FileService.register_prefix` permits granting
1495 unprivileged access to whole filesystem subtrees, rather than single files at
1496 a time.
1497
1498 * :gh:commit:`8f85ee03`:
1499 :meth:`mitogen.core.Router.myself` returns a :class:`mitogen.core.Context`
1500 referring to the current process.
1501
1502 * :gh:commit:`824c7931`: exceptions
1503 raised by the import hook were updated to include probable reasons for
1504 a failure.
1505
1506 * :gh:commit:`57b652ed`: a stray import
1507 meant an extra roundtrip and ~4KiB of data was wasted for any context that
1508 imported :mod:`mitogen.parent`.
1509
1510
1511 Thanks!
1512 ~~~~~~~
1513
1514 Mitogen would not be possible without the support of users. A huge thanks for
1515 bug reports, testing, features and fixes in this release contributed by
1516 `Alex Willmer <https://github.com/moreati>`_,
1517 `Andreas Krüger <https://github.com/woopstar>`_,
1518 `Anton Stroganov <https://github.com/Aeon>`_,
1519 `Berend De Schouwer <https://github.com/berenddeschouwer>`_,
1520 `Brian Candler <https://github.com/candlerb>`_,
1521 `dsgnr <https://github.com/dsgnr>`_,
1522 `Duane Zamrok <https://github.com/dewthefifth>`_,
1523 `Eric Chang <https://github.com/changchichung>`_,
1524 `Gerben Meijer <https://github.com/infernix>`_,
1525 `Guy Knights <https://github.com/knightsg>`_,
1526 `Jesse London <https://github.com/jesteria>`_,
1527 `Jiří Vávra <https://github.com/Houbovo>`_,
1528 `Johan Beisser <https://github.com/jbeisser>`_,
1529 `Jonathan Rosser <https://github.com/jrosser>`_,
1530 `Josh Smift <https://github.com/jbscare>`_,
1531 `Kevin Carter <https://github.com/cloudnull>`_,
1532 `Mehdi <https://github.com/mehdisat7>`_,
1533 `Michael DeHaan <https://github.com/mpdehaan>`_,
1534 `Michal Medvecky <https://github.com/michalmedvecky>`_,
1535 `Mohammed Naser <https://github.com/mnaser/>`_,
1536 `Peter V. Saveliev <https://github.com/svinota/>`_,
1537 `Pieter Avonts <https://github.com/pieteravonts/>`_,
1538 `Ross Williams <https://github.com/overhacked/>`_,
1539 `Sergey <https://github.com/LuckySB/>`_,
1540 `Stéphane <https://github.com/sboisson/>`_,
1541 `Strahinja Kustudic <https://github.com/kustodian>`_,
1542 `Tom Parker-Shemilt <https://github.com/palfrey/>`_,
1543 `Younès HAFRI <https://github.com/yhafri>`_,
1544 `@killua-eu <https://github.com/killua-eu>`_,
1545 `@myssa91 <https://github.com/myssa91>`_,
1546 `@ohmer1 <https://github.com/ohmer1>`_,
1547 `@s3c70r <https://github.com/s3c70r/>`_,
1548 `@syntonym <https://github.com/syntonym/>`_,
1549 `@trim777 <https://github.com/trim777/>`_,
1550 `@whky <https://github.com/whky/>`_, and
1551 `@yodatak <https://github.com/yodatak/>`_.
1552
1553
1554 v0.2.3 (2018-10-23)
1555 -------------------
1556
1557 Mitogen for Ansible
1558 ~~~~~~~~~~~~~~~~~~~
1559
1560 Enhancements
1561 ^^^^^^^^^^^^
1562
1563 * :gh:pull:`315`,
1564 :gh:issue:`392`: Ansible 2.6 and 2.7 are
1565 supported.
1566
1567 * :gh:issue:`321`, :gh:issue:`336`: temporary file handling was simplified,
1568 undoing earlier damage caused by compatibility fixes, improving 2.6
1569 compatibility, and avoiding two network roundtrips for every related action
1570 (:ans:mod:`~assemble`, :ans:mod:`~aws_s3`, :ans:mod:`~copy`,
1571 :ans:mod:`~patch`, :ans:mod:`~script`, :ans:mod:`~template`,
1572 :ans:mod:`~unarchive`, :ans:mod:`~uri`). See :ref:`ansible_tempfiles` for a
1573 complete description.
1574
1575 * :gh:pull:`376`, :gh:pull:`377`: the ``kubectl`` connection type is now
1576 supported. Contributed by Yannig Perré.
1577
1578 * :gh:commit:`084c0ac0`: avoid a roundtrip in :ans:mod:`~copy` and
1579 :ans:mod:`~template` due to an unfortunate default.
1580
1581 * :gh:commit:`7458dfae`: avoid a
1582 roundtrip when transferring files smaller than 124KiB. Copy and template
1583 actions are now 2-RTT, reducing runtime for a 20-iteration template loop over
1584 a 250 ms link from 30 seconds to 10 seconds compared to v0.2.2, down from 120
1585 seconds compared to vanilla.
1586
1587 * :gh:issue:`337`: To avoid a scaling
1588 limitation, a PTY is no longer allocated for an SSH connection unless the
1589 configuration specifies a password.
1590
1591 * :gh:commit:`d62e6e2a`: many-target
1592 runs executed the dependency scanner redundantly due to missing
1593 synchronization, wasting significant runtime in the connection multiplexer.
1594 In one case work was reduced by 95%, which may manifest as faster runs.
1595
1596 * :gh:commit:`5189408e`: threads are
1597 cooperatively scheduled, minimizing `GIL
1598 <https://en.wikipedia.org/wiki/Global_interpreter_lock>`_ contention, and
1599 reducing context switching by around 90%. This manifests as an overall
1600 improvement, but is easily noticeable on short many-target runs, where
1601 startup overhead dominates runtime.
1602
1603 * The `faulthandler <https://faulthandler.readthedocs.io/>`_ module is
1604 automatically activated if it is installed, simplifying debugging of hangs.
1605 See :ref:`diagnosing-hangs` for details.
1606
1607 * The ``MITOGEN_DUMP_THREAD_STACKS`` environment variable's value now indicates
1608 the number of seconds between stack dumps. See :ref:`diagnosing-hangs` for
1609 details.
1610
1611
1612 Fixes
1613 ^^^^^
1614
1615 * :gh:issue:`251`,
1616 :gh:issue:`340`: Connection Delegation
1617 could establish connections to the wrong target when ``delegate_to:`` is
1618 present.
1619
1620 * :gh:issue:`291`: when Mitogen had
1621 previously been installed using ``pip`` or ``setuptools``, the globally
1622 installed version could conflict with a newer version bundled with an
1623 extension that had been installed using the documented steps. Now the bundled
1624 library always overrides over any system-installed copy.
1625
1626 * :gh:issue:`324`: plays with a
1627 `custom module_utils <https://docs.ansible.com/ansible/latest/reference_appendices/config.html#default-module-utils-path>`_
1628 would fail due to fallout from the Python 3 port and related tests being
1629 disabled.
1630
1631 * :gh:issue:`331`: the connection
1632 multiplexer subprocess always exits before the main Ansible process, ensuring
1633 logs generated by it do not overwrite the user's prompt when ``-vvv`` is
1634 enabled.
1635
1636 * :gh:issue:`332`: support a new
1637 :func:`sys.excepthook`-based module exit mechanism added in Ansible 2.6.
1638
1639 * :gh:issue:`338`: compatibility: changes to
1640 ``/etc/environment`` and ``~/.pam_environment`` made by a task are reflected
1641 in the runtime environment of subsequent tasks. See
1642 :ref:`ansible_process_env` for a complete description.
1643
1644 * :gh:issue:`343`: the sudo ``--login``
1645 option is supported.
1646
1647 * :gh:issue:`344`: connections no longer
1648 fail when the controller's login username contains slashes.
1649
1650 * :gh:issue:`345`: the ``IdentitiesOnly
1651 yes`` option is no longer supplied to OpenSSH by default, better matching
1652 Ansible's behaviour.
1653
1654 * :gh:issue:`355`: tasks configured to run
1655 in an isolated forked subprocess were forked from the wrong parent context.
1656 This meant built-in modules overridden via a custom ``module_utils`` search
1657 path may not have had any effect.
1658
1659 * :gh:issue:`362`: to work around a slow
1660 algorithm in the :mod:`subprocess` module, the maximum number of open files
1661 in processes running on the target is capped to 512, reducing the work
1662 required to start a subprocess by >2000x in default CentOS configurations.
1663
1664 * :gh:issue:`397`: recent Mitogen master
1665 versions could fail to clean up temporary directories in a number of
1666 circumstances, and newer Ansibles moved to using :mod:`atexit` to effect
1667 temporary directory cleanup in some circumstances.
1668
1669 * :gh:commit:`b9112a9c`,
1670 :gh:commit:`2c287801`: OpenSSH 7.5
1671 permission denied prompts are now recognized. Contributed by Alex Willmer.
1672
1673 * A missing check caused an exception traceback to appear when using the
1674 ``ansible`` command-line tool with a missing or misspelled module name.
1675
1676 * Ansible since >=2.7 began importing :mod:`__main__` from
1677 :mod:`ansible.module_utils.basic`, causing an error during execution, due to
1678 the controller being configured to refuse network imports outside the
1679 ``ansible.*`` namespace. Update the target implementation to construct a stub
1680 :mod:`__main__` module to satisfy the otherwise seemingly vestigial import.
1681
1682
1683 Core Library
1684 ~~~~~~~~~~~~
1685
1686 * A new :class:`mitogen.parent.CallChain` class abstracts safe pipelining of
1687 related function calls to a target context, cancelling the chain if an
1688 exception occurs.
1689
1690 * :gh:issue:`305`: fix a long-standing minor
1691 race relating to the logging framework, where *no route for Message..*
1692 would frequently appear during startup.
1693
1694 * :gh:issue:`313`:
1695 :meth:`mitogen.parent.Context.call` was documented as capable of accepting
1696 static methods. While possible on Python 2.x the result is ugly, and in every
1697 case it should be trivial to replace with a classmethod. The documentation
1698 was fixed.
1699
1700 * :gh:issue:`337`: to avoid a scaling
1701 limitation, a PTY is no longer allocated for each OpenSSH client if it can be
1702 avoided. PTYs are only allocated if a password is supplied, or when
1703 `host_key_checking=accept`. This is since Linux has a default of 4096 PTYs
1704 (``kernel.pty.max``), while OS X has a default of 127 and an absolute maximum
1705 of 999 (``kern.tty.ptmx_max``).
1706
1707 * :gh:issue:`339`: the LXD connection method
1708 was erroneously executing LXC Classic commands.
1709
1710 * :gh:issue:`345`: the SSH connection method
1711 allows optionally disabling ``IdentitiesOnly yes``.
1712
1713 * :gh:issue:`356`: if the master Python
1714 process does not have :data:`sys.executable` set, the default Python
1715 interpreter used for new children on the local machine defaults to
1716 ``"/usr/bin/python"``.
1717
1718 * :gh:issue:`366`,
1719 :gh:issue:`380`: attempts by children to
1720 import :mod:`__main__` where the main program module lacks an execution guard
1721 are refused, and an error is logged. This prevents a common and highly
1722 confusing error when prototyping new scripts.
1723
1724 * :gh:pull:`371`: the LXC connection method
1725 uses a more compatible method to establish an non-interactive session.
1726 Contributed by Brian Candler.
1727
1728 * :gh:commit:`af2ded66`: add
1729 :func:`mitogen.fork.on_fork` to allow non-Mitogen managed process forks to
1730 clean up Mitogen resources in the child.
1731
1732 * :gh:commit:`d6784242`: the setns method
1733 always resets ``HOME``, ``SHELL``, ``LOGNAME`` and ``USER`` environment
1734 variables to an account in the target container, defaulting to ``root``.
1735
1736 * :gh:commit:`830966bf`: the UNIX
1737 listener no longer crashes if the peer process disappears in the middle of
1738 connection setup.
1739
1740
1741 Thanks!
1742 ~~~~~~~
1743
1744 Mitogen would not be possible without the support of users. A huge thanks for
1745 bug reports, testing, features and fixes in this release contributed by
1746 `Alex Russu <https://github.com/alexrussu>`_,
1747 `Alex Willmer <https://github.com/moreati>`_,
1748 `atoom <https://github.com/atoom>`_,
1749 `Berend De Schouwer <https://github.com/berenddeschouwer>`_,
1750 `Brian Candler <https://github.com/candlerb>`_,
1751 `Dan Quackenbush <https://github.com/danquack>`_,
1752 `dsgnr <https://github.com/dsgnr>`_,
1753 `Jesse London <https://github.com/jesteria>`_,
1754 `John McGrath <https://github.com/jmcgrath207>`_,
1755 `Jonathan Rosser <https://github.com/jrosser>`_,
1756 `Josh Smift <https://github.com/jbscare>`_,
1757 `Luca Nunzi <https://github.com/0xlc>`_,
1758 `Orion Poplawski <https://github.com/opoplawski>`_,
1759 `Peter V. Saveliev <https://github.com/svinota/>`_,
1760 `Pierre-Henry Muller <https://github.com/pierrehenrymuller>`_,
1761 `Pierre-Louis Bonicoli <https://github.com/jesteria>`_,
1762 `Prateek Jain <https://github.com/prateekj201>`_,
1763 `RedheatWei <https://github.com/RedheatWei>`_,
1764 `Rick Box <https://github.com/boxrick>`_,
1765 `nikitakazantsev12 <https://github.com/nikitakazantsev12>`_,
1766 `Tawana Musewe <https://github.com/tbtmuse>`_,
1767 `Timo Beckers <https://github.com/ti-mo>`_, and
1768 `Yannig Perré <https://github.com/yannig>`_.
1769
1770
1771 v0.2.2 (2018-07-26)
1772 -------------------
1773
1774 Mitogen for Ansible
1775 ~~~~~~~~~~~~~~~~~~~
1776
1777 * :gh:issue:`291`: ``ansible_*_interpreter``
1778 variables are parsed using a restrictive shell-like syntax, supporting a
1779 common idiom where ``ansible_python_interpreter`` is set to ``/usr/bin/env
1780 python``.
1781
1782 * :gh:issue:`299`: fix the ``network_cli``
1783 connection type when the Mitogen strategy is active. Mitogen cannot help
1784 network device connections, however it should still be possible to use device
1785 connections while Mitogen is active.
1786
1787 * :gh:pull:`301`: variables like ``$HOME`` in
1788 the ``remote_tmp`` setting are evaluated correctly.
1789
1790 * :gh:pull:`303`: the :ref:`doas` become method
1791 is supported. Contributed by `Mike Walker
1792 <https://github.com/napkindrawing>`_.
1793
1794 * :gh:issue:`309`: fix a regression to
1795 process environment cleanup, caused by the change in v0.2.1 to run local
1796 tasks with the correct environment.
1797
1798 * :gh:issue:`317`: respect the verbosity
1799 setting when writing to Ansible's ``log_path``, if it is enabled. Child log
1800 filtering was also incorrect, causing the master to needlessly wake many
1801 times. This nets a 3.5% runtime improvement running against the local
1802 machine.
1803
1804 * The ``mitogen_ssh_debug_level`` variable is supported, permitting SSH debug
1805 output to be included in Mitogen's ``-vvv`` output when both are specified.
1806
1807
1808 Core Library
1809 ~~~~~~~~~~~~
1810
1811 * :gh:issue:`291`: the ``python_path``
1812 parameter may specify an argument vector prefix rather than a string program
1813 path.
1814
1815 * :gh:issue:`300`: the broker could crash on OS X during shutdown due to
1816 scheduled :freebsd:man2:`kqueue` filter changes for
1817 descriptors that were closed before the IO loop resumes. As a temporary
1818 workaround, kqueue's bulk change feature is not used.
1819
1820 * :gh:pull:`303`: the :ref:`doas` become method
1821 is now supported. Contributed by `Mike Walker
1822 <https://github.com/napkindrawing>`_.
1823
1824 * :gh:issue:`307`: SSH login banner output
1825 containing the word 'password' is no longer confused for a password prompt.
1826
1827 * :gh:issue:`319`: SSH connections would
1828 fail immediately on Windows Subsystem for Linux, due to use of `TCSAFLUSH`
1829 with :func:`termios.tcsetattr`. The flag is omitted if WSL is detected.
1830
1831 * :gh:issue:`320`: The OS X poller
1832 could spuriously wake up due to ignoring an error bit set on events returned
1833 by the kernel, manifesting as a failure to read from an unrelated descriptor.
1834
1835 * :gh:issue:`342`: The ``network_cli``
1836 connection type would fail due to a missing internal SSH plugin method.
1837
1838 * Standard IO forwarding accidentally configured the replacement ``stdout`` and
1839 ``stderr`` write descriptors as non-blocking, causing subprocesses that
1840 generate more output than kernel buffer space existed to throw errors. The
1841 write ends are now configured as blocking.
1842
1843 * When :func:`mitogen.core.enable_profiling` is active, :mod:`mitogen.service`
1844 threads are profiled just like other threads.
1845
1846 * The ``ssh_debug_level`` parameter is supported, permitting SSH debug output
1847 to be redirected to a Mitogen logger when specified.
1848
1849 * Debug logs containing command lines are printed with the minimal quoting and
1850 escaping required.
1851
1852
1853 Thanks!
1854 ~~~~~~~
1855
1856 Mitogen would not be possible without the support of users. A huge thanks for
1857 the bug reports and pull requests in this release contributed by
1858 `Alex Russu <https://github.com/alexrussu>`_,
1859 `Andy Freeland <https://github.com/rouge8>`_,
1860 `Ayaz Ahmed Khan <https://github.com/ayaz>`_,
1861 `Colin McCarthy <https://github.com/colin-mccarthy>`_,
1862 `Dan Quackenbush <https://github.com/danquack>`_,
1863 `Duane Zamrok <https://github.com/dewthefifth>`_,
1864 `Gonzalo Servat <https://github.com/gservat>`_,
1865 `Guy Knights <https://github.com/knightsg>`_,
1866 `Josh Smift <https://github.com/jbscare>`_,
1867 `Mark Janssen <https://github.com/sigio>`_,
1868 `Mike Walker <https://github.com/napkindrawing>`_,
1869 `Orion Poplawski <https://github.com/opoplawski>`_,
1870 `falbanese <https://github.com/falbanese>`_,
1871 `Tawana Musewe <https://github.com/tbtmuse>`_, and
1872 `Zach Swanson <https://github.com/zswanson>`_.
1873
1874
1875 v0.2.1 (2018-07-10)
1876 -------------------
1877
1878 Mitogen for Ansible
1879 ~~~~~~~~~~~~~~~~~~~
1880
1881 * :gh:issue:`297`: compatibility: local
1882 actions set their working directory to that of their defining playbook, and
1883 inherit a process environment as if they were executed as a subprocess of the
1884 forked task worker.
1885
1886
1887 v0.2.0 (2018-07-09)
1888 -------------------
1889
1890 Mitogen 0.2.x is the inaugural feature-frozen branch eligible for fixes only,
1891 except for problem areas listed as in-scope below. While stable from a
1892 development perspective, it should still be considered "beta" at least for the
1893 initial releases.
1894
1895 **In Scope**
1896
1897 * Python 3.x performance improvements
1898 * Subprocess reaping improvements
1899 * Major documentation improvements
1900 * PyPI/packaging improvements
1901 * Test suite improvements
1902 * Replacement CI system to handle every supported OS
1903 * Minor deviations from vanilla Ansible behaviour
1904 * Ansible ``raw`` action support
1905
1906 The goal is a *tick/tock* model where even-numbered series are a maturation of
1907 the previous unstable series, and unstable series are released on PyPI with
1908 ``--pre`` enabled. The API and user visible behaviour should remain unchanged
1909 within a stable series.
1910
1911
1912 Mitogen for Ansible
1913 ~~~~~~~~~~~~~~~~~~~
1914
1915 * Support for Ansible 2.3 - 2.7.x and any mixture of Python 2.6, 2.7 or 3.6 on
1916 controller and target nodes.
1917
1918 * Drop-in support for many Ansible connection types.
1919
1920 * Preview of Connection Delegation feature.
1921
1922 * Built-in file transfer compatible with connection delegation.
1923
1924
1925 Core Library
1926 ~~~~~~~~~~~~
1927
1928 * Synchronous connection establishment via OpenSSH, sudo, su, Docker, LXC and
1929 FreeBSD Jails, local subprocesses and :func:`os.fork`. Parallel connection
1930 setup is possible using multiple threads. Connections may be used from one or
1931 many threads after establishment.
1932
1933 * UNIX masters and children, with Linux, MacOS, FreeBSD, NetBSD, OpenBSD and
1934 Windows Subsystem for Linux explicitly supported.
1935
1936 * Automatic tests covering Python 2.6, 2.7 and 3.6 on Linux only.