tests: add tests

Author: busunkim96

gapic/templates/%namespace/%name_%version/%sub/services/%service/client.py.j2

@@ -210,7 +210,7 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
             self._transport = Transport(
                 credentials=credentials,
                 credentials_file=client_options.credentials_file,
-                host=self.DEFAULT_ENDPOINT,
+                host=client_options.api_endpoint,
                 scopes=client_options.scopes,
                 api_mtls_endpoint=client_options.api_endpoint,
                 client_cert_source=client_options.client_cert_source,

gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/grpc.py.j2

@@ -110,7 +110,7 @@ class {{ service.name }}GrpcTransport({{ service.name }}Transport):
             )
 
         # Run the base constructor.
-        super().__init__(host=host, credentials=credentials, credentials_file=credentials_file, scopes=scopes)
+        super().__init__(host=host, credentials=credentials, credentials_file=credentials_file, scopes=scopes or self.AUTH_SCOPES)
         self._stubs = {}  # type: Dict[str, Callable]
 
     @classmethod

gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/grpc_asyncio.py.j2

@@ -43,6 +43,7 @@ class {{ service.grpc_asyncio_transport_name }}({{ service.name }}Transport):
     def create_channel(cls,
                        host: str{% if service.host %} = '{{ service.host }}'{% endif %},
                        credentials: credentials.Credentials = None,
+                       credentials_file: Optional[str] = None,
                        scopes: Optional[Sequence[str]] = None,
                        **kwargs) -> aio.Channel:
         """Create and return a gRPC AsyncIO channel object.
@@ -53,6 +54,9 @@ class {{ service.grpc_asyncio_transport_name }}({{ service.name }}Transport):
                 credentials identify this application to the service. If
                 none are specified, the client will attempt to ascertain
                 the credentials from the environment.
+            credentials_file (Optional[str]): A file with credentials that can
+                be loaded with :func:`google.auth.load_credentials_from_file`.
+                This argument is ignored if ``channel`` is provided.
             scopes (Optional[Sequence[str]]): A optional list of scopes needed for this
                 service. These are only used when credentials are not specified and
                 are passed to :func:`google.auth.default`.
@@ -65,13 +69,16 @@ class {{ service.grpc_asyncio_transport_name }}({{ service.name }}Transport):
         return grpc_helpers_async.create_channel(
             host,
             credentials=credentials,
+            credentials_file=credentials_file,
             scopes=scopes,
             **kwargs
         )
 
     def __init__(self, *,
             host: str{% if service.host %} = '{{ service.host }}'{% endif %},
             credentials: credentials.Credentials = None,
+            credentials_file: Optional[str] = None,
+            scopes: Optional[Sequence[str]] = None,
             channel: aio.Channel = None,
             api_mtls_endpoint: str = None,
             client_cert_source: Callable[[], Tuple[bytes, bytes]] = None) -> None:
@@ -86,6 +93,12 @@ class {{ service.grpc_asyncio_transport_name }}({{ service.name }}Transport):
                 are specified, the client will attempt to ascertain the
                 credentials from the environment.
                 This argument is ignored if ``channel`` is provided.
+            credentials_file (Optional[str]): A file with credentials that can
+                be loaded with :func:`google.auth.load_credentials_from_file`.
+                This argument is ignored if ``channel`` is provided.
+            scopes (Optional[Sequence[str]]): A optional list of scopes needed for this
+                service. These are only used when credentials are not specified and
+                are passed to :func:`google.auth.default`.
             channel (Optional[aio.Channel]): A ``Channel`` instance through
                 which to make calls.
             api_mtls_endpoint (Optional[str]): The mutual TLS endpoint. If
@@ -98,8 +111,9 @@ class {{ service.grpc_asyncio_transport_name }}({{ service.name }}Transport):
                 is None.
 
         Raises:
-          google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport
+            google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport
               creation failed for any reason.
+            ValueError: If both ``credentials`` and ``credentials_file`` are passed.
         """
         if channel:
             # Sanity check: Ensure that channel and credentials are not both
@@ -125,12 +139,13 @@ class {{ service.grpc_asyncio_transport_name }}({{ service.name }}Transport):
             self._grpc_channel = type(self).create_channel(
                 host,
                 credentials=credentials,
+                credentials_file=credentials_file,
                 ssl_credentials=ssl_credentials,
-                scopes=self.AUTH_SCOPES,
+                scopes=scopes or self.AUTH_SCOPES,
             )
 
         # Run the base constructor.
-        super().__init__(host=host, credentials=credentials)
+        super().__init__(host=host, credentials=credentials, credentials_file=credentials_file, scopes=scopes or self.AUTH_SCOPES)
         self._stubs = {}
 
     @property

gapic/templates/noxfile.py.j2

@@ -13,6 +13,10 @@ def unit(session):
     session.install('coverage', 'pytest', 'pytest-cov', 'asyncmock', 'pytest-asyncio')
     session.install('-e', '.')
 
+    # TODO(busunkim): Remove once these PRs are merged
+    session.install('--force-reinstall', 'git+https://github.com/googleapis/python-api-core.git@creds-and-scope-overrides')
+    session.install('--force-reinstall', 'git+https://github.com/googleapis/google-auth-library-python.git@support-scopes')
+
     session.run(
         'py.test',
         '--quiet',

gapic/templates/tests/unit/gapic/%name_%version/%sub/test_%service.py.j2

@@ -101,10 +101,12 @@ def test_{{ service.client_name|snake_case }}_client_options(client_class, trans
         patched.return_value = None
         client = client_class(client_options=options)
         patched.assert_called_once_with(
-            api_mtls_endpoint="squid.clam.whelk",
-            client_cert_source=None,
             credentials=None,
+            credentials_file=None,
             host="squid.clam.whelk",
+            scopes=None,
+            api_mtls_endpoint="squid.clam.whelk",
+            client_cert_source=None,
         )
 
     # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS is
@@ -114,10 +116,12 @@ def test_{{ service.client_name|snake_case }}_client_options(client_class, trans
         patched.return_value = None
         client = client_class()
         patched.assert_called_once_with(
-            api_mtls_endpoint=client.DEFAULT_ENDPOINT,
-            client_cert_source=None,
             credentials=None,
+            credentials_file=None,
             host=client.DEFAULT_ENDPOINT,
+            scopes=None,
+            api_mtls_endpoint=client.DEFAULT_ENDPOINT,
+            client_cert_source=None,
         )
 
     # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS is
@@ -127,10 +131,12 @@ def test_{{ service.client_name|snake_case }}_client_options(client_class, trans
         patched.return_value = None
         client = client_class()
         patched.assert_called_once_with(
-            api_mtls_endpoint=client.DEFAULT_MTLS_ENDPOINT,
-            client_cert_source=None,
             credentials=None,
+            credentials_file=None,
             host=client.DEFAULT_MTLS_ENDPOINT,
+            scopes=None,
+            api_mtls_endpoint=client.DEFAULT_MTLS_ENDPOINT,
+            client_cert_source=None,
         )
 
     # Check the case api_endpoint is not provided, GOOGLE_API_USE_MTLS is
@@ -141,10 +147,13 @@ def test_{{ service.client_name|snake_case }}_client_options(client_class, trans
         patched.return_value = None
         client = client_class(client_options=options)
         patched.assert_called_once_with(
-            api_mtls_endpoint=client.DEFAULT_MTLS_ENDPOINT,
-            client_cert_source=client_cert_source_callback,
             credentials=None,
+            credentials_file=None,
             host=client.DEFAULT_MTLS_ENDPOINT,
+            scopes=None,
+            api_mtls_endpoint=client.DEFAULT_MTLS_ENDPOINT,
+            client_cert_source=client_cert_source_callback,
+
         )
 
     # Check the case api_endpoint is not provided, GOOGLE_API_USE_MTLS is
@@ -155,10 +164,12 @@ def test_{{ service.client_name|snake_case }}_client_options(client_class, trans
             patched.return_value = None
             client = client_class()
             patched.assert_called_once_with(
-                api_mtls_endpoint=client.DEFAULT_MTLS_ENDPOINT,
-                client_cert_source=None,
                 credentials=None,
+                credentials_file=None,
                 host=client.DEFAULT_MTLS_ENDPOINT,
+                scopes=None,
+                api_mtls_endpoint=client.DEFAULT_MTLS_ENDPOINT,
+                client_cert_source=None,
             )
 
     # Check the case api_endpoint is not provided, GOOGLE_API_USE_MTLS is
@@ -169,10 +180,12 @@ def test_{{ service.client_name|snake_case }}_client_options(client_class, trans
             patched.return_value = None
             client = client_class()
             patched.assert_called_once_with(
-                api_mtls_endpoint=client.DEFAULT_ENDPOINT,
-                client_cert_source=None,
                 credentials=None,
+                credentials_file=None,
                 host=client.DEFAULT_ENDPOINT,
+                scopes=None,
+                api_mtls_endpoint=client.DEFAULT_ENDPOINT,
+                client_cert_source=None,
             )
 
     # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS has
@@ -184,17 +197,63 @@ def test_{{ service.client_name|snake_case }}_client_options(client_class, trans
     del os.environ["GOOGLE_API_USE_MTLS"]
 
 
+@pytest.mark.parametrize("client_class,transport_class,transport_name", [
+    ({{ service.client_name }}, transports.{{ service.grpc_transport_name }}, "grpc"),
+    ({{ service.async_client_name }}, transports.{{ service.grpc_asyncio_transport_name }}, "grpc_asyncio")
+])
+def test_{{ service.client_name|snake_case }}_client_options_scopes(client_class, transport_class, transport_name):
+    # Check the case api_endpoint is provided.
+    options = client_options.ClientOptions(
+        scopes=["1", "2"],
+    )
+    with mock.patch.object(transport_class, '__init__') as patched:
+        patched.return_value = None
+        client = client_class(client_options=options)
+        patched.assert_called_once_with(
+            credentials=None,
+            credentials_file=None,
+            host="localhost:7469",
+            scopes=["1", "2"],
+            api_mtls_endpoint="localhost:7469",
+            client_cert_source=None,
+        )
+
+
+@pytest.mark.parametrize("client_class,transport_class,transport_name", [
+    ({{ service.client_name }}, transports.{{ service.grpc_transport_name }}, "grpc"),
+    ({{ service.async_client_name }}, transports.{{ service.grpc_asyncio_transport_name }}, "grpc_asyncio")
+])
+def test_{{ service.client_name|snake_case }}_client_options_credentials_file(client_class, transport_class, transport_name):
+    # Check the case api_endpoint is provided.
+    options = client_options.ClientOptions(
+        credentials_file="credentials.json"
+    )
+    with mock.patch.object(transport_class, '__init__') as patched:
+        patched.return_value = None
+        client = client_class(client_options=options)
+        patched.assert_called_once_with(
+            credentials=None,
+            credentials_file="credentials.json",
+            host="localhost:7469",
+            scopes=None,
+            api_mtls_endpoint="localhost:7469",
+            client_cert_source=None,
+        )
+
+
 def test_{{ service.client_name|snake_case }}_client_options_from_dict():
     with mock.patch('{{ (api.naming.module_namespace + (api.naming.versioned_module_name,) + service.meta.address.subpackage)|join(".") }}.services.{{ service.name|snake_case }}.transports.{{ service.name }}GrpcTransport.__init__') as grpc_transport:
         grpc_transport.return_value = None
         client = {{ service.client_name }}(
             client_options={'api_endpoint': 'squid.clam.whelk'}
         )
         grpc_transport.assert_called_once_with(
-            api_mtls_endpoint="squid.clam.whelk",
-            client_cert_source=None,
             credentials=None,
+            credentials_file=None,
             host="squid.clam.whelk",
+            scopes=None,
+            api_mtls_endpoint="squid.clam.whelk",
+            client_cert_source=None,
         )
 
 
@@ -793,6 +852,27 @@ def test_credentials_transport_error():
             transport=transport,
         )
 
+    # It is an error to provide a credentials file and a transport instance.
+    transport = transports.{{ service.name }}GrpcTransport(
+        credentials=credentials.AnonymousCredentials(),
+    )
+    with pytest.raises(ValueError):
+        client = {{ service.client_name }}(
+            client_options={"credentials_file": "credentials.json"},
+            transport=transport,
+        )
+
+    # It is an error to provide scopes and a transport instance.
+    transport = transports.{{ service.name }}GrpcTransport(
+        credentials=credentials.AnonymousCredentials(),
+    )
+    with pytest.raises(ValueError):
+        client = {{ service.client_name }}(
+            client_options={"scopes": ["1", "2"]},
+            transport=transport,
+        )
+    
+
 
 def test_transport_instance():
     # A client may be instantiated with a custom transport instance.
@@ -829,6 +909,16 @@ def test_transport_grpc_default():
     )
 
 
+def test_{{ service.name|snake_case }}_base_transport_error():
+    # Passing both a credentials object and credentials_file should raise an error
+    with pytest.raises(ValueError) as excinfo:
+        transport = transports.{{ service.name }}Transport(
+            credentials=credentials.AnonymousCredentials(),
+            credentials_file="credentials.json"
+        )
+    assert "mutually exclusive" in str(excinfo.value)
+
+
 def test_{{ service.name|snake_case }}_base_transport():
     # Instantiate the base transport.
     transport = transports.{{ service.name }}Transport(
@@ -854,6 +944,20 @@ def test_{{ service.name|snake_case }}_base_transport():
     {% endif %}
 
 
+def test_{{ service.name|snake_case }}_base_transport_with_credentials_file():
+    # Instantiate the base transport with a credentials file
+    with mock.patch.object(auth, 'load_credentials_from_file') as load_creds:
+        load_creds.return_value = (credentials.AnonymousCredentials(), None)
+        transport = transports.{{ service.name }}Transport(
+            credentials_file="credentials.json",
+        )
+        load_creds.assert_called_once_with("credentials.json", scopes=(
+            {%- for scope in service.oauth_scopes %}
+            '{{ scope }}',
+            {%- endfor %}
+        ))
+
+
 def test_{{ service.name|snake_case }}_auth_adc():
     # If no credentials are provided, we should use ADC credentials.
     with mock.patch.object(auth, 'default') as adc:
@@ -960,12 +1064,13 @@ def test_{{ service.name|snake_case }}_grpc_transport_channel_mtls_with_client_c
     grpc_create_channel.assert_called_once_with(
         "mtls.squid.clam.whelk:443",
         credentials=mock_cred,
-        ssl_credentials=mock_ssl_cred,
+        credentials_file=None,
         scopes=(
             {%- for scope in service.oauth_scopes %}
             '{{ scope }}',
             {%- endfor %}
         ),
+        ssl_credentials=mock_ssl_cred,
     )
     assert transport.grpc_channel == mock_grpc_channel
 
@@ -997,12 +1102,13 @@ def test_{{ service.name|snake_case }}_grpc_asyncio_transport_channel_mtls_with_
     grpc_create_channel.assert_called_once_with(
         "mtls.squid.clam.whelk:443",
         credentials=mock_cred,
-        ssl_credentials=mock_ssl_cred,
+        credentials_file=None,
         scopes=(
             {%- for scope in service.oauth_scopes %}
             '{{ scope }}',
             {%- endfor %}
         ),
+        ssl_credentials=mock_ssl_cred,
     )
     assert transport.grpc_channel == mock_grpc_channel
 
@@ -1036,12 +1142,13 @@ def test_{{ service.name|snake_case }}_grpc_transport_channel_mtls_with_adc(
         grpc_create_channel.assert_called_once_with(
             "mtls.squid.clam.whelk:443",
             credentials=mock_cred,
-            ssl_credentials=mock_ssl_cred,
+            credentials_file=None,
             scopes=(
                 {%- for scope in service.oauth_scopes %}
                 '{{ scope }}',
                 {%- endfor %}
             ),
+            ssl_credentials=mock_ssl_cred,
         )
         assert transport.grpc_channel == mock_grpc_channel
 
@@ -1075,12 +1182,13 @@ def test_{{ service.name|snake_case }}_grpc_asyncio_transport_channel_mtls_with_
         grpc_create_channel.assert_called_once_with(
             "mtls.squid.clam.whelk:443",
             credentials=mock_cred,
-            ssl_credentials=mock_ssl_cred,
+            credentials_file=None,
             scopes=(
                 {%- for scope in service.oauth_scopes %}
                 '{{ scope }}',
                 {%- endfor %}
             ),
+            ssl_credentials=mock_ssl_cred,
         )
         assert transport.grpc_channel == mock_grpc_channel