Merge branch 'main' into feature/custom-log-formatting

Author: smghasempour

.github/workflows/main.yml

@@ -8,11 +8,14 @@ env:
             pip --no-cache-dir"
 
 jobs:
-  tests_py27:
-    runs-on: ubuntu-20.04
-    container: python:2.7
+  tests_py2x:
+    runs-on: ubuntu-22.04
+    container:
+      image: python:2.7
     strategy:
       fail-fast: false
+      matrix:
+        toxenv: [py27, py27-configparser]
 
     steps:
     - uses: actions/checkout@v4
@@ -21,56 +24,66 @@ jobs:
       run: $PIP install virtualenv tox
 
     - name: Run the unit tests
-      run: TOXENV=py27 tox
+      run: TOXENV=${{ matrix.toxenv }} tox
 
     - name: Run the end-to-end tests
-      run: TOXENV=py27 END_TO_END=1 tox
+      run: TOXENV=${{ matrix.toxenv }} END_TO_END=1 tox
 
   tests_py34:
-    runs-on: ubuntu-20.04
-    strategy:
-      fail-fast: false
+    runs-on: ubuntu-22.04
+    container:
+      image: ubuntu:20.04
+      env:
+        LANG: C.UTF-8
 
     steps:
     - uses: actions/checkout@v4
 
-    - name: Build OpenSSL 1.0.2 (required by Python 3.4)
+    - name: Install build dependencies
       run: |
-        sudo apt-get install build-essential zlib1g-dev 
+        apt-get update
+        apt-get install -y build-essential unzip wget \
+                           libncurses5-dev libgdbm-dev libnss3-dev \
+                           libreadline-dev zlib1g-dev
 
+    - name: Build OpenSSL 1.0.2 (required by Python 3.4)
+      run: |
         cd $RUNNER_TEMP
         wget https://github.com/openssl/openssl/releases/download/OpenSSL_1_0_2u/openssl-1.0.2u.tar.gz
         tar -xf openssl-1.0.2u.tar.gz
         cd openssl-1.0.2u
         ./config --prefix=/usr/local/ssl --openssldir=/usr/local/ssl shared zlib-dynamic
         make
-        sudo make install
+        make install
 
-        echo CFLAGS="-I/usr/local/ssl/include $CFLAGS" >> $GITHUB_ENV 
+        echo CFLAGS="-I/usr/local/ssl/include $CFLAGS" >> $GITHUB_ENV
         echo LDFLAGS="-L/usr/local/ssl/lib $LDFLAGS" >> $GITHUB_ENV
         echo LD_LIBRARY_PATH="/usr/local/ssl/lib:$LD_LIBRARY_PATH" >> $GITHUB_ENV
 
-        sudo ln -s /usr/local/ssl/lib/libssl.so.1.0.0 /usr/lib/libssl.so.1.0.0
-        sudo ln -s /usr/local/ssl/lib/libcrypto.so.1.0.0 /usr/lib/libcrypto.so.1.0.0
-        sudo ldconfig
+        ln -s /usr/local/ssl/lib/libssl.so.1.0.0 /usr/lib/libssl.so.1.0.0
+        ln -s /usr/local/ssl/lib/libcrypto.so.1.0.0 /usr/lib/libcrypto.so.1.0.0
+        ldconfig
 
     - name: Build Python 3.4
       run: |
-        sudo apt-get install build-essential libncurses5-dev libgdbm-dev libnss3-dev libreadline-dev zlib1g-dev 
-
         cd $RUNNER_TEMP
         wget -O cpython-3.4.10.zip https://github.com/python/cpython/archive/refs/tags/v3.4.10.zip
         unzip cpython-3.4.10.zip
         cd cpython-3.4.10
-        ./configure
+        ./configure --with-ensurepip=install
         make
-        sudo make install
+        make install
 
         python3.4 --version
         python3.4 -c 'import ssl'
+        pip3.4 --version
 
-    - name: Install dependencies
-      run: $PIP install virtualenv==20.4.7 tox==3.28.0
+        ln -s /usr/local/bin/python3.4 /usr/local/bin/python
+        ln -s /usr/local/bin/pip3.4 /usr/local/bin/pip
+
+    - name: Install Python dependencies
+      run: |
+        $PIP install virtualenv==20.4.7 tox==3.14.0
 
     - name: Run the unit tests
       run: TOXENV=py34 tox
@@ -79,40 +92,49 @@ jobs:
       run: TOXENV=py34 END_TO_END=1 tox
 
   tests_py35:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
+    container:
+      image: python:3.5
     strategy:
       fail-fast: false
 
     steps:
     - uses: actions/checkout@v4
 
-    - name: Work around pip SSL cert verify error
-      run: sudo $PIP config set global.trusted-host 'pypi.python.org pypi.org files.pythonhosted.org'
+    - name: Install dependencies
+      run: $PIP install virtualenv tox
 
-    - name: Set up Python 3.5
-      uses: actions/setup-python@v5
-      with:
-        python-version: 3.5
+    - name: Run the unit tests
+      run: TOXENV=py35 tox
+
+    - name: Run the end-to-end tests
+      run: TOXENV=py35 END_TO_END=1 tox
+
+  tests_py36:
+    runs-on: ubuntu-22.04
+    container:
+      image: python:3.6
+    strategy:
+      fail-fast: false
+
+    steps:
+    - uses: actions/checkout@v4
 
     - name: Install dependencies
       run: $PIP install virtualenv tox
 
-    - name: Set variable for TOXENV based on Python version
-      id: toxenv
-      run: python -c 'import sys; print("TOXENV=py%d%d" % (sys.version_info.major, sys.version_info.minor))' | tee -a $GITHUB_OUTPUT
-
     - name: Run the unit tests
-      run: TOXENV=${{steps.toxenv.outputs.TOXENV}} tox
+      run: TOXENV=py36 tox
 
     - name: Run the end-to-end tests
-      run: TOXENV=${{steps.toxenv.outputs.TOXENV}} END_TO_END=1 tox
+      run: TOXENV=py36 END_TO_END=1 tox
 
   tests_py3x:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9, "3.10", 3.11, 3.12, 3.13]
+        python-version: [3.7, 3.8, 3.9, "3.10", 3.11, 3.12, 3.13]
 
     steps:
     - uses: actions/checkout@v4
@@ -136,8 +158,9 @@ jobs:
       run: TOXENV=${{steps.toxenv.outputs.TOXENV}} END_TO_END=1 tox
 
   coverage_py27:
-    runs-on: ubuntu-20.04
-    container: python:2.7
+    runs-on: ubuntu-22.04
+    container:
+      image: python:2.7
     strategy:
       fail-fast: false
 
@@ -151,7 +174,7 @@ jobs:
       run: TOXENV=cover tox
 
   coverage_py3x:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
       matrix:
@@ -172,7 +195,7 @@ jobs:
       run: TOXENV=cover3 tox
 
   docs:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
 
     steps:
     - uses: actions/checkout@v4

CHANGES.rst

@@ -1,6 +1,29 @@
-4.3.0.dev0 (Next Release)
+4.4.0.dev0 (Next Release)
 -------------------------
 
+- Fixed a bug where the XML-RPC method ``supervisor.getAllConfigInfo()``
+  did not return the value of the ``autorestart`` program option.
+
+- Fixed a bug where an escaped percent sign (``%%``) could not be used
+  in ``environment=`` in the ``[supervisord]`` section of the config file.
+  The bug did not affect ``[program:x]`` sections, where an escaped
+  percent sign in ``environment=`` already worked.  Patch by yuk1pedia.
+
+- Parsing ``environment=`` in the config file now uses ``shlex`` in POSIX
+  mode instead of legacy mode to allow for escaped quotes in the values.
+  However, on Python 2 before 2.7.13 and Python 3 before 3.5.3, POSIX mode
+  can't be used because of a `bug <https://bugs.python.org/issue21999>`_
+  in ``shlex``.  If ``supervisord`` is run on a Python version with the bug,
+  it will fall back to legacy mode.  Patch by Stefan Friesel.
+
+- ``supervisorctl`` now reads extra files included via the ``[include]``
+  section in ``supervisord.conf`` like ``supervisord`` does.  This allows
+  the ``[supervisorctl]`` section or ``[ctlplugin:x]`` sections to be in
+  included files.  Patch by François Granade.
+
+4.3.0 (2025-08-23)
+------------------
+
 - Fixed a bug where the poller would not unregister a closed
   file descriptor under some circumstances, which caused excessive
   polling, resulting in higher CPU usage.  Patch by aftersnow.
@@ -16,10 +39,13 @@
 - On Python 3.8 and later, ``setuptools`` is no longer a runtime
   dependency.  Patch by Ofek Lev.
 
-- ``supervisorctl`` now reads extra files included via the ``[include]``
-  section in ``supervisord.conf`` like ``supervisord`` does.  This allows
-  the ``[supervisorctl]`` section or ``[ctlplugin:x]`` sections to be in
-  included files.  Patch by François Granade.
+- On Python versions before 3.8, ``setuptools`` is still a runtime
+  dependency (for ``pkg_resources``) but it is no longer declared in
+  ``setup.py`` as such.  This is because adding a conditional dependency
+  with an environment marker (``setuptools; python_version < '3.8'``)
+  breaks installation in some scenarios, e.g. ``setup.py install`` or
+  older versions of ``pip``.  Ensure that ``setuptools`` is installed
+  if using Python before 3.8.
 
 4.2.5 (2022-12-23)
 ------------------

docs/installing.rst

@@ -22,6 +22,12 @@ to be the root user to install Supervisor successfully using
 
 You can also install supervisor in a virtualenv via ``pip``.
 
+.. note::
+
+   If installing on a Python version before 3.8, first ensure that the
+   ``setuptools`` package is installed because it is a runtime
+   dependency of Supervisor.
+
 Internet-Installing Without Pip
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -39,6 +45,12 @@ finally install Supervisor itself.
    need to be the root user to successfully invoke ``python
    setup.py install``.
 
+.. note::
+
+   The ``setuptools`` package is required to run ``python setup.py install``.
+   On Python versions before 3.8, ``setuptools`` is also a runtime
+   dependency of Supervisor.
+
 Installing To A System Without Internet Access
 ----------------------------------------------
 
@@ -63,6 +75,12 @@ Finally, run supervisor's ``python setup.py install``.
    need to be the root user to invoke ``python setup.py install``
    successfully for each package.
 
+.. note::
+
+   The ``setuptools`` package is required to run ``python setup.py install``.
+   On Python versions before 3.8, ``setuptools`` is also a runtime
+   dependency of Supervisor.
+
 Installing a Distribution Package
 ---------------------------------
 

setup.py

@@ -22,17 +22,19 @@
 elif (3, 0) < py_version < (3, 4):
     raise RuntimeError('On Python 3, Supervisor requires Python 3.4 or later')
 
-# setuptools is required as a runtime dependency only on
-# Python < 3.8.  See the comments in supervisor/compat.py.
-requires = [
-    "setuptools; python_version < '3.8'",
-]
-
-tests_require = []
-testing_extras = tests_require + [
-    'pytest',
-    'pytest-cov',
-    ]
+# setuptools is required as a runtime dependency only on Python < 3.8.
+# See the comments in supervisor/compat.py.  An environment marker 
+# like "setuptools; python_version < '3.8'" is not used here because
+# it breaks installation via "python setup.py install".  See also the
+# discussion at: https://github.com/Supervisor/supervisor/issues/1692
+if py_version < (3, 8):
+    try:
+        import pkg_resources
+    except ImportError:
+        raise RuntimeError(
+            "On Python < 3.8, Supervisor requires setuptools as a runtime"
+            " dependency because pkg_resources is used to load plugins"
+            )
 
 from setuptools import setup, find_packages
 here = os.path.abspath(os.path.dirname(__file__))
@@ -92,14 +94,12 @@
     author="Chris McDonough",
     author_email="chrism@plope.com",
     packages=find_packages(),
-    install_requires=requires,
+    install_requires=[],
     extras_require={
-        'testing': testing_extras,
+        'test': ['pytest', 'pytest-cov']
     },
-    tests_require=tests_require,
     include_package_data=True,
     zip_safe=False,
-    test_suite="supervisor.tests",
     entry_points={
         'console_scripts': [
             'supervisord = supervisor.supervisord:main',

supervisor/compat.py

@@ -150,6 +150,26 @@ def is_text_stream(stream):
 except ImportError: # pragma: no cover
     from HTMLParser import HTMLParser
 
+# Begin check for working shlex posix mode
+
+# https://github.com/Supervisor/supervisor/issues/328
+# https://github.com/Supervisor/supervisor/issues/873
+# https://bugs.python.org/issue21999
+
+from shlex import shlex as _shlex
+
+_shlex_posix_expectations = {
+    'foo="",bar=a': ['foo', '=', '', ',', 'bar', '=', 'a'],
+    "'')abc":       ['', ')', 'abc']
+}
+
+shlex_posix_works = all(
+    list(_shlex(_input, posix=True)) == _expected
+    for _input, _expected in _shlex_posix_expectations.items()
+)
+
+# End check for working shlex posix mode
+
 # Begin importlib/setuptools compatibility code
 
 # Supervisor used pkg_resources (a part of setuptools) to load package

supervisor/datatypes.py

@@ -5,6 +5,7 @@
 import socket
 import shlex
 
+from supervisor.compat import shlex_posix_works
 from supervisor.compat import urlparse
 from supervisor.compat import long
 from supervisor.loggers import getLevelNumByDescription
@@ -68,7 +69,7 @@ def dict_of_key_value_pairs(arg):
     """ parse KEY=val,KEY2=val2 into {'KEY':'val', 'KEY2':'val2'}
         Quotes can be used to allow commas in the value
     """
-    lexer = shlex.shlex(str(arg))
+    lexer = shlex.shlex(str(arg), posix=shlex_posix_works)
     lexer.wordchars += '/.+-():'
 
     tokens = list(lexer)
@@ -81,7 +82,12 @@ def dict_of_key_value_pairs(arg):
         if len(k_eq_v) != 3 or k_eq_v[1] != '=':
             raise ValueError(
                 "Unexpected end of key/value pairs in value '%s'" % arg)
-        D[k_eq_v[0]] = k_eq_v[2].strip('\'"')
+
+        k, v = k_eq_v[0], k_eq_v[2]
+        if not shlex_posix_works:
+            v = v.strip('\'"')
+
+        D[k] = v
         i += 4
     return D