tools: Add a script for deploying Allure reports to NeoFS

Added a script for deploy Allure tests result as static
web page to NeoFS.
All zip archives with logs are stored as different objects.
This script is planned to be used in GitHub actions.

This new functionality will help to save any test report as an
object in the NeoFS network, we will become independent of
the limitations of the GitHub branches and pages.

It will also be an "advertisement" for our object storage.

Signed-off-by: Oleg Kulachenko <[email protected]>

requirements.txt

@@ -57,4 +57,5 @@ tomli==2.0.1
 typing-extensions==4.2.0
 urllib3==1.26.9
 websocket-client==1.3.2
-yarl==1.7.2
+yarl==1.7.2
+allure-combine==1.0.8

tools/src/process-allure-reports.py

@@ -0,0 +1,101 @@
+import os
+import subprocess
+import argparse
+from allure_combine import combine_allure
+
+COMBINE_DIR = 'combine'
+COMPLETE_FILE_NAME = 'index.html'
+PUT_TIMEOUT = 600
+
+
+def parse_args():
+    parser = argparse.ArgumentParser(description='Process allure reports')
+    parser.add_argument('--neofs_node', required=True, type=str, help='NeoFS node')
+    parser.add_argument('--wallet', required=True, type=str, help='Path to the wallet')
+    parser.add_argument('--cid', required=True, type=str, help='Container ID')
+    parser.add_argument('--run_id', required=True, type=str, help='GitHub run ID')
+    parser.add_argument('--allure_report', type=str, help='Path to generated allure report directory',
+                        default='allure_report')
+    return parser.parse_args()
+
+
+def put_combine_result_as_static_page(directory: str, neofs_node: str, wallet: str, cid: str, run_id: str,
+                                      password: str) -> None:
+    base_cmd = (
+        f'NEOFS_CLI_PASSWORD={password} neofs-cli --rpc-endpoint st1.{neofs_node}:8080 '
+        f'--wallet {wallet}  object put --cid {cid} --timeout {PUT_TIMEOUT}s'
+    )
+
+    for subdir, dirs, files in os.walk(directory):
+        current_dir_name = os.path.basename(subdir)
+        for filename in files:
+            filepath = subdir + os.sep + filename
+            base_cmd_with_file = f'{base_cmd} --file {filepath}'
+            if filename == 'complete.html' and current_dir_name == COMBINE_DIR:
+                # allure_combine combines the Allure report and saves it as a static page under the name "complete.html"
+                # Later we will write a patch in allure_combine or fork it, but for now we will rename to "index.html"
+                filename = COMPLETE_FILE_NAME
+                object_cmd = f'{base_cmd_with_file} --attributes FilePath={run_id}/{filename} RunNumber={run_id}'
+            elif current_dir_name == 'attachments' and filename.endswith('.zip'):
+                # We save the logs archives as separate objects in order to make a static page small size.
+                # Without this, its size will be hundreds of megabytes.
+                object_cmd = (
+                    f'{base_cmd_with_file} --attributes FilePath={run_id}/data/{current_dir_name}/{filename} '
+                    f'RunNumber={run_id} ContentType=application/zip'
+                )
+            else:
+                # Unfortunately, for a static page, we can't collect all the test artifacts.
+                # So we do only archives with logs, other important data are contained in the static page.
+                continue
+
+            print(f'Cmd: {object_cmd}')
+
+            try:
+                compl_proc = subprocess.run(object_cmd, check=True, text=True,
+                                            stdout=subprocess.PIPE, stderr=subprocess.PIPE, timeout=PUT_TIMEOUT,
+                                            shell=True)
+
+                print(f'RC: {compl_proc.returncode}')
+                print(f'Output: {compl_proc.stdout}')
+                print(f'Error: {compl_proc.stderr}')
+
+            except subprocess.CalledProcessError as e:
+                raise Exception(
+                    f'Command failed: {e.cmd}\n'
+                    f'Error code: {e.returncode}\n'
+                    f'Output: {e.output}\n'
+                    f'Stdout: {e.stdout}\n'
+                    f'Stderr: {e.stderr}\n'
+                )
+
+
+def combine_report(allure_path: str) -> str:
+    combine_dir = os.path.join(os.getcwd(), COMBINE_DIR)
+    os.makedirs(combine_dir, exist_ok=True)
+
+    combine_allure(
+        allure_path,
+        dest_folder=combine_dir,
+        auto_create_folders=True,
+        remove_temp_files=True,
+        ignore_utf8_errors=True,
+    )
+
+    return combine_dir
+
+
+def get_password() -> str:
+    password = os.getenv('TEST_RESULTS_PASSWORD')
+    return password
+
+
+if __name__ == '__main__':
+    args = parse_args()
+    combine_path = combine_report(args.allure_report)
+    neofs_password = get_password()
+
+    put_combine_result_as_static_page(combine_path, args.neofs_node, args.wallet, args.cid, args.run_id, neofs_password)
+    put_combine_result_as_static_page(args.allure_report, args.neofs_node, args.wallet, args.cid, args.run_id,
+                                      neofs_password)
+
+    print(f'See report: https://http.{args.neofs_node}/{args.cid}/{args.run_id}/{COMPLETE_FILE_NAME}')