forked from TrueCloudLab/frostfs-testcases
169 lines
6.5 KiB
Python
169 lines
6.5 KiB
Python
#!/usr/bin/python3.9
|
|
|
|
"""
|
|
This module contains keywords that utilize `neofs-cli container` commands.
|
|
"""
|
|
|
|
import json
|
|
from time import sleep
|
|
from typing import Optional, Union
|
|
|
|
import json_transformers
|
|
from cli_utils import NeofsCli
|
|
from common import NEOFS_ENDPOINT, WALLET_CONFIG
|
|
from robot.api import logger
|
|
from robot.api.deco import keyword
|
|
|
|
ROBOT_AUTO_KEYWORDS = False
|
|
DEFAULT_PLACEMENT_RULE = "REP 2 IN X CBF 1 SELECT 4 FROM * AS X"
|
|
|
|
|
|
@keyword('Create Container')
|
|
def create_container(wallet: str, rule: str = DEFAULT_PLACEMENT_RULE, basic_acl: str = '',
|
|
attributes: Optional[dict] = None, session_token: str = '',
|
|
session_wallet: str = '', name: str = None, options: dict = None,
|
|
await_mode: bool = True, wait_for_creation: bool = True) -> 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, dict): any other options to pass to the call
|
|
name (optional, str): container name attribute
|
|
await_mode (bool): block execution until container is persisted
|
|
wait_for_creation (): Wait for container shows in container list
|
|
|
|
Returns:
|
|
(str): CID of the created container
|
|
"""
|
|
|
|
cli = NeofsCli(config=WALLET_CONFIG, timeout=60)
|
|
output = cli.container.create(rpc_endpoint=NEOFS_ENDPOINT, wallet=session_wallet if session_wallet else wallet,
|
|
policy=rule, basic_acl=basic_acl, attributes=attributes, name=name,
|
|
session=session_token, await_mode=await_mode, **options or {})
|
|
|
|
cid = _parse_cid(output)
|
|
|
|
logger.info("Container created; waiting until it is persisted in the sidechain")
|
|
|
|
if wait_for_creation:
|
|
wait_for_container_creation(wallet, cid)
|
|
|
|
return cid
|
|
|
|
|
|
def wait_for_container_creation(wallet: str, cid: str, attempts: int = 15, sleep_interval: int = 1):
|
|
for _ in range(attempts):
|
|
containers = list_containers(wallet)
|
|
if cid in containers:
|
|
return
|
|
logger.info(f"There is no {cid} in {containers} yet; sleep {sleep_interval} and continue")
|
|
sleep(sleep_interval)
|
|
raise RuntimeError(f"After {attempts * sleep_interval} seconds container {cid} hasn't been persisted; exiting")
|
|
|
|
|
|
def wait_for_container_deletion(wallet: str, cid: str, attempts: int = 30, sleep_interval: int = 1):
|
|
for _ in range(attempts):
|
|
try:
|
|
get_container(wallet, cid)
|
|
sleep(sleep_interval)
|
|
continue
|
|
except Exception as err:
|
|
if 'container not found' not in str(err):
|
|
raise AssertionError(f'Expected "container not found" in error, got\n{err}')
|
|
return
|
|
raise AssertionError(f'Expected container deleted during {attempts * sleep_interval} sec.')
|
|
|
|
|
|
@keyword('List Containers')
|
|
def list_containers(wallet: str) -> list[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
|
|
"""
|
|
cli = NeofsCli(config=WALLET_CONFIG)
|
|
output = cli.container.list(rpc_endpoint=NEOFS_ENDPOINT, wallet=wallet)
|
|
logger.info(f"Containers: \n{output}")
|
|
return output.split()
|
|
|
|
|
|
@keyword('Get Container')
|
|
def get_container(wallet: str, cid: str, json_mode: bool = True) -> Union[dict, str]:
|
|
"""
|
|
A wrapper for `neofs-cli container get` call. It extracts container's
|
|
attributes and rearranges them into a more compact view.
|
|
Args:
|
|
wallet (str): path to a wallet on whose behalf we get the container
|
|
cid (str): ID of the container to get
|
|
json_mode (bool): return container in JSON format
|
|
Returns:
|
|
(dict, str): dict of container attributes
|
|
"""
|
|
cli = NeofsCli(config=WALLET_CONFIG)
|
|
output = cli.container.get(rpc_endpoint=NEOFS_ENDPOINT, wallet=wallet, cid=cid, json_mode=json_mode)
|
|
|
|
if not json_mode:
|
|
return output
|
|
|
|
container_info = json.loads(output)
|
|
attributes = dict()
|
|
for attr in container_info['attributes']:
|
|
attributes[attr['key']] = attr['value']
|
|
container_info['attributes'] = attributes
|
|
container_info['ownerID'] = json_transformers.json_reencode(container_info['ownerID']['value'])
|
|
return container_info
|
|
|
|
|
|
@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, force: bool = False) -> None:
|
|
"""
|
|
A wrapper for `neofs-cli container delete` call.
|
|
Args:
|
|
wallet (str): path to a wallet on whose behalf we delete the container
|
|
cid (str): ID of the container to delete
|
|
force (bool): do not check whether container contains locks and remove immediately
|
|
This function doesn't return anything.
|
|
"""
|
|
|
|
cli = NeofsCli(config=WALLET_CONFIG)
|
|
cli.container.delete(wallet=wallet, cid=cid, rpc_endpoint=NEOFS_ENDPOINT, force=force)
|
|
|
|
|
|
def _parse_cid(output: str) -> str:
|
|
"""
|
|
Parses container ID from a 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:
|
|
output (str): CLI output to parse
|
|
|
|
Returns:
|
|
(str): extracted CID
|
|
"""
|
|
try:
|
|
# taking first line from command's output
|
|
first_line = output.split('\n')[0]
|
|
except Exception:
|
|
logger.error(f"Got empty output: {output}")
|
|
splitted = first_line.split(": ")
|
|
if len(splitted) != 2:
|
|
raise ValueError(f"no CID was parsed from command output: \t{first_line}")
|
|
return splitted[1]
|