feat(dns): add 'client_options' argument to client ctor (#9516)

tseaver · web-flow · commit 98639f8b79f3 · 2019-10-22T18:39:29.000-04:00
Toward #8475
diff --git a/dns/google/cloud/dns/_http.py b/dns/google/cloud/dns/_http.py
@@ -29,15 +29,14 @@ class Connection(_http.JSONConnection):
     :param client_info: (Optional) instance used to generate user agent.
     """
 
-    def __init__(self, client, client_info=None):
-        super(Connection, self).__init__(client, client_info)
+    DEFAULT_API_ENDPOINT = "https://dns.googleapis.com"
 
+    def __init__(self, client, client_info=None, api_endpoint=DEFAULT_API_ENDPOINT):
+        super(Connection, self).__init__(client, client_info)
+        self.API_BASE_URL = api_endpoint
         self._client_info.gapic_version = __version__
         self._client_info.client_library_version = __version__
 
-    API_BASE_URL = "https://dns.googleapis.com"
-    """The base of the API call URL."""
-
     API_VERSION = "v1"
     """The version of the API, used in building the API call's URL."""
 
diff --git a/dns/google/cloud/dns/client.py b/dns/google/cloud/dns/client.py
@@ -15,6 +15,7 @@
 """Client for interacting with the Google Cloud DNS API."""
 
 from google.api_core import page_iterator
+from google.api_core import client_options as client_options_mod
 from google.cloud.client import ClientWithProject
 
 from google.cloud.dns._http import Connection
@@ -50,16 +51,37 @@ class Client(ClientWithProject):
         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.
+
+    :type client_options: :class:`~google.api_core.client_options.ClientOptions`
+        or :class:`dict`
+    :param client_options: (Optional) Client options used to set user options
+        on the client. API Endpoint should be set through client_options.
     """
 
     SCOPE = ("https://www.googleapis.com/auth/ndev.clouddns.readwrite",)
     """The scopes required for authenticating as a Cloud DNS consumer."""
 
-    def __init__(self, project=None, credentials=None, _http=None, client_info=None):
+    def __init__(
+        self,
+        project=None,
+        credentials=None,
+        _http=None,
+        client_info=None,
+        client_options=None,
+    ):
         super(Client, self).__init__(
             project=project, credentials=credentials, _http=_http
         )
-        self._connection = Connection(self, client_info=client_info)
+
+        kwargs = {"client_info": client_info}
+        if client_options:
+            if isinstance(client_options, dict):
+                client_options = client_options_mod.from_dict(client_options)
+
+            if client_options.api_endpoint:
+                kwargs["api_endpoint"] = client_options.api_endpoint
+
+        self._connection = Connection(self, **kwargs)
 
     def quotas(self):
         """Return DNS quotas for the project associated with this client.
diff --git a/dns/tests/unit/test__http.py b/dns/tests/unit/test__http.py
@@ -44,6 +44,12 @@ def test_build_api_url_w_extra_query_params(self):
         parms = dict(parse_qsl(qs))
         self.assertEqual(parms["bar"], "baz")
 
+    def test_build_api_url_w_custom_endpoint(self):
+        custom_endpoint = "https://foo-dns.googleapis.com"
+        conn = self._make_one(object(), api_endpoint=custom_endpoint)
+        URI = "/".join([custom_endpoint, "dns", conn.API_VERSION, "foo"])
+        self.assertEqual(conn.build_api_url("/foo"), URI)
+
     def test_extra_headers(self):
         import requests
         from google.cloud import _http as base_http
diff --git a/dns/tests/unit/test_client.py b/dns/tests/unit/test_client.py
@@ -37,7 +37,7 @@ def _get_target_class():
     def _make_one(self, *args, **kw):
         return self._get_target_class()(*args, **kw)
 
-    def test_ctor(self):
+    def test_ctor_defaults(self):
         from google.api_core.client_info import ClientInfo
         from google.cloud.dns._http import Connection
 
@@ -48,6 +48,9 @@ def test_ctor(self):
         self.assertIs(client._connection.credentials, creds)
         self.assertIs(client._connection.http, http)
         self.assertIsInstance(client._connection._client_info, ClientInfo)
+        self.assertEqual(
+            client._connection.API_BASE_URL, client._connection.DEFAULT_API_ENDPOINT
+        )
 
     def test_ctor_w_client_info(self):
         from google.api_core.client_info import ClientInfo
@@ -65,6 +68,55 @@ def test_ctor_w_client_info(self):
         self.assertIs(client._connection.http, http)
         self.assertIs(client._connection._client_info, client_info)
 
+    def test_ctor_w_empty_client_options_object(self):
+        from google.api_core.client_info import ClientInfo
+        from google.api_core.client_options import ClientOptions
+        from google.cloud.dns._http import Connection
+
+        creds = _make_credentials()
+        http = object()
+        client = self._make_one(
+            project=self.PROJECT,
+            credentials=creds,
+            _http=http,
+            client_options=ClientOptions(),
+        )
+        self.assertIsInstance(client._connection, Connection)
+        self.assertIs(client._connection.credentials, creds)
+        self.assertIs(client._connection.http, http)
+        self.assertIsInstance(client._connection._client_info, ClientInfo)
+        self.assertEqual(
+            client._connection.API_BASE_URL, client._connection.DEFAULT_API_ENDPOINT
+        )
+
+    def test_ctor_w_client_options_object(self):
+        from google.api_core.client_options import ClientOptions
+
+        api_endpoint = "https://foo-dns.googleapis.com"
+        creds = _make_credentials()
+        http = object()
+        client_options = ClientOptions(api_endpoint=api_endpoint)
+        client = self._make_one(
+            project=self.PROJECT,
+            credentials=creds,
+            _http=http,
+            client_options=client_options,
+        )
+        self.assertEqual(client._connection.API_BASE_URL, api_endpoint)
+
+    def test_ctor_w_client_options_dict(self):
+        api_endpoint = "https://foo-dns.googleapis.com"
+        creds = _make_credentials()
+        http = object()
+        client_options = {"api_endpoint": api_endpoint}
+        client = self._make_one(
+            project=self.PROJECT,
+            credentials=creds,
+            _http=http,
+            client_options=client_options,
+        )
+        self.assertEqual(client._connection.API_BASE_URL, api_endpoint)
+
     def test_quotas_defaults(self):
         PATH = "projects/%s" % (self.PROJECT,)
         MANAGED_ZONES = 1234
