Pass ssh-agent variables by default (#3572)

Author: daniilgankov

docs/changelog/3572.feature.rst

@@ -0,0 +1,2 @@
+Pass ssh-agent variables ``SSH_AGENT_PID`` and ``SSH_AUTH_SOCK`` in ``pass_env`` by default.
+- by :user:`daniilgankov`

docs/config.rst

@@ -552,6 +552,14 @@ Base options
             - ✅
             - ✅
             - ✅
+        *   - SSH_AGENT_PID
+            - ✅
+            - ✅
+            - ❌
+        *   - SSH_AUTH_SOCK
+            - ✅
+            - ✅
+            - ❌
 
    More environment variable-related information can be found in :ref:`environment variable substitutions`.
 

src/tox/tox_env/api.py

@@ -267,6 +267,8 @@ def _default_pass_env(self) -> list[str]:  # noqa: PLR6301
                     "TMPDIR",  # temporary file location
                     "NIX_LD",  # nix-ld loader
                     "NIX_LD_LIBRARY_PATH",  # nix-ld library path
+                    "SSH_AGENT_PID",  # ssh-agent process ID
+                    "SSH_AUTH_SOCK",  # ssh-agent socket path
                 ],
             )
         return env

tests/session/cmd/test_show_config.py

@@ -135,7 +135,9 @@ def test_pass_env_config_default(tox_project: ToxProjectCreator, stdout_is_atty:
         + (["PROGRAMDATA"] if is_win else [])
         + (["PROGRAMFILES"] if is_win else [])
         + (["PROGRAMFILES(x86)"] if is_win else [])
-        + ["PYTHON_GIL", "REQUESTS_CA_BUNDLE", "SSL_CERT_FILE"]
+        + ["PYTHON_GIL", "REQUESTS_CA_BUNDLE"]
+        + (["SSH_AGENT_PID", "SSH_AUTH_SOCK"] if not is_win else [])
+        + ["SSL_CERT_FILE"]
         + (["SYSTEMDRIVE", "SYSTEMROOT", "TEMP"] if is_win else [])
         + (["TERM"] if stdout_is_atty else [])
         + (["TMP", "USERPROFILE"] if is_win else ["TMPDIR"])