release: sync with internal Picus

.github/workflows/config-test/action.yml

@@ -0,0 +1,28 @@
+name: Config test
+description: Configuration test
+inputs:
+  param:
+    description: Parameter for the run
+    required: true
+  exit:
+    description: Expected exit code (either 8 for safe or 9 for unsafe)
+    required: true
+runs:
+  using: composite
+  steps:
+    - name: run picus with param ${{ inputs.param }}
+      run: |
+        set +e
+        racket ./picus.rkt ${{ inputs.param }} | tee result.out
+        code=$?
+        if [ $code -ne ${{ inputs.exit  }} ]; then
+          echo "original exit code: $code"
+          exit 1
+        fi
+      shell: bash # this ensures that pipefail is set
+    - name: test expected result
+      run: |
+        grep "^${{ inputs.exit == '9' && 'The circuit is underconstrained' ||
+                   (inputs.exit == '8' && 'The circuit is properly constrained' ||
+                    'This should fail') }}$" ./result.out
+      shell: bash

.github/workflows/docker-base-modular-push.yml

@@ -0,0 +1,28 @@
+name: Docker Base Modular Image Push
+
+on: workflow_dispatch
+
+jobs:
+  build-base-docker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: 'true'
+          token: ${{ secrets.RELEASE_TOKEN }}
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - name: Login to DockerHub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.SAAS_DOCKERHUB_USERNAME }}
+          password: ${{ secrets.SAAS_DOCKERHUB_TOKEN }}
+      - name: Build and push to DockerHub
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          push: true
+          file: resources/Dockerfile@base-modular
+          platforms: linux/amd64
+          tags: veridise/picus:base-modular

.github/workflows/docker-base.yml → .github/workflows/docker-base-push.yml

@@ -1,21 +1,27 @@
-name: Docker Base Image
+name: Docker Base Image Push
 
 on: workflow_dispatch
 
 jobs:
   build-base-docker:
     runs-on: ubuntu-latest
     steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: 'true'
+          token: ${{ secrets.RELEASE_TOKEN }}
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
       - name: Login to DockerHub
         uses: docker/login-action@v2
         with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
+          username: ${{ secrets.SAAS_DOCKERHUB_USERNAME }}
+          password: ${{ secrets.SAAS_DOCKERHUB_TOKEN }}
       - name: Build and push to DockerHub
         uses: docker/build-push-action@v3
         with:
+          context: .
           push: true
           file: resources/Dockerfile@base
           platforms: linux/amd64

.github/workflows/docker-image.yml

@@ -8,100 +8,18 @@ on:
   workflow_dispatch:
 
 jobs:
-  configuration-test:
-    strategy:
-      matrix:
-        param:
-          - --solver cvc5                              ./benchmarks/circomlib-cff5ab6/[email protected]
-          - --solver z3                                ./benchmarks/circomlib-cff5ab6/[email protected]
-          - --solver cvc5 --opt-level 0                ./benchmarks/circomlib-cff5ab6/[email protected]
-          - --solver cvc5 --opt-level 2 --patch-circom ./benchmarks/circomlib-cff5ab6/[email protected]
-    runs-on: ubuntu-latest
-    container: 
-      image: veridise/picus:git-latest
-    env:
-      PLTADDONDIR: /root/.local/share/racket/
-    steps:
-      - uses: actions/checkout@v1
-      - name: linking circom
-        run: ln -s /root/.cargo/bin/circom /usr/bin/circom
-      - name: compile circomlib
-        run: bash ./scripts/prepare-circomlib.sh
-      - name: run picus with param ${{ matrix.param }}
-        run: |
-          set +e
-          racket ./picus.rkt ${{ matrix.param }} | tee result.out
-          code=$?
-          if [ $code -ne 9 ]; then
-            echo "original exit code: $code"
-            exit 1
-          fi
-        shell: bash # this ensures that pipefail is set
-      - name: test expected result
-        run: |
-          grep "^The circuit is underconstrained$" ./result.out
-
-  wtns-test:
-    runs-on: ubuntu-latest
-    container:
-      image: veridise/picus:git-latest
-    env:
-      PLTADDONDIR: /root/.local/share/racket/
-    steps:
-      - uses: actions/checkout@v1
-      - name: linking circom
-        run: ln -s /root/.cargo/bin/circom /usr/bin/circom
-      - name: run picus
-        run: |
-          set +e
-          racket ./picus.rkt --wtns . ./benchmarks/circomlib-cff5ab6/[email protected]
-          code=$?
-          if [ $code -ne 9 ]; then
-            echo "original exit code: $code"
-            exit 1
-          fi
-        shell: bash # this ensures that pipefail is set
-      - name: test expected result
-        run: |
-          diff first-witness.wtns tests/data/first-witness.wtns.expect
-          diff second-witness.wtns tests/data/second-witness.wtns.expect
-
-  # run the full test with cvc5
-  main-test:
-    strategy:
-      matrix:
-        id: [0, 1, 2, 3]
-    runs-on: ubuntu-latest
-    container: 
-      image: veridise/picus:git-latest
-    env:
-      PLTADDONDIR: /root/.local/share/racket/
-    steps:
-      - uses: actions/checkout@v1
-      - name: linking circom
-        run: ln -s /root/.cargo/bin/circom /usr/bin/circom
-      - name: run picus with cvc5, using v3
-        run: raco test ++args "--parallel ${{ matrix.id }} 4" ./tests/circomlib-test.rkt
-
-  misc-test:
-    runs-on: ubuntu-latest
-    container:
-      image: veridise/picus:git-latest
-    env:
-      PLTADDONDIR: /root/.local/share/racket/
-    steps:
-      - uses: actions/checkout@v1
-      - name: run tests
-        run: |
-          raco test ./tests/performance-test.rkt
-          raco test ./tests/framework-test.rkt
-
   publish-docker:
-    needs: [wtns-test, configuration-test, main-test, misc-test]
     name: "Publish Docker image to DockerHub"
     if: github.event_name == 'push' && github.repository == 'Veridise/picus-private'
+    env:
+      IMAGE_TAG: git-latest
     runs-on: ubuntu-latest
     steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: 'true'
+          token: ${{ secrets.RELEASE_TOKEN }}
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
       - name: Login to DockerHub
@@ -112,6 +30,7 @@ jobs:
       - name: Build and push to DockerHub
         uses: docker/build-push-action@v3
         with:
+          context: .
           push: true
           file: Dockerfile
           platforms: linux/amd64

.github/workflows/full-test.yml

@@ -0,0 +1,112 @@
+name: Full test
+
+on: [push, workflow_dispatch]
+
+jobs:
+  configuration-test:
+    runs-on: ubuntu-latest
+    container:
+      image: veridise/picus:git-latest
+    env:
+      PLTADDONDIR: /root/.local/share/racket/
+    steps:
+      - uses: actions/checkout@v1
+      - name: linking circom
+        run: ln -s /root/.cargo/bin/circom /usr/bin/circom
+      - name: compile circomlib
+        run: bash ./scripts/prepare-circomlib.sh
+
+      - name: unsafe test cvc5 solver
+        uses: ./.github/workflows/config-test
+        with:
+          param: --solver cvc5 ./benchmarks/circomlib-cff5ab6/[email protected]
+          exit: 9
+      - name: unsafe test z3 solver
+        uses: ./.github/workflows/config-test
+        with:
+          param: --solver z3 ./benchmarks/circomlib-cff5ab6/[email protected]
+          exit: 9
+      - name: unsafe test circom format with opt-level 2
+        uses: ./.github/workflows/config-test
+        with:
+          param: --opt-level 2 ./benchmarks/circomlib-cff5ab6/[email protected]
+          exit: 9
+      - name: unsafe test r1cs format
+        uses: ./.github/workflows/config-test
+        with:
+          param: ./benchmarks/circomlib-cff5ab6/[email protected]
+          exit: 9
+      - name: unsafe test sr1cs format
+        uses: ./.github/workflows/config-test
+        with:
+          param: ./tests/sr1cs/unsafe.sr1cs
+          exit: 9
+
+      - name: safe test cvc5 solver
+        uses: ./.github/workflows/config-test
+        with:
+          param: --solver cvc5 ./benchmarks/circomlib-cff5ab6/[email protected]
+          exit: 8
+      - name: safe test z3 solver
+        uses: ./.github/workflows/config-test
+        with:
+          param: --solver z3 ./benchmarks/circomlib-cff5ab6/[email protected]
+          exit: 8
+      - name: safe test circom format with opt-level 2
+        uses: ./.github/workflows/config-test
+        with:
+          param: --opt-level 2 ./benchmarks/circomlib-cff5ab6/[email protected]
+          exit: 8
+      - name: safe test r1cs format
+        uses: ./.github/workflows/config-test
+        with:
+          param: ./benchmarks/circomlib-cff5ab6/[email protected]
+          exit: 8
+      - name: safe test sr1cs format
+        uses: ./.github/workflows/config-test
+        with:
+          param: ./tests/sr1cs/safe.sr1cs
+          exit: 8
+
+      - name: generate witness files
+        uses: ./.github/workflows/config-test
+        with:
+          param: --wtns . ./benchmarks/circomlib-cff5ab6/[email protected]
+          exit: 9
+      - name: test witness files
+        run: |
+          diff first-witness.wtns tests/data/first-witness.wtns.expect
+          diff second-witness.wtns tests/data/second-witness.wtns.expect
+
+  misc-test:
+    runs-on: ubuntu-latest
+    container:
+      image: veridise/picus:git-latest
+    env:
+      PLTADDONDIR: /root/.local/share/racket/
+    steps:
+      - uses: actions/checkout@v1
+      - name: run tests
+        run: |
+          raco test ./tests/performance-test.rkt
+          raco test ./tests/framework-test.rkt
+
+  main-test:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - name: circomlib
+            num-runs: 3
+            jobs: '[0, 1, 2]'
+            path: ./tests/circomlib-test.rkt
+          - name: mixed
+            num-runs: 1
+            jobs: '[0]'
+            path: ./tests/mixed-test.rkt
+    uses: ./.github/workflows/main-test.yml
+    with:
+      name: ${{ matrix.name }}
+      num-runs: ${{ matrix.num-runs }}
+      jobs: ${{ matrix.jobs }}
+      path: ${{ matrix.path }}

.github/workflows/main-test.yml

@@ -0,0 +1,42 @@
+on:
+  workflow_call:
+    inputs:
+      name:
+        description: Name
+        required: true
+        type: string
+      num-runs:
+        description: Max number of runners
+        required: true
+        type: string
+      jobs:
+        description: Job array
+        required: true
+        type: string
+      path:
+        description: Path to file
+        required: true
+        type: string
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        id: ${{ fromJSON(inputs.jobs) }}
+    runs-on: ubuntu-latest
+    container:
+      image: veridise/picus:git-latest
+    env:
+      PLTADDONDIR: /root/.local/share/racket/
+    steps:
+      - uses: actions/checkout@v1
+      - name: linking circom
+        run: ln -s /root/.cargo/bin/circom /usr/bin/circom
+      - name: run picus with cvc5
+        run: raco test ++args "--parallel ${{ matrix.id }} ${{ inputs.num-runs }}" ${{ inputs.path }}
+      - uses: actions/upload-artifact@v3
+        if: ${{ always() }}
+        with:
+          name: ${{ inputs.name }}-${{ github.sha }}
+          path: benchmarks/**/*.json
+          retention-days: 14

.gitignore

@@ -1,3 +1,4 @@
+.venv
 benchmarks/**/*.patched.circom
 benchmarks/**/*.json
 benchmarks/**/*.sym

CHANGELOG.md

@@ -0,0 +1,11 @@
+## v1.0.2 - 2023-11-02
+### Fixed
+- Fixed ANSI codes not stripped away correctly
+
+## v1.0.1 - 2023-11-01
+### Fixed
+- Fixed the format of accounting logging in the --json mode.
+
+## v1.0.0 - 2023-10-26
+### Changed
+- Changed the supported Circom version from 2.0.7 to 2.1.6.