149 lines
5.5 KiB
Python
149 lines
5.5 KiB
Python
#!/usr/bin/python3
|
|
|
|
"""
|
|
This module contains keywords which are used for asserting
|
|
that storage policies are kept.
|
|
"""
|
|
|
|
from typing import Optional
|
|
|
|
from robot.api import logger
|
|
from robot.api.deco import keyword
|
|
|
|
import complex_object_actions
|
|
import neofs_verbs
|
|
from common import NEOFS_NETMAP
|
|
|
|
ROBOT_AUTO_KEYWORDS = False
|
|
|
|
|
|
@keyword('Get Object Copies')
|
|
def get_object_copies(complexity: str, wallet: str, cid: str, oid: str):
|
|
"""
|
|
The function performs requests to all nodes of the container and
|
|
finds out if they store a copy of the object. The procedure is
|
|
different for simple and complex object, so the function requires
|
|
a sign of object complexity.
|
|
Args:
|
|
complexity (str): the tag of object size and complexity,
|
|
[Simple|Complex]
|
|
wallet (str): the path to the wallet on whose behalf the
|
|
copies are got
|
|
cid (str): ID of the container
|
|
oid (str): ID of the Object
|
|
Returns:
|
|
(int): the number of object copies in the container
|
|
"""
|
|
return (get_simple_object_copies(wallet, cid, oid) if complexity == "Simple"
|
|
else get_complex_object_copies(wallet, cid, oid))
|
|
|
|
|
|
@keyword('Get Simple Object Copies')
|
|
def get_simple_object_copies(wallet: str, cid: str, oid: str):
|
|
"""
|
|
To figure out the number of a simple object copies, only direct
|
|
HEAD requests should be made to the every node of the container.
|
|
We consider non-empty HEAD response as a stored object copy.
|
|
Args:
|
|
wallet (str): the path to the wallet on whose behalf the
|
|
copies are got
|
|
cid (str): ID of the container
|
|
oid (str): ID of the Object
|
|
Returns:
|
|
(int): the number of object copies in the container
|
|
"""
|
|
copies = 0
|
|
for node in NEOFS_NETMAP:
|
|
try:
|
|
response = neofs_verbs.head_object(wallet, cid, oid,
|
|
endpoint=node,
|
|
is_direct=True)
|
|
if response:
|
|
logger.info(f"Found object {oid} on node {node}")
|
|
copies += 1
|
|
except Exception:
|
|
logger.info(f"No {oid} object copy found on {node}, continue")
|
|
continue
|
|
return copies
|
|
|
|
|
|
@keyword('Get Complex Object Copies')
|
|
def get_complex_object_copies(wallet: str, cid: str, oid: str):
|
|
"""
|
|
To figure out the number of a complex object copies, we firstly
|
|
need to retrieve its Last object. We consider that the number of
|
|
complex object copies is equal to the number of its last object
|
|
copies. When we have the Last object ID, the task is reduced
|
|
to getting simple object copies.
|
|
Args:
|
|
wallet (str): the path to the wallet on whose behalf the
|
|
copies are got
|
|
cid (str): ID of the container
|
|
oid (str): ID of the Object
|
|
Returns:
|
|
(int): the number of object copies in the container
|
|
"""
|
|
last_oid = complex_object_actions.get_last_object(wallet, cid, oid)
|
|
return get_simple_object_copies(wallet, cid, last_oid)
|
|
|
|
|
|
@keyword('Get Nodes With Object')
|
|
def get_nodes_with_object(wallet: str, cid: str, oid: str, skip_nodes: Optional[list[str]] = None) -> list[str]:
|
|
"""
|
|
The function returns list of nodes which store
|
|
the given object.
|
|
Args:
|
|
wallet (str): the path to the wallet on whose behalf
|
|
we request the nodes
|
|
cid (str): ID of the container which store the object
|
|
oid (str): object ID
|
|
skip_nodes (list): list of nodes that should be excluded from check
|
|
Returns:
|
|
(list): nodes which store the object
|
|
"""
|
|
nodes_to_search = NEOFS_NETMAP
|
|
if skip_nodes:
|
|
nodes_to_search = [node for node in NEOFS_NETMAP if node not in skip_nodes]
|
|
|
|
nodes_list = []
|
|
for node in nodes_to_search:
|
|
try:
|
|
res = neofs_verbs.head_object(wallet, cid, oid,
|
|
endpoint=node,
|
|
is_direct=True)
|
|
if res is not None:
|
|
logger.info(f"Found object {oid} on node {node}")
|
|
nodes_list.append(node)
|
|
except Exception:
|
|
logger.info(f"No {oid} object copy found on {node}, continue")
|
|
continue
|
|
return nodes_list
|
|
|
|
|
|
@keyword('Get Nodes Without Object')
|
|
def get_nodes_without_object(wallet: str, cid: str, oid: str):
|
|
"""
|
|
The function returns list of nodes which do not store
|
|
the given object.
|
|
Args:
|
|
wallet (str): the path to the wallet on whose behalf
|
|
we request the nodes
|
|
cid (str): ID of the container which store the object
|
|
oid (str): object ID
|
|
Returns:
|
|
(list): nodes which do not store the object
|
|
"""
|
|
nodes_list = []
|
|
for node in NEOFS_NETMAP:
|
|
try:
|
|
res = neofs_verbs.head_object(wallet, cid, oid,
|
|
endpoint=node,
|
|
is_direct=True)
|
|
if res is None:
|
|
nodes_list.append(node)
|
|
except Exception as err:
|
|
if 'object not found' in str(err):
|
|
nodes_list.append(node)
|
|
else:
|
|
raise Exception(f'Got error {err} on head object command') from err
|
|
return nodes_list
|