gluetool 3.3__tar.gz → 3.4__tar.gz

{gluetool-3.3 → gluetool-3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gluetool
-Version: 3.3
+Version: 3.4
 Summary: Python framework for constructing command-line pipelines.
 Home-page: https://gluetool.readthedocs.org/
 License: BSD

{gluetool-3.3 → gluetool-3.4}/gluetool/glue.py

@@ -1788,6 +1788,15 @@ class Glue(Configurable):
                 'action': 'store_true',
                 'default': False
             },
+            'sigterm-timeout': {
+                'help': """
+                        Time, in seconds, to wait for a child process to exit after sending it ``SIGTERM``,
+                        before resorting to ``SIGKILL``. Takes precedence over the ``GLUETOOL_SIGTERM_TIMEOUT``
+                        environment variable (Default: 60).
+                        """,
+                'type': int,
+                'default': None
+            },
         }),
         ('Output control', {
             ('c', 'colors'): {
@@ -2510,6 +2519,7 @@ class Glue(Configurable):
         * GLUETOOL_TRACING_SERVICE_NAME (string) - name of the trace produced by tool execution
         * GLUETOOL_TRACING_REPORTING_HOST (string) - a hostname where tracing collector listens
         * GLUETOOL_TRACING_REPORTING_PORT (int) - a port on which tracing collector listens
+        * GLUETOOL_SIGTERM_TIMEOUT (int) - seconds to wait for a child to exit after SIGTERM before SIGKILL
         """).format(module_dirs, data_dirs, module_config_dirs)
 
         self._parse_args(args,

{gluetool-3.3 → gluetool-3.4}/gluetool/tests/test_tool.py

@@ -175,3 +175,69 @@ def test_signal(monkeypatch, log, tested_signal, exception, terminate_process_tr
     assert log.match(levelno=logging.WARNING, message=warnmsg)
     assert log.match(levelno=logging.DEBUG, message='Exiting with status 0')
     assert log.match(levelno=logging.INFO, message='gluetool some-version')
+
+
+def test_sigterm_timeout_default(monkeypatch):
+    monkeypatch.delenv(gluetool.tool.SIGTERM_TIMEOUT_ENVVAR, raising=False)
+
+    assert gluetool.tool.sigterm_timeout() == gluetool.tool.DEFAULT_SIGTERM_TIMEOUT
+
+
+@pytest.mark.parametrize('value,expected', [
+    ('0', 0),
+    ('1', 1),
+    ('120', 120),
+], ids=['zero', 'one', 'custom'])
+def test_sigterm_timeout_envvar(monkeypatch, value, expected):
+    monkeypatch.setenv(gluetool.tool.SIGTERM_TIMEOUT_ENVVAR, value)
+
+    assert gluetool.tool.sigterm_timeout() == expected
+
+
+def test_sigterm_timeout_envvar_invalid(monkeypatch):
+    monkeypatch.setenv(gluetool.tool.SIGTERM_TIMEOUT_ENVVAR, 'not-a-number')
+
+    with pytest.raises(ValueError):
+        gluetool.tool.sigterm_timeout()
+
+
+def test_sigterm_timeout_option_overrides_envvar(monkeypatch):
+    # The `sigterm-timeout` option (command line or configuration file) takes precedence over the env variable.
+    monkeypatch.setenv(gluetool.tool.SIGTERM_TIMEOUT_ENVVAR, '30')
+
+    glue = MagicMock()
+    glue.option = MagicMock(return_value=90)
+
+    assert gluetool.tool.sigterm_timeout(glue) == 90
+    glue.option.assert_called_once_with('sigterm-timeout')
+
+
+def test_sigterm_timeout_option_unset_falls_back_to_envvar(monkeypatch):
+    # When the option is not set, the env variable is used.
+    monkeypatch.setenv(gluetool.tool.SIGTERM_TIMEOUT_ENVVAR, '30')
+
+    glue = MagicMock()
+    glue.option = MagicMock(return_value=None)
+
+    assert gluetool.tool.sigterm_timeout(glue) == 30
+
+
+def test_sigterm_timeout_option_unset_falls_back_to_default(monkeypatch):
+    # When neither the option nor the env variable is set, the default is used.
+    monkeypatch.delenv(gluetool.tool.SIGTERM_TIMEOUT_ENVVAR, raising=False)
+
+    glue = MagicMock()
+    glue.option = MagicMock(return_value=None)
+
+    assert gluetool.tool.sigterm_timeout(glue) == gluetool.tool.DEFAULT_SIGTERM_TIMEOUT
+
+
+def test_sigterm_timeout_option_from_cmdline(monkeypatch):
+    # The `sigterm-timeout` option is wired into the command-line parser and parsed as an integer.
+    monkeypatch.delenv(gluetool.tool.SIGTERM_TIMEOUT_ENVVAR, raising=False)
+
+    glue = NonLoadingGlue()
+    glue._parse_args(['--sigterm-timeout', '120'])
+
+    assert glue.option('sigterm-timeout') == 120
+    assert gluetool.tool.sigterm_timeout(glue) == 120

{gluetool-3.3 → gluetool-3.4}/gluetool/tool.py

@@ -44,6 +44,36 @@ DEFAULT_GLUETOOL_CONFIG_PATHS = [
 
 DEFAULT_SIGTERM_TIMEOUT = 60
 
+# Environment variable overriding the time (in seconds) ``gluetool`` waits for a child process to exit after
+# sending it ``SIGTERM`` before resorting to ``SIGKILL``.
+SIGTERM_TIMEOUT_ENVVAR = 'GLUETOOL_SIGTERM_TIMEOUT'
+
+
+def sigterm_timeout(glue: Optional['gluetool.glue.Glue'] = None) -> int:
+    """
+    Return the time, in seconds, ``gluetool`` waits for a child process to exit after sending it ``SIGTERM``
+    before resorting to ``SIGKILL``.
+
+    The value is resolved with the following precedence:
+
+    1. the ``sigterm-timeout`` option (set on the command line or in a configuration file),
+    2. the :py:data:`SIGTERM_TIMEOUT_ENVVAR` environment variable,
+    3. :py:data:`DEFAULT_SIGTERM_TIMEOUT`.
+
+    :param glue: ``Glue`` instance to read the ``sigterm-timeout`` option from. When not provided, the option
+        is skipped and the value is resolved from the environment variable or the default.
+    """
+
+    if glue is not None:
+        option = glue.option('sigterm-timeout')
+        if option is not None:
+            return cast(int, option)
+
+    if SIGTERM_TIMEOUT_ENVVAR in os.environ:
+        return int(os.environ[SIGTERM_TIMEOUT_ENVVAR])
+
+    return DEFAULT_SIGTERM_TIMEOUT
+
 
 def handle_exc(func: Callable[..., Any]) -> Callable[..., Any]:
 
@@ -305,7 +335,7 @@ Will try to submit it to Sentry but giving up on everything else.
             child.terminate()
 
             try:
-                child.wait(timeout=DEFAULT_SIGTERM_TIMEOUT)
+                child.wait(timeout=sigterm_timeout(Glue))
 
             except psutil.TimeoutExpired:
                 Glue.warn("Sending SIGKILL to child process '{}' (PID {})".format(child.name(), child.pid))

{gluetool-3.3 → gluetool-3.4}/pyproject.toml

@@ -4,7 +4,7 @@ dynamic = ["version"]
 
 [tool.poetry]
 name = "gluetool"
-version = "3.3"
+version = "3.4"
 description = "Python framework for constructing command-line pipelines."
 authors = [
   "Milos Prchlik <mprchlik@redhat.com>",
@@ -108,7 +108,7 @@ opentelemetry-sdk = "^1.40.0"
 opentelemetry-exporter-otlp-proto-grpc = "^1.40.0"
 
 [tool.poetry-dynamic-versioning]
-enable = true
+enable = false
 
 [build-system]
 requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning>=1.0.0,<2.0.0"]