Merge pull request #75 from davxy/reorg-stf-vectors

STF vectors reorg

Author: davxy

.github/workflows/ci.yml

@@ -15,7 +15,17 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        validator: [codec, accumulate, assurances, authorizations, disputes, history, preimages, reports, safrole, statistics]
+        validator:
+          - codec
+          - stf/accumulate
+          - stf/assurances
+          - stf/authorizations
+          - stf/disputes
+          - stf/history
+          - stf/preimages
+          - stf/reports
+          - stf/safrole
+          - stf/statistics
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -28,3 +38,4 @@ jobs:
           pip install git+https://github.com/davxy/asn1tools.git
       - name: Validate ${{ matrix.validator }}
         run: ./${{ matrix.validator }}/validate.py
+

CHANGELOG.md

@@ -0,0 +1,67 @@
+#!/usr/bin/env python3
+
+import glob
+import os
+import re
+import sys
+from jam_types import (
+    AssurancesXt,
+    Block,
+    Culprit,
+    DisputesXt,
+    Extrinsics,
+    Fault,
+    GuaranteesXt,
+    Header,
+    PreimagesXt,
+    RefineContext,
+    TicketsXt,
+    Verdict,
+    WorkItem,
+    WorkPackage,
+    WorkPackageAvailSpec,
+    WorkReport,
+    WorkResult,
+    spec
+)
+
+script_dir = os.path.dirname(os.path.abspath(__file__))
+sys.path.append(os.path.abspath(os.path.join(script_dir, '../lib')))
+from bin_to_json import convert_to_json # noqa: E402
+
+os.chdir(script_dir)
+
+# Map the subsystem's parameter to the corresponding dump class
+dump_classes = {
+    "refine_context": RefineContext,
+    "work_item": WorkItem,
+    "work_package": WorkPackage,
+    "work_package_avail_spec": WorkPackageAvailSpec,
+    "work_result": WorkResult,
+    "work_report": WorkReport,
+    "header": Header,
+    "verdict": Verdict,
+    "culprit": Culprit,
+    "fault": Fault,
+    "tickets_extrinsic": TicketsXt,
+    "disputes_extrinsic": DisputesXt,
+    "preimages_extrinsic": PreimagesXt,
+    "assurances_extrinsic": AssurancesXt,
+    "guarantees_extrinsic": GuaranteesXt,
+    "extrinsic": Extrinsics,
+    "block": Block,
+}
+
+
+def convert(spec_name):
+    print(f"\n[Converting codec ({spec_name})]")
+    spec.set_spec(spec_name)
+    for filename in glob.glob(f"{spec_name}/*.bin"):
+        print("Converting ", filename)
+        basename = os.path.splitext(os.path.basename(filename))[0]
+        basename = re.sub(r'_\d+$', '', basename)
+        class_type = dump_classes[basename]
+        convert_to_json(filename, class_type)   
+
+for spec_name in ["tiny", "full"]:
+    convert(spec_name)

README.md

@@ -4,9 +4,9 @@
 import sys
 
 script_dir = os.path.dirname(os.path.abspath(__file__))
-sys.path.append(os.path.abspath(os.path.join(script_dir, '../jam-types-asn')))
+sys.path.append(os.path.abspath(os.path.join(script_dir, '../lib')))
 
-from utils import validate_group  # noqa: E402
+from validate_asn1 import validate_group  # noqa: E402
 
 os.chdir(script_dir)
 

codec/convert.py

@@ -0,0 +1,51 @@
+# Binary to JSON conversion support utilities.
+#
+# Depends on [`jam_types`](https://github.com/davxy/jam-types)
+
+import json
+import glob
+from jam_types import Struct, ScaleBytes, spec
+
+class StfTestVector(Struct):
+    state_class = None
+    input_class = None
+    output_class = None
+    errno_map = None
+
+    def __init__(self, data):
+        self.type_mapping = [
+            ('input', self.input_class),
+            ('pre_state', self.state_class),
+            ('output', self.output_class),
+            ('post_state', self.state_class)
+        ]
+        super().__init__(data)
+
+    def decode(self):
+        decoded = super().decode()
+        output = decoded['output']
+        if isinstance(output, dict):
+            errno = output.get('err')
+            if errno is not None and self.errno_map is not None:
+                decoded['output']['err'] = self.errno_map.get(errno, "other_error")
+        return decoded
+
+
+def convert_to_json(filename, subsystem_type):
+    with open(filename, 'rb') as file:
+        blob = file.read()
+        scale_bytes = ScaleBytes(blob)
+        dump = subsystem_type(data=scale_bytes)
+        decoded = dump.decode()
+        json_filename = filename.replace('.bin', '.json')
+        with open(json_filename, 'w') as json_file:
+            json.dump(decoded, json_file, indent=4)
+            json_file.write('\n')
+
+def convert_group(group_name, spec_name, subsystem_type):
+    if spec_name in ("tiny", "full"):
+        spec.set_spec(spec_name)
+    print(f"\n[Converting {group_name} ({spec_name})]")
+    for file in glob.glob(f"{spec_name}/*.bin"):
+        print("* Converting:", file)
+        convert_to_json(file, subsystem_type)