Extend user agent with aws-gate version information (#245)

Author: xen0l

aws_gate/utils.py

@@ -8,6 +8,7 @@
 import boto3
 import botocore
 
+from aws_gate import __version__
 from aws_gate.constants import DEFAULT_GATE_BIN_PATH, PLUGIN_NAME
 from aws_gate.exceptions import AWSConnectionError
 
@@ -55,6 +56,10 @@ def _create_aws_session(region_name=None, profile_name=None):
 
     session = boto3.session.Session(**kwargs)
 
+    # Add aws-gate version to the client user-agent
+    # pylint: disable=protected-access
+    session._session.user_agent_extra += " " + "aws-gate/{}".format(__version__)
+
     return session
 
 

tests/unit/test_utils.py

@@ -7,6 +7,7 @@
 from hypothesis import given
 from hypothesis.strategies import lists, text
 
+from aws_gate import __version__
 from aws_gate.exceptions import AWSConnectionError
 from aws_gate.utils import (
     is_existing_profile,
@@ -50,6 +51,13 @@ def test_create_aws_session(mocker):
     assert session_mock.Session.call_args == mocker.call(region_name="eu-west-1")
 
 
+def test_create_aws_session_user_agent():
+    session = _create_aws_session(region_name="eu-west-1")
+
+    # pylint: disable=protected-access
+    assert "aws-gate/{}".format(__version__) in session._session.user_agent()
+
+
 def test_create_aws_session_with_profile(mocker):
     session_mock = mocker.patch(
         "aws_gate.utils.boto3.session", return_value=mocker.MagicMock()