TCP Keep-Alive Environment Variable Support (boto#3579)

Author: adev-code

.changes/next-release/enhancement-config-81168.json

@@ -0,0 +1,5 @@
+{
+  "type": "enhancement",
+  "category": "config",
+  "description": "Add support for TCP Keep-Alive configuration via BOTOCORE_TCP_KEEPALIVE environment variable"
+}

botocore/args.py

@@ -556,13 +556,15 @@ def _resolve_endpoint(
     def _compute_socket_options(self, scoped_config, client_config=None):
         # This disables Nagle's algorithm and is the default socket options
         # in urllib3.
+
         socket_options = [(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)]
         client_keepalive = client_config and client_config.tcp_keepalive
-        scoped_keepalive = scoped_config and self._ensure_boolean(
-            scoped_config.get("tcp_keepalive", False)
-        )
-        # Enables TCP Keepalive if specified in client config object or shared config file.
-        if client_keepalive or scoped_keepalive:
+        if client_keepalive is None:
+            client_keepalive = self._config_store.get_config_variable(
+                'tcp_keepalive'
+            )
+
+        if client_keepalive:
             socket_options.append((socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1))
         return socket_options
 

botocore/configprovider.py

@@ -204,6 +204,12 @@
         None,
         None,
     ),
+    'tcp_keepalive': (
+        'tcp_keepalive',
+        'BOTOCORE_TCP_KEEPALIVE',
+        None,
+        utils.ensure_boolean,
+    ),
 }
 # A mapping for the s3 specific configuration vars. These are the configuration
 # vars that typically go in the s3 section of the config file. This mapping

tests/unit/test_args.py

@@ -240,42 +240,20 @@ def test_region_does_not_resolve_if_not_s3_and_endpoint_url_provided(self):
         )
         self.assertEqual(client_args['client_config'].region_name, None)
 
-    def test_tcp_keepalive_enabled_scoped_config(self):
-        scoped_config = {'tcp_keepalive': 'true'}
-        with mock.patch('botocore.args.EndpointCreator') as m:
-            self.call_get_client_args(scoped_config=scoped_config)
-            self.assert_create_endpoint_call(
-                m,
-                socket_options=self.default_socket_options
-                + [(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)],
-            )
-
     def test_tcp_keepalive_not_specified(self):
         with mock.patch('botocore.args.EndpointCreator') as m:
-            self.call_get_client_args(scoped_config={}, client_config=None)
+            self.call_get_client_args(client_config=None)
             self.assert_create_endpoint_call(
                 m, socket_options=self.default_socket_options
             )
-            self.call_get_client_args(
-                scoped_config=None, client_config=Config()
-            )
+            self.call_get_client_args(client_config=Config())
             self.assert_create_endpoint_call(
                 m, socket_options=self.default_socket_options
             )
 
     def test_tcp_keepalive_enabled_if_set_anywhere(self):
         with mock.patch('botocore.args.EndpointCreator') as m:
             self.call_get_client_args(
-                scoped_config={'tcp_keepalive': 'true'},
-                client_config=Config(tcp_keepalive=False),
-            )
-            self.assert_create_endpoint_call(
-                m,
-                socket_options=self.default_socket_options
-                + [(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)],
-            )
-            self.call_get_client_args(
-                scoped_config={'tcp_keepalive': 'false'},
                 client_config=Config(tcp_keepalive=True),
             )
             self.assert_create_endpoint_call(
@@ -284,18 +262,28 @@ def test_tcp_keepalive_enabled_if_set_anywhere(self):
                 + [(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)],
             )
 
+    def test_tcp_keepalive_enabled_environment_variable(self):
+        with mock.patch.dict('os.environ', {'BOTOCORE_TCP_KEEPALIVE': 'true'}):
+            with mock.patch('botocore.args.EndpointCreator') as m:
+                self.call_get_client_args()
+                self.assert_create_endpoint_call(
+                    m,
+                    socket_options=self.default_socket_options
+                    + [(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)],
+                )
+
     def test_tcp_keepalive_explicitly_disabled(self):
-        scoped_config = {'tcp_keepalive': 'false'}
+        self.config_store.set_config_variable('tcp_keepalive', False)
         with mock.patch('botocore.args.EndpointCreator') as m:
-            self.call_get_client_args(scoped_config=scoped_config)
+            self.call_get_client_args()
             self.assert_create_endpoint_call(
                 m, socket_options=self.default_socket_options
             )
 
     def test_tcp_keepalive_enabled_case_insensitive(self):
-        scoped_config = {'tcp_keepalive': 'True'}
+        self.config_store.set_config_variable('tcp_keepalive', 'True')
         with mock.patch('botocore.args.EndpointCreator') as m:
-            self.call_get_client_args(scoped_config=scoped_config)
+            self.call_get_client_args()
             self.assert_create_endpoint_call(
                 m,
                 socket_options=self.default_socket_options