async def test_state_list_paginated_by_max_index(self):
"""Verifies GET /state paginated by a max index works properly.
It will receive a Protobuf response with:
- a head id of 'd'
- a paging response with a start of 0, and 4 total resources
- three entries with the ids {'d': b'4'}, {'c': b'3'} and {'b': b'2'}
It should send a Protobuf request with:
- a paging controls with a count of 2 and an start_index of 0
It should send back a JSON response with:
- a response status of 200
- a head property of 'd'
- a link property that ends in '/state?head=d&min=3&count=7'
- paging that matches the response, with a next link
- a data property that is a list of 2 dicts
- and those dicts are entries that match those received
"""
paging = Mocks.make_paging_response(0, 4)
entries = Mocks.make_entries(d=b'4', c=b'3', b=b'2')
self.connection.preset_response(head_id='d',
paging=paging,
entries=entries)
response = await self.get_assert_200('/state?max=2&count=7')
controls = Mocks.make_paging_controls(3, start_index=0)
self.connection.assert_valid_request_sent(paging=controls)
self.assert_has_valid_head(response, 'd')
self.assert_has_valid_link(response, '/state?head=d&max=2&count=7')
self.assert_has_valid_paging(response, paging,
'/state?head=d&min=3&count=7')
self.assert_has_valid_data_list(response, 3)
self.assert_entries_match(entries, response['data'])
async def test_state_list_paginated_without_count(self):
"""Verifies GET /state paginated without count works properly.
It will receive a Protobuf response with:
- a head id of 'd'
- a paging response with a start of 2, and 4 total resources
- two entries of {'b': b'2'} and {'a': b'1'}
It should send a Protobuf request with:
- a paging controls with a start_index of 2
It should send back a JSON response with:
- a response status of 200
- a head property of 'd'
- a link property that ends in '/state?head=d&min=2&count=2'
- paging that matches the response, with a previous link
- a data property that is a list of 2 dicts
- and those dicts are entries that match those received
"""
paging = Mocks.make_paging_response(2, 4)
entries = Mocks.make_entries(b=b'2', a=b'1')
self.connection.preset_response(head_id='d',
paging=paging,
entries=entries)
response = await self.get_assert_200('/state?min=2')
controls = Mocks.make_paging_controls(None, start_index=2)
self.connection.assert_valid_request_sent(paging=controls)
self.assert_has_valid_head(response, 'd')
self.assert_has_valid_link(response, '/state?head=d&min=2')
self.assert_has_valid_paging(
response, paging, previous_link='/state?head=d&min=0&count=2')
self.assert_has_valid_data_list(response, 2)
self.assert_entries_match(entries, response['data'])
async def test_state_list_paginated_with_just_count(self):
"""Verifies GET /state paginated just by count works properly.
It will receive a Protobuf response with:
- a head id of 'd'
- a paging response with a start of 0, and 4 total resources
- two entries of {'d': b'4'}, and {'c': b'3'}
It should send a Protobuf request with:
- a paging controls with a count of 2
It should send back a JSON response with:
- a response status of 200
- a head property of 'd'
- a link property that ends in '/state?head=d&min=0&count=2'
- paging that matches the response with a next link
- a data property that is a list of 2 dicts
- and those dicts are entries that match those received
"""
paging = Mocks.make_paging_response(0, 4)
entries = Mocks.make_entries(d=b'4', c=b'3')
self.connection.preset_response(head_id='d',
paging=paging,
entries=entries)
response = await self.get_assert_200('/state?count=2')
controls = Mocks.make_paging_controls(2)
self.connection.assert_valid_request_sent(paging=controls)
self.assert_has_valid_head(response, 'd')
self.assert_has_valid_link(response, '/state?head=d&count=2')
self.assert_has_valid_paging(response, paging,
'/state?head=d&min=2&count=2')
self.assert_has_valid_data_list(response, 2)
self.assert_entries_match(entries, response['data'])
async def test_state_list_sorted_by_many_keys(self):
"""Verifies a GET /state can send proper sort parameters.
It will receive a Protobuf response with:
- a head id of '2'
- a paging response with a start of 0, and 3 total resources
- three entries with addresses/data of:
* 'c': b'7'
* 'b': b'5'
* 'a': b'3'
It should send a Protobuf request with:
- empty paging controls
- multiple sort controls with:
* a key of 'address' that is reversed
* a key of 'value' that is sorted by length
It should send back a JSON response with:
- a status of 200
- a head property of '2'
- link with '/state?head=2&sort=-address,value.length'
- a paging property that matches the paging response
- a data property that is a list of 3 dicts
- three entries that match those in Protobuf response
"""
paging = Mocks.make_paging_response(0, 3)
entries = Mocks.make_entries(c=b'7', b=b'5', a=b'3')
self.connection.preset_response(state_root='beef',
paging=paging,
entries=entries)
self.connection.preset_response(
proto=client_block_pb2.ClientBlockGetResponse,
block=block_pb2.Block(
header_signature='2',
header=block_pb2.BlockHeader(
state_root_hash='beef').SerializeToString()))
response = await self.get_assert_200(
'/state?sort=-address,value.length')
page_controls = Mocks.make_paging_controls()
sorting = (Mocks.make_sort_controls('address', reverse=True) +
Mocks.make_sort_controls('value', compare_length=True))
self.connection.assert_valid_request_sent(state_root='beef',
paging=page_controls,
sorting=sorting)
self.assert_has_valid_head(response, '2')
self.assert_has_valid_link(response,
'/state?head=2&sort=-address,value.length')
self.assert_has_valid_paging(response, paging)
self.assert_has_valid_data_list(response, 3)
self.assert_entries_match(entries, response['data'])
async def test_state_list_sorted_in_reverse(self):
"""Verifies a GET /state can send proper sort parameters.
It will receive a Protobuf response with:
- a head id of ID_C
- a paging response with a start of c and limit of 100
- three entries with addresses/data of:
* 'c': b'7'
* 'b': b'5'
* 'a': b'3'
It should send a Protobuf request with:
- empty paging controls
- sort controls with a key of 'address' that is reversed
It should send back a JSON response with:
- a status of 200
- a head property of ID_C
- a link property ending in
'/state?head={}&start=c&limit=100&reverse'.format(ID_C)
- a paging property that matches the paging response
- a data property that is a list of 3 dicts
- three entries that match those in Protobuf response
"""
paging = Mocks.make_paging_response("", "c", DEFAULT_LIMIT)
entries = Mocks.make_entries(c=b'7', b=b'5', a=b'3')
self.connection.preset_response(state_root='beef',
paging=paging,
entries=entries)
self.connection.preset_response(
proto=client_block_pb2.ClientBlockGetResponse,
block=block_pb2.Block(
header_signature=ID_C,
header=block_pb2.BlockHeader(
state_root_hash='beef').SerializeToString()))
response = await self.get_assert_200('/state?reverse')
page_controls = Mocks.make_paging_controls()
sorting = Mocks.make_sort_controls('default', reverse=True)
self.connection.assert_valid_request_sent(state_root='beef',
paging=page_controls,
sorting=sorting)
self.assert_has_valid_head(response, ID_C)
self.assert_has_valid_link(
response, '/state?head={}&start=c&limit=100&reverse'.format(ID_C))
self.assert_has_valid_paging(response, paging)
self.assert_has_valid_data_list(response, 3)
self.assert_entries_match(entries, response['data'])
async def test_state_list_sorted_in_reverse(self):
"""Verifies a GET /state can send proper sort parameters.
It will receive a Protobuf response with:
- a head id of ID_C
- a paging response with a start of c and limit of 100
- three entries with addresses/data of:
* 'c': b'7'
* 'b': b'5'
* 'a': b'3'
It should send a Protobuf request with:
- empty paging controls
- sort controls with a key of 'address' that is reversed
It should send back a JSON response with:
- a status of 200
- a head property of ID_C
- a link property ending in
'/state?head={}&start=c&limit=100&reverse'.format(ID_C)
- a paging property that matches the paging response
- a data property that is a list of 3 dicts
- three entries that match those in Protobuf response
"""
paging = Mocks.make_paging_response("", "c", DEFAULT_LIMIT)
entries = Mocks.make_entries(c=b'7', b=b'5', a=b'3')
self.connection.preset_response(state_root='beef', paging=paging,
entries=entries)
self.connection.preset_response(
proto=client_block_pb2.ClientBlockGetResponse,
block=block_pb2.Block(
header_signature=ID_C,
header=block_pb2.BlockHeader(
state_root_hash='beef').SerializeToString()))
response = await self.get_assert_200('/state?reverse')
page_controls = Mocks.make_paging_controls()
sorting = Mocks.make_sort_controls('default', reverse=True)
self.connection.assert_valid_request_sent(
state_root='beef',
paging=page_controls,
sorting=sorting)
self.assert_has_valid_head(response, ID_C)
self.assert_has_valid_link(
response, '/state?head={}&start=c&limit=100&reverse'.format(ID_C))
self.assert_has_valid_paging(response, paging)
self.assert_has_valid_data_list(response, 3)
self.assert_entries_match(entries, response['data'])
async def test_state_list_with_head_and_address(self):
"""Verifies GET /state works with a head and filtered by address.
It will receive a Protobuf response with:
- a head id of ID_B
- a paging response with a start of a and a limit of 100
- one leaf with addresses/data of: 'a': b'2'
It should send a Protobuf request with:
- a head_id property of ID_B
- an address property of 'a'
- empty paging controls
It should send back a JSON response with:
- a response status of 200
- a head property of ID_B
- a link property that ends in
'/state?head={}&start=a&limit=100&address=a'.format(ID_B)
- a paging property that matches the paging response
- a data property that is a list of 1 leaf dict
- one leaf that matches the Protobuf response
"""
paging = Mocks.make_paging_response("", "a", DEFAULT_LIMIT)
entries = Mocks.make_entries(a=b'2')
self.connection.preset_response(state_root='beef',
paging=paging,
entries=entries)
self.connection.preset_response(
proto=client_block_pb2.ClientBlockGetResponse,
block=block_pb2.Block(
header_signature=ID_B,
header=block_pb2.BlockHeader(
state_root_hash='beef').SerializeToString()))
response = await self.get_assert_200(
'/state?address=a&head={}'.format(ID_B))
self.connection.assert_valid_request_sent(
state_root='beef',
address='a',
paging=Mocks.make_paging_controls())
self.assert_has_valid_head(response, ID_B)
self.assert_has_valid_link(
response,
'/state?head={}&start=a&limit=100&address=a'.format(ID_B))
self.assert_has_valid_paging(response, paging)
self.assert_has_valid_data_list(response, 1)
self.assert_entries_match(entries, response['data'])
async def test_state_list_paginated_by_max_id(self):
"""Verifies GET /state paginated by a max id works properly.
It will receive a Protobuf response with:
- a head id of 'd'
- a paging response with:
* a start_index of 1
* a total_resources of 4
* a previous_id of 'd'
* a next_id of 'a'
- two entries of {'c': b'3'} and {'b': b'3'}
It should send a Protobuf request with:
- a paging controls with a count of 2 and an end_id of 'b'
It should send back a JSON response with:
- a response status of 200
- a head property of 'd'
- a link property that ends in '/state?head=d&max=b&count=2'
- paging that matches the response, with next and previous links
- a data property that is a list of 2 dicts
- and those dicts are entries that match those received
"""
paging = Mocks.make_paging_response(1, 4, previous_id='d', next_id='a')
entries = Mocks.make_entries(c=b'3', b=b'2')
self.connection.preset_response(state_root='beef',
paging=paging,
entries=entries)
self.connection.preset_response(
proto=client_block_pb2.ClientBlockGetResponse,
block=block_pb2.Block(
header_signature='d',
header=block_pb2.BlockHeader(
state_root_hash='beef').SerializeToString()))
response = await self.get_assert_200('/state?max=b&count=2')
controls = Mocks.make_paging_controls(2, end_id='b')
self.connection.assert_valid_request_sent(state_root='beef',
paging=controls)
self.assert_has_valid_head(response, 'd')
self.assert_has_valid_link(response, '/state?head=d&max=b&count=2')
self.assert_has_valid_paging(response, paging,
'/state?head=d&min=a&count=2',
'/state?head=d&max=d&count=2')
self.assert_has_valid_data_list(response, 2)
self.assert_entries_match(entries, response['data'])
async def test_state_list_with_head_and_address(self):
"""Verifies GET /state works with a head and filtered by address.
It will receive a Protobuf response with:
- a head id of ID_B
- a paging response with a start of a and a limit of 100
- one leaf with addresses/data of: 'a': b'2'
It should send a Protobuf request with:
- a head_id property of ID_B
- an address property of 'a'
- empty paging controls
It should send back a JSON response with:
- a response status of 200
- a head property of ID_B
- a link property that ends in
'/state?head={}&start=a&limit=100&address=a'.format(ID_B)
- a paging property that matches the paging response
- a data property that is a list of 1 leaf dict
- one leaf that matches the Protobuf response
"""
paging = Mocks.make_paging_response("", "a", DEFAULT_LIMIT)
entries = Mocks.make_entries(a=b'2')
self.connection.preset_response(state_root='beef', paging=paging,
entries=entries)
self.connection.preset_response(
proto=client_block_pb2.ClientBlockGetResponse,
block=block_pb2.Block(
header_signature=ID_B,
header=block_pb2.BlockHeader(
state_root_hash='beef').SerializeToString()))
response = await self.get_assert_200(
'/state?address=a&head={}'.format(ID_B))
self.connection.assert_valid_request_sent(
state_root='beef',
address='a',
paging=Mocks.make_paging_controls())
self.assert_has_valid_head(response, ID_B)
self.assert_has_valid_link(
response,
'/state?head={}&start=a&limit=100&address=a'.format(ID_B))
self.assert_has_valid_paging(response, paging)
self.assert_has_valid_data_list(response, 1)
self.assert_entries_match(entries, response['data'])
async def test_state_list(self):
"""Verifies a GET /state without parameters works properly.
It will receive a Protobuf response with:
- a state root of ID_C
- a paging response with start of "a" and a limit of 100
- three entries with addresses/data of:
* 'a': b'3'
* 'b': b'5'
* 'c': b'7'
It should send a Protobuf request with:
- empty paging controls
It should send back a JSON response with:
- a response status of 200
- a head property of ID_C
- a link property that ends in
/state?head={}&start=a&limit=100'.format(ID_C)
- a paging property that matches the paging response
- a data property that is a list of 3 leaf dicts
- three entries that match those in Protobuf response
"""
paging = Mocks.make_paging_response("", "a", DEFAULT_LIMIT)
entries = Mocks.make_entries(a=b'3', b=b'5', c=b'7')
self.connection.preset_response(state_root='beef',
paging=paging,
entries=entries)
self.connection.preset_response(
proto=client_block_pb2.ClientBlockGetResponse,
block=block_pb2.Block(
header_signature=ID_C,
header=block_pb2.BlockHeader(
state_root_hash='beef').SerializeToString()))
response = await self.get_assert_200('/state')
controls = Mocks.make_paging_controls()
self.connection.assert_valid_request_sent(state_root='beef',
paging=controls)
self.assert_has_valid_head(response, ID_C)
self.assert_has_valid_link(
response, '/state?head={}&start=a&limit=100'.format(ID_C))
self.assert_has_valid_paging(response, paging)
self.assert_has_valid_data_list(response, 3)
self.assert_entries_match(entries, response['data'])
async def test_state_list(self):
"""Verifies a GET /state without parameters works properly.
It will receive a Protobuf response with:
- a state root of ID_C
- a paging response with start of "a" and a limit of 100
- three entries with addresses/data of:
* 'a': b'3'
* 'b': b'5'
* 'c': b'7'
It should send a Protobuf request with:
- empty paging controls
It should send back a JSON response with:
- a response status of 200
- a head property of ID_C
- a link property that ends in
/state?head={}&start=a&limit=100'.format(ID_C)
- a paging property that matches the paging response
- a data property that is a list of 3 leaf dicts
- three entries that match those in Protobuf response
"""
paging = Mocks.make_paging_response("", "a", DEFAULT_LIMIT)
entries = Mocks.make_entries(a=b'3', b=b'5', c=b'7')
self.connection.preset_response(state_root='beef', paging=paging,
entries=entries)
self.connection.preset_response(
proto=client_block_pb2.ClientBlockGetResponse,
block=block_pb2.Block(
header_signature=ID_C,
header=block_pb2.BlockHeader(
state_root_hash='beef').SerializeToString()))
response = await self.get_assert_200('/state')
controls = Mocks.make_paging_controls()
self.connection.assert_valid_request_sent(
state_root='beef', paging=controls)
self.assert_has_valid_head(response, ID_C)
self.assert_has_valid_link(
response, '/state?head={}&start=a&limit=100'.format(ID_C))
self.assert_has_valid_paging(response, paging)
self.assert_has_valid_data_list(response, 3)
self.assert_entries_match(entries, response['data'])
async def test_state_list_paginated_with_just_limit(self):
"""Verifies GET /state paginated just by limit works properly.
It will receive a Protobuf response with:
- a head id of ID_D
- a paging response with a start of d and limit of 2
- two entries of {ID_D: b'4'}, and {'c': b'3'}
It should send a Protobuf request with:
- a paging controls with a limit of 2
It should send back a JSON response with:
- a response status of 200
- a head property of ID_D
- a link property that ends in
'/state?head={}&start=d&limit=2'.format(ID_D)
- paging that matches the response with a next link
- a data property that is a list of 2 dicts
- and those dicts are entries that match those received
"""
paging = Mocks.make_paging_response("b", "d", 2)
entries = Mocks.make_entries(d=b'4', c=b'3')
self.connection.preset_response(state_root='beef',
paging=paging,
entries=entries)
self.connection.preset_response(
proto=client_block_pb2.ClientBlockGetResponse,
block=block_pb2.Block(
header_signature=ID_D,
header=block_pb2.BlockHeader(
state_root_hash='beef').SerializeToString()))
response = await self.get_assert_200('/state?limit=2')
controls = Mocks.make_paging_controls(2)
self.connection.assert_valid_request_sent(state_root='beef',
paging=controls)
self.assert_has_valid_head(response, ID_D)
self.assert_has_valid_link(
response, '/state?head={}&start=d&limit=2'.format(ID_D))
self.assert_has_valid_paging(
response, paging, '/state?head={}&start=b&limit=2'.format(ID_D))
self.assert_has_valid_data_list(response, 2)
self.assert_entries_match(entries, response['data'])
async def test_state_list_paginated(self):
"""Verifies GET /state paginated by works properly.
It will receive a Protobuf response with:
- a head id of ID_D
- a paging response with a start of 2
- one leaf of {'c': b'3'}
It should send a Protobuf request with:
- a paging controls with a limit of 1, and a start of 1
It should send back a JSON response with:
- a response status of 200
- a head property of ID_D
- a link property that ends in
'/state?head={}&start=c&limit=1'.format(ID_D)
- paging that matches the response, with next and previous links
- a data property that is a list of 1 dict
- and that dict is a leaf that matches the one received
"""
paging = Mocks.make_paging_response("b", "c", 1)
entries = Mocks.make_entries(c=b'3')
self.connection.preset_response(state_root='beef',
paging=paging,
entries=entries)
self.connection.preset_response(
proto=client_block_pb2.ClientBlockGetResponse,
block=block_pb2.Block(
header_signature=ID_D,
header=block_pb2.BlockHeader(
state_root_hash='beef').SerializeToString()))
response = await self.get_assert_200('/state?start=c&limit=1')
controls = Mocks.make_paging_controls(1, start="c")
self.connection.assert_valid_request_sent(state_root='beef',
paging=controls)
self.assert_has_valid_head(response, ID_D)
self.assert_has_valid_link(
response, '/state?head={}&start=c&limit=1'.format(ID_D))
self.assert_has_valid_paging(
response, paging, '/state?head={}&start=b&limit=1'.format(ID_D))
self.assert_has_valid_data_list(response, 1)
self.assert_entries_match(entries, response['data'])
async def test_state_list_with_address(self):
"""Verifies a GET /state works properly filtered by address.
It will receive a Protobuf response with:
- a head id of '2'
- a paging response with a start of 0, and 1 total resource
- one leaf with addresses/data of: 'c': b'7'
It should send a Protobuf request with:
- an address property of 'c'
- empty paging controls
It should send back a JSON response with:
- a response status of 200
- a head property of '2'
- a link property that ends in
'/state?head=2&min=0&count=1&address=c'
- a paging property that matches the paging response
- a data property that is a list of 1 leaf dict
- one leaf that matches the Protobuf response
"""
paging = Mocks.make_paging_response(0, 1)
entries = Mocks.make_entries(c=b'7')
self.connection.preset_response(state_root='beef',
paging=paging,
entries=entries)
self.connection.preset_response(
proto=client_block_pb2.ClientBlockGetResponse,
block=block_pb2.Block(
header_signature='2',
header=block_pb2.BlockHeader(
state_root_hash='beef').SerializeToString()))
response = await self.get_assert_200('/state?address=c')
controls = Mocks.make_paging_controls()
self.connection.assert_valid_request_sent(state_root='beef',
address='c',
paging=controls)
self.assert_has_valid_head(response, '2')
self.assert_has_valid_link(response, '/state?head=2&address=c')
self.assert_has_valid_paging(response, paging)
self.assert_has_valid_data_list(response, 1)
self.assert_entries_match(entries, response['data'])
async def test_state_list_with_head(self):
"""Verifies a GET /state works properly with head specified.
It will receive a Protobuf response with:
- a head id of '1'
- a paging response with a start of 0, and 2 total resources
- two entries with addresses/data of:
* 'a': b'2'
* 'b': b'4'
It should send a Protobuf request with:
- a head_id property of '1'
- empty paging controls
It should send back a JSON response with:
- a response status of 200
- a head property of '1'
- a link property that ends in '/state?head=1&min=0&count=2'
- a paging property that matches the paging response
- a data property that is a list of 2 leaf dicts
- three entries that match those in Protobuf response
"""
paging = Mocks.make_paging_response(0, 2)
entries = Mocks.make_entries(a=b'2', b=b'4')
self.connection.preset_response(state_root='beef',
paging=paging,
entries=entries)
self.connection.preset_response(
proto=client_block_pb2.ClientBlockGetResponse,
block=block_pb2.Block(
header_signature='1',
header=block_pb2.BlockHeader(
state_root_hash='beef').SerializeToString()))
response = await self.get_assert_200('/state?head=1')
controls = Mocks.make_paging_controls()
self.connection.assert_valid_request_sent(state_root='beef',
paging=controls)
self.assert_has_valid_head(response, '1')
self.assert_has_valid_link(response, '/state?head=1')
self.assert_has_valid_paging(response, paging)
self.assert_has_valid_data_list(response, 2)
self.assert_entries_match(entries, response['data'])
async def test_state_list_paginated_with_just_limit(self):
"""Verifies GET /state paginated just by limit works properly.
It will receive a Protobuf response with:
- a head id of ID_D
- a paging response with a start of d and limit of 2
- two entries of {ID_D: b'4'}, and {'c': b'3'}
It should send a Protobuf request with:
- a paging controls with a limit of 2
It should send back a JSON response with:
- a response status of 200
- a head property of ID_D
- a link property that ends in
'/state?head={}&start=d&limit=2'.format(ID_D)
- paging that matches the response with a next link
- a data property that is a list of 2 dicts
- and those dicts are entries that match those received
"""
paging = Mocks.make_paging_response("b", "d", 2)
entries = Mocks.make_entries(d=b'4', c=b'3')
self.connection.preset_response(state_root='beef', paging=paging,
entries=entries)
self.connection.preset_response(
proto=client_block_pb2.ClientBlockGetResponse,
block=block_pb2.Block(
header_signature=ID_D,
header=block_pb2.BlockHeader(
state_root_hash='beef').SerializeToString()))
response = await self.get_assert_200('/state?limit=2')
controls = Mocks.make_paging_controls(2)
self.connection.assert_valid_request_sent(
state_root='beef', paging=controls)
self.assert_has_valid_head(response, ID_D)
self.assert_has_valid_link(
response, '/state?head={}&start=d&limit=2'.format(ID_D))
self.assert_has_valid_paging(
response, paging, '/state?head={}&start=b&limit=2'.format(ID_D))
self.assert_has_valid_data_list(response, 2)
self.assert_entries_match(entries, response['data'])
async def test_state_list_paginated_by_start_id(self):
"""Verifies GET /state paginated by a start id works properly.
It will receive a Protobuf response with:
- a head id of ID_D
- a paging response with a start of c and limit of 5
- three entries of {'c': b'3'}, {'b': b'2'}, and {'a': b'1'}
It should send a Protobuf request with:
- a paging controls with a start_id of ID_C
It should send back a JSON response with:
- a response status of 200
- a head property of ID_D
- a link property that ends in
'/state?head={}&start=c&limit=5'.format(ID_D, ID_C)
- paging that matches the response, with a previous link
- a data property that is a list of 3 dicts
- and those dicts are entries that match those received
"""
paging = Mocks.make_paging_response("", "c", 5)
entries = Mocks.make_entries(c=b'3', b=b'2', a=b'1')
self.connection.preset_response(state_root='beef',
paging=paging,
entries=entries)
self.connection.preset_response(
proto=client_block_pb2.ClientBlockGetResponse,
block=block_pb2.Block(
header_signature=ID_D,
header=block_pb2.BlockHeader(
state_root_hash='beef').SerializeToString()))
response = await self.get_assert_200('/state?start=c&limit=5')
controls = Mocks.make_paging_controls(5, "c")
self.connection.assert_valid_request_sent(state_root='beef',
paging=controls)
self.assert_has_valid_head(response, ID_D)
self.assert_has_valid_link(
response, '/state?head={}&start=c&limit=5'.format(ID_D))
self.assert_has_valid_paging(response, paging)
self.assert_has_valid_data_list(response, 3)
self.assert_entries_match(entries, response['data'])
async def test_state_list_paginated(self):
"""Verifies GET /state paginated by works properly.
It will receive a Protobuf response with:
- a head id of ID_D
- a paging response with a start of 2
- one leaf of {'c': b'3'}
It should send a Protobuf request with:
- a paging controls with a limit of 1, and a start of 1
It should send back a JSON response with:
- a response status of 200
- a head property of ID_D
- a link property that ends in
'/state?head={}&start=c&limit=1'.format(ID_D)
- paging that matches the response, with next and previous links
- a data property that is a list of 1 dict
- and that dict is a leaf that matches the one received
"""
paging = Mocks.make_paging_response("b", "c", 1)
entries = Mocks.make_entries(c=b'3')
self.connection.preset_response(state_root='beef', paging=paging,
entries=entries)
self.connection.preset_response(
proto=client_block_pb2.ClientBlockGetResponse,
block=block_pb2.Block(
header_signature=ID_D,
header=block_pb2.BlockHeader(
state_root_hash='beef').SerializeToString()))
response = await self.get_assert_200('/state?start=c&limit=1')
controls = Mocks.make_paging_controls(1, start="c")
self.connection.assert_valid_request_sent(
state_root='beef', paging=controls)
self.assert_has_valid_head(response, ID_D)
self.assert_has_valid_link(
response, '/state?head={}&start=c&limit=1'.format(ID_D))
self.assert_has_valid_paging(
response, paging, '/state?head={}&start=b&limit=1'.format(ID_D))
self.assert_has_valid_data_list(response, 1)
self.assert_entries_match(entries, response['data'])
async def test_state_list_paginated_without_count(self):
"""Verifies GET /state paginated without count works properly.
It will receive a Protobuf response with:
- a head id of ID_D
- a paging response start of "b" and limit of 100
- two entries of {'b': b'2'} and {'a': b'1'}
It should send a Protobuf request with:
- a paging controls with a start of 2
It should send back a JSON response with:
- a response status of 200
- a head property of ID_D
- a link property that ends in
'/state?head={}&start=b&limit=100'.format(ID_D))
- paging that matches the response, with a previous link
- a data property that is a list of 2 dicts
- and those dicts are entries that match those received
"""
paging = Mocks.make_paging_response("", "b", DEFAULT_LIMIT)
entries = Mocks.make_entries(b=b'2', a=b'1')
self.connection.preset_response(state_root='beef',
paging=paging,
entries=entries)
self.connection.preset_response(
proto=client_block_pb2.ClientBlockGetResponse,
block=block_pb2.Block(
header_signature=ID_D,
header=block_pb2.BlockHeader(
state_root_hash='beef').SerializeToString()))
response = await self.get_assert_200('/state?start=2')
controls = Mocks.make_paging_controls(None, start="2")
self.connection.assert_valid_request_sent(state_root='beef',
paging=controls)
self.assert_has_valid_head(response, ID_D)
self.assert_has_valid_link(
response, '/state?head={}&start=b&limit=100'.format(ID_D))
self.assert_has_valid_paging(response, paging)
self.assert_has_valid_data_list(response, 2)
self.assert_entries_match(entries, response['data'])
async def test_state_list_paginated(self):
"""Verifies GET /state paginated by min id works properly.
It will receive a Protobuf response with:
- a head id of 'd'
- a paging response with a start of 1, and 4 total resources
- one leaf of {'c': b'3'}
It should send a Protobuf request with:
- a paging controls with a count of 1, and a start_index of 1
It should send back a JSON response with:
- a response status of 200
- a head property of 'd'
- a link property that ends in '/state?head=d&min=1&count=1'
- paging that matches the response, with next and previous links
- a data property that is a list of 1 dict
- and that dict is a leaf that matches the one received
"""
paging = Mocks.make_paging_response(1, 4)
entries = Mocks.make_entries(c=b'3')
self.connection.preset_response(state_root='beef',
paging=paging,
entries=entries)
self.connection.preset_response(
proto=client_block_pb2.ClientBlockGetResponse,
block=block_pb2.Block(
header_signature='d',
header=block_pb2.BlockHeader(
state_root_hash='beef').SerializeToString()))
response = await self.get_assert_200('/state?min=1&count=1')
controls = Mocks.make_paging_controls(1, start_index=1)
self.connection.assert_valid_request_sent(state_root='beef',
paging=controls)
self.assert_has_valid_head(response, 'd')
self.assert_has_valid_link(response, '/state?head=d&min=1&count=1')
self.assert_has_valid_paging(response, paging,
'/state?head=d&min=2&count=1',
'/state?head=d&min=0&count=1')
self.assert_has_valid_data_list(response, 1)
self.assert_entries_match(entries, response['data'])
async def test_state_list_paginated_by_start_id(self):
"""Verifies GET /state paginated by a start id works properly.
It will receive a Protobuf response with:
- a head id of ID_D
- a paging response with a start of c and limit of 5
- three entries of {'c': b'3'}, {'b': b'2'}, and {'a': b'1'}
It should send a Protobuf request with:
- a paging controls with a start_id of ID_C
It should send back a JSON response with:
- a response status of 200
- a head property of ID_D
- a link property that ends in
'/state?head={}&start=c&limit=5'.format(ID_D, ID_C)
- paging that matches the response, with a previous link
- a data property that is a list of 3 dicts
- and those dicts are entries that match those received
"""
paging = Mocks.make_paging_response("", "c", 5)
entries = Mocks.make_entries(c=b'3', b=b'2', a=b'1')
self.connection.preset_response(state_root='beef', paging=paging,
entries=entries)
self.connection.preset_response(
proto=client_block_pb2.ClientBlockGetResponse,
block=block_pb2.Block(
header_signature=ID_D,
header=block_pb2.BlockHeader(
state_root_hash='beef').SerializeToString()))
response = await self.get_assert_200('/state?start=c&limit=5')
controls = Mocks.make_paging_controls(5, "c")
self.connection.assert_valid_request_sent(
state_root='beef', paging=controls)
self.assert_has_valid_head(response, ID_D)
self.assert_has_valid_link(
response, '/state?head={}&start=c&limit=5'.format(ID_D))
self.assert_has_valid_paging(response, paging)
self.assert_has_valid_data_list(response, 3)
self.assert_entries_match(entries, response['data'])
async def test_state_list_paginated_without_count(self):
"""Verifies GET /state paginated without count works properly.
It will receive a Protobuf response with:
- a head id of ID_D
- a paging response start of "b" and limit of 100
- two entries of {'b': b'2'} and {'a': b'1'}
It should send a Protobuf request with:
- a paging controls with a start of 2
It should send back a JSON response with:
- a response status of 200
- a head property of ID_D
- a link property that ends in
'/state?head={}&start=b&limit=100'.format(ID_D))
- paging that matches the response, with a previous link
- a data property that is a list of 2 dicts
- and those dicts are entries that match those received
"""
paging = Mocks.make_paging_response("", "b", DEFAULT_LIMIT)
entries = Mocks.make_entries(b=b'2', a=b'1')
self.connection.preset_response(state_root='beef', paging=paging,
entries=entries)
self.connection.preset_response(
proto=client_block_pb2.ClientBlockGetResponse,
block=block_pb2.Block(
header_signature=ID_D,
header=block_pb2.BlockHeader(
state_root_hash='beef').SerializeToString()))
response = await self.get_assert_200('/state?start=2')
controls = Mocks.make_paging_controls(None, start="2")
self.connection.assert_valid_request_sent(
state_root='beef', paging=controls)
self.assert_has_valid_head(response, ID_D)
self.assert_has_valid_link(
response, '/state?head={}&start=b&limit=100'.format(ID_D))
self.assert_has_valid_paging(response, paging)
self.assert_has_valid_data_list(response, 2)
self.assert_entries_match(entries, response['data'])
async def test_state_list_sorted_by_length(self):
"""Verifies a GET /state can send proper sort parameters.
It will receive a Protobuf response with:
- a head id of '2'
- a paging response with a start of 0, and 3 total resources
- three entries with addresses/data of:
* 'c': b'7'
* 'b': b'45'
* 'a': b'123'
It should send a Protobuf request with:
- empty paging controls
- sort controls with a key of 'value' sorted by length
It should send back a JSON response with:
- a status of 200
- a head property of '2'
- a link property ending in '/state?head=2&sort=value.length'
- a paging property that matches the paging response
- a data property that is a list of 3 dicts
- three entries that match those in Protobuf response
"""
paging = Mocks.make_paging_response(0, 3)
entries = Mocks.make_entries(c=b'7', b=b'45', a=b'123')
self.connection.preset_response(head_id='2',
paging=paging,
entries=entries)
response = await self.get_assert_200('/state?sort=value.length')
page_controls = Mocks.make_paging_controls()
sorting = Mocks.make_sort_controls('value', compare_length=True)
self.connection.assert_valid_request_sent(paging=page_controls,
sorting=sorting)
self.assert_has_valid_head(response, '2')
self.assert_has_valid_link(response, '/state?head=2&sort=value.length')
self.assert_has_valid_paging(response, paging)
self.assert_has_valid_data_list(response, 3)
self.assert_entries_match(entries, response['data'])
async def test_state_list_paginated_by_min_id(self):
"""Verifies GET /state paginated by a min id works properly.
It will receive a Protobuf response with:
- a head id of 'd'
- a paging response with:
* a start_index of 1
* total_resources of 4
* a previous_id of 'd'
- three entries of {'c': b'3'}, {'b': b'2'}, and {'a': b'1'}
It should send a Protobuf request with:
- a paging controls with a start_id of 'c'
It should send back a JSON response with:
- a response status of 200
- a head property of 'd'
- a link property that ends in '/state?head=d&min=c&count=5'
- paging that matches the response, with a previous link
- a data property that is a list of 3 dicts
- and those dicts are entries that match those received
"""
paging = Mocks.make_paging_response(1, 4, previous_id='d')
entries = Mocks.make_entries(c=b'3', b=b'2', a=b'1')
self.connection.preset_response(head_id='d',
paging=paging,
entries=entries)
response = await self.get_assert_200('/state?min=c&count=5')
controls = Mocks.make_paging_controls(5, start_id='c')
self.connection.assert_valid_request_sent(paging=controls)
self.assert_has_valid_head(response, 'd')
self.assert_has_valid_link(response, '/state?head=d&min=c&count=5')
self.assert_has_valid_paging(
response, paging, previous_link='/state?head=d&max=d&count=5')
self.assert_has_valid_data_list(response, 3)
self.assert_entries_match(entries, response['data'])
async def test_state_list_with_head_and_address(self):
"""Verifies GET /state works with a head and filtered by address.
It will receive a Protobuf response with:
- a head id of '1'
- a paging response with a start of 0, and 1 total resource
- one leaf with addresses/data of: 'a': b'2'
It should send a Protobuf request with:
- a head_id property of '1'
- an address property of 'a'
- empty paging controls
It should send back a JSON response with:
- a response status of 200
- a head property of '1'
- a link property that ends in
'/state?head=1&min=0&count=1&address=a'
- a paging property that matches the paging response
- a data property that is a list of 1 leaf dict
- one leaf that matches the Protobuf response
"""
paging = Mocks.make_paging_response(0, 1)
entries = Mocks.make_entries(a=b'2')
self.connection.preset_response(head_id='1',
paging=paging,
entries=entries)
response = await self.get_assert_200('/state?address=a&head=1')
self.connection.assert_valid_request_sent(
head_id='1', address='a', paging=Mocks.make_paging_controls())
self.assert_has_valid_head(response, '1')
self.assert_has_valid_link(response, '/state?head=1&address=a')
self.assert_has_valid_paging(response, paging)
self.assert_has_valid_data_list(response, 1)
self.assert_entries_match(entries, response['data'])
async def test_state_list(self):
"""Verifies a GET /state without parameters works properly.
It will receive a Protobuf response with:
- a head id of '2'
- a paging response with a start of 0, and 3 total resources
- three entries with addresses/data of:
* 'a': b'3'
* 'b': b'5'
* 'c': b'7'
It should send a Protobuf request with:
- empty paging controls
It should send back a JSON response with:
- a response status of 200
- a head property of '2'
- a link property that ends in '/state?head=2&min=0&count=3'
- a paging property that matches the paging response
- a data property that is a list of 3 leaf dicts
- three entries that match those in Protobuf response
"""
paging = Mocks.make_paging_response(0, 3)
entries = Mocks.make_entries(a=b'3', b=b'5', c=b'7')
self.connection.preset_response(head_id='2',
paging=paging,
entries=entries)
response = await self.get_assert_200('/state')
controls = Mocks.make_paging_controls()
self.connection.assert_valid_request_sent(paging=controls)
self.assert_has_valid_head(response, '2')
self.assert_has_valid_link(response, '/state?head=2')
self.assert_has_valid_paging(response, paging)
self.assert_has_valid_data_list(response, 3)
self.assert_entries_match(entries, response['data'])
async def test_state_list_with_address(time=100):
"""Verifies a GET /state works properly filtered by address.
It will receive a Protobuf response with:
- a head id of ID_C
- an empty paging response
- one leaf with addresses/data of: 'c': b'7'
It should send a Protobuf request with:
- an address property of 'c'
- empty paging controls
It should send back a JSON response with:
- a response status of 200
- a head property of ID_C
- a link property that ends in
'/state?head={}&start=c&limit=100&address=c'.format(ID_C)
- a paging property that matches the paging response
- a data property that is a list of 1 leaf dict
- one leaf that matches the Protobuf response
"""
paging = Mocks.make_paging_response("", "c", DEFAULT_LIMIT)
entries = Mocks.make_entries(c=b'7')
stateListTests.connection.preset_response(state_root='beef', paging=paging,
entries=entries)
stateListTests.connection.preset_response(
proto=client_block_pb2.ClientBlockGetResponse,
block=block_pb2.Block(
header_signature=ID_C,
header=block_pb2.BlockHeader(
state_root_hash='beef').SerializeToString()))
for _ in range(time):
response = await stateListTests.get_assert_200('/state?address=c')
print(response)
