Skip to content

Core, BigQuery: refactor 'client_info' support. #7849

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.

Sign up for GitHub

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

Merged
tseaver merged 14 commits into from
May 7, 2019
Merged

Core, BigQuery: refactor 'client_info' support. #7849

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
73e497e
Add 'user_agent' and 'extra_headers' properties to 'Connection'.
tseaver May 2, 2019
dffc79b
Add 'client_info' parameter to 'Connection' ctor.
tseaver May 2, 2019
13aa677
Implement 'Connection.user_agent' via its '_client_info'.
tseaver May 2, 2019
cfed70b
Ensure 'X-Goog-API-Client' header is always passed.
tseaver May 2, 2019
7803503
Avoid relying on systest envvars in a unit test.
tseaver May 2, 2019
ce60f3a
Rely on base connection class for user_agent, extra_headers support.
tseaver May 2, 2019
551a76b
Lint.
tseaver May 2, 2019
e6dc855
Move 'X-Goog-API-Client' header generation out of 'extra_headers'.
tseaver May 3, 2019
0276af1
Add unit test showing that item assingment to 'extra_headers' propert…
tseaver May 3, 2019
dfa12fe
Document the 'client_info' parameter to 'bigquery._http.Connection'.
tseaver May 3, 2019
8597741
Create/use non-GAPIC-specific 'ClientInfo' class FBO HTTP/JSON clients.
tseaver May 3, 2019
08b316f
Avoid use of deprecated 'USER_AGENT' attr of connection.
tseaver May 3, 2019
5a7da2e
Fix class reference for client_info.
tseaver May 3, 2019
443a822
Document 'ClientInfo' classes.
tseaver May 7, 2019
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
Prev Previous commit
Next Next commit
Ensure 'X-Goog-API-Client' header is always passed.
  • Loading branch information
@tseaver
tseaver committed May 2, 2019
commit cfed70bdaa4b5a5cfd1811228a5eda5c87fa5013
4 changes: 3 additions & 1 deletion core/google/cloud/_http.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,9 @@ def extra_headers(self):
:rtype: dict
:returns: header keys / values
"""
return self._extra_headers or {}
result = self._extra_headers.copy() if self._extra_headers else {}
result[CLIENT_INFO_HEADER] = self.user_agent
return result

@extra_headers.setter
def extra_headers(self, value):
Expand Down
59 changes: 53 additions & 6 deletions core/tests/unit/test__http.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,15 @@ def test_user_agent_setter(self):
self.assertEqual(conn._client_info.user_agent, user_agent)

def test_extra_headers_all_caps_getter_deprecated(self):
from google.cloud._http import CLIENT_INFO_HEADER

client = object()
conn = self._make_one(client)
expected = conn._extra_headers = {"foo": "bar"}
conn._extra_headers = {"foo": "bar"}
expected = {
CLIENT_INFO_HEADER: conn._client_info.to_user_agent(),
"foo": "bar",
}

with mock.patch.object(warnings, "warn", autospec=True) as warn:
self.assertEqual(conn._EXTRA_HEADERS, expected)
Expand All @@ -95,12 +101,21 @@ def test_extra_headers_all_caps_setter_deprecated(self):
warn.assert_called_once_with(mock.ANY, DeprecationWarning, stacklevel=2)

def test_extra_headers_getter_default(self):
from google.cloud._http import CLIENT_INFO_HEADER

conn = self._make_one(object())
self.assertEqual(conn.extra_headers, {})
expected = {CLIENT_INFO_HEADER: conn._client_info.to_user_agent()}
self.assertEqual(conn.extra_headers, expected)

def test_extra_headers_getter_overridden(self):
from google.cloud._http import CLIENT_INFO_HEADER

conn = self._make_one(object())
expected = conn._extra_headers = {"foo": "bar"}
conn._extra_headers = {"foo": "bar"}
expected = {
CLIENT_INFO_HEADER: conn._client_info.to_user_agent(),
"foo": "bar",
}
self.assertEqual(conn.extra_headers, expected)

def test_extra_headers_setter(self):
Expand Down Expand Up @@ -192,6 +207,8 @@ def test_build_api_url_w_extra_query_params(self):
self.assertEqual(parms["qux"], ["quux", "corge"])

def test__make_request_no_data_no_content_type_no_headers(self):
from google.cloud._http import CLIENT_INFO_HEADER

http = make_requests_session([make_response()])
client = mock.Mock(_http=http, spec=["_http"])
conn = self._make_one(client)
Expand All @@ -202,12 +219,18 @@ def test__make_request_no_data_no_content_type_no_headers(self):
self.assertEqual(response.status_code, http_client.OK)
self.assertEqual(response.content, b"")

expected_headers = {"Accept-Encoding": "gzip", "User-Agent": conn.user_agent}
expected_headers = {
"Accept-Encoding": "gzip",
"User-Agent": conn.user_agent,
CLIENT_INFO_HEADER: conn.user_agent,
}
http.request.assert_called_once_with(
method="GET", url=url, headers=expected_headers, data=None
)

def test__make_request_w_data_no_extra_headers(self):
from google.cloud._http import CLIENT_INFO_HEADER

http = make_requests_session([make_response()])
client = mock.Mock(_http=http, spec=["_http"])
conn = self._make_one(client)
Expand All @@ -220,12 +243,15 @@ def test__make_request_w_data_no_extra_headers(self):
"Accept-Encoding": "gzip",
"Content-Type": "application/json",
"User-Agent": conn.user_agent,
CLIENT_INFO_HEADER: conn.user_agent,
}
http.request.assert_called_once_with(
method="GET", url=url, headers=expected_headers, data=data
)

def test__make_request_w_extra_headers(self):
from google.cloud._http import CLIENT_INFO_HEADER

http = make_requests_session([make_response()])
client = mock.Mock(_http=http, spec=["_http"])
conn = self._make_one(client)
Expand All @@ -237,12 +263,15 @@ def test__make_request_w_extra_headers(self):
"Accept-Encoding": "gzip",
"X-Foo": "foo",
"User-Agent": conn.user_agent,
CLIENT_INFO_HEADER: conn.user_agent,
}
http.request.assert_called_once_with(
method="GET", url=url, headers=expected_headers, data=None
)

def test_api_request_defaults(self):
from google.cloud._http import CLIENT_INFO_HEADER

http = make_requests_session(
[make_response(content=b"{}", headers=self.JSON_HEADERS)]
)
Expand All @@ -252,7 +281,11 @@ def test_api_request_defaults(self):

self.assertEqual(conn.api_request("GET", path), {})

expected_headers = {"Accept-Encoding": "gzip", "User-Agent": conn.user_agent}
expected_headers = {
"Accept-Encoding": "gzip",
"User-Agent": conn.user_agent,
CLIENT_INFO_HEADER: conn.user_agent,
}
expected_url = "{base}/mock/{version}{path}".format(
base=conn.API_BASE_URL, version=conn.API_VERSION, path=path
)
Expand Down Expand Up @@ -280,6 +313,7 @@ def test_api_request_wo_json_expected(self):
def test_api_request_w_query_params(self):
from six.moves.urllib.parse import parse_qs
from six.moves.urllib.parse import urlsplit
from google.cloud._http import CLIENT_INFO_HEADER

http = make_requests_session([self.EMPTY_JSON_RESPONSE])
client = mock.Mock(_http=http, spec=["_http"])
Expand All @@ -289,7 +323,11 @@ def test_api_request_w_query_params(self):

self.assertEqual(result, {})

expected_headers = {"Accept-Encoding": "gzip", "User-Agent": conn.user_agent}
expected_headers = {
"Accept-Encoding": "gzip",
"User-Agent": conn.user_agent,
CLIENT_INFO_HEADER: conn.user_agent,
}
http.request.assert_called_once_with(
method="GET", url=mock.ANY, headers=expected_headers, data=None
)
Expand All @@ -305,6 +343,8 @@ def test_api_request_w_query_params(self):
self.assertEqual(parms["baz"], ["qux", "quux"])

def test_api_request_w_headers(self):
from google.cloud._http import CLIENT_INFO_HEADER

http = make_requests_session([self.EMPTY_JSON_RESPONSE])
client = mock.Mock(_http=http, spec=["_http"])
conn = self._make_mock_one(client)
Expand All @@ -316,12 +356,15 @@ def test_api_request_w_headers(self):
"Accept-Encoding": "gzip",
"User-Agent": conn.user_agent,
"X-Foo": "bar",
CLIENT_INFO_HEADER: conn.user_agent,
}
http.request.assert_called_once_with(
method="GET", url=mock.ANY, headers=expected_headers, data=None
)

def test_api_request_w_extra_headers(self):
from google.cloud._http import CLIENT_INFO_HEADER

http = make_requests_session([self.EMPTY_JSON_RESPONSE])
client = mock.Mock(_http=http, spec=["_http"])
conn = self._make_mock_one(client)
Expand All @@ -339,12 +382,15 @@ def test_api_request_w_extra_headers(self):
"User-Agent": conn.user_agent,
"X-Foo": "not-bar", # The one passed-in is overridden.
"X-Baz": "dax-quux",
CLIENT_INFO_HEADER: conn.user_agent,
}
http.request.assert_called_once_with(
method="GET", url=mock.ANY, headers=expected_headers, data=None
)

def test_api_request_w_data(self):
from google.cloud._http import CLIENT_INFO_HEADER

http = make_requests_session([self.EMPTY_JSON_RESPONSE])
client = mock.Mock(_http=http, spec=["_http"])
conn = self._make_mock_one(client)
Expand All @@ -358,6 +404,7 @@ def test_api_request_w_data(self):
"Accept-Encoding": "gzip",
"Content-Type": "application/json",
"User-Agent": conn.user_agent,
CLIENT_INFO_HEADER: conn.user_agent,
}

http.request.assert_called_once_with(
Expand Down