generate execution graphs

Author: jaromil

.github/workflows/main.yml

@@ -31,6 +31,9 @@ jobs:
         with:
           install: true
           cache: false
+      - name: install graphviz
+        run: |
+          sudo apt-get -qy install graphviz
       - name: slangroom tests
         run: |
           ln -s `mise which slangroom-exec` bin/slangroom-exec

.gitignore

@@ -1,6 +1,7 @@
 # bin/slexfe
 bin/slangroom-exec
 src/*.json
+src/*.svg
 *.orig
 *.rdf
 *.slang

bats/setup

@@ -42,10 +42,14 @@ slexe() {
   }
   # run bats_pipe bash bin/slexfe -F $1 \| slangroom-exec
   >&3 echo " 🔥 `basename ${1}.slang`"
+  local start_time_s=$(date +%s)
+  local start_time_ns=$(date +%N)
   bash bin/slexfe -F $1 \
     | slangroom-exec \
         1>$TMP/out 2> >(tee $TMP/err | grep -v 'J64 ' >&2)
   local res=$?
+  local end_time_s=$(date +%s)
+  local end_time_ns=$(date +%N)
   export output=`cat $TMP/out`
   [ "$res" != 0 ] && {
     >&2 echo "TRACE:"
@@ -60,11 +64,52 @@ slexe() {
     _err "Output is missing, no result from previous computation" | tee -a $TMP/err
     exit 1
   }
+  # Avoid leading zero issues by normalizing inputs
+  start_time_s=$((10#$start_time_s))
+  start_time_ns=$((10#$start_time_ns))
+  end_time_s=$((10#$end_time_s))
+  end_time_ns=$((10#$end_time_ns))
+  # Convert and calculate elapsed time in milliseconds
+  local start_time_ms=$((start_time_s * 1000 + start_time_ns / 1000000))
+  local end_time_ms=$((end_time_s * 1000 + end_time_ns / 1000000))
+  local execution_time_ms=$((end_time_ms - start_time_ms))
   rm -f "${1}.out.json"
   echo "$output" > "${1}.out.json"
   >&3 echo " 💾 `basename ${1}.out.json`"
   >&3 echo ""
   set -e
+  if [ -L $1.data.json ]; then
+    idata=`readlink $1.data.json`
+    local size=$(stat --format="%s" "$idata") # Get file size in bytes
+    idata="`basename $idata`\n\n$size bytes"
+  else
+    idata="null\n\n0 bytes"
+  fi
+  if [ -L $1.keys.json ]; then
+    ikeys=`readlink $1.keys.json`
+    local size=$(stat --format="%s" "$ikeys") # Get file size in bytes
+    ikeys="`basename $ikeys`\n\n$size bytes"
+  else
+    ikeys="null\n\n0 bytes"
+  fi
+  # size_kilobytes=$(echo "scale=2; $size / 1024" | bc)
+  iout="`basename $1`\n\n$(stat --format="%s" "$1.out.json") bytes"
+cat <<EOF | dot -Tsvg -o ${1}.svg
+digraph G {
+    rankdir=LR;
+    node [shape=box, style=rounded, fontname="Arial", fontsize=12, color=black, fillcolor=lightgray, margin=0.2];
+    bgcolor=transparent;
+    edge [arrowsize=0.8];
+    Input1 [label="$idata"];
+    Input2 [label="$ikeys"];
+    Script [shape=ellipse, label="zencode_exec\n\ntime: $execution_time_ms ms"];
+    Output [label="$iout"];
+    Input1 -> Script;
+    Input2 -> Script;
+    Script -> Output;
+    edge [color=black, arrowsize=0.7];
+}
+EOF
 }
 
 save_output() {
@@ -78,7 +123,7 @@ save_output() {
   >&3 echo " 💾 > `basename $1`"
 }
 
-prepare() {
+input() {
   [ -r "$2" ] || {
     _err "Input file not found: $2" | tee -a $TMP/err
     exit 1

sign_ecdsa-rdfc-2019.bats

@@ -58,8 +58,8 @@ EOF
 }
 EOF
   export contract="ecdsa_rdf-canon-objects"
-  prepare data $SRC/unsecuredDocument.data.json
-  prepare keys $SRC/${algo}_keyring.out.json
+  input data $SRC/unsecuredDocument.data.json
+  input keys $SRC/${algo}_keyring.out.json
   cat <<EOF > $SRC/${contract}.slang
 rule unknown ignore
 Given I have a 'string dictionary' named 'unsecuredDocument'
@@ -89,8 +89,8 @@ EOF
 
 @test "Create the signature" {
   export contract=${algo}_hash-and-sign
-  prepare data $SRC/${algo}_rdf-canon-objects.out.json
-  prepare keys $SRC/${algo}_keyring.out.json
+  input data $SRC/${algo}_rdf-canon-objects.out.json
+  input keys $SRC/${algo}_keyring.out.json
   cat <<EOF > $SRC/${contract}.slang
 Scenario es256
 Given I have a 'keyring'

sign_eddsa-rdfc-2022.bats

@@ -60,8 +60,8 @@ EOF
 }
 EOF
   export contract=${algo}_rdf-canon-objects
-  prepare data $SRC/unsecuredDocument.data.json
-  prepare keys $SRC/${algo}_keyring.out.json
+  input data $SRC/unsecuredDocument.data.json
+  input keys $SRC/${algo}_keyring.out.json
   cat <<EOF > $SRC/${algo}_rdf-canon-objects.slang
 rule unknown ignore
 Given I have a 'string dictionary' named 'unsecuredDocument'
@@ -91,8 +91,8 @@ EOF
 
 @test "Create the signature" {
   export contract=${algo}_hash-and-sign
-  prepare data $SRC/${algo}_rdf-canon-objects.out.json
-  prepare keys $SRC/${algo}_keyring.out.json
+  input data $SRC/${algo}_rdf-canon-objects.out.json
+  input keys $SRC/${algo}_keyring.out.json
   cat <<EOF > $SRC/${algo}_hash-and-sign.slang
 Scenario eddsa
 Given I have a 'keyring'

sign_mldsa-rdfc-2025.bats

@@ -57,8 +57,8 @@ EOF
 }
 EOF
   export contract="${algo}_rdf-canon-objects"
-  prepare data $SRC/unsecuredDocument.data.json
-  prepare keys $SRC/${algo}_keyring.out.json
+  input data $SRC/unsecuredDocument.data.json
+  input keys $SRC/${algo}_keyring.out.json
   cat <<EOF > $SRC/${contract}.slang
 rule unknown ignore
 Given I have a 'string dictionary' named 'unsecuredDocument'
@@ -88,8 +88,8 @@ EOF
 
 @test "Create the signature" {
   export contract=${algo}_hash-and-sign
-  prepare data $SRC/${algo}_rdf-canon-objects.out.json
-  prepare keys $SRC/${algo}_keyring.out.json
+  input data $SRC/${algo}_rdf-canon-objects.out.json
+  input keys $SRC/${algo}_keyring.out.json
   cat <<EOF > $SRC/${contract}.slang
 Scenario qp
 Given I have a 'keyring'

src/index.md

@@ -11,7 +11,7 @@ hero:
     alt: Hands-on, Dyne.org style
   actions:
     - theme: brand
-      text: 💥 MLDSA (Post-Quantum)
+      text: MLDSA (Post-Quantum)
       link: /mldsa-w3c-vc
     - theme: alt
       text: ECDSA (P256)

src/mldsa-w3c-vc.md

@@ -13,6 +13,7 @@ Conforming to:
 ## Generate keys
 
 <<< @/mldsa_keyring.slang{gherkin}
+![](mldsa_keyring.svg)
 
 ### Output
 
@@ -37,6 +38,7 @@ Results in both private and public keys, which can also be generated in two sepa
 ### Zencode
 
 <<< @/mldsa_rdf-canon-objects.slang{gherkin}
+![](mldsa_rdf-canon-objects.svg)
 
 ### Output
 
@@ -57,6 +59,7 @@ Results in seralized canonical RDF versions of the document and signature settin
 ### Zencode
 
 <<< @/mldsa_hash-and-sign.slang{gherkin}
+![](mldsa_hash-and-sign.svg)
 
 ### 💾 Output
 
@@ -73,6 +76,7 @@ Results in seralized canonical RDF versions of the document and signature settin
 ### Zencode
 
 <<< @/mldsa_prepare-verification-signed-doc.slang{gherkin}
+![](mldsa_prepare-verification-signed-doc.svg)
 
 ### Output
 
@@ -89,6 +93,7 @@ Results again in serialized canonical RDF version of the document and signature
 ### Zencode
 
 <<< @/mldsa_verify-prepared-signed-doc.slang{gherkin}
+![](mldsa_verify-prepared-signed-doc.svg)
 
 ### Output
 

verify_ecdsa-rdfc-2019.bats

@@ -25,8 +25,8 @@ setup() {
 
 @test "Prepare the document signature verification" {
   export contract=${algo}_prepare-verification-signed-doc
-  prepare data $SRC/${algo}_hash-and-sign.out.json
-  prepare keys $SRC/${algo}_keyring.out.json
+  input data $SRC/${algo}_hash-and-sign.out.json
+  input keys $SRC/${algo}_keyring.out.json
   cat <<EOF > $SRC/${contract}.slang
 rule output encoding base64
 Scenario es256
@@ -57,8 +57,8 @@ EOF
 
 @test "Verify the signature" {
   export contract=${algo}_verify-prepared-signed-doc
-  prepare data $SRC/${algo}_prepare-verification-signed-doc.out.json
-  prepare keys /dev/null
+  input data $SRC/${algo}_prepare-verification-signed-doc.out.json
+  input keys /dev/null
   cat <<EOF > ${SRC}/${contract}.slang
 Scenario es256
 Given I have a 'base64' named 'document rdf-canon'

verify_eddsa-rdfc-2022.bats

@@ -25,8 +25,8 @@ setup() {
 
 @test "Prepare the document signature verification" {
   export contract=${algo}_prepare-verification-signed-doc
-  prepare data $SRC/${algo}_hash-and-sign.out.json
-  prepare keys $SRC/${algo}_keyring.out.json
+  input data $SRC/${algo}_hash-and-sign.out.json
+  input keys $SRC/${algo}_keyring.out.json
   cat <<EOF > $SRC/${contract}.slang
 Scenario eddsa
 Given I have a 'keyring'
@@ -56,8 +56,8 @@ EOF
 
 @test "Verify the signature" {
   export contract=${algo}_verify-prepared-signed-doc
-  prepare data $SRC/${algo}_prepare-verification-signed-doc.out.json
-  prepare keys /dev/null
+  input data $SRC/${algo}_prepare-verification-signed-doc.out.json
+  input keys /dev/null
   cat <<EOF > ${SRC}/${contract}.slang
 Scenario eddsa
 Given I have a 'base64' named 'document rdf-canon'

verify_mldsa-rdfc-2025.bats

@@ -24,8 +24,8 @@ setup() {
 
 @test "Prepare the document signature verification" {
   export contract=${algo}_prepare-verification-signed-doc
-  prepare data $SRC/${algo}_hash-and-sign.out.json
-  prepare keys $SRC/${algo}_keyring.out.json
+  input data $SRC/${algo}_hash-and-sign.out.json
+  input keys $SRC/${algo}_keyring.out.json
   cat <<EOF > $SRC/${contract}.slang
 rule output encoding base64
 Scenario qp
@@ -56,8 +56,8 @@ EOF
 
 @test "Verify the signature" {
   export contract=${algo}_verify-prepared-signed-doc
-  prepare data $SRC/${algo}_prepare-verification-signed-doc.out.json
-  prepare keys /dev/null
+  input data $SRC/${algo}_prepare-verification-signed-doc.out.json
+  input keys /dev/null
   cat <<EOF > ${SRC}/${contract}.slang
 Scenario qp
 Given I have a 'base64' named 'document rdf-canon'