Merge pull request #526 from freyes/user-agent

Set user agent.
openstack-charmers · Jul 13, 2022 · 93a51a8 · 93a51a8
2 parents b393baa + c4df9bc
commit 93a51a8
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 6 deletions.
diff --git a/unit_tests/test_zaza_utilities_openstack_provider.py b/unit_tests/test_zaza_utilities_openstack_provider.py
@@ -103,10 +103,13 @@ def test_get_nova_session_client(self):
         session_mock = mock.MagicMock()
         self.patch_object(openstack_provider.novaclient_client, "Client")
         openstack_provider.get_nova_session_client(session_mock)
-        self.Client.assert_called_once_with(2, session=session_mock)
+        self.Client.assert_called_once_with(
+            2, session=session_mock, user_agent=openstack_provider.USER_AGENT)
         self.Client.reset_mock()
         openstack_provider.get_nova_session_client(session_mock, version=2.56)
-        self.Client.assert_called_once_with(2.56, session=session_mock)
+        self.Client.assert_called_once_with(
+            2.56, session=session_mock,
+            user_agent=openstack_provider.USER_AGENT)
 
     def test__resource_removed(self):
         resource_mock = mock.MagicMock()
@@ -185,7 +188,8 @@ def test_get_keystone_session(self):
             "OS_TENANT_NAME": "tenant",
         }
         openstack_provider.get_keystone_session(_openrc)
-        self.session.Session.assert_called_once_with(auth=_auth, verify=None)
+        self.session.Session.assert_called_once_with(
+            auth=_auth, verify=None, user_agent=openstack_provider.USER_AGENT)
 
     def test_get_keystone_session_tls(self):
         self.patch_object(openstack_provider, "session")
@@ -202,4 +206,5 @@ def test_get_keystone_session_tls(self):
         }
         openstack_provider.get_keystone_session(_openrc)
         self.session.Session.assert_called_once_with(
-            auth=_auth, verify=_cacert)
+            auth=_auth, verify=_cacert,
+            user_agent=openstack_provider.USER_AGENT)
diff --git a/zaza/utilities/openstack_provider.py b/zaza/utilities/openstack_provider.py
@@ -26,6 +26,9 @@
 from novaclient import client as novaclient_client
 
 
+USER_AGENT = 'zaza'
+
+
 class MissingOSAthenticationException(Exception):
     """Exception when some data needed to authenticate is missing."""
 
@@ -66,7 +69,8 @@ def get_keystone_session(openrc_creds, scope='PROJECT', verify=None):
         auth = v2.Password(**keystone_creds)
     else:
         auth = v3.Password(**keystone_creds)
-    return session.Session(auth=auth, verify=verify)
+    return session.Session(auth=auth, verify=verify,
+                           user_agent=USER_AGENT)
 
 
 def get_ks_creds(cloud_creds, scope='PROJECT'):
@@ -191,7 +195,8 @@ def get_nova_session_client(session, version=2):
     :returns: Authenticated novaclient
     :rtype: novaclient.Client object
     """
-    return novaclient_client.Client(version, session=session)
+    return novaclient_client.Client(version, session=session,
+                                    user_agent=USER_AGENT)
 
 
 # Manage resources