Integration new main

.github/ISSUE_TEMPLATE/bug_report.md

@@ -17,7 +17,7 @@ A clear and concise description of what the bug is.
 **Operating system**: Name/version of the operating system.  
 
 **`configure.sh` options**  
-Paste `configure.sh` here.
+Paste the options passed to `configure.sh` here.
 
 **`configure.sh` output**  
 Paste the output of `configure.sh` here.

.github/actions/add-jar/action.yml

@@ -0,0 +1,82 @@
+name: Add self-contained JAR with the cvc5 Java bindings
+description: |
+  Creates a JAR that includes the cvc5 Java bindings
+  along with the necessary native libraries.
+inputs:
+  install-path:
+    description: path to the directory with installed artifacts
+  jar-libs-dir:
+    description: name of the directory that will contain the libraries within the JAR
+  jar-name:
+    description: target name of the JAR
+  github-token-latest:
+    description: token to upload JAR to latest
+  github-token-release:
+    description: token to upload JAR to release
+  shell:
+    default: bash
+runs:
+  using: composite
+  steps:
+    - name: Create JAR contents (Linux)
+      if: runner.os == 'Linux'
+      shell: ${{ inputs.shell }}
+      run: |
+        echo "::group::Create JAR contents (Linux)"
+        mkdir ${{ inputs.jar-libs-dir }}
+        cd ${{ inputs.jar-libs-dir }}
+        cp ${{ inputs.install-path }}/lib/libcvc5jni.so .
+        echo "::endgroup::"
+
+    - name: Create JAR contents (macOS)
+      if: runner.os == 'macOS'
+      shell: ${{ inputs.shell }}
+      run: |
+        echo "::group::Create JAR contents (macOS)"
+        mkdir ${{ inputs.jar-libs-dir }}
+        cd ${{ inputs.jar-libs-dir }}
+        cp ${{ inputs.install-path }}/lib/libcvc5jni.dylib .
+        echo "::endgroup::"
+
+    - name: Create JAR contents (Windows)
+      if: runner.os == 'Windows'
+      shell: ${{ inputs.shell }}
+      run: |
+        echo "::group::Create JAR contents (Windows)"
+        mkdir ${{ inputs.jar-libs-dir }}
+        cd ${{ inputs.jar-libs-dir }}
+        cp ${{ inputs.install-path }}/bin/cvc5jni.dll .
+        echo "::endgroup::"
+
+    - name: Create JAR
+      shell: ${{ inputs.shell }}
+      run: |
+        echo "::group::Create JAR"
+        unzip ${{ inputs.install-path }}/share/java/cvc5.jar
+        jar cf ${{ inputs.jar-name }}.jar AUTHORS COPYING licenses io ${{ inputs.jar-libs-dir }}
+        echo "::endgroup::"
+
+    - name: Test JAR
+      shell: ${{ inputs.shell }}
+      run: |
+        javac -cp "${{ inputs.jar-name }}.jar" ./examples/api/java/QuickStart.java -d .
+        if [[ "$RUNNER_OS" == "Windows" ]]; then
+          java -cp "${{ inputs.jar-name }}.jar;." QuickStart
+        else
+          java -cp "${{ inputs.jar-name }}.jar:." QuickStart
+        fi
+        rm QuickStart.class
+
+    - name: Store to latest
+      if: github.ref == 'refs/heads/main'
+      uses: ./.github/actions/store-to-latest
+      with:
+        asset-filename: ${{ inputs.jar-name }}.jar
+        github-token: ${{ inputs.github-token-latest }}
+
+    - name: Store to release
+      if: startsWith(github.ref, 'refs/tags/')
+      uses: ./.github/actions/store-to-release
+      with:
+        asset-filename: ${{ inputs.jar-name }}.jar
+        github-token: ${{ inputs.github-token-release }}

.github/actions/add-package/action.yml

@@ -11,10 +11,15 @@ inputs:
     description: token to upload package to release
   shell:
     default: bash
+outputs:
+  install-path:
+    description: path to the installation directory
+    value: ${{ steps.create-zip.outputs.install-path }}
 runs:
   using: composite
   steps:
     - name: Create ZIP file
+      id: create-zip
       shell: ${{ inputs.shell }}
       run: |
         echo "::group::Create ZIP file"
@@ -27,22 +32,34 @@ runs:
         # They are built for testing purposes, but
         # only work for the specific CI Python version.
         rm -rf ${{ inputs.build-dir }}/install/lib/python*
-
-        # Copy COPYING file and licenses directory to install directory
-        cp COPYING ${{ inputs.build-dir }}/install/
+        rm -rf ${{ inputs.build-dir }}/install/lib/site-packages
+
+        if [[ "$RUNNER_OS" == "Windows" ]]; then
+          if [ -f ${{ inputs.build-dir }}/install/bin/libcvc5.dll ]; then
+            cp /mingw64/bin/libgcc_s_seh-1.dll ${{ inputs.build-dir }}/install/bin/
+            cp /mingw64/bin/libstdc++-6.dll ${{ inputs.build-dir }}/install/bin/
+            cp /mingw64/bin/libwinpthread-1.dll ${{ inputs.build-dir }}/install/bin/
+          else
+            cp /mingw64/lib/libgmp.a ${{ inputs.build-dir }}/install/lib/
+          fi
+        fi
+
+        # Copy AUTHORS and COPYING files and licenses directory to install directory
+        cp AUTHORS COPYING ${{ inputs.build-dir }}/install/
         cp -r licenses ${{ inputs.build-dir }}/install/
 
         # Create ZIP file
         pushd ${{ inputs.build-dir }}
         mv install ${{ inputs.package-name }}
+        echo "install-path=${{ inputs.build-dir }}/${{ inputs.package-name }}" >> $GITHUB_OUTPUT
         zip -r ${{ inputs.package-name }} ${{ inputs.package-name }}
         popd
 
         # Move package to root directory
         mv ${{ inputs.build-dir }}/${{ inputs.package-name }}.zip .
         echo "::endgroup::"
 
-    - name: install pyGithub
+    - name: Install pyGithub
       shell: ${{ inputs.shell }}
       run: |
         # Upgrading pyopenssl resolves the following error:
@@ -53,82 +70,14 @@ runs:
 
     - name: Store to latest
       if: github.ref == 'refs/heads/main'
-      shell: 'python3 {0}'
-      env:
-        GITHUB_TOKEN: ${{ inputs.github-token-latest }}
-        PACKAGE: ${{ inputs.package-name }}.zip
-      run: |
-        import datetime
-        import os
-        from github import Github
-
-        sha = os.getenv('GITHUB_SHA')
-
-        gh = Github(os.getenv('GITHUB_TOKEN'))
-        repo = gh.get_repo(os.getenv('GITHUB_REPOSITORY'))
-
-        try:
-          ref = repo.get_git_ref('tags/latest')
-          # update "latest" to current commit if sha changed
-          if ref.object.sha != sha:
-            ref.edit(sha)
-        except:
-          print('tag `latest` does not exist.')
-          exit
-
-        try:
-          rel = repo.get_release('latest')
-        except:
-          print('New `latest` release')
-          rel = repo.create_git_release('latest', 'latest', 'Latest builds')
-
-        # generate new filename
-        package = os.getenv('PACKAGE')
-        name,ext = os.path.splitext(package)
-        curtime = repo.get_git_commit(sha).committer.date.strftime('%Y-%m-%d')
-        samedayprefix = '{}-{}-'.format(name, curtime)
-        filename = '{}-{}-{}{}'.format(name, curtime, sha[:7], ext)
-
-        # prune old commits
-        assets = list(rel.get_assets())
-        assets.sort(key=lambda x: x.created_at, reverse=True)
-
-        for cnt,asset in enumerate(assets):
-          delete = False
-          # We generate 10 artifacts per build:
-          # {Linux, Linux-arm64, macOS, macOS-arm64, Windows} * {static, shared}
-          if cnt >= 20: # Keep at most 2 builds
-            delete = True
-          if asset.name.startswith(samedayprefix):
-            delete = True
-          # convert to timezone-aware datetime
-          age = datetime.datetime.now().replace(tzinfo=datetime.timezone.utc) - asset.created_at
-          if age.days > 7:
-            delete = True
-          if delete:
-            asset.delete_asset()
-
-        # upload as asset with proper name
-        rel.upload_asset(package, name=filename)
+      uses: ./.github/actions/store-to-latest
+      with:
+        asset-filename: ${{ inputs.package-name }}.zip
+        github-token: ${{ inputs.github-token-latest }}
 
     - name: Store to release
       if: startsWith(github.ref, 'refs/tags/')
-      shell: 'python3 {0}'
-      env:
-        GITHUB_TOKEN: ${{ inputs.github-token-release }}
-        PACKAGE: ${{ inputs.package-name }}.zip
-      run: |
-        import os
-        from github import Github
-
-        refname = os.getenv('GITHUB_REF_NAME')
-        gh = Github(os.getenv('GITHUB_TOKEN'))
-        repo = gh.get_repo(os.getenv('GITHUB_REPOSITORY'))
-        try:
-          rel = repo.get_release(refname)
-        except:
-          print("New release from " + refname)
-          ref = repo.get_git_ref('tags/' + refname)
-          commit = repo.get_git_commit(ref.object.sha)
-          rel = repo.create_git_release(refname, refname, commit.message)
-        rel.upload_asset(os.getenv('PACKAGE'))
+      uses: ./.github/actions/store-to-release
+      with:
+        asset-filename: ${{ inputs.package-name }}.zip
+        github-token: ${{ inputs.github-token-release }}

.github/actions/configure-and-build/action.yml

@@ -45,12 +45,7 @@ runs:
           -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -DCMAKE_C_COMPILER_LAUNCHER=ccache
 
         cd build-shared/ && pwd=$(pwd)
-        if [[ "$RUNNER_OS" == "Windows" ]]; then
-          ccache --set-config="base_dir=$pwd"
-        else
-          # can not use `ccache --set-config=base_dir=` due to ccache bug, fixed with 3.7.10
-          $SED -i.orig -n -e '/^base_dir = /!p' -e "\$abase_dir = $pwd" $CCACHE_CONFIGPATH
-        fi
+        ccache --set-config="base_dir=$pwd"
 
         make -j${{ env.num_proc }}
 
@@ -66,16 +61,11 @@ runs:
       run: |
         echo "::group::Static build"
         ${{ inputs.configure-env }} ./configure.sh ${{ inputs.configure-config }} \
-          --prefix=$(pwd)/build-static/install --werror --static --name=build-static --no-java-bindings \
+          --prefix=$(pwd)/build-static/install --werror --static --name=build-static \
           -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -DCMAKE_C_COMPILER_LAUNCHER=ccache
 
         cd build-static/ && pwd=$(pwd)
-        if [[ "$RUNNER_OS" == "Windows" ]]; then
-          ccache --set-config="base_dir=$pwd"
-        else
-          # can not use `ccache --set-config=base_dir=` due to ccache bug, fixed with 3.7.10
-          $SED -i.orig -n -e '/^base_dir = /!p' -e "\$abase_dir = $pwd" $CCACHE_CONFIGPATH
-        fi
+        ccache --set-config="base_dir=$pwd"
 
         make -j${{ env.num_proc }}
 
@@ -90,11 +80,7 @@ runs:
       shell: ${{ inputs.shell }}
       run: |
         echo "::group::Reset ccache base_dir"
-        if [[ "$RUNNER_OS" == "Windows" ]]; then
-          ccache --set-config="base_dir="
-        else
-          $SED -i.orig -n -e '/^base_dir = /!p' -e "\$abase_dir =" $CCACHE_CONFIGPATH
-        fi
+        ccache --set-config="base_dir="
         echo "::endgroup::"
 
     - name: ccache Statistics

.github/actions/install-dependencies/action.yml

@@ -6,8 +6,12 @@ inputs:
   windows-build:
     default: false
     type: boolean
+  wasm-build:
+    default: false
+    type: boolean
   shell:
     default: bash
+
 runs:
   using: composite
   steps:
@@ -27,7 +31,6 @@ runs:
           libtinfo-dev \
           libfl-dev
         echo "SED=sed" >> $GITHUB_ENV
-        echo "CCACHE_CONFIGPATH=/home/runner/.ccache/ccache.conf" >> $GITHUB_ENV
         echo "::endgroup::"
 
     - name: Install software for cross-compiling for arm64 Linux
@@ -57,6 +60,21 @@ runs:
         sudo update-alternatives --set x86_64-w64-mingw32-g++ /usr/bin/x86_64-w64-mingw32-g++-posix
         echo "::endgroup::"
 
+    - name: Install software for WebAssembly compilation
+      # Boolean inputs are actually strings:
+      # https://github.com/actions/runner/issues/1483
+      if: inputs.wasm-build == 'true'
+      shell: bash
+      run: |
+        echo "::group::Install software for WebAssembly compilation"
+        sudo apt-get update
+        git clone https://github.com/emscripten-core/emsdk.git
+        cd emsdk/
+        ./emsdk install '3.1.18'
+        ./emsdk activate '3.1.18'
+        echo "$(pwd)" >> $GITHUB_PATH
+        echo "$(pwd)/upstream/emscripten" >> $GITHUB_PATH
+
     - name: Install Windows software
       if: runner.os == 'Windows' && inputs.windows-build == 'true'
       uses: msys2/setup-msys2@v2
@@ -66,6 +84,7 @@ runs:
         path-type: inherit
         install: |
           make
+          mingw-w64-x86_64-autotools
           mingw-w64-x86_64-ccache
           mingw-w64-x86_64-cmake
           mingw-w64-x86_64-gcc
@@ -89,13 +108,14 @@ runs:
         brew config
         brew untap homebrew/core homebrew/cask
         brew config
-
-        brew install \
+        if [[ $RUNNER_ARCH == "ARM64" ]]; then
+          AUTOTOOLS="autoconf libtool"
+        fi
+        brew install $AUTOTOOLS \
+          automake \
           ccache \
-          pkgconfig \
           gnu-sed
         echo "SED=gsed" >> $GITHUB_ENV
-        echo "CCACHE_CONFIGPATH=/Users/runner/Library/Preferences/ccache/ccache.conf" >> $GITHUB_ENV
         echo "num_proc=$(( $(sysctl -n hw.logicalcpu) + 1 ))" >> $GITHUB_ENV
         echo "::endgroup::"
 
@@ -109,6 +129,14 @@ runs:
         echo "$HOME/.venv/bin" >> $GITHUB_PATH
         echo "::endgroup::"
 
+    # Required for the installation of Python bindings
+    - name: Upgrade Python pip
+      shell: ${{ inputs.shell }}
+      run: |
+        echo "::group::Upgrade Python pip"
+        python3 -m pip install --upgrade pip
+        echo "::endgroup::"
+
     - name: Install software for documentation
       if: inputs.with-documentation == 'true'
       shell: ${{ inputs.shell }}
@@ -118,5 +146,5 @@ runs:
         python3 -m pip install \
           sphinx==7.1.2 \
           sphinxcontrib-bibtex==2.5.0 sphinx-tabs==3.4.1 sphinx-rtd-theme==1.3.0 breathe==4.35.0 \
-          sphinxcontrib-programoutput==0.17
+          sphinxcontrib-programoutput==0.17 sphinxcontrib-googleanalytics==0.4
         echo "::endgroup::"

.github/actions/run-tests/action.yml

@@ -46,7 +46,12 @@ runs:
       shell: ${{ inputs.shell }}
       run: |
         if [[ "${{ inputs.check-python-bindings }}" != "true" ]]; then exit 0; fi
-        export PYTHONPATH="$PYTHONPATH:$(dirname $(dirname $(find ${{ inputs.build-dir }}/install -name 'cvc5_python_base*')))"
+        PYTHON_MODULE_PATH="$(dirname $(dirname $(find ${{ inputs.build-dir }}/install -name 'cvc5_python_base*')))"
+        if [[ "$RUNNER_OS" == "Windows" ]]; then
+          export PYTHONPATH="$PYTHONPATH;$(cygpath -w $PYTHON_MODULE_PATH)"
+        else
+          export PYTHONPATH="$PYTHONPATH:$PYTHON_MODULE_PATH"
+        fi
         python3 -c "import cvc5"
 
     - name: Check Examples
@@ -59,6 +64,8 @@ runs:
           export PATH="${{ inputs.build-dir }}/install/bin:$PATH"
           export CMAKE_GENERATOR="MSYS Makefiles"
         fi
+        export CFLAGS=-Werror
+        export CXXFLAGS=-Werror
         cmake .. -DCMAKE_PREFIX_PATH=${{ inputs.build-dir }}/install/lib/cmake \
           -DPython_EXECUTABLE=$(command -v python3)
         make -j${{ env.num_proc }}