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

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

robot/resources/lib/python_keywords/container.py

@@ -0,0 +1,158 @@
+#!/usr/bin/python3
+
+"""
+    This module contains keywords which utilize `neofs-cli container`
+    commands.
+"""
+
+import json
+import time
+
+from common import NEOFS_ENDPOINT, COMMON_PLACEMENT_RULE, NEOFS_CLI_EXEC, WALLET_PASS
+from cli_helpers import _cmd_run
+from data_formatters import dict_to_attrs
+
+from robot.api.deco import keyword
+from robot.api import logger
+
+
+ROBOT_AUTO_KEYWORDS = False
+
+
+@keyword('Create Container')
+def create_container(wallet: str, rule: str=COMMON_PLACEMENT_RULE, basic_acl: str='',
+        attributes: dict={}, session_token: str='', session_wallet: str='',
+        options: str=''):
+    """
+        A wrapper for `neofs-cli container create` call.
+
+        Args:
+            wallet (str): a wallet on whose behalf a container is created
+            rule (optional, str): placement rule for container
+            basic_acl (optional, str): an ACL for container, will be
+                                appended to `--basic-acl` key
+            attributes (optional, dict): container attributes , will be
+                                appended to `--attributes` key
+            session_token (optional, str): a path to session token file
+            session_wallet(optional, str): a path to the wallet which signed
+                                the session token; this parameter makes sense
+                                when paired with `session_token`
+            options (optional, str): any other options to pass to the call
+
+        Returns:
+            (str): CID of the created container
+    """
+
+    cmd = (
+        f'{NEOFS_CLI_EXEC} --rpc-endpoint {NEOFS_ENDPOINT} container create '
+        f'--wallet {session_wallet if session_wallet else wallet} '
+        f'--config {WALLET_PASS} --policy "{rule}" '
+        f'{"--basic-acl " + basic_acl if basic_acl else ""} '
+        f'{"--attributes " + dict_to_attrs(attributes) if attributes else ""} '
+        f'{"--session " + session_token if session_token else ""} '
+        f'{options} --await'
+    )
+    output = _cmd_run(cmd, timeout=60)
+    cid = _parse_cid(output)
+
+    logger.info("Container created; waiting until it is persisted in sidechain")
+
+    deadline_to_persist = 15 # seconds
+    for i in range(0, deadline_to_persist):
+        time.sleep(1)
+        containers = list_containers(wallet)
+        if cid in containers:
+            break
+        logger.info(f"There is no {cid} in {containers} yet; continue")
+        if i+1 == deadline_to_persist:
+            raise RuntimeError(
+                            f"After {deadline_to_persist} seconds the container "
+                            f"{cid} hasn't been persisted; exiting"
+                        )
+    return cid
+
+
+@keyword('List Containers')
+def list_containers(wallet: str):
+    """
+        A wrapper for `neofs-cli container list` call. It returns all the
+        available containers for the given wallet.
+        Args:
+            wallet (str): a wallet on whose behalf we list the containers
+        Returns:
+            (list): list of containers
+    """
+    cmd = (
+        f'{NEOFS_CLI_EXEC} --rpc-endpoint {NEOFS_ENDPOINT} --wallet {wallet} '
+        f'--config {WALLET_PASS} container list'
+    )
+    output = _cmd_run(cmd)
+    return output.split()
+
+
+@keyword('Get Container Attributes')
+def get_container_attributes(wallet: str, cid: str):
+    """
+        A wrapper for `neofs-cli container get` call. It extracts
+        container attributes and rearranges them to more compact view.
+        Args:
+            wallet (str): a wallet on whose behalf we get the container
+            cid (str): ID of the container to get
+        Returns:
+            (dict): dict of container attributes
+    """
+    cmd = (
+        f'{NEOFS_CLI_EXEC} --rpc-endpoint {NEOFS_ENDPOINT} --wallet {wallet} '
+        f'--config {WALLET_PASS} --cid {cid} container get --json'
+    )
+    output = _cmd_run(cmd)
+    container_info = json.loads(output)
+    attributes = dict()
+    for attr in container_info['attributes']:
+        attributes[attr['key']] = attr['value']
+    return attributes
+
+
+@keyword('Delete Container')
+# TODO: make the error message about a non-found container more user-friendly
+# https://github.com/nspcc-dev/neofs-contract/issues/121
+def delete_container(wallet: str, cid: str):
+    """
+        A wrapper for `neofs-cli container delete` call.
+        Args:
+            wallet (str): a wallet on whose behalf we delete the container
+            cid (str): ID of the container to delete
+        This function doesn't return anything.
+    """
+
+    cmd = (
+        f'{NEOFS_CLI_EXEC} --rpc-endpoint {NEOFS_ENDPOINT} --wallet {wallet} '
+        f'--config {WALLET_PASS} container delete --cid {cid}'
+    )
+    _cmd_run(cmd)
+
+
+def _parse_cid(ouptut: str):
+    """
+    This function parses CID from given CLI output. The input string we
+    expect:
+            container ID: 2tz86kVTDpJxWHrhw3h6PbKMwkLtBEwoqhHQCKTre1FN
+            awaiting...
+            container has been persisted on sidechain
+    We want to take 'container ID' value from the string.
+
+    Args:
+        ouptut (str): a command run output
+
+    Returns:
+        (str): extracted CID
+    """
+    try:
+        # taking first string from command output
+        fst_str = ouptut.split('\n')[0]
+    except Exception:
+        logger.error(f"Got empty output: {ouptut}")
+    splitted = fst_str.split(": ")
+    if len(splitted) != 2:
+        raise ValueError(f"no CID was parsed from command output: \t{fst_str}")
+    return splitted[1]