robot/resources/lib/python -> robot/resources/lib/python_keywords

Signed-off-by: anastasia prasolova <anastasia@nspcc.ru>

robot/resources/lib/python_keywords/storage_policy.py

@@ -0,0 +1,125 @@
+#!/usr/bin/python3
+
+'''
+    This module contains keywords which are used for asserting
+    that storage policies are kept.
+'''
+
+from common import NEOFS_NETMAP
+import complex_object_actions
+import neofs_verbs
+
+from robot.api.deco import keyword
+
+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:
+        response = neofs_verbs.head_object(wallet, cid, oid,
+                                endpoint=node,
+                                is_direct=True)
+        if response:
+            copies += 1
+    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):
+    """
+       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
+       Returns:
+            (list): nodes which store the object
+    """
+    nodes_list = []
+    for node in NEOFS_NETMAP:
+        res = neofs_verbs.head_object(wallet, cid, oid,
+                        endpoint=node,
+                        is_direct=True)
+        if res is not None:
+            nodes_list.append(node)
+    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:
+        res = neofs_verbs.head_object(wallet, cid, oid,
+                        endpoint=node,
+                        is_direct=True)
+        if res is None:
+            nodes_list.append(node)
+    return nodes_list