def test_create_realm_flattened():
client = RealmsServiceClient(
credentials=credentials.AnonymousCredentials())
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.create_realm),
"__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = operations_pb2.Operation(name="operations/op")
# Call the method with a truthy value for each flattened field,
# using the keyword arguments to the method.
response = client.create_realm(
parent="parent_value",
realm=realms.Realm(name="name_value"),
realm_id="realm_id_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].parent == "parent_value"
assert args[0].realm == realms.Realm(name="name_value")
assert args[0].realm_id == "realm_id_value"
def test_get_realm(transport: str = "grpc"):
client = RealmsServiceClient(
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 = realms.GetRealmRequest()
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.get_realm),
"__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = realms.Realm(
name="name_value",
time_zone="time_zone_value",
etag="etag_value",
description="description_value",
)
response = client.get_realm(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, realms.Realm)
assert response.name == "name_value"
assert response.time_zone == "time_zone_value"
assert response.etag == "etag_value"
assert response.description == "description_value"
def test_update_realm_flattened_error():
client = RealmsServiceClient(
credentials=credentials.AnonymousCredentials())
# Attempting to call a method with both a request object and flattened
# fields is an error.
with pytest.raises(ValueError):
client.update_realm(
realms.UpdateRealmRequest(),
realm=realms.Realm(name="name_value"),
update_mask=field_mask.FieldMask(paths=["paths_value"]),
)
def test_create_realm_flattened_error():
client = RealmsServiceClient(
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_realm(
realms.CreateRealmRequest(),
parent="parent_value",
realm=realms.Realm(name="name_value"),
realm_id="realm_id_value",
)
def update_realm(project_id, location, realm_id):
"""Updates a realm."""
client = gaming.RealmsServiceClient()
request = realms.UpdateRealmRequest(
realm=realms.Realm(
name=f"projects/{project_id}/locations/{location}/realms/{realm_id}",
labels={"label-key-1": "label-value-1", "label-key-2": "label-value-2"},
),
update_mask=field_mask.FieldMask(paths=["labels"]),
)
operation = client.update_realm(request)
print(f"Update realm operation: {operation.operation.name}")
operation.result(timeout=120)
def create_realm(project_id, location, realm_id):
"""Creates a realm."""
client = gaming.RealmsServiceClient()
request = realms.CreateRealmRequest(
parent=f"projects/{project_id}/locations/{location}",
realm_id=realm_id,
realm=realms.Realm(
description="My Realm",
time_zone="US/Pacific",
),
)
operation = client.create_realm(request)
print(f"Create realm operation: {operation.operation.name}")
operation.result(timeout=120)
def test_get_realm_field_headers():
client = RealmsServiceClient(
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 = realms.GetRealmRequest(name="name/value")
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.get_realm),
"__call__") as call:
call.return_value = realms.Realm()
client.get_realm(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_list_realms_pages():
client = RealmsServiceClient(credentials=credentials.AnonymousCredentials)
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.list_realms),
"__call__") as call:
# Set the response to a series of pages.
call.side_effect = (
realms.ListRealmsResponse(
realms=[realms.Realm(),
realms.Realm(),
realms.Realm()],
next_page_token="abc",
),
realms.ListRealmsResponse(realms=[], next_page_token="def"),
realms.ListRealmsResponse(realms=[realms.Realm()],
next_page_token="ghi"),
realms.ListRealmsResponse(
realms=[realms.Realm(), realms.Realm()]),
RuntimeError,
)
pages = list(client.list_realms(request={}).pages)
for page, token in zip(pages, ["abc", "def", "ghi", ""]):
assert page.raw_page.next_page_token == token
def test_list_realms_pager():
client = RealmsServiceClient(credentials=credentials.AnonymousCredentials)
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.list_realms),
"__call__") as call:
# Set the response to a series of pages.
call.side_effect = (
realms.ListRealmsResponse(
realms=[realms.Realm(),
realms.Realm(),
realms.Realm()],
next_page_token="abc",
),
realms.ListRealmsResponse(realms=[], next_page_token="def"),
realms.ListRealmsResponse(realms=[realms.Realm()],
next_page_token="ghi"),
realms.ListRealmsResponse(
realms=[realms.Realm(), realms.Realm()]),
RuntimeError,
)
results = [i for i in client.list_realms(request={})]
assert len(results) == 6
assert all(isinstance(i, realms.Realm) for i in results)
