def test_create_span_field_headers():
client = TraceServiceClient(
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 = trace.Span()
request.name = "name/value"
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.create_span),
"__call__") as call:
call.return_value = trace.Span()
client.create_span(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",
"name=name/value",
) in kw["metadata"]
def test_credentials_transport_error():
# It is an error to provide credentials and a transport instance.
transport = transports.TraceServiceGrpcTransport(
credentials=credentials.AnonymousCredentials(), )
with pytest.raises(ValueError):
client = TraceServiceClient(
credentials=credentials.AnonymousCredentials(),
transport=transport,
)
# It is an error to provide a credentials file and a transport instance.
transport = transports.TraceServiceGrpcTransport(
credentials=credentials.AnonymousCredentials(), )
with pytest.raises(ValueError):
client = TraceServiceClient(
client_options={"credentials_file": "credentials.json"},
transport=transport,
)
# It is an error to provide scopes and a transport instance.
transport = transports.TraceServiceGrpcTransport(
credentials=credentials.AnonymousCredentials(), )
with pytest.raises(ValueError):
client = TraceServiceClient(
client_options={"scopes": ["1", "2"]},
transport=transport,
)
def test_batch_write_spans_flattened():
client = TraceServiceClient(
credentials=credentials.AnonymousCredentials(), )
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.batch_write_spans),
"__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = None
# Call the method with a truthy value for each flattened field,
# using the keyword arguments to the method.
client.batch_write_spans(
name="name_value",
spans=[trace.Span(name="name_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].name == "name_value"
assert args[0].spans == [trace.Span(name="name_value")]
def test_batch_write_spans(transport: str = "grpc",
request_type=tracing.BatchWriteSpansRequest):
client = TraceServiceClient(
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 = request_type()
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.batch_write_spans),
"__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = None
response = client.batch_write_spans(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == tracing.BatchWriteSpansRequest()
# Establish that the response is the type that we expect.
assert response is None
def test_parse_span_path():
expected = {
"project": "octopus",
"trace": "oyster",
"span": "nudibranch",
}
path = TraceServiceClient.span_path(**expected)
# Check that the path construction is reversible.
actual = TraceServiceClient.parse_span_path(path)
assert expected == actual
def test_batch_write_spans_flattened_error():
client = TraceServiceClient(
credentials=credentials.AnonymousCredentials(), )
# Attempting to call a method with both a request object and flattened
# fields is an error.
with pytest.raises(ValueError):
client.batch_write_spans(
tracing.BatchWriteSpansRequest(),
name="name_value",
spans=[trace.Span(name="name_value")],
)
def test_trace_service_host_with_port():
client = TraceServiceClient(
credentials=credentials.AnonymousCredentials(),
client_options=client_options.ClientOptions(
api_endpoint="cloudtrace.googleapis.com:8000"),
)
assert client._transport._host == "cloudtrace.googleapis.com:8000"
def test_transport_grpc_default():
# A client should use the gRPC transport by default.
client = TraceServiceClient(
credentials=credentials.AnonymousCredentials(), )
assert isinstance(
client._transport,
transports.TraceServiceGrpcTransport,
)
def test_client_withDEFAULT_CLIENT_INFO():
client_info = gapic_v1.client_info.ClientInfo()
with mock.patch.object(transports.TraceServiceTransport,
"_prep_wrapped_messages") as prep:
client = TraceServiceClient(
credentials=credentials.AnonymousCredentials(),
client_info=client_info,
)
prep.assert_called_once_with(client_info)
with mock.patch.object(transports.TraceServiceTransport,
"_prep_wrapped_messages") as prep:
transport_class = TraceServiceClient.get_transport_class()
transport = transport_class(
credentials=credentials.AnonymousCredentials(),
client_info=client_info,
)
prep.assert_called_once_with(client_info)
def test_trace_service_auth_adc():
# If no credentials are provided, we should use ADC credentials.
with mock.patch.object(auth, "default") as adc:
adc.return_value = (credentials.AnonymousCredentials(), None)
TraceServiceClient()
adc.assert_called_once_with(
scopes=(
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.append",
),
quota_project_id=None,
)
def test_span_path():
project = "squid"
trace = "clam"
span = "whelk"
expected = "projects/{project}/traces/{trace}/spans/{span}".format(
project=project,
trace=trace,
span=span,
)
actual = TraceServiceClient.span_path(project, trace, span)
assert expected == actual
def test_create_span(transport: str = "grpc", request_type=trace.Span):
client = TraceServiceClient(
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 = request_type()
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.create_span),
"__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = trace.Span(
name="name_value",
span_id="span_id_value",
parent_span_id="parent_span_id_value",
span_kind=trace.Span.SpanKind.INTERNAL,
)
response = client.create_span(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == trace.Span()
# Establish that the response is the type that we expect.
assert isinstance(response, trace.Span)
assert response.name == "name_value"
assert response.span_id == "span_id_value"
assert response.parent_span_id == "parent_span_id_value"
assert response.span_kind == trace.Span.SpanKind.INTERNAL
def test_trace_service_client_client_options_from_dict():
with mock.patch(
"google.cloud.trace_v2.services.trace_service.transports.TraceServiceGrpcTransport.__init__"
) as grpc_transport:
grpc_transport.return_value = None
client = TraceServiceClient(
client_options={"api_endpoint": "squid.clam.whelk"})
grpc_transport.assert_called_once_with(
credentials=None,
credentials_file=None,
host="squid.clam.whelk",
scopes=None,
api_mtls_endpoint="squid.clam.whelk",
client_cert_source=None,
quota_project_id=None,
client_info=transports.base.DEFAULT_CLIENT_INFO,
)
def test__get_default_mtls_endpoint():
api_endpoint = "example.googleapis.com"
api_mtls_endpoint = "example.mtls.googleapis.com"
sandbox_endpoint = "example.sandbox.googleapis.com"
sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com"
non_googleapi = "api.example.com"
assert TraceServiceClient._get_default_mtls_endpoint(None) is None
assert (TraceServiceClient._get_default_mtls_endpoint(api_endpoint) ==
api_mtls_endpoint)
assert (TraceServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) ==
api_mtls_endpoint)
assert (TraceServiceClient._get_default_mtls_endpoint(sandbox_endpoint) ==
sandbox_mtls_endpoint)
assert (TraceServiceClient._get_default_mtls_endpoint(
sandbox_mtls_endpoint) == sandbox_mtls_endpoint)
assert TraceServiceClient._get_default_mtls_endpoint(
non_googleapi) == non_googleapi
def test_trace_service_client_get_transport_class():
transport = TraceServiceClient.get_transport_class()
assert transport == transports.TraceServiceGrpcTransport
transport = TraceServiceClient.get_transport_class("grpc")
assert transport == transports.TraceServiceGrpcTransport
def test_transport_instance():
# A client may be instantiated with a custom transport instance.
transport = transports.TraceServiceGrpcTransport(
credentials=credentials.AnonymousCredentials(), )
client = TraceServiceClient(transport=transport)
assert client._transport is transport
