20230326 better print

.github/workflows/build-test.yml

@@ -91,9 +91,10 @@ jobs:
 
     - name: Build Windows with maturin on Python ${{ matrix.python }}
       if: startsWith(matrix.os, 'windows')
+      shell: bash
       run: |
         python -m venv venv
-        echo ". .\venv\Scripts\Activate.ps1" > activate.ps1
+        cp venv/Scripts/activate .
         . ./activate
         maturin build -i python --release --strip
         # Find and install the newly built wheel
@@ -140,14 +141,35 @@ jobs:
         python -c 'import clvm_tools_rs; print(clvm_tools_rs.__file__)'
         echo "CLVM_TOOLS_RS_VERSION=$(python -c 'import clvm_tools_rs; print(clvm_tools_rs.get_version())')" >> "$GITHUB_ENV"
 
+    # Test cldb output both run from python and via its command line tool.
+    - name: "Run step run tests"
+      shell: bash
+      run: |
+        . ./activate
+        cargo build
+        pip install .
+        pip install clvm_rs
+        pip install clvm_tools
+        cd resources/tests && \
+        python test_clvm_step.py && \
+        python mandelbrot-cldb.py
+
+    - name: "Test step run with mandelbrot, setting print only"
+      shell: bash
+      run: |
+        . ./activate
+        python ./resources/tests/lib/steprun.py ./resources/tests/mandelbrot/mandelbrot.clvm.hex resources/tests/mandelbrot/mand_args.txt ./resources/tests/mandelbrot/mandelbrot.sym > /tmp/mand_output.txt
+        # Fail if the output differs.
+        diff -s -q /tmp/mand_output.txt ./resources/tests/mandelbrot/mand_test.txt
+
 
     - name: Verify recompilation of old sources match with new compiler
       if: startsWith(matrix.os, 'ubuntu') && startsWith(matrix.python, '3.8')
       run: |
         set -x
         . ./activate
         # Build cmd line tools
-        PYO3_PYTHON=`which python` cargo build --no-default-features --release
+        PYO3_PYTHON=`which python` cargo build --release
 
         # Grab chia-blockchain
         rm -rf chia-blockchain
@@ -210,7 +232,7 @@ jobs:
 
     - name: Run tests
       if: startsWith(matrix.os, 'ubuntu') && startsWith(matrix.python, '3.8')
-      run: cargo test --no-default-features
+      run: cargo test
 
     - name: Exhaustive assign tests
       if: startsWith(matrix.os, 'ubuntu') && startsWith(matrix.python, '3.8')

resources/tests/game-referee-in-cl21/test_library_basics.py

@@ -70,7 +70,7 @@ def test_smoke_compare():
     compare_program.run(Program.to([]))
 
 def test_handcalc():
-    diag_run_clvm(test_handcalc_program, Program.to([]), 'test_handcalc.sym')
+    diag_run_clvm(test_handcalc_program, Program.to([]), 'test_handcalc.sym', {'print': True})
 
 def proper_list_inner(result,cl):
     if hasattr(cl, 'pair') and cl.pair is not None:
@@ -137,20 +137,20 @@ def test_permutations_2():
     all_b_string = 0x626262626262
     for try_list in [[all_a_string,all_b_string], [all_b_string,all_a_string]]:
         want_set = list([list(v) for v in sorted(permutations(try_list))])
-        listed_result = diag_run_clvm(smoke_test_permutations_program, Program.to([try_list]), 'smoke_test_permutations.sym')
+        listed_result = diag_run_clvm(smoke_test_permutations_program, Program.to([try_list]), 'smoke_test_permutations.sym', {'print': True})
         pl = proper_list(listed_result)
         perms_result = sorted([int_list(x) for x in de_none_list(pl)])
         assert want_set == perms_result
 
 def test_chialisp_sort_program():
-    diag_run_clvm(test_sort_program, Program.to([]), 'test_sort.sym')
+    diag_run_clvm(test_sort_program, Program.to([]), 'test_sort.sym', {'print': True})
 
 def test_permutations_n():
     for i in range(3,6):
         do_test_permutations_of_size_n(i)
 
 def test_chialisp_permutations_program():
-    diag_run_clvm(test_permutations_program, Program.to([3, 5]), 'test_permutations.sym')
+    diag_run_clvm(test_permutations_program, Program.to([3, 5]), 'test_permutations.sym', {'print': True})
 
 def test_smoke_sort():
     for length in range(7): # 0-7 length

resources/tests/lib/steprun.py

@@ -1,15 +1,11 @@
+from typing import List
 import binascii
 import json
 import os
 from pathlib import Path
-from typing import List
-
-# from chia.types.blockchain_format.program import Program
+from clvm_tools_rs import start_clvm_program, compose_run_function, compile_clvm
+from clvm_tools.binutils import assemble
 from clvm_rs import Program
-from clvm_tools.binutils import assemble, disassemble
-
-from clvm_tools_rs import compile_clvm, compose_run_function, start_clvm_program
-
 
 def compile_module_with_symbols(include_paths: List[Path], source: Path):
     path_obj = Path(source)
@@ -36,34 +32,36 @@ def run_until_end(p):
         step_result = p.step()
         if step_result is not None:
             last = step_result
-            if "Print" in last:
-                to_print = last["Print"]
-                if "Print-Location" in last:
-                    print(f"{last['Print-Location']}: print {to_print}")
-                else:
-                    print(f"print {to_print}")
+            if 'Print' in last:
+                print(f"{last['Print']}")
 
     return last
 
-
-def diag_run_clvm(program, args, symbols):
-    hex_form_of_program = binascii.hexlify(bytes(program)).decode("utf8")
-    hex_form_of_args = binascii.hexlify(bytes(args)).decode("utf8")
+def diag_run_clvm(program, args, symbols, options):
+    hex_form_of_program = binascii.hexlify(bytes(program)).decode('utf8')
+    hex_form_of_args = binascii.hexlify(bytes(args)).decode('utf8')
     symbols = json.loads(open(symbols).read())
-    p = start_clvm_program(
-        hex_form_of_program, hex_form_of_args, symbols, None
-    )
+    p = start_clvm_program(hex_form_of_program, hex_form_of_args, symbols, None, options)
     report = run_until_end(p)
-    if "Failure" in report:
-        raise Exception(report)
+    if 'Failure' in report:
+        print(report['Failure'])
     else:
-        return assemble(report["Final"])
+        return assemble(report['Final'])
 
-
-if __name__ == "__main__":
+if __name__ == '__main__':
     # smoke test
     import sys
+    import argparse
+    import traceback
+
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-p', '--print', action='store_true', default=True)
+    parser.add_argument('program')
+    parser.add_argument('env')
+    parser.add_argument('symbols')
+    args = parser.parse_args()
 
-    program = Program.fromhex(open(sys.argv[1]).read())
-    args = Program.fromhex(open(sys.argv[2]).read())
-    diag_run_clvm(program, args)
+    program = Program.fromhex(open(args.program).read())
+    env = Program.fromhex(open(args.env).read())
+    options = { 'print': args.print }
+    diag_run_clvm(program, env, args.symbols, options)

resources/tests/mandelbrot-cldb.py

@@ -0,0 +1,37 @@
+#!/usr/bin/env python
+
+import subprocess
+
+command = ['../../target/debug/cldb', '-p', './mandelbrot/mandelbrot.clsp', '(-192 -128 -144 -96 8)']
+want_output = """---
+- Print: ((escape-at -152 -104) 14)
+- Print: ((escape-at -160 -104) 14)
+- Print: ((escape-at -168 -104) 14)
+- Print: ((escape-at -176 -104) 11)
+- Print: ((escape-at -184 -104) 8)
+- Print: ((escape-at -192 -104) 7)
+- Print: ((escape-at -152 -112) 14)
+- Print: ((escape-at -160 -112) 14)
+- Print: ((escape-at -168 -112) 14)
+- Print: ((escape-at -176 -112) 14)
+- Print: ((escape-at -184 -112) 8)
+- Print: ((escape-at -192 -112) 7)
+- Print: ((escape-at -152 -120) 14)
+- Print: ((escape-at -160 -120) 14)
+- Print: ((escape-at -168 -120) 14)
+- Print: ((escape-at -176 -120) 13)
+- Print: ((escape-at -184 -120) 8)
+- Print: ((escape-at -192 -120) 6)
+- Print: ((escape-at -152 -128) 12)
+- Print: ((escape-at -160 -128) 10)
+- Print: ((escape-at -168 -128) 10)
+- Print: ((escape-at -176 -128) 7)
+- Print: ((escape-at -184 -128) 6)
+- Print: ((escape-at -192 -128) 5)
+- Print: "(\\"result\\" \\"||567AAC|68DEEE|78EEEE|78BEEE\\")"
+- Final: "3356114000950459963475899699747220812557867594760040767593731831711045"
+  Final-Location: "./mandelbrot/mandelbrot.clsp(8):43"
+"""
+
+have_output = subprocess.check_output(command).decode('utf8')
+assert have_output == want_output

resources/tests/mandelbrot/mand_args.txt

@@ -0,0 +1 @@
+ff82ff40ff8180ff82ff70ff81a0ff0880

resources/tests/mandelbrot/mand_test.txt

@@ -0,0 +1,25 @@
+(("escape-at" -152 -104) 14)
+(("escape-at" -160 -104) 14)
+(("escape-at" -168 -104) 14)
+(("escape-at" -176 -104) 11)
+(("escape-at" -184 -104) 8)
+(("escape-at" -192 -104) 7)
+(("escape-at" -152 -112) 14)
+(("escape-at" -160 -112) 14)
+(("escape-at" -168 -112) 14)
+(("escape-at" -176 -112) 14)
+(("escape-at" -184 -112) 8)
+(("escape-at" -192 -112) 7)
+(("escape-at" -152 -120) 14)
+(("escape-at" -160 -120) 14)
+(("escape-at" -168 -120) 14)
+(("escape-at" -176 -120) 13)
+(("escape-at" -184 -120) 8)
+(("escape-at" -192 -120) 6)
+(("escape-at" -152 -128) 12)
+(("escape-at" -160 -128) 10)
+(("escape-at" -168 -128) 10)
+(("escape-at" -176 -128) 7)
+(("escape-at" -184 -128) 6)
+(("escape-at" -192 -128) 5)
+("result" "||567AAC|68DEEE|78EEEE|78BEEE")

resources/tests/mandelbrot/mandelbrot.clsp

@@ -0,0 +1,55 @@
+;; Mandelbrot set in chialisp
+(mod (X1 Y1 X2 Y2 STEP)
+  (include *standard-cl-21*)
+  (defconstant LIMIT 0x0400)
+  (defconstant MAXITERS 15)
+  (defconstant CHARS "0123456789ABCDEF")
+
+  (defun print (M P) (if (all "$print$" M P) P P))
+
+  (defun to-char (V)
+    (c 1 (substr CHARS V (+ 1 V)))
+    )
+
+  (defun escape-steps (X Y WX WY V)
+    (if (> MAXITERS V)
+      (let
+        ((xsqr (ash (* X X) -8))
+         (ysqr (ash (* Y Y) -8)))
+        (if (> (+ xsqr ysqr) LIMIT)
+          (- V 1)
+          (let
+            ((next-x (+ (- xsqr ysqr) WX))
+             (next-y (+ (* 2 (ash (* X Y) -8)) WY)))
+            (escape-steps next-x next-y WX WY (+ 1 V))
+            )
+          )
+        )
+      (- V 1)
+      )
+    )
+
+
+  (defun basic-scanline (X1 Y1 X2 STEP)
+    (if (> X2 X1)
+      (let ((escape (print (list "escape-at" X1 Y1) (escape-steps 0 0 X1 Y1 0)))
+            (rest (basic-scanline (+ X1 STEP) Y1 X2 STEP)))
+        (c (to-char escape) rest)
+        )
+      ()
+      )
+    )
+
+  (defun stringify-row (R)
+    (a (c 14 (c (c 1 "|") R)) ())
+    )
+
+  (defun scan (X1 Y1 X2 Y2 STEP)
+    (if (> Y2 Y1)
+      (c (c 1 (stringify-row (basic-scanline X1 Y1 X2 STEP))) (scan X1 (+ STEP Y1) X2 Y2 STEP))
+      ()
+      )
+    )
+
+  (print "result" (stringify-row (scan X1 Y1 X2 Y2 STEP)))
+  )

resources/tests/mandelbrot/mandelbrot.clvm.hex

@@ -0,0 +1 @@
+ff02ffff01ff02ff08ffff04ff02ffff04ffff0186726573756c74ffff04ffff02ff16ffff04ff02ffff04ffff02ff1effff04ff02ffff04ff05ffff04ff0bffff04ff17ffff04ff2fffff04ff5fff8080808080808080ff80808080ff8080808080ffff04ffff01ffffff02ffff01ff02ffff03ffff22ffff0187247072696e7424ff05ff0b80ffff01ff02ffff010bff0180ffff01ff02ffff010bff018080ff0180ff0180ffff02ffff01ff04ffff0101ffff0cffff019030313233343536373839414243444546ff05ffff10ffff0101ff05808080ff0180ff02ffff01ff02ffff03ffff15ffff010fff5f80ffff01ff02ffff01ff02ffff03ffff15ffff10ffff16ffff12ff05ff0580ffff0181f880ffff16ffff12ff0bff0b80ffff0181f88080ffff0182040080ffff01ff02ffff01ff11ffff05ffff06ffff06ffff06ffff06ffff06ff01808080808080ffff010180ff0180ffff01ff02ffff01ff02ff1cffff04ff02ffff04ffff10ffff11ffff16ffff12ff05ff0580ffff0181f880ffff16ffff12ff0bff0b80ffff0181f88080ffff05ffff06ffff06ffff06ff018080808080ffff04ffff10ffff12ffff0102ffff16ffff12ffff05ffff06ff018080ffff05ffff06ffff06ff0180808080ffff0181f88080ffff05ffff06ffff06ffff06ffff06ff01808080808080ffff04ffff05ffff06ffff06ffff05ffff04ffff04ffff05ffff06ff018080ffff04ffff05ffff06ffff06ff01808080ffff04ffff05ffff06ffff06ffff06ff0180808080ffff04ffff05ffff06ffff06ffff06ffff06ff018080808080ffff04ffff05ffff06ffff06ffff06ffff06ffff06ff01808080808080ffff01808080808080ffff04ffff16ffff12ff05ff0580ffff0181f880ffff04ffff16ffff12ff0bff0b80ffff0181f880ffff018080808080808080ffff04ffff05ffff06ffff06ffff06ffff05ffff04ffff04ffff05ffff06ff018080ffff04ffff05ffff06ffff06ff01808080ffff04ffff05ffff06ffff06ffff06ff0180808080ffff04ffff05ffff06ffff06ffff06ffff06ff018080808080ffff04ffff05ffff06ffff06ffff06ffff06ffff06ff01808080808080ffff01808080808080ffff04ffff16ffff12ff05ff0580ffff0181f880ffff04ffff16ffff12ff0bff0b80ffff0181f880ffff01808080808080808080ffff04ffff10ffff0101ffff05ffff06ffff06ffff06ffff06ffff05ffff04ffff04ffff05ffff06ff018080ffff04ffff05ffff06ffff06ff01808080ffff04ffff05ffff06ffff06ffff06ff0180808080ffff04ffff05ffff06ffff06ffff06ffff06ff018080808080ffff04ffff05ffff06ffff06ffff06ffff06ffff06ff01808080808080ffff01808080808080ffff04ffff16ffff12ff05ff0580ffff0181f880ffff04ffff16ffff12ff0bff0b80ffff0181f880ffff018080808080808080808080ff8080808080808080ff018080ff0180ff0180ffff01ff02ffff01ff11ff5fffff010180ff018080ff0180ff0180ffff02ffff01ff02ffff03ffff15ff17ff0580ffff01ff02ffff01ff04ffff02ff14ffff04ff02ffff04ffff02ff08ffff04ff02ffff04ffff04ffff01896573636170652d6174ffff04ff05ffff04ff0bffff0180808080ffff04ffff02ff1cffff04ff02ffff04ffff0180ffff04ffff0180ffff04ff05ffff04ff0bffff04ffff0180ff8080808080808080ff8080808080ff80808080ffff02ff0affff04ff02ffff04ffff10ff05ff2f80ffff04ff0bffff04ff17ffff04ff2fff8080808080808080ff0180ffff01ff02ffff01ff0180ff018080ff0180ff0180ffff02ffff01ff02ffff04ffff010effff04ffff04ffff0101ffff017c80ff058080ffff018080ff0180ff02ffff01ff02ffff03ffff15ff2fff0b80ffff01ff02ffff01ff04ffff04ffff0101ffff02ff16ffff04ff02ffff04ffff02ff0affff04ff02ffff04ff05ffff04ff0bffff04ff17ffff04ff5fff80808080808080ff8080808080ffff02ff1effff04ff02ffff04ff05ffff04ffff10ff5fff0b80ffff04ff17ffff04ff2fffff04ff5fff808080808080808080ff0180ffff01ff02ffff01ff0180ff018080ff0180ff0180ff018080

resources/tests/test_clvm_step.py

@@ -4,17 +4,23 @@
 import json
 from clvm_tools_rs import start_clvm_program, compose_run_function
 
-def run_until_end(p):
+def do_nothing(p):
+    pass
+
+def run_until_end(p,printing=do_nothing,spam=True):
     last = None
     location = None
 
     while not p.is_ended():
         step_result = p.step()
         if step_result is not None:
             last = step_result
+            if 'Print' in last:
+                printing(last['Print'])
             if 'Operator-Location' in last:
                 location = last['Operator-Location']
-            print(json.dumps(step_result))
+            if spam:
+                print(json.dumps(step_result))
 
     return (last, location)
 
@@ -43,6 +49,54 @@ def fact_base_override(env):
 
     assert int(last['Final']) == 11880
 
+def test_with_printing():
+    mypath = Path(os.path.abspath(__file__))
+    testpath = mypath.parent.joinpath('mandelbrot')
+    symbols = json.loads(open(str(testpath.joinpath('mandelbrot.sym'))).read())
+
+    p = start_clvm_program(open(str(testpath.joinpath('mandelbrot.clvm.hex'))).read(), 'ff82ff40ff8180ff82ff70ff81a0ff0880', symbols, {})
+
+    print_outputs = []
+    def do_print(p):
+        print(p)
+        print_outputs.append(p)
+
+    last, location = run_until_end(p,printing=do_print,spam=False)
+
+    expected_outcome = "||567AAC|68DEEE|78EEEE|78BEEE"
+    want_prints = [
+        "((\"escape-at\" -152 -104) 14)",
+        "((\"escape-at\" -160 -104) 14)",
+        "((\"escape-at\" -168 -104) 14)",
+        "((\"escape-at\" -176 -104) 11)",
+        "((\"escape-at\" -184 -104) 8)",
+        "((\"escape-at\" -192 -104) 7)",
+        "((\"escape-at\" -152 -112) 14)",
+        "((\"escape-at\" -160 -112) 14)",
+        "((\"escape-at\" -168 -112) 14)",
+        "((\"escape-at\" -176 -112) 14)",
+        "((\"escape-at\" -184 -112) 8)",
+        "((\"escape-at\" -192 -112) 7)",
+        "((\"escape-at\" -152 -120) 14)",
+        "((\"escape-at\" -160 -120) 14)",
+        "((\"escape-at\" -168 -120) 14)",
+        "((\"escape-at\" -176 -120) 13)",
+        "((\"escape-at\" -184 -120) 8)",
+        "((\"escape-at\" -192 -120) 6)",
+        "((\"escape-at\" -152 -128) 12)",
+        "((\"escape-at\" -160 -128) 10)",
+        "((\"escape-at\" -168 -128) 10)",
+        "((\"escape-at\" -176 -128) 7)",
+        "((\"escape-at\" -184 -128) 6)",
+        "((\"escape-at\" -192 -128) 5)",
+        f"(\"result\" \"{expected_outcome}\")"
+    ]
+
+    assert print_outputs == want_prints
+    to_hex = hex(int(last['Final']))
+    have_outcome = bytes.fromhex(to_hex[2:]).decode('utf8')
+    assert have_outcome == expected_outcome
+
 def single_function_test():
     mypath = Path(os.path.abspath(__file__))
     testpath = mypath.parent.joinpath('steprun')
@@ -60,3 +114,4 @@ def single_function_test():
     simple_test()
     complex_test()
     single_function_test()
+    test_with_printing()