Skip to content

Commit

Permalink
Misc/update newsfrag for the app stop logic refactor (#1143)
Browse files Browse the repository at this point in the history
  • Loading branch information
zhenyu-ms authored Oct 29, 2024
1 parent cf9034b commit f90ae3b
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion doc/newsfragments/3041_changed.app_stop.rst
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Refactor the stop logic of :py:class:`App <~testplan.testing.multitest.driver.app.App>` driver for faster environment shutdown. Rename parameter ``sigint_timeout`` to ``stop_timeout``. Add a new parameter ``stop_signal`` for custom stop signals, its default value ``None`` invokes ``terminate`` method on subprocess during stop.
Refactor the stop logic of :py:class:`App <~testplan.testing.multitest.driver.app.App>` driver for faster environment shutdown. Rename parameter ``sigint_timeout`` to ``stop_timeout``. Add a new parameter ``stop_signal`` for custom stop signals, its default value ``None`` invokes ``terminate`` method to stop subprocess, i.e. sending ``SIGTERM`` signal to subprocess on Linux.
**Environment will fail to stop if subprocess doesn't terminate within the default 5-second** ``stop_timeout`` **for graceful shutdown**. Increase ``stop_timeout`` or change ``stop_signal`` (to maybe ``SIGKILL`` on Linux) could resolve this issue.

0 comments on commit f90ae3b

Please sign in to comment.