Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Resource Manager: Add 'client_info' support to client / connection. #7870

Merged
merged 3 commits into from
May 8, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions resource_manager/google/cloud/resource_manager/_http.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,22 @@
from google.cloud.resource_manager import __version__


_CLIENT_INFO = _http.CLIENT_INFO_TEMPLATE.format(__version__)


class Connection(_http.JSONConnection):
"""A connection to Google Cloud Resource Manager via the JSON REST API.

:type client: :class:`~google.cloud.resource_manager.client.Client`
:param client: The client that owns the current connection.

:type client_info: :class:`~google.api_core.client_info.ClientInfo`
:param client_info: (Optional) instance used to generate user agent.
"""

def __init__(self, client, client_info=None):
super(Connection, self).__init__(client, client_info)

self._client_info.gapic_version = __version__
self._client_info.client_library_version = __version__

API_BASE_URL = "https://cloudresourcemanager.googleapis.com"
"""The base of the API call URL."""

Expand All @@ -38,5 +44,3 @@ class Connection(_http.JSONConnection):

API_URL_TEMPLATE = "{api_base_url}/{api_version}{path}"
"""A template for the URL of a particular API call."""

_EXTRA_HEADERS = {_http.CLIENT_INFO_HEADER: _CLIENT_INFO}
11 changes: 9 additions & 2 deletions resource_manager/google/cloud/resource_manager/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,21 @@ class Client(BaseClient):
``credentials`` for the current object.
This parameter should be considered private, and could
change in the future.

:type client_info: :class:`~google.api_core.client_info.ClientInfo`
:param client_info:
The client info used to send a user-agent string along with API
requests. If ``None``, then default info will be used. Generally,
you only need to set this if you're developing your own library
or partner tool.
"""

SCOPE = ("https://www.googleapis.com/auth/cloud-platform",)
"""The scopes required for authenticating as a Resouce Manager consumer."""

def __init__(self, credentials=None, _http=None):
def __init__(self, credentials=None, _http=None, client_info=None):
super(Client, self).__init__(credentials=credentials, _http=_http)
self._connection = Connection(self)
self._connection = Connection(self, client_info=client_info)

def new_project(self, project_id, name=None, labels=None):
"""Create a project bound to the current client.
Expand Down
6 changes: 2 additions & 4 deletions resource_manager/tests/unit/test__http.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,7 @@ def test_build_api_url_w_extra_query_params(self):

def test_extra_headers(self):
import requests

from google.cloud import _http as base_http
from google.cloud.resource_manager import _http as MUT

http = mock.create_autospec(requests.Session, instance=True)
response = requests.Response()
Expand All @@ -65,8 +63,8 @@ def test_extra_headers(self):

expected_headers = {
"Accept-Encoding": "gzip",
base_http.CLIENT_INFO_HEADER: MUT._CLIENT_INFO,
"User-Agent": conn.USER_AGENT,
base_http.CLIENT_INFO_HEADER: conn.user_agent,
"User-Agent": conn.user_agent,
}
expected_uri = conn.build_api_url("/rainbow")
http.request.assert_called_once_with(
Expand Down
19 changes: 18 additions & 1 deletion resource_manager/tests/unit/test_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ def _get_target_class():
def _make_one(self, *args, **kw):
return self._get_target_class()(*args, **kw)

def test_constructor(self):
def test_ctor_wo_client_info(self):
from google.cloud._http import ClientInfo
from google.cloud.resource_manager._http import Connection

http = object()
Expand All @@ -42,6 +43,22 @@ def test_constructor(self):
self.assertIsInstance(client._connection, Connection)
self.assertIs(client._credentials, credentials)
self.assertIs(client._http_internal, http)
self.assertIsInstance(client._connection._client_info, ClientInfo)

def test_ctor_w_client_info(self):
from google.cloud._http import ClientInfo
from google.cloud.resource_manager._http import Connection

http = object()
client_info = ClientInfo()
credentials = _make_credentials()
client = self._make_one(
credentials=credentials, _http=http, client_info=client_info
)
self.assertIsInstance(client._connection, Connection)
self.assertIs(client._credentials, credentials)
self.assertIs(client._http_internal, http)
self.assertIs(client._connection._client_info, client_info)

def test_new_project_factory(self):
from google.cloud.resource_manager.project import Project
Expand Down