339 lines
11 KiB
Python
339 lines
11 KiB
Python
#!/usr/bin/python3
|
|
|
|
import base64
|
|
from datetime import datetime
|
|
import json
|
|
import os
|
|
import re
|
|
import random
|
|
import uuid
|
|
import docker
|
|
import base58
|
|
|
|
from neo3 import wallet
|
|
from common import (NEOFS_NETMAP, WALLET_PASS, NEOFS_ENDPOINT,
|
|
NEOFS_NETMAP_DICT, ASSETS_DIR)
|
|
from cli_helpers import _cmd_run
|
|
import json_transformers
|
|
from robot.api.deco import keyword
|
|
from robot.api import logger
|
|
|
|
ROBOT_AUTO_KEYWORDS = False
|
|
|
|
# path to neofs-cli executable
|
|
NEOFS_CLI_EXEC = os.getenv('NEOFS_CLI_EXEC', 'neofs-cli')
|
|
|
|
|
|
# TODO: move to neofs-keywords
|
|
@keyword('Get ScriptHash')
|
|
def get_scripthash(wif: str):
|
|
acc = wallet.Account.from_wif(wif, '')
|
|
return str(acc.script_hash)
|
|
|
|
|
|
@keyword('Stop nodes')
|
|
def stop_nodes(down_num: int, *nodes_list):
|
|
|
|
# select nodes to stop from list
|
|
nodes = random.sample(nodes_list, down_num)
|
|
|
|
for node in nodes:
|
|
m = re.search(r'(s\d+).', node)
|
|
node = m.group(1)
|
|
|
|
client = docker.APIClient()
|
|
client.stop(node)
|
|
|
|
return stop_nodes
|
|
|
|
|
|
@keyword('Start nodes')
|
|
def start_nodes(*nodes_list):
|
|
|
|
for node in nodes_list:
|
|
m = re.search(r'(s\d+).', node)
|
|
node = m.group(1)
|
|
client = docker.APIClient()
|
|
client.start(node)
|
|
|
|
|
|
@keyword('Get nodes with object')
|
|
def get_nodes_with_object(wallet: str, cid: str, oid: str):
|
|
|
|
nodes_list = []
|
|
|
|
for node in NEOFS_NETMAP:
|
|
res = _search_object(node, wallet, cid, oid)
|
|
if res:
|
|
if oid in res:
|
|
nodes_list.append(node)
|
|
|
|
logger.info(f"Nodes with object: {nodes_list}")
|
|
return nodes_list
|
|
|
|
|
|
@keyword('Get nodes without object')
|
|
def get_nodes_without_object(wallet: str, cid: str, oid: str):
|
|
|
|
nodes_list = []
|
|
|
|
for node in NEOFS_NETMAP:
|
|
search_res = _search_object(node, wallet, cid, oid)
|
|
if search_res:
|
|
if not re.search(fr'({oid})', search_res):
|
|
nodes_list.append(node)
|
|
else:
|
|
nodes_list.append(node)
|
|
|
|
logger.info(f"Nodes without object: {nodes_list}")
|
|
return nodes_list
|
|
|
|
|
|
@keyword('Validate storage policy for object')
|
|
def validate_storage_policy_for_object(wallet: str, expected_copies: int, cid, oid,
|
|
expected_node_list=[], storage_nodes=[]):
|
|
storage_nodes = storage_nodes if len(storage_nodes) != 0 else NEOFS_NETMAP
|
|
copies = 0
|
|
found_nodes = []
|
|
oid = oid.strip()
|
|
|
|
for node in storage_nodes:
|
|
res = _search_object(node, wallet, cid, oid)
|
|
if res:
|
|
if oid in res:
|
|
copies += 1
|
|
found_nodes.append(node)
|
|
|
|
if copies != expected_copies:
|
|
raise Exception("Object copies is not match storage policy."
|
|
f"Found: {copies}, expected: {expected_copies}.")
|
|
else:
|
|
logger.info(f"Found copies: {copies}, expected: {expected_copies}")
|
|
|
|
logger.info(f"Found nodes: {found_nodes}")
|
|
|
|
if expected_node_list:
|
|
if sorted(found_nodes) == sorted(expected_node_list):
|
|
logger.info(f"Found node list '{found_nodes}' "
|
|
f"is equal for expected list '{expected_node_list}'")
|
|
else:
|
|
raise Exception(f"Found node list '{found_nodes}' "
|
|
f"is not equal to expected list '{expected_node_list}'")
|
|
|
|
|
|
@keyword('Verify Head Tombstone')
|
|
def verify_head_tombstone(wallet: str, cid: str, oid_ts: str, oid: str, addr: str):
|
|
# TODO: replace with HEAD from neofs_verbs.py
|
|
object_cmd = (
|
|
f'{NEOFS_CLI_EXEC} --rpc-endpoint {NEOFS_ENDPOINT} --wallet {wallet} '
|
|
f'--config {WALLET_PASS} object head --cid {cid} --oid {oid_ts} --json'
|
|
)
|
|
output = _cmd_run(object_cmd)
|
|
full_headers = json.loads(output)
|
|
logger.info(f"Output: {full_headers}")
|
|
|
|
# Header verification
|
|
header_cid = full_headers["header"]["containerID"]["value"]
|
|
if json_transformers.json_reencode(header_cid) == cid:
|
|
logger.info(f"Header CID is expected: {cid} ({header_cid} in the output)")
|
|
else:
|
|
raise Exception("Header CID is not expected.")
|
|
|
|
header_owner = full_headers["header"]["ownerID"]["value"]
|
|
if json_transformers.json_reencode(header_owner) == addr:
|
|
logger.info(f"Header ownerID is expected: {addr} ({header_owner} in the output)")
|
|
else:
|
|
raise Exception("Header ownerID is not expected.")
|
|
|
|
header_type = full_headers["header"]["objectType"]
|
|
if header_type == "TOMBSTONE":
|
|
logger.info(f"Header Type is expected: {header_type}")
|
|
else:
|
|
raise Exception("Header Type is not expected.")
|
|
|
|
header_session_type = full_headers["header"]["sessionToken"]["body"]["object"]["verb"]
|
|
if header_session_type == "DELETE":
|
|
logger.info(f"Header Session Type is expected: {header_session_type}")
|
|
else:
|
|
raise Exception("Header Session Type is not expected.")
|
|
|
|
header_session_cid = full_headers["header"]["sessionToken"]["body"]["object"]["address"]["containerID"]["value"]
|
|
if json_transformers.json_reencode(header_session_cid) == cid:
|
|
logger.info(f"Header ownerID is expected: {addr} ({header_session_cid} in the output)")
|
|
else:
|
|
raise Exception("Header Session CID is not expected.")
|
|
|
|
header_session_oid = full_headers["header"]["sessionToken"]["body"]["object"]["address"]["objectID"]["value"]
|
|
if json_transformers.json_reencode(header_session_oid) == oid:
|
|
logger.info(f"Header Session OID (deleted object) is expected: {oid} ({header_session_oid} in the output)")
|
|
else:
|
|
raise Exception("Header Session OID (deleted object) is not expected.")
|
|
|
|
|
|
@keyword('Get control endpoint with wif')
|
|
def get_control_endpoint_with_wif(endpoint_number: str = ''):
|
|
if endpoint_number == '':
|
|
netmap = []
|
|
for key in NEOFS_NETMAP_DICT.keys():
|
|
netmap.append(key)
|
|
endpoint_num = random.sample(netmap, 1)[0]
|
|
logger.info(f'Random node chosen: {endpoint_num}')
|
|
else:
|
|
endpoint_num = endpoint_number
|
|
|
|
endpoint_values = NEOFS_NETMAP_DICT[f'{endpoint_num}']
|
|
endpoint_control = endpoint_values['control']
|
|
wif = endpoint_values['wif']
|
|
|
|
return endpoint_num, endpoint_control, wif
|
|
|
|
|
|
@keyword('Get Locode')
|
|
def get_locode():
|
|
endpoint_values = random.choice(list(NEOFS_NETMAP_DICT.values()))
|
|
locode = endpoint_values['UN-LOCODE']
|
|
logger.info(f'Random locode chosen: {locode}')
|
|
|
|
return locode
|
|
|
|
|
|
@keyword('Get Nodes Log Latest Timestamp')
|
|
def get_logs_latest_timestamp():
|
|
"""
|
|
Keyword return:
|
|
nodes_logs_time -- structure (dict) of nodes container name (key) and latest logs timestamp (value)
|
|
"""
|
|
client_api = docker.APIClient()
|
|
|
|
nodes_logs_time = dict()
|
|
|
|
for node in NEOFS_NETMAP:
|
|
container = node.split('.')[0]
|
|
log_line = client_api.logs(container, tail=1)
|
|
|
|
m = re.search(r'(\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d+Z)', str(log_line))
|
|
if m != None:
|
|
timestamp = m.group(1)
|
|
|
|
timestamp_date = datetime.fromisoformat(timestamp[:-1])
|
|
|
|
nodes_logs_time[container] = timestamp_date
|
|
|
|
logger.info(f"Latest logs timestamp list: {nodes_logs_time}")
|
|
|
|
return nodes_logs_time
|
|
|
|
|
|
@keyword('Find in Nodes Log')
|
|
def find_in_nodes_log(line: str, nodes_logs_time: dict):
|
|
|
|
client_api = docker.APIClient()
|
|
container_names = list()
|
|
|
|
for docker_container in client_api.containers():
|
|
container_names.append(docker_container['Names'][0][1:])
|
|
|
|
global_count = 0
|
|
|
|
for container in nodes_logs_time.keys():
|
|
# check if container exists
|
|
if container in container_names:
|
|
# Get log since timestamp
|
|
timestamp_date = nodes_logs_time[container]
|
|
log_lines = client_api.logs(container, since=timestamp_date)
|
|
logger.info(f"Timestamp since: {timestamp_date}")
|
|
found_count = len(re.findall(line, log_lines.decode("utf-8") ))
|
|
logger.info(f"Node {container} log - found counter: {found_count}")
|
|
global_count += found_count
|
|
|
|
else:
|
|
logger.info(f"Container {container} has not been found.")
|
|
|
|
if global_count > 0:
|
|
logger.info(f"Expected line '{line}' has been found in the logs.")
|
|
else:
|
|
raise Exception(f"Expected line '{line}' has not been found in the logs.")
|
|
|
|
return 1
|
|
|
|
|
|
@keyword('Generate Session Token')
|
|
def generate_session_token(owner: str, pub_key: str, cid: str = "", wildcard: bool = False) -> str:
|
|
|
|
file_path = f"{os.getcwd()}/{ASSETS_DIR}/{str(uuid.uuid4())}"
|
|
|
|
owner_64 = base64.b64encode(base58.b58decode(owner)).decode('utf-8')
|
|
cid_64 = base64.b64encode(cid.encode('utf-8')).decode('utf-8')
|
|
pub_key_64 = base64.b64encode(bytes.fromhex(pub_key)).decode('utf-8')
|
|
id_64 = base64.b64encode(uuid.uuid4().bytes).decode('utf-8')
|
|
|
|
session_token = {
|
|
"body":{
|
|
"id":f"{id_64}",
|
|
"ownerID":{
|
|
"value":f"{owner_64}"
|
|
},
|
|
"lifetime":{
|
|
"exp":"100000000",
|
|
"nbf":"0",
|
|
"iat":"0"
|
|
},
|
|
"sessionKey":f"{pub_key_64}",
|
|
"container":{
|
|
"verb":"PUT",
|
|
"wildcard": wildcard,
|
|
**({ "containerID":{"value":f"{cid_64}"} } if not wildcard else {})
|
|
}
|
|
}
|
|
}
|
|
|
|
logger.info(f"Got this Session Token: {session_token}")
|
|
|
|
with open(file_path, 'w', encoding='utf-8') as session_token_file:
|
|
json.dump(session_token, session_token_file, ensure_ascii=False, indent=4)
|
|
|
|
return file_path
|
|
|
|
|
|
@keyword ('Sign Session Token')
|
|
def sign_session_token(session_token: str, wallet: str, to_file: str=''):
|
|
if to_file:
|
|
to_file = f'--to {to_file}'
|
|
cmd = (
|
|
f'{NEOFS_CLI_EXEC} util sign session-token --from {session_token} '
|
|
f'-w {wallet} {to_file} --config {WALLET_PASS}'
|
|
)
|
|
logger.info(f"cmd: {cmd}")
|
|
_cmd_run(cmd)
|
|
|
|
|
|
def _parse_oid(input_str: str):
|
|
"""
|
|
This function parses OID from given CLI output. The input string we
|
|
expect:
|
|
Object successfully stored
|
|
ID: 4MhrLA7RXTBXCsaNnbahYVAPuoQdiUPuyNEWnywvoSEs
|
|
CID: HeZu2DXBuPve6HXbuHZx64knS7KcGtfSj2L59Li72kkg
|
|
We want to take 'ID' value from the string.
|
|
|
|
Parameters:
|
|
- input_str: a string with command run output
|
|
"""
|
|
try:
|
|
# taking second string from command output
|
|
snd_str = input_str.split('\n')[1]
|
|
except:
|
|
logger.error(f"Got empty input: {input_str}")
|
|
splitted = snd_str.split(": ")
|
|
if len(splitted) != 2:
|
|
raise Exception(f"no OID was parsed from command output: \t{snd_str}")
|
|
return splitted[1]
|
|
|
|
|
|
def _search_object(node:str, wallet: str, cid:str, oid: str):
|
|
cmd = (
|
|
f'{NEOFS_CLI_EXEC} --rpc-endpoint {node} --wallet {wallet} --ttl 1 '
|
|
f'object search --root --cid {cid} --oid {oid} --config {WALLET_PASS}'
|
|
)
|
|
output = _cmd_run(cmd)
|
|
return output
|