def test_create_topic(transport: str = 'grpc'): client = PublisherClient( credentials=credentials.AnonymousCredentials(), transport=transport, ) # Everything is optional in proto3 as far as the runtime is concerned, # and we are mocking out the actual API, so just send an empty request. request = pubsub.Topic() # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object(type(client._transport.create_topic), '__call__') as call: # Designate an appropriate return value for the call. call.return_value = pubsub.Topic( name='name_value', kms_key_name='kms_key_name_value', ) response = client.create_topic(request) # Establish that the underlying gRPC stub method was called. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] assert args[0] == request # Establish that the response is the type that we expect. assert isinstance(response, pubsub.Topic) assert response.name == 'name_value' assert response.kms_key_name == 'kms_key_name_value'
def test_create_topic_flattened_error(): client = PublisherClient(credentials=credentials.AnonymousCredentials(), ) # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): client.create_topic( pubsub.Topic(), name='name_value', )
def test_list_topics_pages(): client = PublisherClient(credentials=credentials.AnonymousCredentials, ) # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object(type(client._transport.list_topics), '__call__') as call: # Set the response to a series of pages. call.side_effect = ( pubsub.ListTopicsResponse( topics=[ pubsub.Topic(), pubsub.Topic(), pubsub.Topic(), ], next_page_token='abc', ), pubsub.ListTopicsResponse( topics=[], next_page_token='def', ), pubsub.ListTopicsResponse( topics=[ pubsub.Topic(), ], next_page_token='ghi', ), pubsub.ListTopicsResponse(topics=[ pubsub.Topic(), pubsub.Topic(), ], ), RuntimeError, ) pages = list(client.list_topics(request={}).pages) for page, token in zip(pages, ['abc', 'def', 'ghi', '']): assert page.raw_page.next_page_token == token
def test_list_topics_pager(): client = PublisherClient(credentials=credentials.AnonymousCredentials, ) # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object(type(client._transport.list_topics), '__call__') as call: # Set the response to a series of pages. call.side_effect = ( pubsub.ListTopicsResponse( topics=[ pubsub.Topic(), pubsub.Topic(), pubsub.Topic(), ], next_page_token='abc', ), pubsub.ListTopicsResponse( topics=[], next_page_token='def', ), pubsub.ListTopicsResponse( topics=[ pubsub.Topic(), ], next_page_token='ghi', ), pubsub.ListTopicsResponse(topics=[ pubsub.Topic(), pubsub.Topic(), ], ), RuntimeError, ) results = [i for i in client.list_topics(request={}, )] assert len(results) == 6 assert all(isinstance(i, pubsub.Topic) for i in results)
def test_get_topic_flattened(): client = PublisherClient(credentials=credentials.AnonymousCredentials(), ) # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object(type(client._transport.get_topic), '__call__') as call: # Designate an appropriate return value for the call. call.return_value = pubsub.Topic() # Call the method with a truthy value for each flattened field, # using the keyword arguments to the method. response = client.get_topic(topic='topic_value', ) # Establish that the underlying call was made with the expected # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] assert args[0].topic == 'topic_value'
def test_get_topic_field_headers(): client = PublisherClient(credentials=credentials.AnonymousCredentials(), ) # Any value that is part of the HTTP/1.1 URI should be sent as # a field header. Set these to a non-empty value. request = pubsub.GetTopicRequest(topic='topic/value', ) # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object(type(client._transport.get_topic), '__call__') as call: call.return_value = pubsub.Topic() client.get_topic(request) # Establish that the underlying gRPC stub method was called. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] assert args[0] == request # Establish that the field header was sent. _, _, kw = call.mock_calls[0] assert ( 'x-goog-request-params', 'topic=topic/value', ) in kw['metadata']
async def create_topic( self, request: pubsub.Topic = None, *, name: str = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pubsub.Topic: r"""Creates the given topic with the given name. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names). Args: request (:class:`google.pubsub_v1.types.Topic`): The request object. A topic resource. name (:class:`str`): Required. The name of the topic. It must have the format ``"projects/{project}/topics/{topic}"``. ``{topic}`` must start with a letter, and contain only letters (``[A-Za-z]``), numbers (``[0-9]``), dashes (``-``), underscores (``_``), periods (``.``), tildes (``~``), plus (``+``) or percent signs (``%``). It must be between 3 and 255 characters in length, and it must not start with ``"goog"``. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this should not be set. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. Returns: google.pubsub_v1.types.Topic: A topic resource. """ # Create or coerce a protobuf request object. # Sanity check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([name]) if request is not None and has_flattened_params: raise ValueError("If the `request` argument is set, then none of " "the individual field arguments should be set.") request = pubsub.Topic(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if name is not None: request.name = name # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = gapic_v1.method_async.wrap_method( self._client._transport.create_topic, default_retry=retries.Retry( initial=0.1, maximum=60.0, multiplier=1.3, predicate=retries.if_exception_type( exceptions.ServiceUnavailable, ), deadline=60.0, ), default_timeout=60.0, client_info=DEFAULT_CLIENT_INFO, ) # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata( (("name", request.name), )), ) # Send the request. response = await rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response
def create_topic( self, request: pubsub.Topic = None, *, name: str = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pubsub.Topic: r"""Creates the given topic with the given name. See the resource name rules. Args: request (:class:`~.pubsub.Topic`): The request object. A topic resource. name (:class:`str`): Required. The name of the topic. It must have the format ``"projects/{project}/topics/{topic}"``. ``{topic}`` must start with a letter, and contain only letters (``[A-Za-z]``), numbers (``[0-9]``), dashes (``-``), underscores (``_``), periods (``.``), tildes (``~``), plus (``+``) or percent signs (``%``). It must be between 3 and 255 characters in length, and it must not start with ``"goog"``. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this should not be set. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. Returns: ~.pubsub.Topic: A topic resource. """ # Create or coerce a protobuf request object. # Sanity check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. if request is not None and any([name]): raise ValueError('If the `request` argument is set, then none of ' 'the individual field arguments should be set.') request = pubsub.Topic(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if name is not None: request.name = name # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = gapic_v1.method.wrap_method( self._transport.create_topic, default_timeout=None, client_info=_client_info, ) # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response
def create_topic( self, request: pubsub.Topic = None, *, name: str = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pubsub.Topic: r"""Creates the given topic with the given name. See the `resource name rules <https://cloud.google.com/pubsub/docs/admin#resource_names>`__. Args: request (:class:`~.pubsub.Topic`): The request object. A topic resource. name (:class:`str`): Required. The name of the topic. It must have the format ``"projects/{project}/topics/{topic}"``. ``{topic}`` must start with a letter, and contain only letters (``[A-Za-z]``), numbers (``[0-9]``), dashes (``-``), underscores (``_``), periods (``.``), tildes (``~``), plus (``+``) or percent signs (``%``). It must be between 3 and 255 characters in length, and it must not start with ``"goog"``. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this should not be set. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. Returns: ~.pubsub.Topic: A topic resource. """ # Create or coerce a protobuf request object. # Sanity check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([name]) if request is not None and has_flattened_params: raise ValueError("If the `request` argument is set, then none of " "the individual field arguments should be set.") # Minor optimization to avoid making a copy if the user passes # in a pubsub.Topic. # There's no risk of modifying the input as we've already verified # there are no flattened fields. if not isinstance(request, pubsub.Topic): request = pubsub.Topic(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if name is not None: request.name = name # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.create_topic] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata( (("name", request.name), )), ) # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response